<?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title>DB_ENV->set_encrypt()</title> <link rel="stylesheet" href="apiReference.css" type="text/css" /> <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> <link rel="start" href="index.html" title="Berkeley DB C API Reference" /> <link rel="up" href="env.html" title="Chapter 5. The DB_ENV Handle" /> <link rel="prev" href="envset_create_dir.html" title="DB_ENV->set_create_dir()" /> <link rel="next" href="envevent_notify.html" title="DB_ENV->set_event_notify()" /> </head> <body> <div xmlns="" class="navheader"> <div class="libver"> <p>Library Version 11.2.5.3</p> </div> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">DB_ENV->set_encrypt()</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="envset_create_dir.html">Prev</a> </td> <th width="60%" align="center">Chapter 5. The DB_ENV Handle </th> <td width="20%" align="right"> <a accesskey="n" href="envevent_notify.html">Next</a></td> </tr> </table> <hr /> </div> <div class="sect1" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"><a id="envset_encrypt"></a>DB_ENV->set_encrypt()</h2> </div> </div> </div> <pre class="programlisting">#include <db.h> int DB_ENV->set_encrypt(DB_ENV *dbenv, const char *passwd, u_int32_t flags); </pre> <p> Set the password used by the Berkeley DB library to perform encryption and decryption. </p> <p> The <code class="methodname">DB_ENV->set_encrypt()</code> method configures a database environment, not only operations performed using the specified <a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a> handle. </p> <p> The <code class="methodname">DB_ENV->set_encrypt()</code> method may not be called after the <a class="xref" href="envopen.html" title="DB_ENV->open()">DB_ENV->open()</a> method is called. If the database environment already exists when <a class="xref" href="envopen.html" title="DB_ENV->open()">DB_ENV->open()</a> is called, the information specified to <code class="methodname">DB_ENV->set_encrypt()</code> must be consistent with the existing environment or an error will be returned. </p> <p> The <code class="methodname">DB_ENV->set_encrypt()</code> <span> <span> method returns a non-zero error value on failure and 0 on success. </span> </span> </p> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp59862784"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp59864504"></a>passwd</h4> </div> </div> </div> <p> The <span class="bold"><strong>passwd</strong></span> parameter is the password used to perform encryption and decryption. </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp59868216"></a>flags</h4> </div> </div> </div> <p> The <span class="bold"><strong>flags</strong></span> parameter must be set to 0 or the following value: </p> <div class="itemizedlist"> <ul type="disc"> <li> <p><a id="envset_encrypt_DB_ENCRYPT_AES"></a> <code class="literal">DB_ENCRYPT_AES</code> </p> <p> Use the Rijndael/AES (also known as the Advanced Encryption Standard and Federal Information Processing Standard (FIPS) 197) algorithm for encryption or decryption. </p> </li> </ul> </div> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp59885096"></a>Errors</h3> </div> </div> </div> <p> The <code class="methodname">DB_ENV->set_encrypt()</code> <span> <span> method may fail and return one of the following non-zero errors: </span> </span> </p> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp59889544"></a>EINVAL</h4> </div> </div> </div> <p> If the method was called after <a class="xref" href="envopen.html" title="DB_ENV->open()">DB_ENV->open()</a> was called; or if an invalid flag value or parameter was specified. </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp59890624"></a>EOPNOTSUPP</h4> </div> </div> </div> <p> Cryptography is not available in this Berkeley DB release. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp59887600"></a>Class</h3> </div> </div> </div> <p> <a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a> </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp59884536"></a>See Also</h3> </div> </div> </div> <p> <a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a> </p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="envset_create_dir.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href="env.html">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="envevent_notify.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">DB_ENV->set_create_dir() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> DB_ENV->set_event_notify()</td> </tr> </table> </div> </body> </html>