alexaClientSDK::acsdkProperties::DataPropertyCodec Struct Reference

ASN.1 Encoder/Decoder for encrypted property value. More...

#include <DataPropertyCodec.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
	Tag data type. More...

Static Public Member Functions
static bool	encode (const std::shared_ptr< acsdkCryptoInterfaces::CryptoFactoryInterface > &cryptoFactory, const IV &dataIV, const DataBlock &dataCiphertext, const Tag &dataTag, DataBlock &derEncoded) noexcept
	Encodes encrypted property value into DER form. More...
static bool	decode (const std::shared_ptr< acsdkCryptoInterfaces::CryptoFactoryInterface > &cryptoFactory, const std::vector< uint8_t > &derEncoded, IV &dataIV, DataBlock &dataCiphertext, Tag &dataTag, DataBlock &digestDecoded, DataBlock &digestActual) noexcept
	Decodes encrypted property value from DER form. More...

Detailed Description

ASN.1 Encoder/Decoder for encrypted property value.

This class provides top-level functions to encode encryption property value into DER format or decode it from DER format.

See also

DataPropertyCodecState

Member Typedef Documentation

DataBlock

typedef acsdkCryptoInterfaces::CryptoCodecInterface::DataBlock alexaClientSDK::acsdkProperties::DataPropertyCodec::DataBlock

Byte vector data type.

IV

typedef acsdkCryptoInterfaces::CryptoCodecInterface::IV alexaClientSDK::acsdkProperties::DataPropertyCodec::IV

Initialization vector data type.

Tag

typedef acsdkCryptoInterfaces::CryptoCodecInterface::Tag alexaClientSDK::acsdkProperties::DataPropertyCodec::Tag

Tag data type.

Member Function Documentation

decode()

bool alexaClientSDK::acsdkProperties::DataPropertyCodec::decode ( const std::shared_ptr< acsdkCryptoInterfaces::CryptoFactoryInterface > &  cryptoFactory, const std::vector< uint8_t > &  derEncoded, IV &  dataIV, DataBlock &  dataCiphertext, Tag &  dataTag, DataBlock &  digestDecoded, DataBlock &  digestActual  )

staticnoexcept

Decodes encrypted property value from DER form.

Parameters

[in]	cryptoFactory	Crypto factory for digest operations. Must not be nullptr.
[in]	derEncoded	DER-encoded property value.
[out]	dataIV	Reference to container for initialization vector of encrypted data.
[out]	dataCiphertext	Reference to container for encrypted data.
[out]	dataTag	Reference to container for data tag.
[out]	digestDecoded	Reference to container for decoded digest (from the DER message).
[out]	digestActual	Reference to container for actual (recomputed) digest.

Returns

True if operation is successful.

encode()

bool alexaClientSDK::acsdkProperties::DataPropertyCodec::encode ( const std::shared_ptr< acsdkCryptoInterfaces::CryptoFactoryInterface > &  cryptoFactory, const IV &  dataIV, const DataBlock &  dataCiphertext, const Tag &  dataTag, DataBlock &  derEncoded  )

staticnoexcept

Encodes encrypted property value into DER form.

Parameters

[in]	cryptoFactory	Crypto factory for digest operations. Must not be nullptr.
[in]	dataIV	Initialization vector for encrypted data.
[in]	dataCiphertext	Encrypted data.
[in]	dataTag	Data tag.
[out]	derEncoded	Reference to output data buffer.

Returns

True if operation is successful.

---

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

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