From e465722b908aa870bdc293b9a417d3c15294aa6d Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 25 Dec 2024 20:36:29 +0100 Subject: New upstream version 1.50.1 --- docs/libnm/html/NMDeviceMacsec.html | 941 ------------------------------------ 1 file changed, 941 deletions(-) delete mode 100644 docs/libnm/html/NMDeviceMacsec.html (limited to 'docs/libnm/html/NMDeviceMacsec.html') diff --git a/docs/libnm/html/NMDeviceMacsec.html b/docs/libnm/html/NMDeviceMacsec.html deleted file mode 100644 index d2357543..00000000 --- a/docs/libnm/html/NMDeviceMacsec.html +++ /dev/null @@ -1,941 +0,0 @@ - - - - -NMDeviceMacsec: libnm Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

NMDeviceMacsec

-

NMDeviceMacsec

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-NMDevice * - -nm_device_macsec_get_parent () -
const char * - -nm_device_macsec_get_hw_address () -
-guint64 - -nm_device_macsec_get_sci () -
-guint8 - -nm_device_macsec_get_icv_length () -
-guint64 - -nm_device_macsec_get_cipher_suite () -
-guint - -nm_device_macsec_get_window () -
-guint8 - -nm_device_macsec_get_encoding_sa () -
const char * - -nm_device_macsec_get_validation () -
-gboolean - -nm_device_macsec_get_encrypt () -
-gboolean - -nm_device_macsec_get_protect () -
-gboolean - -nm_device_macsec_get_include_sci () -
-gboolean - -nm_device_macsec_get_es () -
-gboolean - -nm_device_macsec_get_scb () -
-gboolean - -nm_device_macsec_get_replay_protect () -
-
-
-

Properties

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
guint64cipher-suiteRead
gucharencoding-saRead
gbooleanencryptRead
gbooleanesRead
gucharicv-lengthRead
gbooleaninclude-sciRead
-NMDevice *parentRead
gbooleanprotectRead
gbooleanreplay-protectRead
gbooleanscbRead
guint64sciRead
-char *validationRead
guintwindowRead
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineNM_DEVICE_MACSEC_PARENT
#defineNM_DEVICE_MACSEC_HW_ADDRESS
#defineNM_DEVICE_MACSEC_SCI
#defineNM_DEVICE_MACSEC_ICV_LENGTH
#defineNM_DEVICE_MACSEC_CIPHER_SUITE
#defineNM_DEVICE_MACSEC_WINDOW
#defineNM_DEVICE_MACSEC_ENCODING_SA
#defineNM_DEVICE_MACSEC_VALIDATION
#defineNM_DEVICE_MACSEC_ENCRYPT
#defineNM_DEVICE_MACSEC_PROTECT
#defineNM_DEVICE_MACSEC_INCLUDE_SCI
#defineNM_DEVICE_MACSEC_ES
#defineNM_DEVICE_MACSEC_SCB
#defineNM_DEVICE_MACSEC_REPLAY_PROTECT
 NMDeviceMacsec
-
-
-

Object Hierarchy

-
    GObject
-    ╰── NMObject
-        ╰── NMDevice
-            ╰── NMDeviceMacsec
-
-
-
-

Description

-
-
-

Functions

-
-

nm_device_macsec_get_parent ()

-
NMDevice *
-nm_device_macsec_get_parent (NMDeviceMacsec *device);
-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

the device's parent device.

-

[transfer none]

-
-

Since: 1.42

-
-
-
-

nm_device_macsec_get_hw_address ()

-
const char *
-nm_device_macsec_get_hw_address (NMDeviceMacsec *device);
-
-

nm_device_macsec_get_hw_address has been deprecated since version 1.24 and should not be used in newly-written code.

-

Use nm_device_get_hw_address() instead.

-
-

Gets the hardware (MAC) address of the NMDeviceMacsec

-

[skip]

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

the hardware address. This is the internal string used by the -device, and must not be modified.

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_sci ()

-
guint64
-nm_device_macsec_get_sci (NMDeviceMacsec *device);
-

Gets the Secure Channel Identifier in use

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

the SCI

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_icv_length ()

-
guint8
-nm_device_macsec_get_icv_length (NMDeviceMacsec *device);
-

Gets the length of ICV (Integrity Check Value)

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

the length of ICV

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_cipher_suite ()

-
guint64
-nm_device_macsec_get_cipher_suite (NMDeviceMacsec *device);
-

Gets the set of cryptographic algorithms in use

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

the set of cryptographic algorithms in use

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_window ()

-
guint
-nm_device_macsec_get_window (NMDeviceMacsec *device);
-

Gets the size of the replay window

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

size of the replay window

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_encoding_sa ()

-
guint8
-nm_device_macsec_get_encoding_sa (NMDeviceMacsec *device);
-

Gets the value of the Association Number (0..3) for the Security -Association in use.

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

the current Security Association

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_validation ()

-
const char *
-nm_device_macsec_get_validation (NMDeviceMacsec *device);
-

Gets the validation mode for incoming packets (strict, check, -disabled)

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

the validation mode

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_encrypt ()

-
gboolean
-nm_device_macsec_get_encrypt (NMDeviceMacsec *device);
-

Gets whether encryption of transmitted frames is enabled

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

whether encryption is enabled

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_protect ()

-
gboolean
-nm_device_macsec_get_protect (NMDeviceMacsec *device);
-

Gets whether protection of transmitted frames is enabled

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

whether protection is enabled

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_include_sci ()

-
gboolean
-nm_device_macsec_get_include_sci (NMDeviceMacsec *device);
-

Gets whether the SCI is always included in SecTAG for transmitted -frames

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

whether the SCI is always included

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_es ()

