macsec_impl

Warning

doxygenfile: Cannot find file “eos/macsec_impl.h

Type definitions in macsec_impl

namespace eos

class macsec_key_impl_t

#include <macsec_impl.h>

A connectivity association key.

Public Functions

macsec_key_impl_t()

std::string cak() const

Getter for ‘cak’: connectivity association key (CAK). CAK is a hex string.

void cak_is(std::string cak)

Setter for ‘cak’.

std::string ckn() const

Getter for ‘ckn’: connectivity association key name (CKN). CKN is a hex string.

void ckn_is(std::string ckn)

Setter for ‘ckn’.

bool encoded() const

Getter for ‘encoded’: whether or not the CAK has been encoded.

void encoded_is(bool encoded)

Setter for ‘encoded’.

bool operator==(macsec_key_impl_t const &other) const

bool operator!=(macsec_key_impl_t const &other) const

bool operator<(macsec_key_impl_t const &other) const

uint32_t hash() const

The hash function for type macsec_key_t.

void mix_me(hash_mix &h) const

The hash mix function for type macsec_key_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

std::string cak_

std::string ckn_

bool encoded_

Friends

std::ostream &operator<<(std::ostream &os, const macsec_key_impl_t &obj)

A utility stream operator that adds a string representation of macsec_key_t to the ostream.

class macsec_profile_impl_t

#include <macsec_impl.h>

A MACsec profile which can be attached to an interface.

Public Functions

macsec_profile_impl_t()

macsec_profile_impl_t(macsec_profile_name_t name)

macsec_profile_name_t name() const

Getter for ‘name’: the name of the profile.

void name_is(macsec_profile_name_t name)

Setter for ‘name’.

macsec_key_t primary_key() const

Getter for ‘primary_key’: the primary key, which is represented by a CKN and an associated CAK.

void primary_key_is(macsec_key_t primary_key)

Setter for ‘primary_key’.

macsec_key_t fallback_key() const

Getter for ‘fallback_key’: the fallback, or default, key, which is used when the primary is not successful.

void fallback_key_is(macsec_key_t fallback_key)

Setter for ‘fallback_key’.

uint8_t key_server_priority() const

Getter for ‘key_server_priority’: MACsec Key Agreement (MKA) protocol key server priority. 255 is the highest priority.

void key_server_priority_is(uint8_t key_server_priority)

Setter for ‘key_server_priority’.

uint32_t rekey_period() const

Getter for ‘rekey_period’: MKA session re-key period in seconds.

void rekey_period_is(uint32_t rekey_period)

Setter for ‘rekey_period’.

uint32_t mka_life_time() const

Getter for ‘mka_life_time’: MKA session lifetime in seconds.

void mka_life_time_is(uint32_t mka_life_time)

Setter for ‘mka_life_time’.

macsec_cipher_suite_t cipher() const

Getter for ‘cipher’: which encryption standard to use.

void cipher_is(macsec_cipher_suite_t cipher)

Setter for ‘cipher’.

bool dot1x() const

Getter for ‘dot1x’: if set, derive MAC security keys from IEEE 802.1X based port authentication. This will be disabled if a key is provided manually.

void dot1x_is(bool dot1x)

Setter for ‘dot1x’.

bool include_sci() const

Getter for ‘include_sci’: if set, include secure channel identifier (SCI) in data packets.

void include_sci_is(bool include_sci)

Setter for ‘include_sci’.

bool bypass_lldp() const

Getter for ‘bypass_lldp’: if set, transmit/receive LLDP frames without protection : deprecated in favour of lldp_bypass_level.

void bypass_lldp_is(bool bypass_lldp)

Setter for ‘bypass_lldp’: deprecated in favour of lldp_bypass_level_is.

macsec_bypass_t lldp_bypass_level() const

Getter for ‘lldp_bypass_level’: If set, transmit/receive LLDP frames without Macsec encryption when port is authorized/unauthorized.

void lldp_bypass_level_is(macsec_bypass_t lldp_bypass_level)

Setter for ‘lldp_bypass_level’.

macsec_profile_traffic_policy_t traffic_policy() const

Getter for ‘traffic_policy’: traffic policy to be used by an interface.

void traffic_policy_is(macsec_profile_traffic_policy_t traffic_policy)

Setter for ‘traffic_policy’.

bool allow_unprotected() const

Getter for ‘allow_unprotected’: deprecated in favour of traffic_policy.

void allow_unprotected_is(bool allow_unprotected)

Setter for ‘allow_unprotected’: deprecated in favour of traffic_policy.

