Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > 909f302ad53a08b3685753343102c969 > files > 93

lib64db4.1-devel-4.1.25-13mdv2008.1.x86_64.rpm

<!--$Id: env_set_encrypt.so,v 10.5 2002/09/03 19:33:33 bostic Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB_ENV-&gt;set_encrypt</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td>
<h1>DB_ENV-&gt;set_encrypt</h1>
</td>
<td align=right>
<a href="../../db4-devel-4.1.25/api_c/c_index.html"><img src="../../db4-4.1.25/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.1.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include &lt;db.h&gt;
<p>
int
DB_ENV-&gt;set_encrypt(DB_ENV *dbenv, const char *passwd, u_int32_t flags);
</pre></h3>
<h1>Description</h1>
<p>Set the password used by the <a href="../../db4-devel-4.1.25/api_c/env_class.html">DB_ENV</a> and <a href="../../db4-devel-4.1.25/api_c/db_class.html">DB</a> methods to
perform encryption and decryption.
<p>The <b>flags</b> value must be set to 0 or
the following value:
<p><dl compact>
<p><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>
<p>The DB_ENV-&gt;set_encrypt method configures a database environment, not only operations
performed using the specified <a href="../../db4-devel-4.1.25/api_c/env_class.html">DB_ENV</a> handle.
<p>The DB_ENV-&gt;set_encrypt interface may not be called after the <a href="../../db4-devel-4.1.25/api_c/env_open.html">DB_ENV-&gt;open</a>
interface is called.
If the database environment already exists when
<a href="../../db4-devel-4.1.25/api_c/env_open.html">DB_ENV-&gt;open</a> is called, the information specified to DB_ENV-&gt;set_encrypt
must be consistent with the existing environment or an error will be
returned.
<p>The DB_ENV-&gt;set_encrypt method returns a non-zero error value on failure and 0 on success.
<h1>Errors</h1>
<p>The DB_ENV-&gt;set_encrypt method may fail and return a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>Called after
<a href="../../db4-devel-4.1.25/api_c/env_open.html">DB_ENV-&gt;open</a>
was called.
</dl>
<p><dl compact>
<p><dt>EOPNOTSUPP<dd>Cryptography is not available in this Berkeley DB release.
</dl>
<p>The DB_ENV-&gt;set_encrypt method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the DB_ENV-&gt;set_encrypt method may fail and
return <a href="../../db4-devel-4.1.25/ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>Class</h1>
<a href="../../db4-devel-4.1.25/api_c/env_class.html">DB_ENV</a>
<h1>See Also</h1>
<a href="../../db4-devel-4.1.25/api_c/env_list.html">Database Environments and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../../db4-devel-4.1.25/api_c/c_index.html"><img src="../../db4-4.1.25/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.1.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>