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 [6/47] - in /apr/site/trunk/docs/docs: apr-util/trunk/
apr/trunk/
Added: apr/site/trunk/docs/docs/apr/trunk/apr__crypto__internal_8h-source.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__crypto__internal_8h-source.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__crypto__internal_8h-source.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__crypto__internal_8h-source.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,284 @@
+<!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_internal.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_internal.h</h1><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_INTERNAL_H</span>
+<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_CRYPTO_INTERNAL_H</span>
+<a name="l00019"></a>00019 <span class="preprocessor"></span>
+<a name="l00020"></a>00020 <span class="preprocessor">#include <stdarg.h></span>
+<a name="l00021"></a>00021
+<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="apr__crypto_8h.html" title="APR-UTIL Crypto library.">apr_crypto.h</a>"</span>
+<a name="l00023"></a>00023
+<a name="l00024"></a>00024 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+<a name="l00026"></a>00026 <span class="preprocessor">#endif</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#if APU_HAVE_CRYPTO</span>
+<a name="l00029"></a>00029 <span class="preprocessor"></span>
+<a name="l00030"></a>00030 <span class="keyword">struct </span>apr_crypto_driver_t {
+<a name="l00031"></a>00031 <span class="comment"></span>
+<a name="l00032"></a>00032 <span class="comment"> /** name */</span>
+<a name="l00033"></a>00033 <span class="keyword">const</span> <span class="keywordtype">char</span> *name;
+<a name="l00034"></a>00034 <span class="comment"></span>
+<a name="l00035"></a>00035 <span class="comment"> /**</span>
+<a name="l00036"></a>00036 <span class="comment"> * @brief: allow driver to perform once-only initialisation.</span>
+<a name="l00037"></a>00037 <span class="comment"> * Called once only.</span>
+<a name="l00038"></a>00038 <span class="comment"> * @param pool The pool to register the cleanup in.</span>
+<a name="l00039"></a>00039 <span class="comment"> * @param params An array of optional init parameters.</span>
+<a name="l00040"></a>00040 <span class="comment"> */</span>
+<a name="l00041"></a>00041 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*init)(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <span class="keyword">const</span> <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *params, <span class="keywordtype">int</span> *rc);
+<a name="l00042"></a>00042 <span class="comment"></span>
+<a name="l00043"></a>00043 <span class="comment"> /**</span>
+<a name="l00044"></a>00044 <span class="comment"> * @brief Create a context for supporting encryption. Keys, certificates,</span>
+<a name="l00045"></a>00045 <span class="comment"> * algorithms and other parameters will be set per context. More than</span>
+<a name="l00046"></a>00046 <span class="comment"> * one context can be created at one time. A cleanup will be automatically</span>
+<a name="l00047"></a>00047 <span class="comment"> * registered with the given pool to guarantee a graceful shutdown.</span>
+<a name="l00048"></a>00048 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00049"></a>00049 <span class="comment"> * @param pool - process pool</span>
+<a name="l00050"></a>00050 <span class="comment"> * @param params - array of key parameters</span>
+<a name="l00051"></a>00051 <span class="comment"> * @param f - context pointer will be written here</span>
+<a name="l00052"></a>00052 <span class="comment"> * @return APR_ENOENGINE when the engine specified does not exist. APR_EINITENGINE</span>
+<a name="l00053"></a>00053 <span class="comment"> * if the engine cannot be initialised.</span>
+<a name="l00054"></a>00054 <span class="comment"> */</span>
+<a name="l00055"></a>00055 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*factory)(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <span class="keyword">const</span> <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *params,
+<a name="l00056"></a>00056 apr_crypto_t **f);
+<a name="l00057"></a>00057 <span class="comment"></span>
+<a name="l00058"></a>00058 <span class="comment"> /**</span>
+<a name="l00059"></a>00059 <span class="comment"> * @brief Create a key from the given passphrase. By default, the PBKDF2</span>
+<a name="l00060"></a>00060 <span class="comment"> * algorithm is used to generate the key from the passphrase. It is expected</span>
+<a name="l00061"></a>00061 <span class="comment"> * that the same pass phrase will generate the same key, regardless of the</span>
+<a name="l00062"></a>00062 <span class="comment"> * backend crypto platform used. The key is cleaned up when the context</span>
+<a name="l00063"></a>00063 <span class="comment"> * is cleaned, and may be reused with multiple encryption or decryption</span>
+<a name="l00064"></a>00064 <span class="comment"> * operations.</span>
+<a name="l00065"></a>00065 <span class="comment"> * @note If *key is NULL, a apr_crypto_key_t will be created from a pool. If</span>
+<a name="l00066"></a>00066 <span class="comment"> * *key is not NULL, *key must point at a previously created structure.</span>
+<a name="l00067"></a>00067 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00068"></a>00068 <span class="comment"> * @param p The pool to use.</span>
+<a name="l00069"></a>00069 <span class="comment"> * @param f The context to use.</span>
+<a name="l00070"></a>00070 <span class="comment"> * @param pass The passphrase to use.</span>
+<a name="l00071"></a>00071 <span class="comment"> * @param passLen The passphrase length in bytes</span>
+<a name="l00072"></a>00072 <span class="comment"> * @param salt The salt to use.</span>
+<a name="l00073"></a>00073 <span class="comment"> * @param saltLen The salt length in bytes</span>
+<a name="l00074"></a>00074 <span class="comment"> * @param type 3DES_192, AES_128, AES_192, AES_256.</span>
+<a name="l00075"></a>00075 <span class="comment"> * @param mode Electronic Code Book / Cipher Block Chaining.</span>
+<a name="l00076"></a>00076 <span class="comment"> * @param doPad Pad if necessary.</span>
+<a name="l00077"></a>00077 <span class="comment"> * @param key The key returned, see note.</span>
+<a name="l00078"></a>00078 <span class="comment"> * @param ivSize The size of the initialisation vector will be returned, based</span>
+<a name="l00079"></a>00079 <span class="comment"> * on whether an IV is relevant for this type of crypto.</span>
+<a name="l00080"></a>00080 <span class="comment"> * @return Returns APR_ENOKEY if the pass phrase is missing or empty, or if a backend</span>
+<a name="l00081"></a>00081 <span class="comment"> * error occurred while generating the key. APR_ENOCIPHER if the type or mode</span>
+<a name="l00082"></a>00082 <span class="comment"> * is not supported by the particular backend. APR_EKEYTYPE if the key type is</span>
+<a name="l00083"></a>00083 <span class="comment"> * not known. APR_EPADDING if padding was requested but is not supported.</span>
+<a name="l00084"></a>00084 <span class="comment"> * APR_ENOTIMPL if not implemented.</span>
+<a name="l00085"></a>00085 <span class="comment"> */</span>
+<a name="l00086"></a>00086 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*passphrase)(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> apr_crypto_t *f,
+<a name="l00087"></a>00087 <span class="keyword">const</span> <span class="keywordtype">char</span> *pass, apr_size_t passLen, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * salt,
+<a name="l00088"></a>00088 apr_size_t saltLen, <span class="keyword">const</span> apr_crypto_block_key_type_e type,
+<a name="l00089"></a>00089 <span class="keyword">const</span> apr_crypto_block_key_mode_e mode, <span class="keyword">const</span> <span class="keywordtype">int</span> doPad,
+<a name="l00090"></a>00090 <span class="keyword">const</span> <span class="keywordtype">int</span> iterations, apr_crypto_key_t **key, apr_size_t *ivSize);
+<a name="l00091"></a>00091 <span class="comment"></span>
+<a name="l00092"></a>00092 <span class="comment"> /**</span>
+<a name="l00093"></a>00093 <span class="comment"> * @brief Initialise a context for encrypting arbitrary data using the given key.</span>
+<a name="l00094"></a>00094 <span class="comment"> * @note If *ctx is NULL, a apr_crypto_block_t will be created from a pool. If</span>
+<a name="l00095"></a>00095 <span class="comment"> * *ctx is not NULL, *ctx must point at a previously created structure.</span>
+<a name="l00096"></a>00096 <span class="comment"> * @param p The pool to use.</span>
+<a name="l00097"></a>00097 <span class="comment"> * @param f The block factory to use.</span>
+<a name="l00098"></a>00098 <span class="comment"> * @param key The key structure.</span>
+<a name="l00099"></a>00099 <span class="comment"> * @param iv Optional initialisation vector. If the buffer pointed to is NULL,</span>
+<a name="l00100"></a>00100 <span class="comment"> * an IV will be created at random, in space allocated from the pool.</span>
+<a name="l00101"></a>00101 <span class="comment"> * If the buffer pointed to is not NULL, the IV in the buffer will be</span>
+<a name="l00102"></a>00102 <span class="comment"> * used.</span>
+<a name="l00103"></a>00103 <span class="comment"> * @param ctx The block context returned, see note.</span>
+<a name="l00104"></a>00104 <span class="comment"> * @param ivSize The size of the initialisation vector will be returned, based</span>
+<a name="l00105"></a>00105 <span class="comment"> * on whether an IV is relevant for this type of crypto.</span>
+<a name="l00106"></a>00106 <span class="comment"> * @param blockSize The block size of the cipher.</span>
+<a name="l00107"></a>00107 <span class="comment"> * @return Returns APR_ENOIV if an initialisation vector is required but not specified.</span>
+<a name="l00108"></a>00108 <span class="comment"> * Returns APR_EINIT if the backend failed to initialise the context. Returns</span>
+<a name="l00109"></a>00109 <span class="comment"> * APR_ENOTIMPL if not implemented.</span>
+<a name="l00110"></a>00110 <span class="comment"> */</span>
+<a name="l00111"></a>00111 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*block_encrypt_init)(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> apr_crypto_t *f,
+<a name="l00112"></a>00112 <span class="keyword">const</span> apr_crypto_key_t *key, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **iv,
+<a name="l00113"></a>00113 apr_crypto_block_t **ctx, apr_size_t *blockSize);
+<a name="l00114"></a>00114 <span class="comment"></span>
+<a name="l00115"></a>00115 <span class="comment"> /**</span>
+<a name="l00116"></a>00116 <span class="comment"> * @brief Encrypt data provided by in, write it to out.</span>
+<a name="l00117"></a>00117 <span class="comment"> * @note The number of bytes written will be written to outlen. If</span>
+<a name="l00118"></a>00118 <span class="comment"> * out is NULL, outlen will contain the maximum size of the</span>
+<a name="l00119"></a>00119 <span class="comment"> * buffer needed to hold the data, including any data</span>
+<a name="l00120"></a>00120 <span class="comment"> * generated by apr_crypto_block_encrypt_finish below. If *out points</span>
+<a name="l00121"></a>00121 <span class="comment"> * to NULL, a buffer sufficiently large will be created from</span>
+<a name="l00122"></a>00122 <span class="comment"> * the pool provided. If *out points to a not-NULL value, this</span>
+<a name="l00123"></a>00123 <span class="comment"> * value will be used as a buffer instead.</span>
+<a name="l00124"></a>00124 <span class="comment"> * @param ctx The block context to use.</span>
+<a name="l00125"></a>00125 <span class="comment"> * @param out Address of a buffer to which data will be written,</span>
+<a name="l00126"></a>00126 <span class="comment"> * see note.</span>
+<a name="l00127"></a>00127 <span class="comment"> * @param outlen Length of the output will be written here.</span>
+<a name="l00128"></a>00128 <span class="comment"> * @param in Address of the buffer to read.</span>
+<a name="l00129"></a>00129 <span class="comment"> * @param inlen Length of the buffer to read.</span>
+<a name="l00130"></a>00130 <span class="comment"> * @return APR_ECRYPT if an error occurred. Returns APR_ENOTIMPL if</span>
+<a name="l00131"></a>00131 <span class="comment"> * not implemented.</span>
+<a name="l00132"></a>00132 <span class="comment"> */</span>
+<a name="l00133"></a>00133 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*block_encrypt)(apr_crypto_block_t *ctx, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **out,
+<a name="l00134"></a>00134 apr_size_t *outlen, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *in, apr_size_t inlen);
+<a name="l00135"></a>00135 <span class="comment"></span>
+<a name="l00136"></a>00136 <span class="comment"> /**</span>
+<a name="l00137"></a>00137 <span class="comment"> * @brief Encrypt final data block, write it to out.</span>
+<a name="l00138"></a>00138 <span class="comment"> * @note If necessary the final block will be written out after being</span>
+<a name="l00139"></a>00139 <span class="comment"> * padded. Typically the final block will be written to the</span>
+<a name="l00140"></a>00140 <span class="comment"> * same buffer used by apr_crypto_block_encrypt, offset by the</span>
+<a name="l00141"></a>00141 <span class="comment"> * number of bytes returned as actually written by the</span>
+<a name="l00142"></a>00142 <span class="comment"> * apr_crypto_block_encrypt() call. After this call, the context</span>
+<a name="l00143"></a>00143 <span class="comment"> * is cleaned and can be reused by apr_crypto_block_encrypt_init().</span>
+<a name="l00144"></a>00144 <span class="comment"> * @param ctx The block context to use.</span>
+<a name="l00145"></a>00145 <span class="comment"> * @param out Address of a buffer to which data will be written. This</span>
+<a name="l00146"></a>00146 <span class="comment"> * buffer must already exist, and is usually the same</span>
+<a name="l00147"></a>00147 <span class="comment"> * buffer used by apr_evp_crypt(). See note.</span>
+<a name="l00148"></a>00148 <span class="comment"> * @param outlen Length of the output will be written here.</span>
+<a name="l00149"></a>00149 <span class="comment"> * @return APR_ECRYPT if an error occurred.</span>
+<a name="l00150"></a>00150 <span class="comment"> * @return APR_EPADDING if padding was enabled and the block was incorrectly</span>
+<a name="l00151"></a>00151 <span class="comment"> * formatted.</span>
+<a name="l00152"></a>00152 <span class="comment"> * @return APR_ENOTIMPL if not implemented.</span>
+<a name="l00153"></a>00153 <span class="comment"> */</span>
+<a name="l00154"></a>00154 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*block_encrypt_finish)(apr_crypto_block_t *ctx,
+<a name="l00155"></a>00155 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *out, apr_size_t *outlen);
+<a name="l00156"></a>00156 <span class="comment"></span>
+<a name="l00157"></a>00157 <span class="comment"> /**</span>
+<a name="l00158"></a>00158 <span class="comment"> * @brief Initialise a context for decrypting arbitrary data using the given key.</span>
+<a name="l00159"></a>00159 <span class="comment"> * @note If *ctx is NULL, a apr_crypto_block_t will be created from a pool. If</span>
+<a name="l00160"></a>00160 <span class="comment"> * *ctx is not NULL, *ctx must point at a previously created structure.</span>
+<a name="l00161"></a>00161 <span class="comment"> * @param p The pool to use.</span>
+<a name="l00162"></a>00162 <span class="comment"> * @param f The block factory to use.</span>
+<a name="l00163"></a>00163 <span class="comment"> * @param key The key structure.</span>
+<a name="l00164"></a>00164 <span class="comment"> * @param iv Optional initialisation vector. If the buffer pointed to is NULL,</span>
+<a name="l00165"></a>00165 <span class="comment"> * an IV will be created at random, in space allocated from the pool.</span>
+<a name="l00166"></a>00166 <span class="comment"> * If the buffer is not NULL, the IV in the buffer will be used.</span>
+<a name="l00167"></a>00167 <span class="comment"> * @param ctx The block context returned, see note.</span>
+<a name="l00168"></a>00168 <span class="comment"> * @param blockSize The block size of the cipher.</span>
+<a name="l00169"></a>00169 <span class="comment"> * @return Returns APR_ENOIV if an initialisation vector is required but not specified.</span>
+<a name="l00170"></a>00170 <span class="comment"> * Returns APR_EINIT if the backend failed to initialise the context. Returns</span>
+<a name="l00171"></a>00171 <span class="comment"> * APR_ENOTIMPL if not implemented.</span>
+<a name="l00172"></a>00172 <span class="comment"> */</span>
+<a name="l00173"></a>00173 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*block_decrypt_init)(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <span class="keyword">const</span> apr_crypto_t *f,
+<a name="l00174"></a>00174 <span class="keyword">const</span> apr_crypto_key_t *key, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *iv,
+<a name="l00175"></a>00175 apr_crypto_block_t **ctx, apr_size_t *blockSize);
+<a name="l00176"></a>00176 <span class="comment"></span>
+<a name="l00177"></a>00177 <span class="comment"> /**</span>
+<a name="l00178"></a>00178 <span class="comment"> * @brief Decrypt data provided by in, write it to out.</span>
+<a name="l00179"></a>00179 <span class="comment"> * @note The number of bytes written will be written to outlen. If</span>
+<a name="l00180"></a>00180 <span class="comment"> * out is NULL, outlen will contain the maximum size of the</span>
+<a name="l00181"></a>00181 <span class="comment"> * buffer needed to hold the data, including any data</span>
+<a name="l00182"></a>00182 <span class="comment"> * generated by apr_crypto_block_decrypt_finish below. If *out points</span>
+<a name="l00183"></a>00183 <span class="comment"> * to NULL, a buffer sufficiently large will be created from</span>
+<a name="l00184"></a>00184 <span class="comment"> * the pool provided. If *out points to a not-NULL value, this</span>
+<a name="l00185"></a>00185 <span class="comment"> * value will be used as a buffer instead.</span>
+<a name="l00186"></a>00186 <span class="comment"> * @param ctx The block context to use.</span>
+<a name="l00187"></a>00187 <span class="comment"> * @param out Address of a buffer to which data will be written,</span>
+<a name="l00188"></a>00188 <span class="comment"> * see note.</span>
+<a name="l00189"></a>00189 <span class="comment"> * @param outlen Length of the output will be written here.</span>
+<a name="l00190"></a>00190 <span class="comment"> * @param in Address of the buffer to read.</span>
+<a name="l00191"></a>00191 <span class="comment"> * @param inlen Length of the buffer to read.</span>
+<a name="l00192"></a>00192 <span class="comment"> * @return APR_ECRYPT if an error occurred. Returns APR_ENOTIMPL if</span>
+<a name="l00193"></a>00193 <span class="comment"> * not implemented.</span>
+<a name="l00194"></a>00194 <span class="comment"> */</span>
+<a name="l00195"></a>00195 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*block_decrypt)(apr_crypto_block_t *ctx, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **out,
+<a name="l00196"></a>00196 apr_size_t *outlen, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *in, apr_size_t inlen);
+<a name="l00197"></a>00197 <span class="comment"></span>
+<a name="l00198"></a>00198 <span class="comment"> /**</span>
+<a name="l00199"></a>00199 <span class="comment"> * @brief Decrypt final data block, write it to out.</span>
+<a name="l00200"></a>00200 <span class="comment"> * @note If necessary the final block will be written out after being</span>
+<a name="l00201"></a>00201 <span class="comment"> * padded. Typically the final block will be written to the</span>
+<a name="l00202"></a>00202 <span class="comment"> * same buffer used by apr_crypto_block_decrypt, offset by the</span>
+<a name="l00203"></a>00203 <span class="comment"> * number of bytes returned as actually written by the</span>
+<a name="l00204"></a>00204 <span class="comment"> * apr_crypto_block_decrypt() call. After this call, the context</span>
+<a name="l00205"></a>00205 <span class="comment"> * is cleaned and can be reused by apr_crypto_block_decrypt_init().</span>
+<a name="l00206"></a>00206 <span class="comment"> * @param ctx The block context to use.</span>
+<a name="l00207"></a>00207 <span class="comment"> * @param out Address of a buffer to which data will be written. This</span>
+<a name="l00208"></a>00208 <span class="comment"> * buffer must already exist, and is usually the same</span>
+<a name="l00209"></a>00209 <span class="comment"> * buffer used by apr_evp_crypt(). See note.</span>
+<a name="l00210"></a>00210 <span class="comment"> * @param outlen Length of the output will be written here.</span>
+<a name="l00211"></a>00211 <span class="comment"> * @return APR_ECRYPT if an error occurred.</span>
+<a name="l00212"></a>00212 <span class="comment"> * @return APR_EPADDING if padding was enabled and the block was incorrectly</span>
+<a name="l00213"></a>00213 <span class="comment"> * formatted.</span>
+<a name="l00214"></a>00214 <span class="comment"> * @return APR_ENOTIMPL if not implemented.</span>
+<a name="l00215"></a>00215 <span class="comment"> */</span>
+<a name="l00216"></a>00216 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*block_decrypt_finish)(apr_crypto_block_t *ctx,
+<a name="l00217"></a>00217 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *out, apr_size_t *outlen);
+<a name="l00218"></a>00218 <span class="comment"></span>
+<a name="l00219"></a>00219 <span class="comment"> /**</span>
+<a name="l00220"></a>00220 <span class="comment"> * @brief Clean encryption / decryption context.</span>
+<a name="l00221"></a>00221 <span class="comment"> * @note After cleanup, a context is free to be reused if necessary.</span>
+<a name="l00222"></a>00222 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00223"></a>00223 <span class="comment"> * @param ctx The block context to use.</span>
+<a name="l00224"></a>00224 <span class="comment"> * @return Returns APR_ENOTIMPL if not supported.</span>
+<a name="l00225"></a>00225 <span class="comment"> */</span>
+<a name="l00226"></a>00226 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*block_cleanup)(apr_crypto_block_t *ctx);
+<a name="l00227"></a>00227 <span class="comment"></span>
+<a name="l00228"></a>00228 <span class="comment"> /**</span>
+<a name="l00229"></a>00229 <span class="comment"> * @brief Clean encryption / decryption factory.</span>
+<a name="l00230"></a>00230 <span class="comment"> * @note After cleanup, a factory is free to be reused if necessary.</span>
+<a name="l00231"></a>00231 <span class="comment"> * @param driver - driver to use</span>
+<a name="l00232"></a>00232 <span class="comment"> * @param f The factory to use.</span>
+<a name="l00233"></a>00233 <span class="comment"> * @return Returns APR_ENOTIMPL if not supported.</span>
+<a name="l00234"></a>00234 <span class="comment"> */</span>
+<a name="l00235"></a>00235 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*cleanup)(apr_crypto_t *f);
+<a name="l00236"></a>00236 <span class="comment"></span>
+<a name="l00237"></a>00237 <span class="comment"> /**</span>
+<a name="l00238"></a>00238 <span class="comment"> * @brief Clean encryption / decryption factory.</span>
+<a name="l00239"></a>00239 <span class="comment"> * @note After cleanup, a factory is free to be reused if necessary.</span>
+<a name="l00240"></a>00240 <span class="comment"> * @param pool The pool to use.</span>
+<a name="l00241"></a>00241 <span class="comment"> * @return Returns APR_ENOTIMPL if not supported.</span>
+<a name="l00242"></a>00242 <span class="comment"> */</span>
+<a name="l00243"></a>00243 <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*shutdown)(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
+<a name="l00244"></a>00244
+<a name="l00245"></a>00245 };
+<a name="l00246"></a>00246
+<a name="l00247"></a>00247 <span class="preprocessor">#endif</span>
+<a name="l00248"></a>00248 <span class="preprocessor"></span>
+<a name="l00249"></a>00249 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00250"></a>00250 <span class="preprocessor"></span>}
+<a name="l00251"></a>00251 <span class="preprocessor">#endif</span>
+<a name="l00252"></a>00252 <span class="preprocessor"></span>
+<a name="l00253"></a>00253 <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__date_8h-source.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__date_8h-source.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__date_8h-source.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__date_8h-source.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,137 @@
+<!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_date.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_date.h</h1><a href="apr__date_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_DATE_H</span>
+<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_DATE_H</span>
+<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00020"></a>00020 <span class="comment">/**</span>
+<a name="l00021"></a>00021 <span class="comment"> * @file apr_date.h</span>
+<a name="l00022"></a>00022 <span class="comment"> * @brief APR-UTIL date routines</span>
+<a name="l00023"></a>00023 <span class="comment"> */</span>
+<a name="l00024"></a>00024 <span class="comment"></span>
+<a name="l00025"></a>00025 <span class="comment">/**</span>
+<a name="l00026"></a>00026 <span class="comment"> * @defgroup APR_Util_Date Date routines</span>
+<a name="l00027"></a>00027 <span class="comment"> * @ingroup APR_Util</span>
+<a name="l00028"></a>00028 <span class="comment"> * @{</span>
+<a name="l00029"></a>00029 <span class="comment"> */</span>
+<a name="l00030"></a>00030
+<a name="l00031"></a>00031 <span class="comment">/*</span>
+<a name="l00032"></a>00032 <span class="comment"> * apr_date.h: prototypes for date parsing utility routines</span>
+<a name="l00033"></a>00033 <span class="comment"> */</span>
+<a name="l00034"></a>00034
+<a name="l00035"></a>00035 <span class="preprocessor">#include "apu.h"</span>
+<a name="l00036"></a>00036 <span class="preprocessor">#include "<a class="code" href="apr__time_8h.html" title="APR Time Library.">apr_time.h</a>"</span>
+<a name="l00037"></a>00037
+<a name="l00038"></a>00038 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+<a name="l00040"></a>00040 <span class="preprocessor">#endif</span>
+<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00042"></a>00042 <span class="comment">/** A bad date. */</span>
+<a name="l00043"></a><a class="code" href="group___a_p_r___util___date.html#g8be88b25f4b477ad13c4067c959411b0">00043</a> <span class="preprocessor">#define APR_DATE_BAD ((apr_time_t)0)</span>
+<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00045"></a>00045 <span class="comment">/**</span>
+<a name="l00046"></a>00046 <span class="comment"> * Compare a string to a mask</span>
+<a name="l00047"></a>00047 <span class="comment"> * @param data The string to compare</span>
+<a name="l00048"></a>00048 <span class="comment"> * @param mask Mask characters (arbitrary maximum is 256 characters):</span>
+<a name="l00049"></a>00049 <span class="comment"> * <PRE></span>
+<a name="l00050"></a>00050 <span class="comment"> * '\@' - uppercase letter</span>
+<a name="l00051"></a>00051 <span class="comment"> * '\$' - lowercase letter</span>
+<a name="l00052"></a>00052 <span class="comment"> * '\&' - hex digit</span>
+<a name="l00053"></a>00053 <span class="comment"> * '#' - digit</span>
+<a name="l00054"></a>00054 <span class="comment"> * '~' - digit or space</span>
+<a name="l00055"></a>00055 <span class="comment"> * '*' - swallow remaining characters</span>
+<a name="l00056"></a>00056 <span class="comment"> * </PRE></span>
+<a name="l00057"></a>00057 <span class="comment"> * @remark The mask tests for an exact match for any other character</span>
+<a name="l00058"></a>00058 <span class="comment"> * @return 1 if the string matches, 0 otherwise</span>
+<a name="l00059"></a>00059 <span class="comment"> */</span>
+<a name="l00060"></a>00060 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<span class="keywordtype">int</span>) apr_date_checkmask(const <span class="keywordtype">char</span> *data, const <span class="keywordtype">char</span> *mask);
+<a name="l00061"></a>00061 <span class="comment"></span>
+<a name="l00062"></a>00062 <span class="comment">/**</span>
+<a name="l00063"></a>00063 <span class="comment"> * Parses an HTTP date in one of three standard forms:</span>
+<a name="l00064"></a>00064 <span class="comment"> * <PRE></span>
+<a name="l00065"></a>00065 <span class="comment"> * Sun, 06 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123</span>
+<a name="l00066"></a>00066 <span class="comment"> * Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036</span>
+<a name="l00067"></a>00067 <span class="comment"> * Sun Nov 6 08:49:37 1994 ; ANSI C's asctime() format</span>
+<a name="l00068"></a>00068 <span class="comment"> * </PRE></span>
+<a name="l00069"></a>00069 <span class="comment"> * @param date The date in one of the three formats above</span>
+<a name="l00070"></a>00070 <span class="comment"> * @return the apr_time_t number of microseconds since 1 Jan 1970 GMT, or</span>
+<a name="l00071"></a>00071 <span class="comment"> * 0 if this would be out of range or if the date is invalid.</span>
+<a name="l00072"></a>00072 <span class="comment"> */</span>
+<a name="l00073"></a>00073 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__time.html#gdb4bde16055748190eae190c55aa02bb">apr_time_t</a>) apr_date_parse_http(const <span class="keywordtype">char</span> *date);
+<a name="l00074"></a>00074 <span class="comment"></span>
+<a name="l00075"></a>00075 <span class="comment">/**</span>
+<a name="l00076"></a>00076 <span class="comment"> * Parses a string resembling an RFC 822 date. This is meant to be</span>
+<a name="l00077"></a>00077 <span class="comment"> * leinent in its parsing of dates. Hence, this will parse a wider </span>
+<a name="l00078"></a>00078 <span class="comment"> * range of dates than apr_date_parse_http.</span>
+<a name="l00079"></a>00079 <span class="comment"> *</span>
+<a name="l00080"></a>00080 <span class="comment"> * The prominent mailer (or poster, if mailer is unknown) that has</span>
+<a name="l00081"></a>00081 <span class="comment"> * been seen in the wild is included for the unknown formats.</span>
+<a name="l00082"></a>00082 <span class="comment"> * <PRE></span>
+<a name="l00083"></a>00083 <span class="comment"> * Sun, 06 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123</span>
+<a name="l00084"></a>00084 <span class="comment"> * Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036</span>
+<a name="l00085"></a>00085 <span class="comment"> * Sun Nov 6 08:49:37 1994 ; ANSI C's asctime() format</span>
+<a name="l00086"></a>00086 <span class="comment"> * Sun, 6 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123</span>
+<a name="l00087"></a>00087 <span class="comment"> * Sun, 06 Nov 94 08:49:37 GMT ; RFC 822</span>
+<a name="l00088"></a>00088 <span class="comment"> * Sun, 6 Nov 94 08:49:37 GMT ; RFC 822</span>
+<a name="l00089"></a>00089 <span class="comment"> * Sun, 06 Nov 94 08:49 GMT ; Unknown [drtr\@ast.cam.ac.uk] </span>
+<a name="l00090"></a>00090 <span class="comment"> * Sun, 6 Nov 94 08:49 GMT ; Unknown [drtr\@ast.cam.ac.uk]</span>
+<a name="l00091"></a>00091 <span class="comment"> * Sun, 06 Nov 94 8:49:37 GMT ; Unknown [Elm 70.85]</span>
+<a name="l00092"></a>00092 <span class="comment"> * Sun, 6 Nov 94 8:49:37 GMT ; Unknown [Elm 70.85] </span>
+<a name="l00093"></a>00093 <span class="comment"> * </PRE></span>
+<a name="l00094"></a>00094 <span class="comment"> *</span>
+<a name="l00095"></a>00095 <span class="comment"> * @param date The date in one of the formats above</span>
+<a name="l00096"></a>00096 <span class="comment"> * @return the apr_time_t number of microseconds since 1 Jan 1970 GMT, or</span>
+<a name="l00097"></a>00097 <span class="comment"> * 0 if this would be out of range or if the date is invalid.</span>
+<a name="l00098"></a>00098 <span class="comment"> */</span>
+<a name="l00099"></a>00099 <a class="code" href="group___a_p_r___util___base64.html#gf43a293bb29d7041e6c85e90b967715f">APU_DECLARE</a>(<a class="code" href="group__apr__time.html#gdb4bde16055748190eae190c55aa02bb">apr_time_t</a>) apr_date_parse_rfc(const <span class="keywordtype">char</span> *date);
+<a name="l00100"></a>00100 <span class="comment"></span>
+<a name="l00101"></a>00101 <span class="comment">/** @} */</span>
+<a name="l00102"></a>00102 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00103"></a>00103 <span class="preprocessor"></span>}
+<a name="l00104"></a>00104 <span class="preprocessor">#endif</span>
+<a name="l00105"></a>00105 <span class="preprocessor"></span>
+<a name="l00106"></a>00106 <span class="preprocessor">#endif </span><span class="comment">/* !APR_DATE_H */</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__date_8h.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__date_8h.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__date_8h.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__date_8h.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,58 @@
+<!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_date.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_date.h File Reference</h1>APR-UTIL date routines.
+<a href="#_details">More...</a>
+<p>
+<code>#include "apu.h"</code><br>
+<code>#include "<a class="el" href="apr__time_8h-source.html">apr_time.h</a>"</code><br>
+
+<p>
+<a href="apr__date_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___date.html#g8be88b25f4b477ad13c4067c959411b0">APR_DATE_BAD</a> ((<a class="el" href="group__apr__time.html#gdb4bde16055748190eae190c55aa02bb">apr_time_t</a>)0)</td></tr>
+
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___date.html#g4a4f99fb264d6c243cbbcb106c8e08c7">APU_DECLARE</a> (int) apr_date_checkmask(const char *data</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___date.html#g9e15cdbb028ab9a85bfcc48eb7e842e9">APU_DECLARE</a> (<a class="el" href="group__apr__time.html#gdb4bde16055748190eae190c55aa02bb">apr_time_t</a>) apr_date_parse_http(const char *date)</td></tr>
+
+<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6bd7250007a3cfeadacf370fbf68cf5a"></a><!-- doxytag: member="apr_date.h::mask" ref="g6bd7250007a3cfeadacf370fbf68cf5a" args="" -->
+const char * </td><td class="memItemRight" valign="bottom"><b>mask</b></td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+APR-UTIL date routines.
+<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>