src/java/com/android/internal/net/ipsec/ike/keepalive/IkeNattKeepalive.java

/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.internal.net.ipsec.ike.keepalive;

import static android.net.ipsec.ike.IkeManager.getIkeLog;

import android.app.PendingIntent;
import android.content.Context;
import android.net.ConnectivityManager;
import android.net.IpSecManager.UdpEncapsulationSocket;
import android.net.Network;

import java.io.IOException;
import java.net.Inet4Address;

/**
 * This class provides methods to manage NAT-T keepalive for a UdpEncapsulationSocket.
 *
 * <p>Upon calling {@link start()}, this class will start a NAT-T keepalive, using hardware offload
 * if available. If hardware offload is not available, a software keepalive will be attempted.
 */
public class IkeNattKeepalive {
    private static final String TAG = "IkeNattKeepalive";

    private NattKeepalive mNattKeepalive;

    /** Construct an instance of IkeNattKeepalive */
    public IkeNattKeepalive(
            Context context,
            ConnectivityManager connectMgr,
            int keepaliveDelaySeconds,
            Inet4Address src,
            Inet4Address dest,
            UdpEncapsulationSocket socket,
            Network network,
            PendingIntent keepAliveAlarmIntent)
            throws IOException {
        mNattKeepalive =
                new HardwareKeepaliveImpl(
                        context,
                        connectMgr,
                        keepaliveDelaySeconds,
                        src,
                        dest,
                        socket,
                        network,
                        new HardwareKeepaliveCb(
                                context,
                                keepaliveDelaySeconds,
                                dest,
                                socket,
                                keepAliveAlarmIntent));
    }

    /** Start keepalive */
    public void start() {
        // Try keepalive using hardware offload first
        getIkeLog().d(TAG, "Start NAT-T keepalive");
        mNattKeepalive.start();
    }

    /** Stop keepalive */
    public void stop() {
        getIkeLog().d(TAG, "Stop NAT-T keepalive");

        mNattKeepalive.stop();
    }

    /** Receive a keepalive alarm */
    public void onAlarmFired() {
        mNattKeepalive.onAlarmFired();
    }

    /** Interface that a keepalive implementation MUST provide to support NAT-T keepalive for IKE */
    public interface NattKeepalive {
        /** Start keepalive */
        void start();
        /** Stop keepalive */
        void stop();
        /** Receive a keepalive alarm */
        void onAlarmFired();
    }

    private class HardwareKeepaliveCb implements HardwareKeepaliveImpl.HardwareKeepaliveCallback {
        private final Context mContext;
        private final int mKeepaliveDelaySeconds;
        private final Inet4Address mDest;
        private final UdpEncapsulationSocket mSocket;
        private final PendingIntent mKeepAliveAlarmIntent;

        HardwareKeepaliveCb(
                Context context,
                int keepaliveDelaySeconds,
                Inet4Address dest,
                UdpEncapsulationSocket socket,
                PendingIntent keepAliveAlarmIntent) {
            mContext = context;
            mKeepaliveDelaySeconds = keepaliveDelaySeconds;
            mDest = dest;
            mSocket = socket;
            mKeepAliveAlarmIntent = keepAliveAlarmIntent;
        }

        @Override
        public void onHardwareOffloadError() {
            getIkeLog().d(TAG, "Switch to software keepalive");
            mNattKeepalive.stop();

            mNattKeepalive =
                    new SoftwareKeepaliveImpl(
                            mContext,
                            mKeepaliveDelaySeconds,
                            mDest,
                            mSocket,
                            mKeepAliveAlarmIntent);
            mNattKeepalive.start();
        }

        @Override
        public void onNetworkError() {
            // Stop doing keepalive when getting network error since it will also fail software
            // keepalive. Considering the only user of IkeNattKeepalive is IkeSessionStateMachine,
            // not notifying user this error won't bring user extral risk. When there is a network
            // error, IkeSessionStateMachine will eventually hit the max request retransmission
            // times and be terminated anyway.
            stop();
        }
    }
}