ProtocolPP::jmacsec Class Reference

Inheritance diagram for ProtocolPP::jmacsec:

Collaboration diagram for ProtocolPP::jmacsec:

Public Member Functions
	jmacsec (std::shared_ptr< jrand > &rand, std::shared_ptr< jmacsecsa > &sec, std::string &replay)
virtual	~jmacsec ()=default
	Standard deconstructor.
void	encap_packet (std::shared_ptr< jarray< uint8_t > > &input, std::shared_ptr< jarray< uint8_t > > &output)
void	decap_packet (std::shared_ptr< jarray< uint8_t > > &input, std::shared_ptr< jarray< uint8_t > > &output)
void	set_hdr (jarray< uint8_t > &hdr)
void	set_field (field_t field, uint64_t value)
jarray< uint8_t >	get_hdr ()
uint64_t	get_field (field_t field, jarray< uint8_t > &hdr)
uint64_t	get_field (field_t field)
void	get_security (std::shared_ptr< jmacsecsa > &sec)
void	to_xml (tinyxml2::XMLPrinter &myxml, direction_t direction)
void	to_json (std::ofstream &myjson, direction_t direction, std::string &indent)
	jmacsec (jmacsec &rhs)=delete
	jmacsec (const jmacsec &rhs)=delete
Public Member Functions inherited from ProtocolPP::jprotocol
	jprotocol (direction_t dir)
	jprotocol (direction_t dir, std::string &file)
	jprotocol (direction_t dir, std::shared_ptr< jrand > &rand)
	jprotocol (direction_t dir, std::shared_ptr< jrand > &rand, std::string &file)
virtual	~jprotocol ()
	Standard deconstructor.
virtual void	encap_packet (std::shared_ptr< jarray< uint8_t > > &output)
virtual void	decap_packet (std::shared_ptr< jarray< uint8_t > > &input)
bool	hasfile ()
uint32_t	get_status ()
jarray< uint8_t >	checksum (iana_t prot, direction_t dir, jarray< uint8_t > &check, uint32_t offset=0)
jarray< uint8_t >	pad (pad_t padtype, uint32_t len)
	jprotocol (jprotocol &jprotocol)=delete
	jprotocol (const jprotocol &jprotocol)=delete

Additional Inherited Members
Static Public Member Functions inherited from ProtocolPP::jprotocol
const static std::string	currentDateTime ()
static std::string	str_status (uint32_t status)
static jarray< uint8_t >	to_array (uint8_t input)
static jarray< uint8_t >	to_array (uint16_t input)
static jarray< uint8_t >	to_array (uint32_t input)
static jarray< uint8_t >	to_array (uint64_t input)
static uint8_t	to_u8 (jarray< uint8_t > src_array)
static uint16_t	to_u16 (jarray< uint8_t > src_array)
static uint32_t	to_u32 (jarray< uint8_t > src_array)
static uint64_t	to_u64 (jarray< uint8_t > src_array)
static uint32_t	fnv_hash (std::shared_ptr< jarray< uint8_t > > &header, jarray< uint8_t > &mask, uint32_t hdrlen)
Protected Member Functions inherited from ProtocolPP::jprotocol
template<typename T , typename TE >
std::shared_ptr< jreplay< T, TE > >	update_replay (protocol_t prot, T &seqnum, TE &extseq, bool usext, uint32_t size)
template<typename T , typename TE >
std::shared_ptr< jreplay< T, TE > >	update_replay (protocol_t prot, T &seqnum, TE &extseq, bool usext, uint32_t size, jarray< uint8_t > &window)
void	update_status (uint32_t stat)
void	get_data (std::shared_ptr< jarray< uint8_t > > &data)
void	put_data (std::shared_ptr< jarray< uint8_t > > &wdata)
void	encryptdat (std::shared_ptr< jarray< uint8_t > > &red, std::shared_ptr< jarray< uint8_t > > &black)
void	decryptdat (std::shared_ptr< jarray< uint8_t > > &black, std::shared_ptr< jarray< uint8_t > > &red)
uint32_t	roundup (uint32_t value, uint32_t mult)
Protected Attributes inherited from ProtocolPP::jprotocol
direction_t	m_dir
	direction of processing
