fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2025-12-31 03:10:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

macsec: document the format of CAK and CKN properties

Browse source 
(cherry picked from commit dfe63d9eb3)
This commit is contained in:
Beniamino Galvani 2022-11-15 13:58:49 +01:00
parent faf8f0ff24
commit 2dd070e646
3 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/libnm-core-impl/nm-setting-macsec.c
View file

@ -501,7 +501,7 @@ nm_setting_macsec_class_init(NMSettingMacsecClass *klass)
* NMSettingMacsec:mka-cak:
*
* The pre-shared CAK (Connectivity Association Key) for MACsec
* Key Agreement.
* Key Agreement. Must be a string of 32 hexadecimal characters.
*
* Since: 1.6
**/
@ -532,7 +532,8 @@ nm_setting_macsec_class_init(NMSettingMacsecClass *klass)
* NMSettingMacsec:mka-ckn:
*
* The pre-shared CKN (Connectivity-association Key Name) for
* MACsec Key Agreement.
* MACsec Key Agreement. Must be a string of hexadecimal characters
* with a even length between 2 and 64.
*
* Since: 1.6
**/

4
src/libnmc-setting/settings-docs.h.in
View file

@ -226,9 +226,9 @@
#define DESCRIBE_DOC_NM_SETTING_IP_TUNNEL_TOS N_("The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.")
#define DESCRIBE_DOC_NM_SETTING_IP_TUNNEL_TTL N_("The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.")
#define DESCRIBE_DOC_NM_SETTING_MACSEC_ENCRYPT N_("Whether the transmitted traffic must be encrypted.")
#define DESCRIBE_DOC_NM_SETTING_MACSEC_MKA_CAK N_("The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement.")
#define DESCRIBE_DOC_NM_SETTING_MACSEC_MKA_CAK N_("The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.")
#define DESCRIBE_DOC_NM_SETTING_MACSEC_MKA_CAK_FLAGS N_("Flags indicating how to handle the \"mka-cak\" property.")
#define DESCRIBE_DOC_NM_SETTING_MACSEC_MKA_CKN N_("The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement.")
#define DESCRIBE_DOC_NM_SETTING_MACSEC_MKA_CKN N_("The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.")
#define DESCRIBE_DOC_NM_SETTING_MACSEC_MODE N_("Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.")
#define DESCRIBE_DOC_NM_SETTING_MACSEC_PARENT N_("If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an \"802-3-ethernet\" setting with a \"mac-address\" property.")
#define DESCRIBE_DOC_NM_SETTING_MACSEC_PORT N_("The port component of the SCI (Secure Channel Identifier), between 1 and 65534.")

4
src/nmcli/generate-docs-nm-settings-nmcli.xml.in
View file

@ -774,12 +774,12 @@
description="Whether the transmitted traffic must be encrypted." />
<property name="mka-cak"
alias="cak"
description="The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement." />
description="The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters." />
<property name="mka-cak-flags"
description="Flags indicating how to handle the &quot;mka-cak&quot; property." />
<property name="mka-ckn"
alias="ckn"
description="The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement." />
description="The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64." />
<property name="port"
alias="port"
description="The port component of the SCI (Secure Channel Identifier), between 1 and 65534." />