You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apr.apache.org by bo...@apache.org on 2009/06/15 02:01:47 UTC
svn commit: r784636 [5/47] - in /apr/site/trunk/docs/docs: apr-util/trunk/
apr/trunk/
Added: apr/site/trunk/docs/docs/apr/trunk/apr__crypto_8h-source.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__crypto_8h-source.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__crypto_8h-source.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__crypto_8h-source.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,493 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Apache Portable Runtime: apr_crypto.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li class="current"><a href="files.html"><span>Files</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="files.html"><span>File List</span></a></li>
+ <li><a href="globals.html"><span>Globals</span></a></li>
+ </ul>
+ </div>
+<h1>apr_crypto.h</h1><a href="apr__crypto_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
+<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
+<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
+<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
+<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
+<a name="l00006"></a>00006 <span class="comment"> * the License. You may obtain a copy of the License at</span>
+<a name="l00007"></a>00007 <span class="comment"> *</span>
+<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
+<a name="l00009"></a>00009 <span class="comment"> *</span>
+<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
+<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
+<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
+<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
+<a name="l00015"></a>00015 <span class="comment"> */</span>
+<a name="l00016"></a>00016
+<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APR_CRYPTO_H</span>
+<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_CRYPTO_H</span>
+<a name="l00019"></a>00019 <span class="preprocessor"></span>
+<a name="l00020"></a>00020 <span class="preprocessor">#include "apu.h"</span>
+<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html" title="APR memory allocation.">apr_pools.h</a>"</span>
+<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="apr__tables_8h.html" title="APR Table library.">apr_tables.h</a>"</span>
+<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="apu__errno_8h.html" title="APR-Util Error Codes.">apu_errno.h</a>"</span>
+<a name="l00024"></a>00024
+<a name="l00025"></a>00025 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+<a name="l00027"></a>00027 <span class="preprocessor">#endif</span>
+<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00029"></a>00029 <span class="comment">/**</span>
+<a name="l00030"></a>00030 <span class="comment"> * @file apr_crypto.h</span>
+<a name="l00031"></a>00031 <span class="comment"> * @brief APR-UTIL Crypto library</span>
+<a name="l00032"></a>00032 <span class="comment"> */</span><span class="comment"></span>
+<a name="l00033"></a>00033 <span class="comment">/**</span>
+<a name="l00034"></a>00034 <span class="comment"> * @defgroup APR_Util_Crypto Crypto routines</span>
+<a name="l00035"></a>00035 <span class="comment"> * @ingroup APR_Util</span>
+<a name="l00036"></a>00036 <span class="comment"> * @{</span>
+<a name="l00037"></a>00037 <span class="comment"> */</span>
+<a name="l00038"></a>00038 <span class="comment"></span>
+<a name="l00039"></a>00039 <span class="comment">/** CA certificate type unknown */</span>
+<a name="l00040"></a><a class="code" href="group___a_p_r___util___crypto.html#g3a6daa6ef5ab33045643cf3c9efc99b0">00040</a> <span class="preprocessor">#define APR_CRYPTO_CA_TYPE_UNKNOWN 0</span>
+<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="comment">/** binary DER encoded CA certificate */</span>
+<a name="l00042"></a><a class="code" href="group___a_p_r___util___crypto.html#g73f957e1c03c120625512249bd6301c3">00042</a> <span class="preprocessor">#define APR_CRYPTO_CA_TYPE_DER 1</span>
+<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="comment">/** PEM encoded CA certificate */</span>
+<a name="l00044"></a><a class="code" href="group___a_p_r___util___crypto.html#g8756d0604c36a983f796b946056a4294">00044</a> <span class="preprocessor">#define APR_CRYPTO_CA_TYPE_BASE64 2</span>
+<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="comment">/** Netscape/Mozilla cert7.db CA certificate database */</span>
+<a name="l00046"></a><a class="code" href="group___a_p_r___util___crypto.html#gaec5757e3d6bc0405a1ed1ec044cb27f">00046</a> <span class="preprocessor">#define APR_CRYPTO_CA_TYPE_CERT7_DB 3</span>
+<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="comment">/** Netscape/Mozilla secmod file */</span>
+<a name="l00048"></a><a class="code" href="group___a_p_r___util___crypto.html#g7fcb37cadc9f8e45cfa194c09a7ace93">00048</a> <span class="preprocessor">#define APR_CRYPTO_CA_TYPE_SECMOD 4</span>
+<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="comment">/** Client certificate type unknown */</span>
+<a name="l00050"></a><a class="code" href="group___a_p_r___util___crypto.html#g04621f567f12632d9983ae10decf53a6">00050</a> <span class="preprocessor">#define APR_CRYPTO_CERT_TYPE_UNKNOWN 5</span>
+<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="comment">/** binary DER encoded client certificate */</span>
+<a name="l00052"></a><a class="code" href="group___a_p_r___util___crypto.html#gd87df30799fbc940838466e5d3814781">00052</a> <span class="preprocessor">#define APR_CRYPTO_CERT_TYPE_DER 6</span>
+<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="comment">/** PEM encoded client certificate */</span>
+<a name="l00054"></a><a class="code" href="group___a_p_r___util___crypto.html#gd10422d474856d786231448ed3185b1a">00054</a> <span class="preprocessor">#define APR_CRYPTO_CERT_TYPE_BASE64 7</span>
+<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="comment">/** Netscape/Mozilla key3.db client certificate database */</span>
+<a name="l00056"></a><a class="code" href="group___a_p_r___util___crypto.html#g48b707d7976def4ba2b51756f612d68d">00056</a> <span class="preprocessor">#define APR_CRYPTO_CERT_TYPE_KEY3_DB 8</span>
+<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="comment">/** Netscape/Mozilla client certificate nickname */</span>
+<a name="l00058"></a><a class="code" href="group___a_p_r___util___crypto.html#g60ca9545d8b3b8df2a2131a93896d9c8">00058</a> <span class="preprocessor">#define APR_CRYPTO_CERT_TYPE_NICKNAME 9</span>
+<a name="l00059"></a>00059 <span class="preprocessor"></span><span class="comment">/** Private key type unknown */</span>
+<a name="l00060"></a><a class="code" href="group___a_p_r___util___crypto.html#g6632b059de9403a9b6cbfbd4fdf1176b">00060</a> <span class="preprocessor">#define APR_CRYPTO_KEY_TYPE_UNKNOWN 10</span>
+<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="comment">/** binary DER encoded private key */</span>
+<a name="l00062"></a><a class="code" href="group___a_p_r___util___crypto.html#g590d49629c79efe97c57679d2cfc65e7">00062</a> <span class="preprocessor">#define APR_CRYPTO_KEY_TYPE_DER 11</span>
+<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="comment">/** PEM encoded private key */</span>
+<a name="l00064"></a><a class="code" href="group___a_p_r___util___crypto.html#gc3fe3a00d27087c37f10beaa2d9fc21a">00064</a> <span class="preprocessor">#define APR_CRYPTO_KEY_TYPE_BASE64 12</span>
+<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="comment">/** PKCS#12 encoded client certificate */</span>
+<a name="l00066"></a><a class="code" href="group___a_p_r___util___crypto.html#g0c8d540c760ad91ab25b0536e9996d4e">00066</a> <span class="preprocessor">#define APR_CRYPTO_CERT_TYPE_PFX 13</span>
+<a name="l00067"></a>00067 <span class="preprocessor"></span><span class="comment">/** PKCS#12 encoded private key */</span>
+<a name="l00068"></a><a class="code" href="group___a_p_r___util___crypto.html#g486b3fb3512ac4ad8a9049aad870f420">00068</a> <span class="preprocessor">#define APR_CRYPTO_KEY_TYPE_PFX 14</span>
+<a name="l00069"></a>00069 <span class="preprocessor"></span><span class="comment">/** Openldap directory full of base64-encoded cert</span>
+<a name="l00070"></a>00070 <span class="comment"> * authorities with hashes in corresponding .0 directory</span>
+<a name="l00071"></a>00071 <span class="comment"> */</span>
+<a name="l00072"></a><a class="code" href="group___a_p_r___util___crypto.html#gc5058657589483e8ccaac6d01dd32a47">00072</a> <span class="preprocessor">#define APR_CRYPTO_CA_TYPE_CACERTDIR_BASE64 15</span>
+<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="comment">/** CMS Key Database with private key and cert chain */</span>
+<a name="l00074"></a><a class="code" href="group___a_p_r___util___crypto.html#g76fd96f686fbcab807b7e0d8cff2045b">00074</a> <span class="preprocessor">#define APR_CRYPTO_CA_TYPE_CMS 16</span>
+<a name="l00075"></a>00075 <span class="preprocessor"></span><span class="comment">/** Symmetrical key */</span>
+<a name="l00076"></a><a class="code" href="group___a_p_r___util___crypto.html#gaa6e7273c8957d99276d3cf58081a544">00076</a> <span class="preprocessor">#define APR_CRYPTO_KEY_TYPE_SYM 17</span>
+<a name="l00077"></a>00077 <span class="preprocessor"></span><span class="comment">/** Netscape/Mozilla certificate database directory */</span>
+<a name="l00078"></a><a class="code" href="group___a_p_r___util___crypto.html#g763aeb6a00bef24e7d6ece142f78ef9c">00078</a> <span class="preprocessor">#define APR_CRYPTO_CA_TYPE_DIR 18</span>
+<a name="l00079"></a>00079 <span class="preprocessor"></span><span class="comment">/** Crypto engine */</span>
+<a name="l00080"></a><a class="code" href="group___a_p_r___util___crypto.html#g06ea873117d91b17d740f486269beb9f">00080</a> <span class="preprocessor">#define APR_CRYPTO_ENGINE 101</span>
+<a name="l00081"></a>00081 <span class="preprocessor"></span>
+<a name="l00082"></a>00082 <span class="preprocessor">#if APU_HAVE_CRYPTO</span>
+<a name="l00083"></a>00083 <span class="preprocessor"></span>
+<a name="l00084"></a>00084 <span class="preprocessor">#ifndef APU_CRYPTO_RECOMMENDED_DRIVER</span>
+<a name="l00085"></a>00085 <span class="preprocessor"></span><span class="preprocessor">#if APU_HAVE_OPENSSL</span>
+<a name="l00086"></a>00086 <span class="preprocessor"></span><span class="preprocessor">#define APU_CRYPTO_RECOMMENDED_DRIVER "openssl"</span>
+<a name="l00087"></a>00087 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00088"></a>00088 <span class="preprocessor"></span><span class="preprocessor">#if APU_HAVE_NSS</span>
+<a name="l00089"></a>00089 <span class="preprocessor"></span><span class="preprocessor">#define APU_CRYPTO_RECOMMENDED_DRIVER "nss"</span>
+<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00091"></a>00091 <span class="preprocessor"></span><span class="preprocessor">#if APU_HAVE_MSCNG</span>
+<a name="l00092"></a>00092 <span class="preprocessor"></span><span class="preprocessor">#define APU_CRYPTO_RECOMMENDED_DRIVER "mscng"</span>
+<a name="l00093"></a>00093 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor">#if APU_HAVE_MSCAPI</span>
+<a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor">#define APU_CRYPTO_RECOMMENDED_DRIVER "mscapi"</span>
+<a name="l00096"></a>00096 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00097"></a>00097 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00098"></a>00098 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00099"></a>00099 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00100"></a>00100 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00101"></a>00101 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00102"></a>00102 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00103"></a>00103 <span class="comment">/**</span>
+<a name="l00104"></a>00104 <span class="comment"> * Symmetric Key types understood by the library.</span>
+<a name="l00105"></a>00105 <span class="comment"> *</span>
+<a name="l00106"></a>00106 <span class="comment"> * NOTE: It is expected that this list will grow over time.</span>
+<a name="l00107"></a>00107 <span class="comment"> *</span>
+<a name="l00108"></a>00108 <span class="comment"> * Interoperability Matrix:</span>
+<a name="l00109"></a>00109 <span class="comment"> *</span>
+<a name="l00110"></a>00110 <span class="comment"> * The matrix is based on the testcrypto.c unit test, which attempts to</span>
+<a name="l00111"></a>00111 <span class="comment"> * test whether a simple encrypt/decrypt will succeed, as well as testing</span>
+<a name="l00112"></a>00112 <span class="comment"> * whether an encrypted string by one library can be decrypted by the</span>
+<a name="l00113"></a>00113 <span class="comment"> * others.</span>
+<a name="l00114"></a>00114 <span class="comment"> *</span>
+<a name="l00115"></a>00115 <span class="comment"> * Some libraries will successfully encrypt and decrypt their own data,</span>
+<a name="l00116"></a>00116 <span class="comment"> * but won't decrypt data from another library. It is hoped that over</span>
+<a name="l00117"></a>00117 <span class="comment"> * time these anomalies will be found and fixed, but until then it is</span>
+<a name="l00118"></a>00118 <span class="comment"> * recommended that ciphers are chosen that interoperate across platform.</span>
+<a name="l00119"></a>00119 <span class="comment"> *</span>
+<a name="l00120"></a>00120 <span class="comment"> * An X below means the test passes, it does not necessarily mean that</span>
+<a name="l00121"></a>00121 <span class="comment"> * encryption performed is correct or secure. Applications should stick</span>
+<a name="l00122"></a>00122 <span class="comment"> * to ciphers that pass the interoperablity tests on the right hand side</span>
+<a name="l00123"></a>00123 <span class="comment"> * of the table.</span>
+<a name="l00124"></a>00124 <span class="comment"> *</span>
+<a name="l00125"></a>00125 <span class="comment"> * Aligned data is data whose length is a multiple of the block size for</span>
+<a name="l00126"></a>00126 <span class="comment"> * the chosen cipher. Padded data is data that is not aligned by block</span>
+<a name="l00127"></a>00127 <span class="comment"> * size and must be padded by the crypto library.</span>
+<a name="l00128"></a>00128 <span class="comment"> *</span>
+<a name="l00129"></a>00129 <span class="comment"> * OpenSSL NSS Interop</span>
+<a name="l00130"></a>00130 <span class="comment"> * Align Pad Align Pad Align Pad</span>
+<a name="l00131"></a>00131 <span class="comment"> * 3DES_192/CBC X X X X X X</span>
+<a name="l00132"></a>00132 <span class="comment"> * 3DES_192/ECB X X</span>
+<a name="l00133"></a>00133 <span class="comment"> * AES_256/CBC X X X X X X</span>
+<a name="l00134"></a>00134 <span class="comment"> * AES_256/ECB X X X X</span>
+<a name="l00135"></a>00135 <span class="comment"> * AES_192/CBC X X X X</span>
+<a name="l00136"></a>00136 <span class="comment"> * AES_192/ECB X X X</span>
+<a name="l00137"></a>00137 <span class="comment"> * AES_128/CBC X X X X</span>
+<a name="l00138"></a>00138 <span class="comment"> * AES_128/ECB X X X</span>
+<a name="l00139"></a>00139 <span class="comment"> *</span>
+<a name="l00140"></a>00140 <span class="comment"> * Conclusion: for padded data, use 3DES_192/CBC or AES_256/CBC. For</span>
+<a name="l00141"></a>00141 <span class="comment"> * aligned data, use 3DES_192/CBC, AES_256/CBC or AES_256/ECB.</span>
+<a name="l00142"></a>00142 <span class="comment"> */</span>
+<a name="l00143"></a>00143
+<a name="l00144"></a>00144 <span class="keyword">typedef</span> <span class="keyword">enum</span> {
+<a name="l00145"></a>00145 KEY_NONE, KEY_3DES_192, <span class="comment">/** 192 bit (3-Key) 3DES */</span>
+<a name="l00146"></a>00146 KEY_AES_128, <span class="comment">/** 128 bit AES */</span>
+<a name="l00147"></a>00147 KEY_AES_192, <span class="comment">/** 192 bit AES */</span>
+<a name="l00148"></a>00148 KEY_AES_256<span class="comment"></span>
+<a name="l00149"></a>00149 <span class="comment">/** 256 bit AES */</span>
+<a name="l00150"></a>00150 } apr_crypto_block_key_type_e;
+<a name="l00151"></a>00151
+<a name="l00152"></a>00152 <span class="keyword">typedef</span> <span class="keyword">enum</span> {
+<a name="l00153"></a>00153 MODE_NONE, <span class="comment">/** An error condition */</span>
+<a name="l00154"></a>00154 MODE_ECB, <span class="comment">/** Electronic Code Book */</span>
+<a name="l00155"></a>00155 MODE_CBC<span class="comment"></span>
+<a name="l00156"></a>00156 <span class="comment">/** Cipher Block Chaining */</span>
+<a name="l00157"></a>00157 } apr_crypto_block_key_mode_e;
+<a name="l00158"></a>00158 <span class="comment"></span>
+<a name="l00159"></a>00159 <span class="comment">/**</span>
+<a name="l00160"></a>00160 <span class="comment"> * Certificate and private key structure.</span>
+<a name="l00161"></a>00161 <span class="comment"> *</span>
+<a name="l00162"></a>00162 <span class="comment"> * The various crypto backends expect certificates and keys in a wide</span>
+<a name="l00163"></a>00163 <span class="comment"> * array of formats. This structure is analogous to apr_ldap_opt_tls_cert_t</span>
+<a name="l00164"></a>00164 <span class="comment"> * from the LDAP interface. Ultimately that interface should be meshed with</span>
+<a name="l00165"></a>00165 <span class="comment"> * this one.</span>
+<a name="l00166"></a>00166 <span class="comment"> * @param type Type of certificate APR_CRYPTO_*_TYPE_*</span>
+<a name="l00167"></a>00167 <span class="comment"> * @param path Path, file or nickname of the certificate</span>
+<a name="l00168"></a>00168 <span class="comment"> * @param password Optional password, can be NULL</span>
+<a name="l00169"></a>00169 <span class="comment"> */</span>
+<a name="l00170"></a>00170 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_crypto_param_t {
+<a name="l00171"></a>00171 <span class="keywordtype">int</span> type;
+<a name="l00172"></a>00172 <span class="keyword">const</span> <span class="keywordtype">char</span> *path;
+<a name="l00173"></a>00173 <span class="keyword">const</span> <span class="keywordtype">char</span> *password;
+<a name="l00174"></a>00174 } apr_crypto_param_t;
+<a name="l00175"></a>00175
+<a name="l00176"></a>00176 <span class="comment">/* These are opaque structs. Instantiation is up to each backend */</span>
+<a name="l00177"></a>00177 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_crypto_driver_t apr_crypto_driver_t;
+<a name="l00178"></a>00178 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_crypto_config_t apr_crypto_config_t;
+<a name="l00179"></a>00179 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_crypto_key_t apr_crypto_key_t;
+<a name="l00180"></a>00180 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_crypto_block_t apr_crypto_block_t;
+<a name="l00181"></a>00181 <span class="comment"></span>
+<a name="l00182"></a>00182 <span class="comment">/**</span>
+<a name="l00183"></a>00183 <span class="comment"> * Public factory API, common to all backends.</span>
+<a name="l00184"></a>00184 <span class="comment"> */</span>
+<a name="l00185"></a>00185 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_crypto_t {
+<a name="l00186"></a>00186 <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool;
+<a name="l00187"></a>00187 <a class="code" href="structapu__err__t.html">apu_err_t</a> *result;
+<a name="l00188"></a>00188 <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *keys;
+<a name="l00189"></a>00189 apr_crypto_config_t *config;
+<a name="l00190"></a>00190 } apr_crypto_t;
+<a name="l00191"></a>00191 <span class="comment"></span>
+<a name="l00192"></a>00192 <span class="comment">/**</span>
+<a name="l00193"></a>00193 <span class="comment"> * @brief Perform once-only initialisation. Call once only.</span>
+<a name="l00194"></a>00194 <span class="comment"> *</span>
+<a name="l00195"></a>00195 <span class="comment"> * @param pool - pool to register any shutdown cleanups, etc</span>
+<a name="l00196"></a>00196 <span class="comment"> * @return APR_NOTIMPL in case of no crypto support.</span>
+<a name="l00197"></a>00197 <span class="comment"> */</span>
+<a name="l00198"></a>00198 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_init(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
+<a name="l00199"></a>00199 const <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *params);
+<a name="l00200"></a>00200 <span class="comment"></span>
+<a name="l00201"></a>00201 <span class="comment">/**</span>
+<a name="l00202"></a>00202 <span class="comment"> * @brief Get the driver struct for a name</span>
+<a name="l00203"></a>00203 <span class="comment"> *</span>
+<a name="l00204"></a>00204 <span class="comment"> * @param pool - (process) pool to register cleanup</span>
+<a name="l00205"></a>00205 <span class="comment"> * @param name - driver name</span>
+<a name="l00206"></a>00206 <span class="comment"> * @param driver - pointer to driver struct.</span>
+<a name="l00207"></a>00207 <span class="comment"> * @return APR_SUCCESS for success</span>
+<a name="l00208"></a>00208 <span class="comment"> * @return APR_ENOTIMPL for no driver (when DSO not enabled)</span>
+<a name="l00209"></a>00209 <span class="comment"> * @return APR_EDSOOPEN if DSO driver file can't be opened</span>
+<a name="l00210"></a>00210 <span class="comment"> * @return APR_ESYMNOTFOUND if the driver file doesn't contain a driver</span>
+<a name="l00211"></a>00211 <span class="comment"> */</span>
+<a name="l00212"></a>00212 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_get_driver(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, const <span class="keywordtype">char</span> *name,
+<a name="l00213"></a>00213 const apr_crypto_driver_t **driver, const <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *params,
+<a name="l00214"></a>00214 const <a class="code" href="structapu__err__t.html">apu_err_t</a> **result);
+<a name="l00215"></a>00215 <span class="comment"></span>
+<a name="l00216"></a>00216 <span class="comment">/**</span>
+<a name="l00217"></a>00217 <span class="comment"> * @brief Return the name of the driver.</span>
+<a name="l00218"></a>00218 <span class="comment"> *</span>
+<a name="l00219"></a>00219 <span class="comment"> * @param driver - The driver in use.</span>
+<a name="l00220"></a>00220 <span class="comment"> * @return The name of the driver.</span>
+<a name="l00221"></a>00221 <span class="comment"> */</span>
+<a name="l00222"></a>00222 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(const <span class="keywordtype">char</span> *)apr_crypto_driver_name (const apr_crypto_driver_t *driver);
+<a name="l00223"></a>00223 <span class="comment"></span>
+<a name="l00224"></a>00224 <span class="comment">/**</span>
+<a name="l00225"></a>00225 <span class="comment"> * @brief Get the result of the last operation on a factory. If the result</span>
+<a name="l00226"></a>00226 <span class="comment"> * is NULL, the operation was successful.</span>
+<a name="l00227"></a>00227 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00228"></a>00228 <span class="comment"> * @param factory - factory pointer will be written here</span>
+<a name="l00229"></a>00229 <span class="comment"> * @param result - the result structure</span>
+<a name="l00230"></a>00230 <span class="comment"> * @return APR_SUCCESS for success</span>
+<a name="l00231"></a>00231 <span class="comment"> */</span>
+<a name="l00232"></a>00232 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_error(const apr_crypto_t *f,
+<a name="l00233"></a>00233 const <a class="code" href="structapu__err__t.html">apu_err_t</a> **result);
+<a name="l00234"></a>00234 <span class="comment"></span>
+<a name="l00235"></a>00235 <span class="comment">/**</span>
+<a name="l00236"></a>00236 <span class="comment"> * @brief Create a context for supporting encryption. Keys, certificates,</span>
+<a name="l00237"></a>00237 <span class="comment"> * algorithms and other parameters will be set per context. More than</span>
+<a name="l00238"></a>00238 <span class="comment"> * one context can be created at one time. A cleanup will be automatically</span>
+<a name="l00239"></a>00239 <span class="comment"> * registered with the given pool to guarantee a graceful shutdown.</span>
+<a name="l00240"></a>00240 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00241"></a>00241 <span class="comment"> * @param pool - process pool</span>
+<a name="l00242"></a>00242 <span class="comment"> * @param params - array of key parameters</span>
+<a name="l00243"></a>00243 <span class="comment"> * @param factory - factory pointer will be written here</span>
+<a name="l00244"></a>00244 <span class="comment"> * @return APR_ENOENGINE when the engine specified does not exist. APR_EINITENGINE</span>
+<a name="l00245"></a>00245 <span class="comment"> * if the engine cannot be initialised.</span>
+<a name="l00246"></a>00246 <span class="comment"> */</span>
+<a name="l00247"></a>00247 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_factory(const apr_crypto_driver_t *driver,
+<a name="l00248"></a>00248 <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, const <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *params, apr_crypto_t **f);
+<a name="l00249"></a>00249 <span class="comment"></span>
+<a name="l00250"></a>00250 <span class="comment">/**</span>
+<a name="l00251"></a>00251 <span class="comment"> * @brief Create a key from the given passphrase. By default, the PBKDF2</span>
+<a name="l00252"></a>00252 <span class="comment"> * algorithm is used to generate the key from the passphrase. It is expected</span>
+<a name="l00253"></a>00253 <span class="comment"> * that the same pass phrase will generate the same key, regardless of the</span>
+<a name="l00254"></a>00254 <span class="comment"> * backend crypto platform used. The key is cleaned up when the context</span>
+<a name="l00255"></a>00255 <span class="comment"> * is cleaned, and may be reused with multiple encryption or decryption</span>
+<a name="l00256"></a>00256 <span class="comment"> * operations.</span>
+<a name="l00257"></a>00257 <span class="comment"> * @note If *key is NULL, a apr_crypto_key_t will be created from a pool. If</span>
+<a name="l00258"></a>00258 <span class="comment"> * *key is not NULL, *key must point at a previously created structure.</span>
+<a name="l00259"></a>00259 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00260"></a>00260 <span class="comment"> * @param p The pool to use.</span>
+<a name="l00261"></a>00261 <span class="comment"> * @param f The context to use.</span>
+<a name="l00262"></a>00262 <span class="comment"> * @param pass The passphrase to use.</span>
+<a name="l00263"></a>00263 <span class="comment"> * @param passLen The passphrase length in bytes</span>
+<a name="l00264"></a>00264 <span class="comment"> * @param salt The salt to use.</span>
+<a name="l00265"></a>00265 <span class="comment"> * @param saltLen The salt length in bytes</span>
+<a name="l00266"></a>00266 <span class="comment"> * @param type 3DES_192, AES_128, AES_192, AES_256.</span>
+<a name="l00267"></a>00267 <span class="comment"> * @param mode Electronic Code Book / Cipher Block Chaining.</span>
+<a name="l00268"></a>00268 <span class="comment"> * @param doPad Pad if necessary.</span>
+<a name="l00269"></a>00269 <span class="comment"> * @param key The key returned, see note.</span>
+<a name="l00270"></a>00270 <span class="comment"> * @param ivSize The size of the initialisation vector will be returned, based</span>
+<a name="l00271"></a>00271 <span class="comment"> * on whether an IV is relevant for this type of crypto.</span>
+<a name="l00272"></a>00272 <span class="comment"> * @return Returns APR_ENOKEY if the pass phrase is missing or empty, or if a backend</span>
+<a name="l00273"></a>00273 <span class="comment"> * error occurred while generating the key. APR_ENOCIPHER if the type or mode</span>
+<a name="l00274"></a>00274 <span class="comment"> * is not supported by the particular backend. APR_EKEYTYPE if the key type is</span>
+<a name="l00275"></a>00275 <span class="comment"> * not known. APR_EPADDING if padding was requested but is not supported.</span>
+<a name="l00276"></a>00276 <span class="comment"> * APR_ENOTIMPL if not implemented.</span>
+<a name="l00277"></a>00277 <span class="comment"> */</span>
+<a name="l00278"></a>00278 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_passphrase(const apr_crypto_driver_t *driver,
+<a name="l00279"></a>00279 <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const apr_crypto_t *f, const <span class="keywordtype">char</span> *pass,
+<a name="l00280"></a>00280 apr_size_t passLen, const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * salt, apr_size_t saltLen,
+<a name="l00281"></a>00281 const apr_crypto_block_key_type_e type,
+<a name="l00282"></a>00282 const apr_crypto_block_key_mode_e mode, const <span class="keywordtype">int</span> doPad,
+<a name="l00283"></a>00283 const <span class="keywordtype">int</span> iterations, apr_crypto_key_t **key, apr_size_t *ivSize);
+<a name="l00284"></a>00284 <span class="comment"></span>
+<a name="l00285"></a>00285 <span class="comment">/**</span>
+<a name="l00286"></a>00286 <span class="comment"> * @brief Initialise a context for encrypting arbitrary data using the given key.</span>
+<a name="l00287"></a>00287 <span class="comment"> * @note If *ctx is NULL, a apr_crypto_block_t will be created from a pool. If</span>
+<a name="l00288"></a>00288 <span class="comment"> * *ctx is not NULL, *ctx must point at a previously created structure.</span>
+<a name="l00289"></a>00289 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00290"></a>00290 <span class="comment"> * @param p The pool to use.</span>
+<a name="l00291"></a>00291 <span class="comment"> * @param f The block factory to use.</span>
+<a name="l00292"></a>00292 <span class="comment"> * @param key The key structure to use.</span>
+<a name="l00293"></a>00293 <span class="comment"> * @param iv Optional initialisation vector. If the buffer pointed to is NULL,</span>
+<a name="l00294"></a>00294 <span class="comment"> * an IV will be created at random, in space allocated from the pool.</span>
+<a name="l00295"></a>00295 <span class="comment"> * If the buffer pointed to is not NULL, the IV in the buffer will be</span>
+<a name="l00296"></a>00296 <span class="comment"> * used.</span>
+<a name="l00297"></a>00297 <span class="comment"> * @param ctx The block context returned, see note.</span>
+<a name="l00298"></a>00298 <span class="comment"> * @param blockSize The block size of the cipher.</span>
+<a name="l00299"></a>00299 <span class="comment"> * @return Returns APR_ENOIV if an initialisation vector is required but not specified.</span>
+<a name="l00300"></a>00300 <span class="comment"> * Returns APR_EINIT if the backend failed to initialise the context. Returns</span>
+<a name="l00301"></a>00301 <span class="comment"> * APR_ENOTIMPL if not implemented.</span>
+<a name="l00302"></a>00302 <span class="comment"> */</span>
+<a name="l00303"></a>00303 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_block_encrypt_init(
+<a name="l00304"></a>00304 const apr_crypto_driver_t *driver, <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,
+<a name="l00305"></a>00305 const apr_crypto_t *f, const apr_crypto_key_t *key,
+<a name="l00306"></a>00306 const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **iv, apr_crypto_block_t **ctx,
+<a name="l00307"></a>00307 apr_size_t *blockSize);
+<a name="l00308"></a>00308 <span class="comment"></span>
+<a name="l00309"></a>00309 <span class="comment">/**</span>
+<a name="l00310"></a>00310 <span class="comment"> * @brief Encrypt data provided by in, write it to out.</span>
+<a name="l00311"></a>00311 <span class="comment"> * @note The number of bytes written will be written to outlen. If</span>
+<a name="l00312"></a>00312 <span class="comment"> * out is NULL, outlen will contain the maximum size of the</span>
+<a name="l00313"></a>00313 <span class="comment"> * buffer needed to hold the data, including any data</span>
+<a name="l00314"></a>00314 <span class="comment"> * generated by apr_crypto_block_encrypt_finish below. If *out points</span>
+<a name="l00315"></a>00315 <span class="comment"> * to NULL, a buffer sufficiently large will be created from</span>
+<a name="l00316"></a>00316 <span class="comment"> * the pool provided. If *out points to a not-NULL value, this</span>
+<a name="l00317"></a>00317 <span class="comment"> * value will be used as a buffer instead.</span>
+<a name="l00318"></a>00318 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00319"></a>00319 <span class="comment"> * @param ctx The block context to use.</span>
+<a name="l00320"></a>00320 <span class="comment"> * @param out Address of a buffer to which data will be written,</span>
+<a name="l00321"></a>00321 <span class="comment"> * see note.</span>
+<a name="l00322"></a>00322 <span class="comment"> * @param outlen Length of the output will be written here.</span>
+<a name="l00323"></a>00323 <span class="comment"> * @param in Address of the buffer to read.</span>
+<a name="l00324"></a>00324 <span class="comment"> * @param inlen Length of the buffer to read.</span>
+<a name="l00325"></a>00325 <span class="comment"> * @return APR_ECRYPT if an error occurred. Returns APR_ENOTIMPL if</span>
+<a name="l00326"></a>00326 <span class="comment"> * not implemented.</span>
+<a name="l00327"></a>00327 <span class="comment"> */</span>
+<a name="l00328"></a>00328 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_block_encrypt(
+<a name="l00329"></a>00329 const apr_crypto_driver_t *driver, apr_crypto_block_t *ctx,
+<a name="l00330"></a>00330 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **out, apr_size_t *outlen, const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *in,
+<a name="l00331"></a>00331 apr_size_t inlen);
+<a name="l00332"></a>00332 <span class="comment"></span>
+<a name="l00333"></a>00333 <span class="comment">/**</span>
+<a name="l00334"></a>00334 <span class="comment"> * @brief Encrypt final data block, write it to out.</span>
+<a name="l00335"></a>00335 <span class="comment"> * @note If necessary the final block will be written out after being</span>
+<a name="l00336"></a>00336 <span class="comment"> * padded. Typically the final block will be written to the</span>
+<a name="l00337"></a>00337 <span class="comment"> * same buffer used by apr_crypto_block_encrypt, offset by the</span>
+<a name="l00338"></a>00338 <span class="comment"> * number of bytes returned as actually written by the</span>
+<a name="l00339"></a>00339 <span class="comment"> * apr_crypto_block_encrypt() call. After this call, the context</span>
+<a name="l00340"></a>00340 <span class="comment"> * is cleaned and can be reused by apr_crypto_block_encrypt_init().</span>
+<a name="l00341"></a>00341 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00342"></a>00342 <span class="comment"> * @param ctx The block context to use.</span>
+<a name="l00343"></a>00343 <span class="comment"> * @param out Address of a buffer to which data will be written. This</span>
+<a name="l00344"></a>00344 <span class="comment"> * buffer must already exist, and is usually the same</span>
+<a name="l00345"></a>00345 <span class="comment"> * buffer used by apr_evp_crypt(). See note.</span>
+<a name="l00346"></a>00346 <span class="comment"> * @param outlen Length of the output will be written here.</span>
+<a name="l00347"></a>00347 <span class="comment"> * @return APR_ECRYPT if an error occurred.</span>
+<a name="l00348"></a>00348 <span class="comment"> * @return APR_EPADDING if padding was enabled and the block was incorrectly</span>
+<a name="l00349"></a>00349 <span class="comment"> * formatted.</span>
+<a name="l00350"></a>00350 <span class="comment"> * @return APR_ENOTIMPL if not implemented.</span>
+<a name="l00351"></a>00351 <span class="comment"> */</span>
+<a name="l00352"></a>00352 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_block_encrypt_finish(
+<a name="l00353"></a>00353 const apr_crypto_driver_t *driver, apr_crypto_block_t *ctx,
+<a name="l00354"></a>00354 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *out, apr_size_t *outlen);
+<a name="l00355"></a>00355 <span class="comment"></span>
+<a name="l00356"></a>00356 <span class="comment">/**</span>
+<a name="l00357"></a>00357 <span class="comment"> * @brief Initialise a context for decrypting arbitrary data using the given key.</span>
+<a name="l00358"></a>00358 <span class="comment"> * @note If *ctx is NULL, a apr_crypto_block_t will be created from a pool. If</span>
+<a name="l00359"></a>00359 <span class="comment"> * *ctx is not NULL, *ctx must point at a previously created structure.</span>
+<a name="l00360"></a>00360 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00361"></a>00361 <span class="comment"> * @param p The pool to use.</span>
+<a name="l00362"></a>00362 <span class="comment"> * @param f The block factory to use.</span>
+<a name="l00363"></a>00363 <span class="comment"> * @param key The key structure to use.</span>
+<a name="l00364"></a>00364 <span class="comment"> * @param iv Optional initialisation vector.</span>
+<a name="l00365"></a>00365 <span class="comment"> * @param ctx The block context returned, see note.</span>
+<a name="l00366"></a>00366 <span class="comment"> * @param blockSize The block size of the cipher.</span>
+<a name="l00367"></a>00367 <span class="comment"> * @return Returns APR_ENOIV if an initialisation vector is required but not specified.</span>
+<a name="l00368"></a>00368 <span class="comment"> * Returns APR_EINIT if the backend failed to initialise the context. Returns</span>
+<a name="l00369"></a>00369 <span class="comment"> * APR_ENOTIMPL if not implemented.</span>
+<a name="l00370"></a>00370 <span class="comment"> */</span>
+<a name="l00371"></a>00371 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_block_decrypt_init(
+<a name="l00372"></a>00372 const apr_crypto_driver_t *driver, <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p,
+<a name="l00373"></a>00373 const apr_crypto_t *f, const apr_crypto_key_t *key,
+<a name="l00374"></a>00374 const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *iv, apr_crypto_block_t **ctx,
+<a name="l00375"></a>00375 apr_size_t *blockSize);
+<a name="l00376"></a>00376 <span class="comment"></span>
+<a name="l00377"></a>00377 <span class="comment">/**</span>
+<a name="l00378"></a>00378 <span class="comment"> * @brief Decrypt data provided by in, write it to out.</span>
+<a name="l00379"></a>00379 <span class="comment"> * @note The number of bytes written will be written to outlen. If</span>
+<a name="l00380"></a>00380 <span class="comment"> * out is NULL, outlen will contain the maximum size of the</span>
+<a name="l00381"></a>00381 <span class="comment"> * buffer needed to hold the data, including any data</span>
+<a name="l00382"></a>00382 <span class="comment"> * generated by apr_crypto_block_decrypt_finish below. If *out points</span>
+<a name="l00383"></a>00383 <span class="comment"> * to NULL, a buffer sufficiently large will be created from</span>
+<a name="l00384"></a>00384 <span class="comment"> * the pool provided. If *out points to a not-NULL value, this</span>
+<a name="l00385"></a>00385 <span class="comment"> * value will be used as a buffer instead.</span>
+<a name="l00386"></a>00386 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00387"></a>00387 <span class="comment"> * @param ctx The block context to use.</span>
+<a name="l00388"></a>00388 <span class="comment"> * @param out Address of a buffer to which data will be written,</span>
+<a name="l00389"></a>00389 <span class="comment"> * see note.</span>
+<a name="l00390"></a>00390 <span class="comment"> * @param outlen Length of the output will be written here.</span>
+<a name="l00391"></a>00391 <span class="comment"> * @param in Address of the buffer to read.</span>
+<a name="l00392"></a>00392 <span class="comment"> * @param inlen Length of the buffer to read.</span>
+<a name="l00393"></a>00393 <span class="comment"> * @return APR_ECRYPT if an error occurred. Returns APR_ENOTIMPL if</span>
+<a name="l00394"></a>00394 <span class="comment"> * not implemented.</span>
+<a name="l00395"></a>00395 <span class="comment"> */</span>
+<a name="l00396"></a>00396 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_block_decrypt(
+<a name="l00397"></a>00397 const apr_crypto_driver_t *driver, apr_crypto_block_t *ctx,
+<a name="l00398"></a>00398 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **out, apr_size_t *outlen, const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *in,
+<a name="l00399"></a>00399 apr_size_t inlen);
+<a name="l00400"></a>00400 <span class="comment"></span>
+<a name="l00401"></a>00401 <span class="comment">/**</span>
+<a name="l00402"></a>00402 <span class="comment"> * @brief Decrypt final data block, write it to out.</span>
+<a name="l00403"></a>00403 <span class="comment"> * @note If necessary the final block will be written out after being</span>
+<a name="l00404"></a>00404 <span class="comment"> * padded. Typically the final block will be written to the</span>
+<a name="l00405"></a>00405 <span class="comment"> * same buffer used by apr_crypto_block_decrypt, offset by the</span>
+<a name="l00406"></a>00406 <span class="comment"> * number of bytes returned as actually written by the</span>
+<a name="l00407"></a>00407 <span class="comment"> * apr_crypto_block_decrypt() call. After this call, the context</span>
+<a name="l00408"></a>00408 <span class="comment"> * is cleaned and can be reused by apr_crypto_block_decrypt_init().</span>
+<a name="l00409"></a>00409 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00410"></a>00410 <span class="comment"> * @param ctx The block context to use.</span>
+<a name="l00411"></a>00411 <span class="comment"> * @param out Address of a buffer to which data will be written. This</span>
+<a name="l00412"></a>00412 <span class="comment"> * buffer must already exist, and is usually the same</span>
+<a name="l00413"></a>00413 <span class="comment"> * buffer used by apr_evp_crypt(). See note.</span>
+<a name="l00414"></a>00414 <span class="comment"> * @param outlen Length of the output will be written here.</span>
+<a name="l00415"></a>00415 <span class="comment"> * @return APR_ECRYPT if an error occurred.</span>
+<a name="l00416"></a>00416 <span class="comment"> * @return APR_EPADDING if padding was enabled and the block was incorrectly</span>
+<a name="l00417"></a>00417 <span class="comment"> * formatted.</span>
+<a name="l00418"></a>00418 <span class="comment"> * @return APR_ENOTIMPL if not implemented.</span>
+<a name="l00419"></a>00419 <span class="comment"> */</span>
+<a name="l00420"></a>00420 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_block_decrypt_finish(
+<a name="l00421"></a>00421 const apr_crypto_driver_t *driver, apr_crypto_block_t *ctx,
+<a name="l00422"></a>00422 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *out, apr_size_t *outlen);
+<a name="l00423"></a>00423 <span class="comment"></span>
+<a name="l00424"></a>00424 <span class="comment">/**</span>
+<a name="l00425"></a>00425 <span class="comment"> * @brief Clean encryption / decryption context.</span>
+<a name="l00426"></a>00426 <span class="comment"> * @note After cleanup, a context is free to be reused if necessary.</span>
+<a name="l00427"></a>00427 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00428"></a>00428 <span class="comment"> * @param ctx The block context to use.</span>
+<a name="l00429"></a>00429 <span class="comment"> * @return Returns APR_ENOTIMPL if not supported.</span>
+<a name="l00430"></a>00430 <span class="comment"> */</span>
+<a name="l00431"></a>00431 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_block_cleanup(
+<a name="l00432"></a>00432 const apr_crypto_driver_t *driver, apr_crypto_block_t *ctx);
+<a name="l00433"></a>00433 <span class="comment"></span>
+<a name="l00434"></a>00434 <span class="comment">/**</span>
+<a name="l00435"></a>00435 <span class="comment"> * @brief Clean encryption / decryption factory.</span>
+<a name="l00436"></a>00436 <span class="comment"> * @note After cleanup, a factory is free to be reused if necessary.</span>
+<a name="l00437"></a>00437 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00438"></a>00438 <span class="comment"> * @param f The factory to use.</span>
+<a name="l00439"></a>00439 <span class="comment"> * @return Returns APR_ENOTIMPL if not supported.</span>
+<a name="l00440"></a>00440 <span class="comment"> */</span>
+<a name="l00441"></a>00441 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_cleanup(const apr_crypto_driver_t *driver,
+<a name="l00442"></a>00442 apr_crypto_t *f);
+<a name="l00443"></a>00443 <span class="comment"></span>
+<a name="l00444"></a>00444 <span class="comment">/**</span>
+<a name="l00445"></a>00445 <span class="comment"> * @brief Shutdown the crypto library.</span>
+<a name="l00446"></a>00446 <span class="comment"> * @note After shutdown, it is expected that the init function can be called again.</span>
+<a name="l00447"></a>00447 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00448"></a>00448 <span class="comment"> * @param p The pool to use.</span>
+<a name="l00449"></a>00449 <span class="comment"> * @return Returns APR_ENOTIMPL if not supported.</span>
+<a name="l00450"></a>00450 <span class="comment"> */</span>
+<a name="l00451"></a>00451 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_crypto_shutdown(const apr_crypto_driver_t *driver,
+<a name="l00452"></a>00452 <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
+<a name="l00453"></a>00453
+<a name="l00454"></a>00454 <span class="preprocessor">#endif </span><span class="comment">/* APU_HAVE_CRYPTO */</span>
+<a name="l00455"></a>00455 <span class="comment"></span>
+<a name="l00456"></a>00456 <span class="comment">/** @} */</span>
+<a name="l00457"></a>00457
+<a name="l00458"></a>00458 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00459"></a>00459 <span class="preprocessor"></span>}
+<a name="l00460"></a>00460 <span class="preprocessor">#endif</span>
+<a name="l00461"></a>00461 <span class="preprocessor"></span>
+<a name="l00462"></a>00462 <span class="preprocessor">#endif</span>
+</pre></div></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>
Added: apr/site/trunk/docs/docs/apr/trunk/apr__crypto_8h.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__crypto_8h.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__crypto_8h.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__crypto_8h.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,89 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Apache Portable Runtime: apr_crypto.h File Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li class="current"><a href="files.html"><span>Files</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="files.html"><span>File List</span></a></li>
+ <li><a href="globals.html"><span>Globals</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>apr_crypto.h File Reference</h1>APR-UTIL Crypto library.
+<a href="#_details">More...</a>
+<p>
+<code>#include "apu.h"</code><br>
+<code>#include "<a class="el" href="apr__pools_8h-source.html">apr_pools.h</a>"</code><br>
+<code>#include "<a class="el" href="apr__tables_8h-source.html">apr_tables.h</a>"</code><br>
+<code>#include "<a class="el" href="apu__errno_8h-source.html">apu_errno.h</a>"</code><br>
+
+<p>
+<a href="apr__crypto_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g3a6daa6ef5ab33045643cf3c9efc99b0">APR_CRYPTO_CA_TYPE_UNKNOWN</a> 0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g73f957e1c03c120625512249bd6301c3">APR_CRYPTO_CA_TYPE_DER</a> 1</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g8756d0604c36a983f796b946056a4294">APR_CRYPTO_CA_TYPE_BASE64</a> 2</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#gaec5757e3d6bc0405a1ed1ec044cb27f">APR_CRYPTO_CA_TYPE_CERT7_DB</a> 3</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g7fcb37cadc9f8e45cfa194c09a7ace93">APR_CRYPTO_CA_TYPE_SECMOD</a> 4</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g04621f567f12632d9983ae10decf53a6">APR_CRYPTO_CERT_TYPE_UNKNOWN</a> 5</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#gd87df30799fbc940838466e5d3814781">APR_CRYPTO_CERT_TYPE_DER</a> 6</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#gd10422d474856d786231448ed3185b1a">APR_CRYPTO_CERT_TYPE_BASE64</a> 7</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g48b707d7976def4ba2b51756f612d68d">APR_CRYPTO_CERT_TYPE_KEY3_DB</a> 8</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g60ca9545d8b3b8df2a2131a93896d9c8">APR_CRYPTO_CERT_TYPE_NICKNAME</a> 9</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g6632b059de9403a9b6cbfbd4fdf1176b">APR_CRYPTO_KEY_TYPE_UNKNOWN</a> 10</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g590d49629c79efe97c57679d2cfc65e7">APR_CRYPTO_KEY_TYPE_DER</a> 11</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#gc3fe3a00d27087c37f10beaa2d9fc21a">APR_CRYPTO_KEY_TYPE_BASE64</a> 12</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g0c8d540c760ad91ab25b0536e9996d4e">APR_CRYPTO_CERT_TYPE_PFX</a> 13</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g486b3fb3512ac4ad8a9049aad870f420">APR_CRYPTO_KEY_TYPE_PFX</a> 14</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#gc5058657589483e8ccaac6d01dd32a47">APR_CRYPTO_CA_TYPE_CACERTDIR_BASE64</a> 15</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g76fd96f686fbcab807b7e0d8cff2045b">APR_CRYPTO_CA_TYPE_CMS</a> 16</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#gaa6e7273c8957d99276d3cf58081a544">APR_CRYPTO_KEY_TYPE_SYM</a> 17</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g763aeb6a00bef24e7d6ece142f78ef9c">APR_CRYPTO_CA_TYPE_DIR</a> 18</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___crypto.html#g06ea873117d91b17d740f486269beb9f">APR_CRYPTO_ENGINE</a> 101</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+APR-UTIL Crypto library.
+<p>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>