uint32_t	m_status
std::shared_ptr< jrand >	m_rand
	random data generator passed into constructor
std::string	m_filename
	file input string for this protocol
std::fstream	m_file
	input file stream object for this protocol
endian_t	m_endian
	endianess string for this protocol

Constructor & Destructor Documentation

jmacsec()

ProtocolPP::jmacsec::jmacsec	(	std::shared_ptr< jrand > &	rand,
		std::shared_ptr< jmacsecsa > &	sec,
		std::string &	replay
	)

Create an instance of the macsec protocol. Use update_sec to create the security association

Parameters

rand	- randomizer
sec	- security association for this flow
replay	- types of packets to generate

Member Function Documentation

decap_packet()

void ProtocolPP::jmacsec::decap_packet ( std::shared_ptr< jarray< uint8_t > > &  input, std::shared_ptr< jarray< uint8_t > > &  output  )

virtual

Decapsulate the packet with macsec

Parameters

input	- shared pointer with array of bytes that represent the encapsulated macsec packet
output	- shared pointer with array of bytes that represent the decapsulated payload

Decapsulation of Macsec Packet Into Payload

Implements ProtocolPP::jprotocol.

encap_packet()

void ProtocolPP::jmacsec::encap_packet ( std::shared_ptr< jarray< uint8_t > > &  input, std::shared_ptr< jarray< uint8_t > > &  output  )

virtual

Encapsulate the payload with macsec

Parameters

input	- shared pointer with array of bytes that represent the payload
output	- shared pointer with array of bytes that represent the encapsulated macsec packet

Encapsulation of Payload Into Macsec Packet

Implements ProtocolPP::jprotocol.

get_field() [1/2]

uint64_t ProtocolPP::jmacsec::get_field ( field_t  field )

virtual

Return the macsec field from the security association

Parameters

field

- MACSEC field to retrieve

Returns

Current macsec field value

Reimplemented from ProtocolPP::jprotocol.

get_field() [2/2]

uint64_t ProtocolPP::jmacsec::get_field ( field_t  field, jarray< uint8_t > &  hdr  )

virtual

Return the macsec field

Parameters

field	- MACSEC field to retrieve
hdr	- header to extract field from

Returns

Current macsec field value

Implements ProtocolPP::jprotocol.

get_hdr()

jarray< uint8_t > ProtocolPP::jmacsec::get_hdr ( )

virtual

Retrieve MACSEC header

Returns

MacSEC header

Implements ProtocolPP::jprotocol.

get_security()

void ProtocolPP::jmacsec::get_security

(

std::shared_ptr< jmacsecsa > &

sec

)

get_security

Parameters

sec	- Shared pointer to hold the security association

set_field()

void ProtocolPP::jmacsec::set_field ( field_t  field, uint64_t  value  )

virtual

Update MACSEC field

Parameters

field	- MACSEC field to update
value	- new value for the MACSEC field

Implements ProtocolPP::jprotocol.

set_hdr()

void ProtocolPP::jmacsec::set_hdr ( jarray< uint8_t > &  hdr )

virtual

Update MACSEC header

Parameters

hdr	- new MacSEC header

Implements ProtocolPP::jprotocol.

to_json()

void ProtocolPP::jmacsec::to_json ( std::ofstream &  myjson, direction_t  direction, std::string &  indent  )

virtual

Write the protocol and security objects as JSON

Parameters

myjson	- JSON object to print with
direction	- randomization
indent	- indentation for JSON output

Implements ProtocolPP::jprotocol.

to_xml()

void ProtocolPP::jmacsec::to_xml ( tinyxml2::XMLPrinter &  myxml, direction_t  direction  )

virtual

Write the protocol and security objects as XML

Parameters

myxml	- XMLPrinter object to print with
direction	- randomization

Implements ProtocolPP::jprotocol.

---

The documentation for this class was generated from the following file:

• include/jmacsec.h