Added in API level 31

IkeSession

class IkeSession : AutoCloseable
kotlin.Any
   ↳ android.net.ipsec.ike.IkeSession

This class represents an IKE Session management object that allows for keying and management of android.net.IpSecTransforms.

An IKE/Child Session represents an IKE/Child SA as well as its rekeyed successors. A Child Session is bounded by the lifecycle of the IKE Session under which it is set up. Closing an IKE Session implicitly closes any remaining Child Sessions under it.

An IKE procedure is one or multiple IKE message exchanges that are used to create, delete or rekey an IKE Session or Child Session.

This class provides methods for initiating IKE procedures, such as the Creation and Deletion of a Child Session, or the Deletion of the IKE session. All procedures (except for IKE deletion) will be initiated sequentially after IKE Session is set up.

Summary

Public constructors
IkeSession(context: Context, ikeSessionParams: IkeSessionParams, firstChildSessionParams: ChildSessionParams, userCbExecutor: Executor, ikeSessionCallback: IkeSessionCallback, firstChildSessionCallback: ChildSessionCallback)

Constructs a new IKE session.
Public methods
Unit

Close the IKE session gracefully.
Unit
closeChildSession(childSessionCallback: ChildSessionCallback)

Delete a Child Session.
Unit

Dumps the state of IkeSession information for the clients
Unit

Terminate (forcibly close) the IKE session.
Unit
openChildSession(childSessionParams: ChildSessionParams, childSessionCallback: ChildSessionCallback)

Request a new Child Session.

Public constructors

IkeSession

Added in API level 31
IkeSession(
    context: Context, 
    ikeSessionParams: IkeSessionParams, 
    firstChildSessionParams: ChildSessionParams, 
    userCbExecutor: Executor, 
    ikeSessionCallback: IkeSessionCallback, 
    firstChildSessionCallback: ChildSessionCallback)

Constructs a new IKE session.

This method will immediately return an instance of IkeSession and asynchronously initiate the setup procedure of IkeSession as well as its first Child Session. Callers will be notified of these two setup results via the callback arguments.

FEATURE_IPSEC_TUNNELS is required for setting up a tunnel mode Child SA.

Parameters
context Context: a valid Context instance. This value cannot be null.
ikeSessionParams IkeSessionParams: the IkeSessionParams that contains a set of valid IkeSession configurations. This value cannot be null.
firstChildSessionParams ChildSessionParams: the ChildSessionParams that contains a set of valid configurations for the first Child Session. This value cannot be null.
userCbExecutor Executor: the Executor upon which all callbacks will be posted. For security and consistency, the callbacks posted to this executor MUST be executed serially and in the order they were posted, as guaranteed by executors such as java.util.concurrent.Executors#newSingleThreadExecutor() This value cannot be null.
ikeSessionCallback IkeSessionCallback: the IkeSessionCallback interface to notify callers of state changes within the IkeSession. This value cannot be null.
firstChildSessionCallback ChildSessionCallback: the ChildSessionCallback interface to notify callers of state changes within the first Child Session. This value cannot be null.
Return
an instance of IkeSession.

Public methods

close

Added in API level 31
fun close(): Unit

Close the IKE session gracefully.

Implements AutoCloseable#close()

Upon closure, IkeSessionCallback#onClosed() or android.net.ipsec.ike.IkeSessionCallback#onClosedWithException(android.net.ipsec.ike.exceptions.IkeException) will be fired.

Closing an IKE Session implicitly closes any remaining Child Sessions negotiated under it. Users SHOULD stop all outbound traffic that uses these Child Sessions ( pairs) before calling this method. Otherwise IPsec packets will be dropped due to the lack of a valid android.net.IpSecTransform.

Closure of an IKE session will take priority over, and cancel other procedures waiting in the queue (but will wait for ongoing locally initiated procedures to complete). After sending the Delete request, the IKE library will wait until a Delete response is received or retransmission timeout occurs.

Exceptions
java.lang.Exception if this resource cannot be closed

closeChildSession

Added in API level 31
fun closeChildSession(childSessionCallback: ChildSessionCallback): Unit

Delete a Child Session.

Upon closure, ChildSessionCallback#onClosed() will be fired.

Parameters
childSessionCallback ChildSessionCallback: The ChildSessionCallback instance that uniquely identify the Child Session. This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if no Child Session found bound with this callback.

dump

Added in API level 35
fun dump(pw: PrintWriter): Unit

Dumps the state of IkeSession information for the clients

Parameters
pw PrintWriter: Print writer This value cannot be null.

kill

Added in API level 31
fun kill(): Unit

Terminate (forcibly close) the IKE session.

Upon closing, IkeSessionCallback#onClosed() will be fired.

Closing an IKE Session implicitly closes any remaining Child Sessions negotiated under it. Users SHOULD stop all outbound traffic that uses these Child Sessions ( pairs) before calling this method. Otherwise IPsec packets will be dropped due to the lack of a valid android.net.IpSecTransform.

Forcible closure of an IKE session will take priority over, and cancel other procedures waiting in the queue. It will also interrupt any ongoing locally initiated procedure.

openChildSession

Added in API level 31
fun openChildSession(
    childSessionParams: ChildSessionParams, 
    childSessionCallback: ChildSessionCallback
): Unit

Request a new Child Session.

Users MUST provide a unique ChildSessionCallback instance for each new Child Session.

Upon setup, ChildSessionCallback#onOpened(ChildSessionConfiguration) will be fired.

FEATURE_IPSEC_TUNNELS is required for setting up a tunnel mode Child SA.

Parameters
childSessionParams ChildSessionParams: the ChildSessionParams that contains the Child Session configurations to negotiate. This value cannot be null.
childSessionCallback ChildSessionCallback: the ChildSessionCallback interface to notify users the state changes of the Child Session. It will be posted to the callback Executor of this IkeSession. This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if the ChildSessionCallback is already in use.