bool replay_protection() const

Getter for ‘replay_protection’: if set, enable replay protection.

void replay_protection_is(bool replay_protection)

Setter for ‘replay_protection’.

uint32_t replay_protection_window() const

Getter for ‘replay_protection_window’: replay protection window size.

void replay_protection_window_is(uint32_t replay_protection_window)

Setter for ‘replay_protection_window’.

bool key_retirement_immediate() const

Getter for ‘key_retirement_immediate’: if set, enable key retirement.

void key_retirement_immediate_is(bool key_retirement_immediate)

Setter for ‘key_retirement_immediate’.

std::forward_list<intf_id_t> const &intfs() const

Getter for ‘intfs’: Interfaces with this profile configured.

bool operator==(macsec_profile_impl_t const &other) const

bool operator!=(macsec_profile_impl_t const &other) const

bool operator<(macsec_profile_impl_t const &other) const

uint32_t hash() const

The hash function for type macsec_profile_t.

void mix_me(hash_mix &h) const

The hash mix function for type macsec_profile_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

macsec_profile_name_t name_

macsec_key_t primary_key_

macsec_key_t fallback_key_

uint8_t key_server_priority_

uint32_t rekey_period_

uint32_t mka_life_time_

macsec_cipher_suite_t cipher_

bool dot1x_

bool include_sci_

bool bypass_lldp_

macsec_bypass_t lldp_bypass_level_

macsec_profile_traffic_policy_t traffic_policy_

bool replay_protection_

uint32_t replay_protection_window_

bool key_retirement_immediate_

std::forward_list<intf_id_t> intfs_

Friends

std::ostream &operator<<(std::ostream &os, const macsec_profile_impl_t &obj)

A utility stream operator that adds a string representation of macsec_profile_t to the ostream.

void addIntf(macsec_profile_t &profile, intf_id_t intfId)

class macsec_intf_status_impl_t

#include <macsec_impl.h>

Information regarding the MACsec status of an interface.

Public Functions

macsec_intf_status_impl_t()

macsec_intf_key_status_t key_status() const

macsec_intf_traffic_status_t traffic_status() const

void status_is(macsec_intf_key_status_t status)

Deprecated: Setter for ‘status’.

macsec_intf_key_status_t status() const

Deprecated: Getter for ‘status’.

bool operator==(macsec_intf_status_impl_t const &other) const

bool operator!=(macsec_intf_status_impl_t const &other) const

bool operator<(macsec_intf_status_impl_t const &other) const

uint32_t hash() const

The hash function for type macsec_intf_status_t.

void mix_me(hash_mix &h) const

The hash mix function for type macsec_intf_status_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

macsec_intf_key_status_t status_

macsec_intf_key_status_t key_status_

macsec_intf_traffic_status_t traffic_status_

Friends

std::ostream &operator<<(std::ostream &os, const macsec_intf_status_impl_t &obj)

A utility stream operator that adds a string representation of macsec_intf_status_t to the ostream.

void status_is(macsec_intf_status_t &status, macsec_intf_key_status_t keyStatus, macsec_intf_traffic_status_t trafficStatus)

class macsec_intf_counters_impl_t

#include <macsec_impl.h>

MACsec interface counters class.

Public Functions

macsec_intf_counters_impl_t()

macsec_intf_counters_impl_t(uint64_t out_pkts_encrypted, uint64_t out_octets_encrypted, uint64_t in_pkts_decrypted, uint64_t in_octets_decrypted, uint64_t in_pkts_not_valid)

uint64_t out_pkts_encrypted() const

uint64_t out_octets_encrypted() const

uint64_t in_pkts_decrypted() const

uint64_t in_octets_decrypted() const

uint64_t in_pkts_not_valid() const

bool operator==(macsec_intf_counters_impl_t const &other) const

bool operator!=(macsec_intf_counters_impl_t const &other) const

bool operator<(macsec_intf_counters_impl_t const &other) const

uint32_t hash() const

The hash function for type macsec_intf_counters_t.

void mix_me(hash_mix &h) const

The hash mix function for type macsec_intf_counters_t.

std::string to_string() const

Returns a string representation of the current object’s values.

Private Members

uint64_t out_pkts_encrypted_

uint64_t out_octets_encrypted_

uint64_t in_pkts_decrypted_

uint64_t in_octets_decrypted_

uint64_t in_pkts_not_valid_

Friends

std::ostream &operator<<(std::ostream &os, const macsec_intf_counters_impl_t &obj)

A utility stream operator that adds a string representation of macsec_intf_counters_t to the ostream.