duckdb::EncryptionKey Class Reference

Public Member Functions
	EncryptionKey (data_ptr_t encryption_key)
	EncryptionKey (const EncryptionKey &)=delete
EncryptionKey &	operator= (const EncryptionKey &)=delete
	EncryptionKey (EncryptionKey &&) noexcept=default
EncryptionKey &	operator= (EncryptionKey &&) noexcept=default
const_data_ptr_t	GetPtr () const
data_ptr_t	GetData ()

Static Public Member Functions
static void	LockEncryptionKey (data_ptr_t key, idx_t key_len=MainHeader::DEFAULT_ENCRYPTION_KEY_LENGTH)
static void	UnlockEncryptionKey (data_ptr_t key, idx_t key_len=MainHeader::DEFAULT_ENCRYPTION_KEY_LENGTH)

Private Attributes
data_t	key [MainHeader::DEFAULT_ENCRYPTION_KEY_LENGTH]

Constructor & Destructor Documentation

EncryptionKey()

duckdb::EncryptionKey::EncryptionKey ( data_ptr_t  encryption_key )

explicit

                                                        {
    // Lock the encryption key
    memcpy(key, encryption_key_p, MainHeader::DEFAULT_ENCRYPTION_KEY_LENGTH);
    D_ASSERT(memcmp(key, encryption_key_p, MainHeader::DEFAULT_ENCRYPTION_KEY_LENGTH) == 0);
 
    // zero out the encryption key in memory
    duckdb_mbedtls::MbedTlsWrapper::AESStateMBEDTLS::SecureClearData(encryption_key_p,
                                                                     MainHeader::DEFAULT_ENCRYPTION_KEY_LENGTH);
    LockEncryptionKey(key);
}

~EncryptionKey()

duckdb::EncryptionKey::~EncryptionKey

(

)

                              {
    UnlockEncryptionKey(key);
}

Member Function Documentation

GetPtr()

const_data_ptr_t duckdb::EncryptionKey::GetPtr ( ) const

inline

                                    {
        return key;
    }

GetData()

data_ptr_t duckdb::EncryptionKey::GetData ( )

inline

                         {
        return key;
    }

LockEncryptionKey()

void duckdb::EncryptionKey::LockEncryptionKey ( data_ptr_t  key, idx_t  key_len = MainHeader::DEFAULT_ENCRYPTION_KEY_LENGTH  )

static

                                                                   {
#if defined(_WIN32)
    VirtualLock(key, key_len);
#elif defined(__MVS__)
    __mlockall(_BPX_NONSWAP);
#else
    mlock(key, key_len);
#endif
}

UnlockEncryptionKey()

void duckdb::EncryptionKey::UnlockEncryptionKey ( data_ptr_t  key, idx_t  key_len = MainHeader::DEFAULT_ENCRYPTION_KEY_LENGTH  )

static

                                                                     {
    duckdb_mbedtls::MbedTlsWrapper::AESStateMBEDTLS::SecureClearData(key, key_len);
#if defined(_WIN32)
    VirtualUnlock(key, key_len);
#elif defined(__MVS__)
    __mlockall(_BPX_SWAP);
#else
    munlock(key, key_len);
#endif
}

---

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

• external/duckdb/duckdb.cpp