DbEnv::set_encrypt()

#include <db_cxx.h>

int
DbEnv::set_encrypt(const char *passwd, u_int32_t flags); 

Set the password used by the Berkeley DB library to perform encryption and decryption.

The DbEnv::set_encrypt() method configures a database environment, not only operations performed using the specified DbEnv handle.

The DbEnv::set_encrypt() method may not be called after the DbEnv::open() method is called. If the database environment already exists when DbEnv::open() is called, the information specified to DbEnv::set_encrypt() must be consistent with the existing environment or an error will be returned.

The DbEnv::set_encrypt() method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success.

Parameters

flags

The flags parameter must be set to 0 or the following value:

  • DB_ENCRYPT_AES

    Use the Rijndael/AES (also known as the Advanced Encryption Standard and Federal Information Processing Standard (FIPS) 197) algorithm for encryption or decryption.

passwd

The passwd parameter is the password used to perform encryption and decryption.

Errors

The DbEnv::set_encrypt() method may fail and throw a DbException exception, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

EINVAL

If the method was called after DbEnv::open() was called; or if an invalid flag value or parameter was specified.

EOPNOTSUPP

Cryptography is not available in this Berkeley DB release.

Class

DbEnv

See Also

Database Environments and Related Methods