Signet Forge 0.1.0
C++20 Parquet library with AI-native extensions
DEMO
Loading...
Searching...
No Matches
signet::forge::crypto::FileEncryptionProperties Struct Reference

Stored in the Parquet FileMetaData.encryption_algorithm field. More...

#include <key_metadata.hpp>

Public Member Functions

std::vector< uint8_t > serialize () const
 Serialize to bytes using TLV format.
 

Static Public Member Functions

static expected< FileEncryptionPropertiesdeserialize (const uint8_t *data, size_t size)
 Deserialize from bytes.
 

Public Attributes

EncryptionAlgorithm algorithm = EncryptionAlgorithm::AES_GCM_CTR_V1
 Encryption algorithm.
 
bool footer_encrypted = true
 Whether the footer itself is encrypted.
 
std::string aad_prefix
 AAD prefix bound into GCM auth tags.
 

Detailed Description

Stored in the Parquet FileMetaData.encryption_algorithm field.

This tells the reader which algorithm was used, whether the footer itself is encrypted, and the AAD prefix bound into authentication tags.

Definition at line 495 of file key_metadata.hpp.

Member Function Documentation

◆ deserialize()

static expected< FileEncryptionProperties > signet::forge::crypto::FileEncryptionProperties::deserialize ( const uint8_t *  data,
size_t  size 
)
inlinestatic

Deserialize from bytes.

Parameters
dataPointer to TLV-serialized bytes.
sizeNumber of bytes to parse.
Returns
Deserialized properties, or ENCRYPTION_ERROR if truncated or missing algorithm.

Definition at line 521 of file key_metadata.hpp.

◆ serialize()

std::vector< uint8_t > signet::forge::crypto::FileEncryptionProperties::serialize ( ) const
inline

Serialize to bytes using TLV format.

Returns
Serialized byte vector.

Definition at line 502 of file key_metadata.hpp.

Member Data Documentation

◆ aad_prefix

std::string signet::forge::crypto::FileEncryptionProperties::aad_prefix

AAD prefix bound into GCM auth tags.

Definition at line 498 of file key_metadata.hpp.

◆ algorithm

EncryptionAlgorithm signet::forge::crypto::FileEncryptionProperties::algorithm = EncryptionAlgorithm::AES_GCM_CTR_V1

Encryption algorithm.

Definition at line 496 of file key_metadata.hpp.

◆ footer_encrypted

bool signet::forge::crypto::FileEncryptionProperties::footer_encrypted = true

Whether the footer itself is encrypted.

Definition at line 497 of file key_metadata.hpp.


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