Remote Access Control

ParameterParser Class Reference

---

Detailed Description

Class to parse and store command line parameters for this application.

Definition at line 57 of file createtxhex.cpp.

Public Member Functions
size_t	GetCounterSize () const
const std::vector< byte > &	GetCounterValue () const
std::string	GetCounterValueString () const
const std::string &	GetFilename () const
size_t	GetKeySize () const
const std::vector< byte > &	GetSecretKey () const
std::string	GetSecretKeyString () const
const std::vector< byte > &	GetSerialNo () const
size_t	GetSerialNoSize () const
std::string	GetSerialNoString () const
const std::vector< byte > &	GetSharedKey () const
std::string	GetSharedKeyString () const
	ParameterParser (size_t argc, const char **argv)
	~ParameterParser ()
Private Member Functions
std::string	CreateHexString (const std::vector< byte > &byteVector) const
std::vector< byte >	ParseHexString (const std::string &hexString) const
Private Attributes
size_t	m_counterSize
std::vector< byte >	m_counterValue
std::string	m_filename
size_t	m_keySize
std::vector< byte >	m_secretKey
std::vector< byte >	m_serialNo
size_t	m_serialNoSize
std::vector< byte >	m_sharedKey

---

Constructor & Destructor Documentation

ParameterParser::ParameterParser	(	size_t	argc,
		const char **	argv
	)

Ctor taking the argc and argv parameters typically given to any main() function.

Definition at line 144 of file createtxhex.cpp.

References m_counterSize, m_counterValue, m_filename, m_keySize, m_secretKey, m_serialNo, m_serialNoSize, m_sharedKey, and ParseHexString().

{
        // Check that argument count is valid.
        if( argc != 9 ) {
                std::cout << "Parameters:\n"
                        "  filename     - Filename for resulting Intel HEX file\n"
                        "  keysize      - Size in bits of the AES secret and shared keys (128, 192 or 256)\n"
                        "  serialnosize - Size in bytes of the serial number (1, 2 or 4)\n"
                        "  countersize  - Size in bytes of the sequential counter (1, 2 or 4)\n"
                        "  sharedkey    - Hex representation of the shared key (32, 48 or 64 digits)\n"
                        "  secretkey    - Hex representation of the secret key (32, 48 or 64 digits)\n"
                        "  serialno     - Hex representation of the serial number (2, 4 or 8 digits)\n"
                        "  countervalue - Hex representation of the current counter value (2, 4 or 8 digits)\n"
                        << std::endl;
                throw std::runtime_error( "Not exactly 8 parameters" );
        }

        //
        // Create strings or string streams from argument character arrays.
        // 
        std::string arg1( argv[1] ); // Filename
        std::istringstream arg2( argv[2] ); // Key size
        std::istringstream arg3( argv[3] ); // Serial no size
        std::istringstream arg4( argv[4] ); // Counter size
        std::string arg5( argv[5] ); // Shared key
        std::string arg6( argv[6] ); // Secret key
        std::string arg7( argv[7] ); // Serial number
        std::string arg8( argv[8] ); // Counter Value

        //
        // Copy string arguments and parse non-string arguments.
        // 
        m_filename = arg1;
        
        arg2 >> m_keySize;
        if( !arg2 ) {
                throw std::runtime_error( "Error parsing key size argument" );
        }
        
        arg3 >> m_serialNoSize;
        if( !arg3 ) {
                throw std::runtime_error( "Error parsing serial no size argument" );
        }
        
        arg4 >> m_counterSize;
        if( !arg4 ) {
                throw std::runtime_error( "Error parsing counter size argument" );
        }
        
        m_sharedKey = ParseHexString( arg5 );
        m_secretKey = ParseHexString( arg6 );
        m_serialNo = ParseHexString( arg7 );
        m_counterValue = ParseHexString( arg8 );
        
        //
        // Check argument validity.
        // 
        if( m_keySize != 128 && m_keySize != 192 && m_keySize != 256 ) {
                throw std::runtime_error( "Key size is not 128, 192 or 256 bits" );
        }

        if( m_serialNoSize != 1 && m_serialNoSize != 2 && m_serialNoSize != 4 ) {
                throw std::runtime_error( "Serial no is not 1, 2 or 4 bytes" );
        }

        if( m_counterSize != 1 && m_counterSize != 2 && m_counterSize != 4 ) {
                throw std::runtime_error( "Counter is not 1, 2 or 4 bytes" );
        }

        if( m_sharedKey.size() != m_keySize / 8 ) {
                throw std::runtime_error( "Shared key has invalid length" );
        }

        if( m_secretKey.size() != m_keySize / 8 ) {
                throw std::runtime_error( "Secret key has invalid length" );
        }

        if( m_serialNo.size() != m_serialNoSize ) {
                throw std::runtime_error( "Serial number has invalid length" );
        }

        if( m_counterValue.size() != m_counterSize ) {
                throw std::runtime_error( "Counter value has invalid length" );
        }
}

Here is the call graph for this function:

ParameterParser::~ParameterParser

(

)

[inline]

Definition at line 77 of file createtxhex.cpp.

{}

---

Member Function Documentation

std::string ParameterParser::CreateHexString

(

const std::vector< byte > &

byteVector

)

const [private]

Creates an HEX string from a vector of data bytes. Space between every two digits, ie. byte.

Definition at line 124 of file createtxhex.cpp.

Referenced by GetCounterValueString(), GetSecretKeyString(), GetSerialNoString(), and GetSharedKeyString().

