Protocol++® (Protocolpp®)  v5.6.2
ProtocolPP::jintegrity Class Reference
Inheritance diagram for ProtocolPP::jintegrity:
Collaboration diagram for ProtocolPP::jintegrity:

Public Member Functions

 jintegrity (std::shared_ptr< jintegritysa > &security)
 
virtual ~jintegrity ()=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)
 
jarray< uint8_t > get_hdr ()
 
uint64_t get_field (field_t field, jarray< uint8_t > &hdr)
 
void set_hdr (jarray< uint8_t > &hdr)
 
void set_field (field_t field, uint64_t value)
 
template<typename T >
void set_field (field_t field, T fieldval)
 
template<typename T >
get_field (field_t field)
 
void get_security (std::shared_ptr< jintegritysa > &sec)
 
void to_xml (tinyxml2::XMLPrinter &myxml, direction_t direction)
 
void to_json (std::ofstream &myjson, direction_t direction, std::string &indent)
 
 jintegrity (jintegrity &rsh)=delete
 
 jintegrity (const jintegrity &rsh)=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< jrandm_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

◆ jintegrity()

ProtocolPP::jintegrity::jintegrity ( std::shared_ptr< jintegritysa > &  security)
explicit

Standard constructor

Parameters
security- Security parameters for cipher protocol

Member Function Documentation

◆ decap_packet()

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

Decapsulate the data with the authenticate parameters

Parameters
input- Authentication data + ICV
* 
*  -----------------------------
*  | Authentication Data | ICV |
*  -----------------------------
* 
output- Integrity Check Value (ICV)
* 
*  -------
*  | ICV |
*  -------
* 

Implements ProtocolPP::jprotocol.

◆ encap_packet()

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

Encapsulate the data with the authentication parameters

Parameters
input- Authentication data
* 
*  -----------------------
*  | Authentication Data |
*  -----------------------
* 
output- Integrity Check Value (ICV)
* 
*  -------
*  | ICV |
*  -------
* 

Implements ProtocolPP::jprotocol.

◆ get_field() [1/2]

template<typename T >
T ProtocolPP::jintegrity::get_field ( field_t  field)
virtual

get_field

Parameters
field- field to retrieve
Returns
Value of the field requested

Reimplemented from ProtocolPP::jprotocol.

◆ get_field() [2/2]

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

Retrieve the value of the field

Parameters
field- field to retrieve
hdr- header to retrieve the field from
Returns
current value of the field

Implements ProtocolPP::jprotocol.

◆ get_hdr()

jarray<uint8_t> ProtocolPP::jintegrity::get_hdr ( )
virtual

Retrieve the header for the packet

Returns
the full header

Implements ProtocolPP::jprotocol.

◆ get_security()

void ProtocolPP::jintegrity::get_security ( std::shared_ptr< jintegritysa > &  sec)

get_security

Parameters
sec- Shared pointer to hold the security association

◆ set_field() [1/2]

template<typename T >
void ProtocolPP::jintegrity::set_field ( field_t  field,
fieldval 
)

set_field

Parameters
field- field to set
fieldval- New value to set in field

◆ set_field() [2/2]

void ProtocolPP::jintegrity::set_field ( field_t  field,
uint64_t  value 
)
virtual

Set the specified field with a new value

Parameters
field- field to set
value- new value for the field

Implements ProtocolPP::jprotocol.

◆ set_hdr()

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

Set the header to the current value

Parameters
hdr- new header value

Implements ProtocolPP::jprotocol.

◆ to_json()

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

to_json Convert the security association to JSON for printing

Parameters
myjson- JSON printing object
direction- direction of processing
indent- indentation for JSON output

Implements ProtocolPP::jprotocol.

◆ to_xml()

void ProtocolPP::jintegrity::to_xml ( tinyxml2::XMLPrinter myxml,
direction_t  direction 
)
virtual

to_xml Convert the security association to XML for printing

Parameters
myxml- XML printing object
direction- direction of processing

Implements ProtocolPP::jprotocol.


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