Linux SRV-16 6.18.44-paas #1 SMP PREEMPT_DYNAMIC Thu Aug 13 10:08:12 UTC 2026 x86_64
/
usr
/
share
/
doc
/
libaprutil1-dev
/
html
/
//usr/share/doc/libaprutil1-dev/html/apr__crypto_8h_source.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.12"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Apache Portable Runtime Utility Library: /build/apr-util-1.5.4/include/apr_crypto.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Apache Portable Runtime Utility Library </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.12 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); </script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">apr_crypto.h</div> </div> </div><!--header--> <div class="contents"> <a href="apr__crypto_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef APR_CRYPTO_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define APR_CRYPTO_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "apu.h"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "apr_pools.h"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "apr_tables.h"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "apr_hash.h"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="apu__errno_8h.html">apu_errno.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#if APU_HAVE_CRYPTO</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#ifndef APU_CRYPTO_RECOMMENDED_DRIVER</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#if APU_HAVE_OPENSSL</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#define APU_CRYPTO_RECOMMENDED_DRIVER "openssl"</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#if APU_HAVE_NSS</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#define APU_CRYPTO_RECOMMENDED_DRIVER "nss"</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#if APU_HAVE_MSCNG</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#define APU_CRYPTO_RECOMMENDED_DRIVER "mscng"</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#if APU_HAVE_MSCAPI</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#define APU_CRYPTO_RECOMMENDED_DRIVER "mscapi"</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  APR_KEY_NONE, APR_KEY_3DES_192, </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  APR_KEY_AES_128, </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  APR_KEY_AES_192, </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  APR_KEY_AES_256</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> } apr_crypto_block_key_type_e;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> {</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  APR_MODE_NONE, </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  APR_MODE_ECB, </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  APR_MODE_CBC</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> } apr_crypto_block_key_mode_e;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment">/* These are opaque structs. Instantiation is up to each backend */</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_crypto_driver_t apr_crypto_driver_t;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_crypto_t apr_crypto_t;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_crypto_config_t apr_crypto_config_t;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_crypto_key_t apr_crypto_key_t;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_crypto_block_t apr_crypto_block_t;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> APU_DECLARE(apr_status_t) apr_crypto_init(apr_pool_t *pool);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> APU_DECLARE(apr_status_t) apr_crypto_clear(apr_pool_t *pool, <span class="keywordtype">void</span> *buffer,</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  apr_size_t size);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> APU_DECLARE(apr_status_t) apr_crypto_get_driver(</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  const apr_crypto_driver_t **driver,</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  const <span class="keywordtype">char</span> *name, const <span class="keywordtype">char</span> *params, const <a class="code" href="structapu__err__t.html">apu_err_t</a> **result,</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  apr_pool_t *pool);</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> APU_DECLARE(const <span class="keywordtype">char</span> *) apr_crypto_driver_name(</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  const apr_crypto_driver_t *driver);</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> APU_DECLARE(apr_status_t) apr_crypto_error(const <a class="code" href="structapu__err__t.html">apu_err_t</a> **result,</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  const apr_crypto_t *f);</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> APU_DECLARE(apr_status_t) apr_crypto_make(apr_crypto_t **f,</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  const apr_crypto_driver_t *driver, const <span class="keywordtype">char</span> *params,</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  apr_pool_t *pool);</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> </div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> APU_DECLARE(apr_status_t) apr_crypto_get_block_key_types(apr_hash_t **types,</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  const apr_crypto_t *f);</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> APU_DECLARE(apr_status_t) apr_crypto_get_block_key_modes(apr_hash_t **modes,</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  const apr_crypto_t *f);</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> APU_DECLARE(apr_status_t) apr_crypto_passphrase(apr_crypto_key_t **key,</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  apr_size_t *ivSize, const <span class="keywordtype">char</span> *pass, apr_size_t passLen,</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * salt, apr_size_t saltLen,</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  const apr_crypto_block_key_type_e type,</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  const apr_crypto_block_key_mode_e mode, const <span class="keywordtype">int</span> doPad,</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  const <span class="keywordtype">int</span> iterations, const apr_crypto_t *f, apr_pool_t *p);</div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> </div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> APU_DECLARE(apr_status_t) apr_crypto_block_encrypt_init(</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  apr_crypto_block_t **ctx, const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **iv,</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  const apr_crypto_key_t *key, apr_size_t *blockSize, apr_pool_t *p);</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> </div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> APU_DECLARE(apr_status_t) apr_crypto_block_encrypt(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **out,</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  apr_size_t *outlen, const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *in, apr_size_t inlen,</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  apr_crypto_block_t *ctx);</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> </div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> APU_DECLARE(apr_status_t) apr_crypto_block_encrypt_finish(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *out,</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  apr_size_t *outlen, apr_crypto_block_t *ctx);</div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span> </div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> APU_DECLARE(apr_status_t) apr_crypto_block_decrypt_init(</div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  apr_crypto_block_t **ctx, apr_size_t *blockSize,</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *iv, const apr_crypto_key_t *key, apr_pool_t *p);</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> </div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> APU_DECLARE(apr_status_t) apr_crypto_block_decrypt(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **out,</div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  apr_size_t *outlen, const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *in, apr_size_t inlen,</div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  apr_crypto_block_t *ctx);</div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span> </div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span> APU_DECLARE(apr_status_t) apr_crypto_block_decrypt_finish(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *out,</div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  apr_size_t *outlen, apr_crypto_block_t *ctx);</div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span> </div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span> APU_DECLARE(apr_status_t) apr_crypto_block_cleanup(apr_crypto_block_t *ctx);</div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span> </div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span> APU_DECLARE(apr_status_t) apr_crypto_cleanup(apr_crypto_t *f);</div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span> </div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span> APU_DECLARE(apr_status_t) apr_crypto_shutdown(</div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span>  const apr_crypto_driver_t *driver);</div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span> </div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="preprocessor">#endif </span><span class="comment">/* APU_HAVE_CRYPTO */</span><span class="preprocessor"></span></div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span> </div><div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00416"></a><span class="lineno"> 416</span> }</div><div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00418"></a><span class="lineno"> 418</span> </div><div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="apu__errno_8h_html"><div class="ttname"><a href="apu__errno_8h.html">apu_errno.h</a></div><div class="ttdoc">APR-Util Error Codes. </div></div> <div class="ttc" id="structapu__err__t_html"><div class="ttname"><a href="structapu__err__t.html">apu_err_t</a></div><div class="ttdef"><b>Definition:</b> apu_errno.h:161</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.12 </small></address> </body> </html>