keypop::calypso::crypto::legacysam::sam::KeyParameter Class Reference

#include <KeyParameter.hpp>

Public Member Functions
virtual const std::vector< uint8_t > &	getRawData () const =0
virtual uint8_t	getKif () const =0
virtual uint8_t	getKvc () const =0
virtual uint8_t	getAlgorithm () const =0
virtual uint8_t	getParameterValue (const int parameterNumber) const =0

Detailed Description

POJO containing the parameters for a key managed by SAM, whether it's a system key or a work key.

Since

0.2.0

Definition at line 26 of file KeyParameter.hpp.

Member Function Documentation

getAlgorithm()

virtual uint8_t keypop::calypso::crypto::legacysam::sam::KeyParameter::getAlgorithm ( ) const

pure virtual

Returns the key algorithm.

Returns

The algorithm identification byte.

Since

0.2.0

getKif()

virtual uint8_t keypop::calypso::crypto::legacysam::sam::KeyParameter::getKif ( ) const

pure virtual

Returns the key identifier (KIF).

Returns

The KIF value.

Since

0.2.0

getKvc()

virtual uint8_t keypop::calypso::crypto::legacysam::sam::KeyParameter::getKvc ( ) const

pure virtual

Returns the key version (KVC).

Returns

The KVC value.

Since

0.2.0

getParameterValue()

virtual uint8_t keypop::calypso::crypto::legacysam::sam::KeyParameter::getParameterValue ( const int  parameterNumber ) const

pure virtual

Returns the value of the parameter whose number is provided.

Parameters

parameterNumber

The number of the parameter to get (in range [1..10]).

Returns

The parameter value.

Exceptions

IllegalArgumentException

If the argument is out of range.

Since

0.2.0

getRawData()

virtual const std::vector< uint8_t > & keypop::calypso::crypto::legacysam::sam::KeyParameter::getRawData ( ) const

pure virtual

Gets the raw data of the key's parameters.

Returns

a byte array of 13 bytes representing the key's parameters, including KIF, KVC, algorithm, and PAR1 to PAR10.

Since

0.2.0

---

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

• /github/workspace/include/keypop/calypso/crypto/legacysam/sam/KeyParameter.hpp