CAPLfunctionIpsecAssociationDatabaseDelete

Open topic with navigation

CAPL Functions » TCP/IP API » ipsecAssociationDatabaseDelete

ipsecAssociationDatabaseDelete

Valid for: CANoe DE • CANoe4SW DE

Note
The function is dependent on the selected stack.
It is not possible to modify the security association database of the operating system TCP/IP stack.

Function Syntax

long ipsecAssociationDatabaseDelete(long association); // form 1
long ipsecAssociationDatabaseDelete(IP_Endpoint source, IP_Endpoint destination, char[] protocol, char[] mode, dword spi); // form 2

Description

With this function, it is possible to manually delete a single security association from the security association database of the current network stack.

Parameters

• association: Handle to a security association record object.
• source: Source endpoint of the security association.
• destination: Destination endpoint of the security association.
• protocol: The Ipsec protocol of the security association. The following values are possible:
  • UNSPEC: 0
  • ESP: 1
  • AH: 2
• mode: The IPsec mode of the security association. The following values are possible:
  • ANY: 0
  • TRANSPORT: 1
  • TUNNEL: 2
• spi: The security parameter index of the security association.

Return Values

• 0: Success
• -1: Failed

Example

on start
{
  long association;

  // create and init a security association record
  association = ipsecAssociationInit(ip_Endpoint(192.168.1.1), ip_Endpoint(192.168.1.10), "ah", "any", 30000);

  // add the security association to the security association database
  ipsecAssociationDatabaseAdd(association);
  // release the association object when it isn't needed anymore
  ipsecAssociationRelease(association);
}

on stopMeasurement
{
  // delete the security association from the security association database
  ipsecAssociationDatabaseDelete(ip_Endpoint(192.168.1.1), ip_Endpoint(192.168.1.10), "ah", "any", 30000);
}