duckdb::EncryptionNonce Struct Reference

Collaboration diagram for duckdb::EncryptionNonce:

Public Member Functions
	EncryptionNonce (EncryptionTypes::CipherType cipher=EncryptionTypes::GCM, EncryptionTypes::EncryptionVersion version=EncryptionTypes::EncryptionVersion::V0_1)
data_ptr_t	data ()
idx_t	size () const
idx_t	total_size () const
idx_t	size_deprecated () const
void	SetSize (idx_t length)

Private Attributes
unique_ptr< data_t[]>	nonce
idx_t	nonce_len
EncryptionTypes::EncryptionVersion	version
EncryptionTypes::CipherType	cipher

Constructor & Destructor Documentation

EncryptionNonce()

duckdb::EncryptionNonce::EncryptionNonce ( EncryptionTypes::CipherType  cipher = EncryptionTypes::GCM, EncryptionTypes::EncryptionVersion  version = EncryptionTypes::EncryptionVersion::V0_1  )

explicit

                                                                       : version(version_p), cipher(cipher_p) {
    switch (version) {
    case Version::V0_0:
        // for prior versions
        // nonce len is 16 for both GCM and CTR
        nonce_len = MainHeader::AES_NONCE_LEN_DEPRECATED;
        nonce = unique_ptr<data_t[]>(new data_t[nonce_len]());
        break;
    case Version::V0_1:
        if (cipher == CipherType::CTR) {
            // for CTR we need a 16-byte nonce / iv
            // the last 4 bytes (counter) are zeroed-out
            nonce_len = MainHeader::AES_IV_LEN;
            nonce = unique_ptr<data_t[]>(new data_t[nonce_len]());
            break;
        }
        // we fall through to NONE (often Parquet) with a 12-byte nonce
        DUCKDB_EXPLICIT_FALLTHROUGH;
    case Version::NONE:
        nonce_len = MainHeader::AES_NONCE_LEN;
        nonce = unique_ptr<data_t[]>(new data_t[nonce_len]());
        break;
    default:
        throw InvalidConfigurationException("Encryption version not recognized!");
    }
 
#ifdef DEBUG
    // Check whether the nonce is zero-initialized
    for (idx_t i = 0; i < nonce_len; i++) {
        if (nonce[i] != 0) {
            throw InvalidInputException("Nonce is not correctly zero-initialized!");
        }
    }
#endif
}

Member Function Documentation

data()

data_ptr_t duckdb::EncryptionNonce::data

(

)

                                 {
    return nonce.get();
}

size()

idx_t duckdb::EncryptionNonce::size

(

)

const

                                  {
    // always return 12 bytes
    if (version == Version::V0_0) {
        // in the first version, nonce was always 16
        return MainHeader::AES_NONCE_LEN_DEPRECATED;
    }
    // in v1, nonce is always 12
    return MainHeader::AES_NONCE_LEN;
}

total_size()

idx_t duckdb::EncryptionNonce::total_size

(

)

const

                                        {
    return nonce_len;
}

size_deprecated()

idx_t duckdb::EncryptionNonce::size_deprecated

(

)

const

                                             {
    return MainHeader::AES_NONCE_LEN_DEPRECATED;
}

SetSize()

void duckdb::EncryptionNonce::SetSize

(

idx_t

length

)

                                          {
    nonce_len = length;
}

---

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

• external/duckdb/duckdb.cpp