Port SERVICEACCESS - MACSEC¶
Port for opening MACsec-protected connections that can be used by other ports
此端口要求安装 PCAP 驱动。
Stimulation¶
此端口不具备激励能力。
Properties 🛈¶
Name |
在以下情况下可用 |
默认值 |
有效值 |
Type |
Description |
|---|---|---|---|---|---|
物理层 ❲网络访问❳ |
|||||
网络接口卡 |
[ONLINE] |
string |
用于接收网络报文的网卡或网络适配器 |
||
MAC 地址 ❲客户端❳ |
‘02:00:4C:4F:4F:50’ |
string |
字符串(格式:02:00:4C:4F:4F:50);若应使用适配器的 MAC 地址,则为 ‘default’ |
||
VLAN Settings ❲IEEE 802.1Q❳ |
|||||
VLAN mode |
disable |
[disable, single tagging] |
string |
如果应使用数据库中的 VLAN ID,则设为 ‘auto’;如果不应使用 VLAN,则设为 ‘disable’;如果应指定固定的 VLAN ID,则设为 ‘single tagging’ |
|
VLAN id |
VLAN 模式:‘single tagging’ |
0 |
int |
如果传入的数据包带有 VLAN 标签,则会对其进行过滤,只有带有该 VLAN ID 的数据包才能通过。不带任何 VLAN 标签的传入数据包也会通过过滤器。 |
|
MACsec 密钥协商 ❲MKA❳ 的设置 |
|||||
Connectivity Association Key ❲CAK❳ |
string |
Key for the MACsec key agreement as a hex string (128 or 256 bits). |
|||
Connectivity Association Key Name ❲CKN❳ |
string |
Text which identifies the CAK, as a hex string (8 to 256 bits). |
|||
Algorithms for MACsec protocol |
‘[GCM-AES-XPN-256, GCM-AES-256, GCM-AES-XPN-128, GCM-AES-128]’ |
string |
List of supported MACsec algorithms. Syntax and a list of all supported algorithms can be found in the help file (Tool tracetronic: Ethernet). |
||
Cycle time MKA [ms] |
500 |
int |
Temporal separation between two transmitted MKPDUs in milliseconds (default value: 500 ms, as specified in IEEE 802.1X-2020 section 9.10 NOTE 2) |
||
Do not stop MKA |
☐ |
bool |
MKA stays active beyond test case execution. |
Jobs 🛈¶
GetMacSecValues¶
Determines the current values for SCI, AN, SAK and CipherSuite which may change e.g. when the remote party causes a new SAK creation. If these values are not yet available, an empty dictionary will be returned.
Parameterization
返回值
Name |
在以下情况下可用 |
默认值 |
有效值 |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
Dictionary containing the determined values for SCI, AN, SAK and CipherSuite. For XPN algorithms also XPN Salt and XPN SCI List are returned. |
RekeyMacSec¶
Triggers a new SAK to be generated. As a key server, a new SAK is generated and distributed. Otherwise, the selection of a new member identifier forces the key server to generate and distribute a new SAK. If no SAK could be distributed or received by the specified timeout, the return value is an empty dictionary. The MKA protocol remains active in the background. The “GetMacSecValues” job can be used to react to subsequent connection parameter changes in the test case, such as the receipt of a new SAK.
Parameterization
Parameter
Name |
在以下情况下可用 |
默认值 |
有效值 |
Type |
Description |
|---|---|---|---|---|---|
Timeout |
5.0 |
float |
Timeout in seconds |
返回值
Name |
在以下情况下可用 |
默认值 |
有效值 |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
Dictionary containing the determined values for SCI, AN, SAK and CipherSuite. For XPN algorithms also XPN Salt and XPN SCI List are returned. |
ShutdownMacSec¶
Closes the MACsec session
StartMacSecManipulation¶
Asynchronously starts the MACsec header custom manipulation mode (s. Header Manipulation). Valid values for the MACsec header bits are None = no manipulation, 0 = bit not set, and 1 = bit set. Parameters with the suffix “flags” are not MACsec header bits. They are used to determine the type of manipulation. The valid values for this are in the parameter-specific description.
Parameterization
Parameter
Name |
在以下情况下可用 |
默认值 |
有效值 |
Type |
Description |
|---|---|---|---|---|---|
AN |
int |
SecTag: Association Number |
|||
C |
[False, True] |
bool |
SecTag-TCI: Changed Text Bit: is to be used in combination with E. See IEEE Std 802.1AE 2018 |
||
E |
[False, True] |
bool |
SecTag-TCI: Encryption Bit: 0 - none, 1 - payload encrypted |
||
ES |
[False, True] |
bool |
SecTag-TCI: End Station Bit |
||
ICVFlags |
int |
SecTag: ICV Flags: None = no manipulation, 1 = make ICV invalid |
|||
PNFlags |
int |
SecTag: Packet Number Flags: None = PNStart is absolute, 1 = PNStart is relative to current PN |
|||
PNStart |
int |
SecTag: Packet Number Start is applied once after StartMacSecManipulation. See PNFlags. |
|||
PNStep |
int |
SecTag: Packet Number Step is applied to each subsequent packet after the initial packet. |
|||
SC |
[False, True] |
bool |
SecTag-TCI: Secure Channel Identifier included in SecTAG |
||
SCB |
[False, True] |
bool |
SecTag-TCI: Single Copy Broadcast Capability Bit |
||
SCI |
ByteStream |
SecTag: Secure Channel Identifier |
|||
SL |
int |
SecTag: Short Length |
|||
V |
[False, True] |
bool |
SecTag-TCI: Version Bit |
||
VlanId |
int |
ID with which VLAN packets should be tagged. None = VLAN ID is not applied. |
StartMkaManipulation¶
启动对发出的 MKPDU 的操纵(s. MKA-Manipulation)。
Parameterization
Parameter
Name |
在以下情况下可用 |
默认值 |
有效值 |
Type |
Description |
|---|---|---|---|---|---|
Manipulator |
object |
A ByteStream or user-defined manipulation object that is dynamically applied to MKA packets to be sent (s. MKA-Manipulation). |
StartupMacSec¶
Establishes a MACsec-secured connection with the remote party. If this is not successful within the specified timeout, an empty dictionary is returned. The MKA protocol remains active in the background. The “GetMacSecValues” job can be used to react to subsequent connection parameter changes in the test case, such as the receipt of a new SAK.
Parameterization
Parameter
Name |
在以下情况下可用 |
默认值 |
有效值 |
Type |
Description |
|---|---|---|---|---|---|
Cak |
object |
Key for the MACsec key agreement as a hex string (128 or 256 bits). None will default to the TBC option. |
|||
Ckn |
object |
Text which identifies the CAK, as a hex string (8 to 256 bits). None will default to the TBC option. |
|||
KeyServerFlag |
True |
[False, True] |
bool |
True: enable key server capability, False: another MKA participant is to be key server |
|
KeyServerPrio |
1 |
int |
Priority from 0 (high) to 255 (low) with which the key server role should be perceived if KeyServerFlag=True |
||
MkaAlgorithms |
object |
List of supported MACsec algorithms. Syntax and a list of all supported algorithms can be found in the help file (Tool tracetronic: Ethernet). None will default to the TBC option. |
|||
MkaCycleTime |
500 |
int |
Temporal separation between two transmitted MKPDUs in milliseconds (default value: 500 ms, as specified in IEEE 802.1X-2020 section 9.10 NOTE 2) |
||
Timeout |
5.0 |
float |
Time (in seconds) to wait until MACsec has been activated |
返回值
Name |
在以下情况下可用 |
默认值 |
有效值 |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
Dictionary containing the determined values for SCI, AN, SAK and CipherSuite. For XPN algorithms also XPN Salt and XPN SCI List are returned. |
StopMacSecManipulation¶
Asynchronously stops the MACsec header custom manipulation mode (s. Header Manipulation).
StopMkaManipulation¶
停止对发出的 MKPDU 的操纵(s. MKA-Manipulation)。