-
gboolean
-nm_device_macsec_get_es (NMDeviceMacsec *device);
-

Gets whether the ES (End station) bit is enabled in SecTAG for -transmitted frames

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

whether the ES (End station) bit is enabled

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_scb ()

-
gboolean
-nm_device_macsec_get_scb (NMDeviceMacsec *device);
-

Gets whether the SCB (Single Copy Broadcast) bit is enabled in -SecTAG for transmitted frames

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

whether the SCB (Single Copy Broadcast) bit is enabled

-
-

Since: 1.6

-
-
-
-

nm_device_macsec_get_replay_protect ()

-
gboolean
-nm_device_macsec_get_replay_protect (NMDeviceMacsec *device);
-

Gets whether replay protection is enabled

-
-

Parameters

-
----- - - - - - -

device

a NMDeviceMacsec

 
-
-
-

Returns

-

whether replay protection is enabled

-
-

Since: 1.6

-
-
-
-

Types and Values

-
-

NM_DEVICE_MACSEC_PARENT

-
#define NM_DEVICE_MACSEC_PARENT         "parent"
-
-
-
-
-

NM_DEVICE_MACSEC_HW_ADDRESS

-
#define NM_DEVICE_MACSEC_HW_ADDRESS     "hw-address"
-
-
-
-
-

NM_DEVICE_MACSEC_SCI

-
#define NM_DEVICE_MACSEC_SCI            "sci"
-
-
-
-
-

NM_DEVICE_MACSEC_ICV_LENGTH

-
#define NM_DEVICE_MACSEC_ICV_LENGTH     "icv-length"
-
-
-
-
-

NM_DEVICE_MACSEC_CIPHER_SUITE

-
#define NM_DEVICE_MACSEC_CIPHER_SUITE   "cipher-suite"
-
-
-
-
-

NM_DEVICE_MACSEC_WINDOW

-
#define NM_DEVICE_MACSEC_WINDOW         "window"
-
-
-
-
-

NM_DEVICE_MACSEC_ENCODING_SA

-
#define NM_DEVICE_MACSEC_ENCODING_SA    "encoding-sa"
-
-
-
-
-

NM_DEVICE_MACSEC_VALIDATION

-
#define NM_DEVICE_MACSEC_VALIDATION     "validation"
-
-
-
-
-

NM_DEVICE_MACSEC_ENCRYPT

-
#define NM_DEVICE_MACSEC_ENCRYPT        "encrypt"
-
-
-
-
-

NM_DEVICE_MACSEC_PROTECT

-
#define NM_DEVICE_MACSEC_PROTECT        "protect"
-
-
-
-
-

NM_DEVICE_MACSEC_INCLUDE_SCI

-
#define NM_DEVICE_MACSEC_INCLUDE_SCI    "include-sci"
-
-
-
-
-

NM_DEVICE_MACSEC_ES

-
#define NM_DEVICE_MACSEC_ES             "es"
-
-
-
-
-

NM_DEVICE_MACSEC_SCB

-
#define NM_DEVICE_MACSEC_SCB            "scb"
-
-
-
-
-

NM_DEVICE_MACSEC_REPLAY_PROTECT

-
#define NM_DEVICE_MACSEC_REPLAY_PROTECT "replay-protect"
-
-
-
-
-

NMDeviceMacsec

-
typedef struct _NMDeviceMacsec NMDeviceMacsec;
-

Since: 1.6

-
-
-
-

Property Details

-
-

The “cipher-suite” property

-
  “cipher-suite”             guint64
-

The set of cryptographic algorithms in use.

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: 0

-

Since: 1.6

-
-
-
-

The “encoding-sa” property

-
  “encoding-sa”              guchar
-

The value of the Association Number (0..3) for the Security -Association in use.

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: 0

-

Since: 1.6

-
-
-
-

The “encrypt” property

-
  “encrypt”                  gboolean
-

Whether encryption of transmitted frames is enabled.

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: FALSE

-

Since: 1.6

-
-
-
-

The “es” property

-
  “es”                       gboolean
-

Whether the ES (End station) bit is enabled in SecTAG for -transmitted frames.

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: FALSE

-

Since: 1.6

-
-
-
-

The “icv-length” property

-
  “icv-length”               guchar
-

The length of ICV (Integrity Check Value).

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: 0

-

Since: 1.6

-
-
-
-

The “include-sci” property

-
  “include-sci”              gboolean
-

Whether the SCI is always included in SecTAG for transmitted -frames.

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: FALSE

-

Since: 1.6

-
-
-
-

The “parent” property

-
  “parent”                   NMDevice *
-

The devices's parent device.

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Since: 1.6

-
-
-
-

The “protect” property

-
  “protect”                  gboolean
-

Whether protection of transmitted frames is enabled.

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: FALSE

-

Since: 1.6

-
-
-
-

The “replay-protect” property

-
  “replay-protect”           gboolean
-

Whether replay protection is enabled.

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: FALSE

-

Since: 1.6

-
-
-
-

The “scb” property

-
  “scb”                      gboolean
-

Whether the SCB (Single Copy Broadcast) bit is enabled in -SecTAG for transmitted frames.

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: FALSE

-

Since: 1.6

-
-
-
-

The “sci” property

-
  “sci”                      guint64
-

The Secure Channel Identifier in use.

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: 0

-

Since: 1.6

-
-
-
-

The “validation” property

-
  “validation”               char *
-

The validation mode for incoming packets (strict, check, -disabled).

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: NULL

-

Since: 1.6

-
-
-
-

The “window” property

-
  “window”                   guint
-

The size of the replay window.

-

Owner: NMDeviceMacsec

-

Flags: Read

-

Default value: 0

-

Since: 1.6

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file -- cgit 1.3.0-6-gf8a5