alexaClientSDK::acsdkProperties::EncryptionKeyPropertyCodec Struct Reference

ASN.1 Codec API for Encryption Key Property Encoding. More...

#include <EncryptionKeyPropertyCodec.h>

Public Types
typedef acsdkCryptoInterfaces::KeyStoreInterface::KeyChecksum	KeyChecksum
typedef acsdkCryptoInterfaces::KeyStoreInterface::DataBlock	DataBlock
typedef acsdkCryptoInterfaces::KeyStoreInterface::IV	IV
typedef acsdkCryptoInterfaces::CryptoCodecInterface::Tag	Tag
typedef acsdkPropertiesInterfaces::PropertiesInterface::Bytes	Bytes

Static Public Member Functions
static bool	encode (const std::shared_ptr< acsdkCryptoInterfaces::CryptoFactoryInterface > &cryptoFactory, const std::string &mainKeyAlias, const KeyChecksum &mainKeyChecksum, alexaClientSDK::acsdkCryptoInterfaces::AlgorithmType dataKeyAlgorithm, const IV &dataKeyIV, const DataBlock &dataKeyCiphertext, const Tag &dataKeyTag, alexaClientSDK::acsdkCryptoInterfaces::AlgorithmType dataAlgorithm, Bytes &derEncoded) noexcept
	Produces encryption key property in DER form. More...
static bool	decode (const std::shared_ptr< acsdkCryptoInterfaces::CryptoFactoryInterface > &cryptoFactory, const Bytes &derEncoded, std::string &mainKeyAlias, KeyChecksum &mainKeyChecksum, alexaClientSDK::acsdkCryptoInterfaces::AlgorithmType &dataKeyAlgorithm, IV &dataKeyIV, DataBlock &dataKeyCiphertext, Tag &dataKeyTag, alexaClientSDK::acsdkCryptoInterfaces::AlgorithmType &dataAlgorithm, DataBlock &digestDecoded, DataBlock &digestActual) noexcept
	Decode encryption key property. More...

Detailed Description

ASN.1 Codec API for Encryption Key Property Encoding.

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

See also

EncryptionKeyPropertyCodecState

Member Typedef Documentation

Bytes

typedef acsdkPropertiesInterfaces::PropertiesInterface::Bytes alexaClientSDK::acsdkProperties::EncryptionKeyPropertyCodec::Bytes

DataBlock

typedef acsdkCryptoInterfaces::KeyStoreInterface::DataBlock alexaClientSDK::acsdkProperties::EncryptionKeyPropertyCodec::DataBlock

IV

typedef acsdkCryptoInterfaces::KeyStoreInterface::IV alexaClientSDK::acsdkProperties::EncryptionKeyPropertyCodec::IV

KeyChecksum

typedef acsdkCryptoInterfaces::KeyStoreInterface::KeyChecksum alexaClientSDK::acsdkProperties::EncryptionKeyPropertyCodec::KeyChecksum

Tag

typedef acsdkCryptoInterfaces::CryptoCodecInterface::Tag alexaClientSDK::acsdkProperties::EncryptionKeyPropertyCodec::Tag

Member Function Documentation

decode()

bool alexaClientSDK::acsdkProperties::EncryptionKeyPropertyCodec::decode ( const std::shared_ptr< acsdkCryptoInterfaces::CryptoFactoryInterface > &  cryptoFactory, const Bytes &  derEncoded, std::string &  mainKeyAlias, KeyChecksum &  mainKeyChecksum, alexaClientSDK::acsdkCryptoInterfaces::AlgorithmType &  dataKeyAlgorithm, IV &  dataKeyIV, DataBlock &  dataKeyCiphertext, Tag &  dataKeyTag, alexaClientSDK::acsdkCryptoInterfaces::AlgorithmType &  dataAlgorithm, DataBlock &  digestDecoded, DataBlock &  digestActual  )

staticnoexcept

Decode encryption key property.

This method parses DER input and extracts encoding fields. Method also computes actual digest for digest verification.

Parameters

[in]	cryptoFactory	Crypto API factory.
[in]	derEncoded	DER-encoded properties.
[out]	mainKeyAlias	Parsed main key alias.
[out]	mainKeyChecksum	Parsed main key checksum.
[out]	dataKeyAlgorithm	Parsed algorithm for data key unwrapping.
[out]	dataKeyIV	Parsed initialization vector for data key unwrapping.
[out]	dataKeyCiphertext	Parsed wrapped data key.
[out]	dataKeyTag	Parsed data key tag.
[out]	dataAlgorithm	Parsed algorithm to encrypt/decrypt data.
[out]	digestDecoded	Parsed digest.
[out]	digestActual	Actual (recomputed) digest.

Returns

True on success.

encode()

bool alexaClientSDK::acsdkProperties::EncryptionKeyPropertyCodec::encode ( const std::shared_ptr< acsdkCryptoInterfaces::CryptoFactoryInterface > &  cryptoFactory, const std::string &  mainKeyAlias, const KeyChecksum &  mainKeyChecksum, alexaClientSDK::acsdkCryptoInterfaces::AlgorithmType  dataKeyAlgorithm, const IV &  dataKeyIV, const DataBlock &  dataKeyCiphertext, const Tag &  dataKeyTag, alexaClientSDK::acsdkCryptoInterfaces::AlgorithmType  dataAlgorithm, Bytes &  derEncoded  )

staticnoexcept

Produces encryption key property in DER form.

Parameters

[in]	cryptoFactory	Crypto API factory.
[in]	mainKeyAlias	Main key alias.
[in]	mainKeyChecksum	Main key checksum.
[in]	dataKeyAlgorithm	Algorithm used to wrap data key.
[in]	dataKeyIV	Initialization vector used to wrap data key.
[in]	dataKeyCiphertext	Wrapped data key.
[in]	dataKeyTag	Data key tag.
[in]	dataAlgorithm	Algorithm for data encryption.
[out]	derEncoded	Encoded properties in DER format.

Returns

True on success.

---

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

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