<?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->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="db.html" title="Chapter 2. The DB Handle" /> <link rel="prev" href="dbset_dup_compare.html" title="DB->set_dup_compare()" /> <link rel="next" href="dbset_errcall.html" title="DB->set_errcall()" /> </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->set_encrypt()</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="dbset_dup_compare.html">Prev</a> </td> <th width="60%" align="center">Chapter 2. The DB Handle </th> <td width="20%" align="right"> <a accesskey="n" href="dbset_errcall.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="dbset_encrypt"></a>DB->set_encrypt()</h2> </div> </div> </div> <pre class="programlisting">#include <db.h> int DB->set_encrypt(DB *db, 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> Because databases opened within Berkeley DB environments use the password specified to the environment, it is an error to attempt to set a password in a database created within an environment. </p> <p> The <code class="methodname">DB->set_encrypt()</code> method may not be called after the <a class="xref" href="dbopen.html" title="DB->open()">DB->open()</a> method is called. </p> <p> The <code class="methodname">DB->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="idp50207232"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp50214040"></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="idp50213608"></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="set_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="idp50227192"></a>Errors</h3> </div> </div> </div> <p> The <code class="methodname">DB->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="idp50231536"></a>EINVAL</h4> </div> </div> </div> <p> If the method was called after <a class="xref" href="dbopen.html" title="DB->open()">DB->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="idp50189104"></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="idp50230456"></a>Class</h3> </div> </div> </div> <p> <a class="link" href="db.html" title="Chapter 2. The DB Handle">DB</a> </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp50233944"></a>See Also</h3> </div> </div> </div> <p> <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database 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="dbset_dup_compare.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href="db.html">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="dbset_errcall.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">DB->set_dup_compare() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> DB->set_errcall()</td> </tr> </table> </div> </body> </html>