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

Public Member Functions

 jrsa (std::shared_ptr< InterfacePP::jlogger > &logger)
 
 jrsa (int bitsize, rsapadtype_t padding, std::shared_ptr< InterfacePP::jlogger > &logger)
 
 jrsa (int bitsize, rsapadtype_t padding, CryptoPP::RSA::PrivateKey &PRVKey, CryptoPP::RSA::PublicKey &PUBKey, std::shared_ptr< InterfacePP::jlogger > &logger)
 
 jrsa (std::shared_ptr< jrsasa > &security)
 
virtual ~jrsa ()=default
 Standard deconstructor.
 
template<typename T >
void set_field (field_t field, T fieldval)
 
template<typename T >
get_field (field_t field)
 
void gen_keypair ()
 Generate key pair.
 
void encrypt (std::shared_ptr< jarray< uint8_t >> &data, std::shared_ptr< jarray< uint8_t >> &ciphertext)
 
void decrypt (std::shared_ptr< jarray< uint8_t >> &ciphertext, std::shared_ptr< jarray< uint8_t >> &data)
 
void sign (std::shared_ptr< jarray< uint8_t >> &data, std::shared_ptr< jarray< uint8_t >> &signature)
 
void verify (std::shared_ptr< jarray< uint8_t >> &signature)
 
void get_security (std::shared_ptr< jrsasa > &sec)
 
void to_xml (tinyxml2::XMLPrinter &myxml, direction_t direction)
 
void to_json (std::ofstream &myjson, direction_t direction, std::string &indent)
 
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)
 
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)
 
 jrsa (jrsa &jrsa)=delete
 
 jrsa (const jrsa &jrsa)=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

◆ jrsa() [1/4]

ProtocolPP::jrsa::jrsa ( std::shared_ptr< InterfacePP::jlogger > &  logger)
explicit

Standard constructor with default values bitsize=3072 padding=PKCS1_5

Parameters
logger- logging object

◆ jrsa() [2/4]

ProtocolPP::jrsa::jrsa ( int  bitsize,
rsapadtype_t  padding,
std::shared_ptr< InterfacePP::jlogger > &  logger 
)

Standard constructor

Parameters
bitsize- size of the private key
padding- padding types (PKCS1_5 and PSS)
logger- logging object

◆ jrsa() [3/4]

ProtocolPP::jrsa::jrsa ( int  bitsize,
rsapadtype_t  padding,
CryptoPP::RSA::PrivateKey &  PRVKey,
CryptoPP::RSA::PublicKey &  PUBKey,
std::shared_ptr< InterfacePP::jlogger > &  logger 
)

Standard constructor

Parameters
bitsize- size of the private key
padding- padding types (PKCS1_5 and PSS)
PRVKey- RSA private key
PUBKey- RSA public key
logger- logging object

◆ jrsa() [4/4]

ProtocolPP::jrsa::jrsa ( std::shared_ptr< jrsasa > &  security)
explicit

Standard constructor

Parameters
security- security association for RSA

Member Function Documentation

◆ decap_packet()

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

Not used in this protocol

Parameters
input- encapsulated packet
output- decapsulated packet

Implements ProtocolPP::jprotocol.

◆ decrypt()

void ProtocolPP::jrsa::decrypt ( std::shared_ptr< jarray< uint8_t >> &  ciphertext,
std::shared_ptr< jarray< uint8_t >> &  data 
)

Decrypt the data

Parameters
ciphertext- encrypted data
data- decrypted data

◆ encap_packet()

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

Not used in this protocol

Parameters
input- data to encapsulate
output- encapsulated packet

Implements ProtocolPP::jprotocol.

◆ encrypt()

void ProtocolPP::jrsa::encrypt ( std::shared_ptr< jarray< uint8_t >> &  data,
std::shared_ptr< jarray< uint8_t >> &  ciphertext 
)

Encrypt the data

Parameters
data- data to encrypt
ciphertext- encrypted data

◆ get_field() [1/2]

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

Returns the version field RSA object

RSA Get Fields
field typefield nameExample
rsapadtype_tRSAPADrsapadtype_t rsapad = get_field<rsapadtype_t>(field_t::RSAPAD)
intBITSIZEint bitsize = get_field<int>(field_t::BITSIZE)
CryptoPP::RSA::PrivateKey PRVKEYCryptoPP::RSA::PrivateKey prvkey = get_field<CryptoPP::RSA::PrivateKey>(field_t::PRVKEY)
CryptoPP::RSA::PublicKey PUBKEYCryptoPP::RSA::PublicKey pubkey = get_field<CryptoPP::RSA::PublicKey>(field_t::PUBKEY)
std::pair<CryptoPP::RSA::PrivateKey, CryptoPP::RSA::PublicKey> KEYPAIRshared_ptr<std::pair<CryptoPP::RSA::PrivateKey, CryptoPP::RSA::PublicKey> keypair = get_field<std::pair<CryptoPP::RSA::PrivateKey, CryptoPP::RSA::PublicKey>>(field_t::KEYPAIR)
Parameters
field- field to retrieve from the IP security association
Returns
field of the IP security association

Reimplemented from ProtocolPP::jprotocol.

◆ get_field() [2/2]

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

Not used in this protocol

Returns
0

Implements ProtocolPP::jprotocol.

◆ get_hdr()

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

Not used in this protocol

Returns
empty array

Implements ProtocolPP::jprotocol.

◆ get_security()

void ProtocolPP::jrsa::get_security ( std::shared_ptr< jrsasa > &  sec)

get_security

Parameters
sec- Shared pointer to hold the security association

◆ set_field() [1/2]

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

Allows the user to update the field RSA object

RSA Set Fields
field typefield nameExample
rsapadtype_tRSAPADset_field<rsapadtype_t>(field_t::RSAPAD, rsapadtype_t::PKCS15)
intBITSIZEset_field<int>(field_t::BITSIZE, bitsize)
Parameters
field- field to update the IP security association
fieldval- value to update the IP security association

◆ set_field() [2/2]

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

Not used in this protocol

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

Implements ProtocolPP::jprotocol.

◆ set_hdr()

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

Not used in this protocol

Parameters
hdr- header of the packet

Implements ProtocolPP::jprotocol.

◆ sign()

void ProtocolPP::jrsa::sign ( std::shared_ptr< jarray< uint8_t >> &  data,
std::shared_ptr< jarray< uint8_t >> &  signature 
)

Sign the data

Parameters
data- Data to sign using the pad type
signature- Generated signature

◆ to_json()

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

Prints the protocol object in JSON

Parameters
myjson- JSON object to print to
direction- randomzation
indent- indentation for JSON output

Implements ProtocolPP::jprotocol.

◆ to_xml()

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

Prints the protocol object in XML

Parameters
myxml- XMLPrinter object to print to
direction- randomzation

Implements ProtocolPP::jprotocol.

◆ verify()

void ProtocolPP::jrsa::verify ( std::shared_ptr< jarray< uint8_t >> &  signature)

Verify the data

Parameters
signature- Signature to verify using the pad type returns result of the signature verification in the status word

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