IkeSessionParams.Builder

Builder

public Builder ()

Construct Builder

Builder

public Builder (IkeSessionParams ikeSessionParams)

Construct Builder from the IkeSessionParams object.

addIkeOption

public IkeSessionParams.Builder addIkeOption (int ikeOption)

Sets the specified IKE Option as enabled.

addIkeSaProposal

public IkeSessionParams.Builder addIkeSaProposal (IkeSaProposal proposal)

Adds an IKE SA proposal to the IkeSessionParams being built.

build

public IkeSessionParams build ()

Validates and builds the IkeSessionParams.

removeIkeOption

public IkeSessionParams.Builder removeIkeOption (int ikeOption)

Resets (disables) the specified IKE Option.

setAuthDigitalSignature

public IkeSessionParams.Builder setAuthDigitalSignature (X509Certificate serverCaCert, 
                X509Certificate clientEndCert, 
                List<X509Certificate> clientIntermediateCerts, 
                PrivateKey clientPrivateKey)

Configures the IkeSession to use public-key-signature-based authentication.

The public key included by the client end certificate and the private key used for signing MUST be a matching key pair.

The IKE library will use the strongest signature algorithm supported by both sides.

Currenly only RSA digital signature is supported.

setAuthDigitalSignature

public IkeSessionParams.Builder setAuthDigitalSignature (X509Certificate serverCaCert, 
                X509Certificate clientEndCert, 
                PrivateKey clientPrivateKey)

Configures the IkeSession to use public-key-signature-based authentication.

The public key included by the client end certificate and the private key used for signing MUST be a matching key pair.

The IKE library will use the strongest signature algorithm supported by both sides.

Currenly only RSA digital signature is supported.

setAuthEap

public IkeSessionParams.Builder setAuthEap (X509Certificate serverCaCert, 
                EapSessionConfig eapConfig)

Configures the IkeSession to use EAP authentication.

Not all EAP methods provide mutual authentication. As such EAP MUST be used in conjunction with a public-key-signature-based authentication of the remote server, unless EAP-Only authentication is enabled.

Callers may enable EAP-Only authentication by setting IkeSessionParams.IKE_OPTION_EAP_ONLY_AUTH, which will make IKE library request the remote to use EAP-Only authentication. The remote may opt to reject the request, at which point the received certificates and authentication payload WILL be validated with the provided root CA or system's truststore as usual. Only safe EAP methods as listed in RFC 5998 will be accepted for EAP-Only authentication.

If IkeSessionParams.IKE_OPTION_EAP_ONLY_AUTH is set, callers MUST configure EAP as the authentication method and all EAP methods set in EAP Session configuration MUST be safe methods that are accepted for EAP-Only authentication. Otherwise callers will get an exception when building the IkeSessionParams

Callers MUST declare only one authentication method. Calling this function will override the previously set authentication configuration.

setAuthPsk

public IkeSessionParams.Builder setAuthPsk (byte[] sharedKey)

Configures the IkeSession to use pre-shared-key-based authentication.

Both client and server MUST be authenticated using the provided shared key. IKE authentication will fail if the remote peer tries to use other authentication methods.

Callers MUST declare only one authentication method. Calling this function will override the previously set authentication configuration.

Callers SHOULD NOT use this if any other authentication methods can be used; PSK-based authentication is generally considered insecure.

setDpdDelaySeconds

public IkeSessionParams.Builder setDpdDelaySeconds (int dpdDelaySeconds)

Sets the Dead Peer Detection(DPD) delay in seconds.

setLifetimeSeconds

public IkeSessionParams.Builder setLifetimeSeconds (int hardLifetimeSeconds, 
                int softLifetimeSeconds)

Sets hard and soft lifetimes.

Lifetimes will not be negotiated with the remote IKE server.

setLocalIdentification

public IkeSessionParams.Builder setLocalIdentification (IkeIdentification identification)

Sets local IKE identification for the IkeSessionParams being built.

It is not allowed to use KEY ID together with digital-signature-based authentication as per RFC 7296.

setNattKeepAliveDelaySeconds

public IkeSessionParams.Builder setNattKeepAliveDelaySeconds (int nattKeepaliveDelaySeconds)

Sets the Network Address Translation Traversal (NATT) keepalive delay in seconds.

setNetwork

public IkeSessionParams.Builder setNetwork (Network network)

Sets the Network for the IkeSessionParams being built.

If no Network is provided, the default Network (as per ConnectivityManager.getActiveNetwork()) will be used when constructing an IkeSession.

setRemoteIdentification

public IkeSessionParams.Builder setRemoteIdentification (IkeIdentification identification)

Sets remote IKE identification for the IkeSessionParams being built.

setRetransmissionTimeoutsMillis

public IkeSessionParams.Builder setRetransmissionTimeoutsMillis (int[] retransTimeoutMillisList)

Sets the retransmission timeout list in milliseconds.

Configures the retransmission by providing an array of relative retransmission timeouts in milliseconds. After sending out a request and before receiving the response, the IKE Session will iterate through the array and wait for the relative timeout before the next retry. If the last timeout is exceeded, the IKE Session will be terminated.

Each element in the array MUST be a value from 500 ms to 1800000 ms (30 minutes). The length of the array MUST NOT exceed 10. This retransmission timeout list defaults to {0.5s, 1s, 2s, 4s, 8s}

setServerHostname

public IkeSessionParams.Builder setServerHostname (String serverHostname)

Sets the server hostname for the IkeSessionParams being built.