Berkeley DB: DbEnv::set_encrypt
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# DbEnv::set_encrypt |

`

###

    #include <db_cxx.h>

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

# Description

Set the password used by the DbEnv and Db methods to perform encryption and decryption.

The flags value 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.

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

The DbEnv::set_encrypt interface may not be called after the DbEnv::open interface 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.

# Errors

The DbEnv::set_encrypt method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

  Called after DbEnv::open was called.

EOPNOTSUPP
  Cryptography is not available in this Berkeley DB release.

The DbEnv::set_encrypt method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the DbEnv::set_encrypt method may fail and either return DB_RUNRECOVERY or throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

DbEnv

# See Also

Database Environments and Related Methods`

Copyright Sleepycat Software