Skip to main content
Open topic with navigation CAPL Functions » Ethernet » Function Overview » EthernetMacsecSecureEntity::GetCurrentCipherSuite

EthernetMacsecSecureEntity::GetCurrentCipherSuite

Valid for: CANoe DE

Method Syntax

byte EthernetMacsecSecureEntity.GetCurrentCipherSuite(qword& cipherSuiteId);

Description

Returns the ID of the currently agreed MACsec cipher suite. The value will be one of:
  • CS_ID_GCM_AES_128 0x0080c20001000001
  • CS_ID_GCM_AES_256 0x0080c20001000002
  • CS_ID_GCM_AES_XPN_128 0x0080c20001000003
  • CS_ID_GCM_AES_XPN_256 0x0080c20001000004
  • CS_ID_NULL 0xFFFFFFFFFFFFFFFF (if non-MACsec traffic has been agreed upon by MKA)
  • CS_ID_INVALID 0x0000000000000000 (cipher suite has not been initialized yet or MKA has not completed yet).

Parameters

  • cipherSuiteId: The reference parameter where the queried value will be returned.

Return Values

  • byte: 1 if the call succeeded, 0 otherwise.

Example


Text