<!--$Id: env_set_encrypt.so,v 10.23 2004/09/28 15:04:20 bostic Exp $--> <!--Copyright (c) 1997,2007 Oracle. All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DbEnv::set_encrypt</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> </head> <body bgcolor=white> <table width="100%"><tr valign=top> <td> <h3>DbEnv::set_encrypt</h3> </td> <td align=right> <a href="../../db46-devel-4.6.21/api_cxx/api_core.html"><img src="../../db46-devel-4.6.21/images/api.gif" alt="API"></a> <a href="../../db46-devel-4.6.21/ref/toc.html"><img src="../../db46-devel-4.6.21/images/ref.gif" alt="Ref"></a></td> </tr></table> <hr size=1 noshade> <tt> <h3><pre> #include <db_cxx.h> <p> int DbEnv::set_encrypt(const char *passwd, u_int32_t flags); <p> int DbEnv::get_encrypt_flags(u_int32_t *flagsp); </pre></h3> <hr size=1 noshade> <h3>Description: DbEnv::set_encrypt</h3> <p>Set the password used by the Berkeley DB library to perform encryption and decryption.</p> <p>The DbEnv::set_encrypt method configures a database environment, not only operations performed using the specified <a href="../../db46-devel-4.6.21/api_cxx/env_class.html">DbEnv</a> handle.</p> <p>The DbEnv::set_encrypt method may not be called after the <a href="../../db46-devel-4.6.21/api_cxx/env_open.html">DbEnv::open</a> method is called. If the database environment already exists when <a href="../../db46-devel-4.6.21/api_cxx/env_open.html">DbEnv::open</a> is called, the information specified to DbEnv::set_encrypt must be consistent with the existing environment or an error will be returned. </p> <p>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. </p> <h3>Parameters</h3> <dl compact> <dt><b>flags</b><dd>The <b>flags</b> parameter must be set to 0 or the following value: <dl compact> <dt><a name="DB_ENCRYPT_AES">DB_ENCRYPT_AES</a><dd>Use the Rijndael/AES (also known as the Advanced Encryption Standard and Federal Information Processing Standard (FIPS) 197) algorithm for encryption or decryption. </dl> <dt><b>passwd</b><dd>The <b>passwd</b> parameter is the password used to perform encryption and decryption. </dl> <h3>Errors</h3> <p>The DbEnv::set_encrypt method may fail and throw <a href="../../db46-devel-4.6.21/api_cxx/except_class.html">DbException</a>, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:</p> <dl compact> <dt>EINVAL<dd>If the method was called after <a href="../../db46-devel-4.6.21/api_cxx/env_open.html">DbEnv::open</a> was called; or if an invalid flag value or parameter was specified. </dl> <dl compact> <dt>EOPNOTSUPP<dd>Cryptography is not available in this Berkeley DB release. </dl> <hr size=1 noshade> <h3>Description: DbEnv::get_encrypt_flags</h3> <p>The DbEnv::get_encrypt_flags method returns the encryption flags.</p> <p>The DbEnv::get_encrypt_flags method may be called at any time during the life of the application.</p> <p>The DbEnv::get_encrypt_flags 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. </p> <h3>Parameters</h3> <dl compact> <dt><b>flagsp</b><dd>The DbEnv::get_encrypt_flags method returns the encryption flags in <b>flagsp</b>. </dl> <hr size=1 noshade> <h3>Class</h3> <a href="../../db46-devel-4.6.21/api_cxx/env_class.html">DbEnv</a> <h3>See Also</h3> <a href="../../db46-devel-4.6.21/api_cxx/env_list.html">Database Environments and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../../db46-devel-4.6.21/api_cxx/api_core.html"><img src="../../db46-devel-4.6.21/images/api.gif" alt="API"></a><a href="../../db46-devel-4.6.21/ref/toc.html"><img src="../../db46-devel-4.6.21/images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1>Copyright (c) 1996,2007 Oracle. All rights reserved.</font> </body> </html>