alexaClientSDK::acsdkProperties::DataPropertyCodecState Class Reference

Helper state for holding ASN.1 structures of DER codec for encrypted property value. More...

#include <DataPropertyCodecState.h>

Public Types
typedef acsdkCryptoInterfaces::CryptoCodecInterface::IV	IV
	Initialization vector data type. More...
typedef acsdkCryptoInterfaces::CryptoCodecInterface::DataBlock	DataBlock
	Byte vector data type. More...
typedef acsdkCryptoInterfaces::CryptoCodecInterface::Tag	Tag
	Data tag type. More...

Public Member Functions
	DataPropertyCodecState () noexcept
	Object constructor. More...
	~DataPropertyCodecState () noexcept
	Releases internal structures. More...
bool	prepareForEncode () noexcept
	Prepares structure for encoding operations. More...
bool	setVersion (int64_t version) noexcept
	Sets encoding version property. More...
bool	setDataIV (const IV &dataIV) noexcept
	Sets initialization vector property. More...
bool	setDataCiphertext (const DataBlock &dataCiphertext) noexcept
	Sets data ciphertext property. More...
bool	setDataTag (const Tag &dataTag) noexcept
	Sets data tag property. More...
bool	setDigestType (DigestType type) noexcept
	Sets digest type property. More...
bool	setDigest (const DataBlock &digest) noexcept
	Sets digest property. More...
bool	encode (DataBlock &der) noexcept
	Produces DER format according to stored properties. More...
bool	getVersion (int64_t &version) noexcept
	Method provides encoding version property. More...
bool	getDataIV (IV &dataIV) noexcept
	Method provides data initialization vector. More...
bool	getDataCiphertext (DataBlock &dataCiphertext) noexcept
	Method provides data ciphertext. More...
bool	getDataTag (Tag &dataTag) noexcept
	Method provides data tag. More...
bool	getDigestType (DigestType &type) noexcept
	Method provides digest type. More...
bool	getDigest (DataBlock &digest) noexcept
	Method provides digest value. More...
bool	decode (const DataBlock &der) noexcept
	Method to decode property fields from DER-encoded input. More...
bool	encodeEncInfo (DataBlock &der) noexcept

Detailed Description

Helper state for holding ASN.1 structures of DER codec for encrypted property value.

See also

DataPropertyCodec

Member Typedef Documentation

DataBlock

typedef acsdkCryptoInterfaces::CryptoCodecInterface::DataBlock alexaClientSDK::acsdkProperties::DataPropertyCodecState::DataBlock

Byte vector data type.

IV

typedef acsdkCryptoInterfaces::CryptoCodecInterface::IV alexaClientSDK::acsdkProperties::DataPropertyCodecState::IV

Initialization vector data type.

Tag

typedef acsdkCryptoInterfaces::CryptoCodecInterface::Tag alexaClientSDK::acsdkProperties::DataPropertyCodecState::Tag

Data tag type.

Constructor & Destructor Documentation

DataPropertyCodecState()

alexaClientSDK::acsdkProperties::DataPropertyCodecState::DataPropertyCodecState ( )

noexcept

Object constructor.

~DataPropertyCodecState()

alexaClientSDK::acsdkProperties::DataPropertyCodecState::~DataPropertyCodecState ( )

noexcept

Releases internal structures.

Member Function Documentation

decode()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::decode ( const DataBlock &  der )

noexcept

Method to decode property fields from DER-encoded input.

Parameters

[in]

der

Der-encoded input.

Returns

True if operation is successful.

encode()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::encode ( DataBlock &  der )

noexcept

Produces DER format according to stored properties.

Parameters

[out]

der

Reference to store DER-encoded data.

Returns

True if operation is successful.

encodeEncInfo()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::encodeEncInfo ( DataBlock &  der )

noexcept

Method encodes payload sequence for computing digest. DER-specification doesn't let multiple ways to encode the same data set, so the result will depend only on supplied values (either from setters or from decoding result).

Parameters

[out]

der

Reference to store result.

Returns

True if operation is successful.

getDataCiphertext()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::getDataCiphertext ( DataBlock &  dataCiphertext )

noexcept

Method provides data ciphertext.

Parameters

[out]

dataCiphertext

Reference to store data ciphertext result.

Returns

True if operation is successful.

getDataIV()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::getDataIV ( IV &  dataIV )

noexcept

Method provides data initialization vector.

Parameters

[out]

dataIV

Reference to store data initialization vector result.

Returns

True if operation is successful.

getDataTag()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::getDataTag ( Tag &  dataTag )

noexcept

Method provides data tag.

Parameters

[out]

dataTag

Reference to store data tag result.

Returns

True if operation is successful.

getDigest()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::getDigest ( DataBlock &  digest )

noexcept

Method provides digest value.

Parameters

[out]

digest

Reference to store digest value.

Returns

True if operation is successful.

getDigestType()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::getDigestType ( DigestType &  type )

noexcept

Method provides digest type.

Parameters

[out]

type

Reference to store digest type.

Returns

True if operation is successful.

getVersion()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::getVersion ( int64_t &  version )

noexcept

Method provides encoding version property.

Parameters

[out]

version

Reference to store encoding version result.

Returns

True if operation is successful.

prepareForEncode()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::prepareForEncode ( )

noexcept

Prepares structure for encoding operations.

This method allocates internal structures and must be called before any setter method.

Returns

True if operation is successful.

setDataCiphertext()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::setDataCiphertext ( const DataBlock &  dataCiphertext )

noexcept

Sets data ciphertext property.

This method must be called after prepareForEncode().

Parameters

[in]

dataCiphertext

Ciphertext data.

Returns

True if operation is successful.

setDataIV()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::setDataIV ( const IV &  dataIV )

noexcept

Sets initialization vector property.

This method must be called after prepareForEncode().

Parameters

[in]

dataIV

Initialization vector data.

Returns

True if operation is successful.

setDataTag()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::setDataTag ( const Tag &  dataTag )

noexcept

Sets data tag property.

This method must be called after prepareForEncode().

Parameters

[in]

dataTag

Tag data.

Returns

True if operation is successful.

setDigest()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::setDigest ( const DataBlock &  digest )

noexcept

Sets digest property.

This method must be called after prepareForEncode().

Parameters

[in]

digest

Digest data.

Returns

True if operation is successful.

setDigestType()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::setDigestType ( DigestType  type )

noexcept

Sets digest type property.

This method must be called after prepareForEncode().

Parameters

[in]

type

Digest type.

Returns

True if operation is successful.

setVersion()

bool alexaClientSDK::acsdkProperties::DataPropertyCodecState::setVersion ( int64_t  version )

noexcept

Sets encoding version property.

This method must be called after prepareForEncode().

Parameters

[in]

version

Version number.

Returns

True if operation is successful.

---

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

• /workplace/avs-device-sdk/core/Properties/acsdkProperties/privateInclude/acsdkProperties/private/DataPropertyCodecState.h
• /workplace/avs-device-sdk/core/Properties/acsdkProperties/src/DataPropertyCodecState.cpp