www.beck-ipc.com

@CHIP-RTOS C Library - TCP/IP API


IPsec_IKE_Phase1_Set

Specify a transform for IKE's phase 1 proposal.

int IPsec_IKE_Phase1_Set(int index,
                 const tIPSEC_TKE_PHASE1 *param) ;

Parameters

index

Index 0 or 1 selects which of the two phase 1 IKE transforms is to be set.

param

Pointer to a tIPSEC_TKE_PHASE1 data structure used to specify the transform's parameters.   A copy of this data is made inside this API, so the caller's image need not persist beyond the return from this function.

Return Value

error code, zero on success.  

Comments

This function adds a user specified phase 1 transform to IKE’s phase 1 proposal.   The user is able to configure up to two such transforms.   The most preferred has index 0, the less preferred has index 1.   If the user configures either of these, the default transform will not be used.

When neither of these optional phase1 proposals is set, the default transform will be used in the phase 1 proposal.   This default transform has the following settings:

    Encryption Algorithm:   3DES CBC
    Hash Algorithm:         SHA1
    Diffie-Hellman Group:   2
    SA Lifetime seconds:   86400 seconds (=1 day)
    SA Lifetime kBytes:   0x10000 kByte (=64 MByte)

The default authentication method is preshared key unless a local certificate has been specified in the CHIP.INI file.

If this API is used to set both of the phase 1 transforms available for user control, then the authentication method specified in these two transforms must be set the same.   Otherwise unpredictable operation may result.

See Also

RTOS API

This library function invokes a RTOS software interrupt.   Refer to the RTOS API function IPSEC_VECTORS for more details.

Related Topics

IKE_PH1_AGGRESSIVE definition in CHIP.INI file

Supported since or modified in @CHIP-RTOS version

    SC12SC13SC11SC1x3SC2x
    n/an/an/aV1.07V1.00

Supported by @CHIP-RTOS C Library since version

    CLIB
    V2.06

This API List
List of C Libraries
@CHIP-RTOS Main Index


End of document