Berkeley DB: DB_ENV->set_encrypt
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++

DB_ENV->set_encrypt |

`

    #include <db.h>

    int
    DB_ENV->set_encrypt(DB_ENV *dbenv, const char *passwd, u_int32_t flags);

    int
    DB_ENV->get_encrypt_flags(DB_ENV *dbenv, u_int32_t *flagsp);

Description: DB_ENV->set_encrypt

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

The DB_ENV->set_encrypt method configures a database environment, not only operations performed using the specified DB_ENV handle.

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

The DB_ENV->set_encrypt method returns a non-zero error value on failure and 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 DB_ENV->set_encrypt method may fail and return one of the following non-zero errors:

EINVAL

- If the method was called after DB_ENV->open was called; or if an invalid flag value or parameter was specified.

EOPNOTSUPP

- Cryptography is not available in this Berkeley DB release.

Description: DB_ENV->get_encrypt_flags

The DB_ENV->get_encrypt_flags method returns the encryption flags.

The DB_ENV->get_encrypt_flags method may be called at any time during the life of the application.

The DB_ENV->get_encrypt_flags method returns a non-zero error value on failure and 0 on success.

Parameters
flagsp

- The DB_ENV->get_encrypt_flags method returns the encryption flags in flagsp.

Class DB_ENV
See Also Database Environments and Related Methods`

Copyright (c) 1996,2008 Oracle. All rights reserved.