{
        std::ostringstream oss;
        oss << std::setfill('0') << std::hex;

        // Add all byte last byte with spaces in between.
        for( size_t idx = 0; idx < byteVector.size() - 1; ++idx ) {
                oss << std::setw(2) << byteVector.at( idx ) << ' ';
        }

        // Add last byte.
        if( byteVector.size() > 0 ) {
                oss << std::setw(2) << byteVector.at( byteVector.size()-1 );
        }

        return oss.str();
}

size_t ParameterParser::GetCounterSize

(

)

const [inline]

Definition at line 85 of file createtxhex.cpp.

References m_counterSize.

Referenced by main().

{ return m_counterSize; }

const std::vector< byte >& ParameterParser::GetCounterValue

(

)

const [inline]

Definition at line 89 of file createtxhex.cpp.

References m_counterValue.

Referenced by CreateHEXFile(), and GetCounterValueString().

{ return m_counterValue; }

std::string ParameterParser::GetCounterValueString

(

)

const [inline]

Definition at line 94 of file createtxhex.cpp.

References CreateHexString(), and GetCounterValue().

Referenced by main().

{ return CreateHexString( GetCounterValue() ); }

Here is the call graph for this function:

const std::string& ParameterParser::GetFilename

(

)

const [inline]

Definition at line 82 of file createtxhex.cpp.

References m_filename.

Referenced by CreateHEXFile(), and main().

{ return m_filename; }

size_t ParameterParser::GetKeySize

(

)

const [inline]

Definition at line 83 of file createtxhex.cpp.

References m_keySize.

Referenced by main().

{ return m_keySize; }

const std::vector< byte >& ParameterParser::GetSecretKey

(

)

const [inline]

Definition at line 87 of file createtxhex.cpp.

References m_secretKey.

Referenced by CreateHEXFile(), and GetSecretKeyString().

{ return m_secretKey; }

std::string ParameterParser::GetSecretKeyString

(

)

const [inline]

Definition at line 92 of file createtxhex.cpp.

References CreateHexString(), and GetSecretKey().

Referenced by main().

{ return CreateHexString( GetSecretKey() ); }

Here is the call graph for this function:

const std::vector< byte >& ParameterParser::GetSerialNo

(

)

const [inline]

Definition at line 88 of file createtxhex.cpp.

References m_serialNo.

Referenced by CreateHEXFile(), and GetSerialNoString().

{ return m_serialNo; }

size_t ParameterParser::GetSerialNoSize

(

)

const [inline]

Definition at line 84 of file createtxhex.cpp.

References m_serialNoSize.

Referenced by main().

{ return m_serialNoSize; }

std::string ParameterParser::GetSerialNoString

(

)

const [inline]

Definition at line 93 of file createtxhex.cpp.

References CreateHexString(), and GetSerialNo().

Referenced by main().

{ return CreateHexString( GetSerialNo() ); }

Here is the call graph for this function:

const std::vector< byte >& ParameterParser::GetSharedKey

(

)

const [inline]

Definition at line 86 of file createtxhex.cpp.

References m_sharedKey.

Referenced by CreateHEXFile(), and GetSharedKeyString().

{ return m_sharedKey; }

std::string ParameterParser::GetSharedKeyString

(

)

const [inline]

Definition at line 91 of file createtxhex.cpp.

References CreateHexString(), and GetSharedKey().

Referenced by main().

{ return CreateHexString( GetSharedKey() ); }

Here is the call graph for this function:

std::vector< byte > ParameterParser::ParseHexString

(

const std::string &

hexString

)

const [private]

Parses an unformatted HEX number string. Must be pairs of HEX digits, ie. bytes.

Definition at line 99 of file createtxhex.cpp.

Referenced by ParameterParser().

{
        // String must be even number of hex digits.
        if( hexString.size() % 2 != 0 ) {
                throw std::runtime_error( "Hex string does not have even character count" );
        }

        //
        // Parse hex digit pairs and insert into byte vector.
        // 
        std::vector< byte > bytes;
        for( size_t idx = 0; idx < hexString.size(); idx += 2 ) {
                std::istringstream iss( hexString.substr( idx, 2 ) );
                byte data;
                iss >> std::hex >> data;
                if( !iss ) {
                        throw std::runtime_error( "Error parsing hex string \"" + hexString + "\"" );
                }
                bytes.push_back( data );
        }
        return bytes;
}

---

Field Documentation

size_t ParameterParser::m_counterSize [private]

Stores synchronization counter size parameter.

Definition at line 63 of file createtxhex.cpp.

Referenced by GetCounterSize(), and ParameterParser().

std::vector< byte > ParameterParser::m_counterValue [private]

Stores synchronization counter value.

Definition at line 67 of file createtxhex.cpp.

Referenced by GetCounterValue(), and ParameterParser().

std::string ParameterParser::m_filename [private]

Stores filename parameter.

Definition at line 60 of file createtxhex.cpp.

Referenced by GetFilename(), and ParameterParser().

size_t ParameterParser::m_keySize [private]

Stores key size parameter.

Definition at line 61 of file createtxhex.cpp.

Referenced by GetKeySize(), and ParameterParser().

std::vector< byte > ParameterParser::m_secretKey [private]

Stores secret key parameter.

Definition at line 65 of file createtxhex.cpp.

Referenced by GetSecretKey(), and ParameterParser().

std::vector< byte > ParameterParser::m_serialNo [private]

Stores serial number.

Definition at line 66 of file createtxhex.cpp.

Referenced by GetSerialNo(), and ParameterParser().

size_t ParameterParser::m_serialNoSize [private]

Stores serial number size parameter.

Definition at line 62 of file createtxhex.cpp.

Referenced by GetSerialNoSize(), and ParameterParser().

std::vector< byte > ParameterParser::m_sharedKey [private]

Stores shared key parameter.

Definition at line 64 of file createtxhex.cpp.

Referenced by GetSharedKey(), and ParameterParser().