<!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"/> <title>Apache Portable Runtime: apr_base64.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.3 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Apache Portable Runtime</div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <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 id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div class="header"> <div class="headertitle"> <h1>apr_base64.h</h1> </div> </div> <div class="contents"> <a href="apr__base64_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"> * The apr_vsnprintf/apr_snprintf functions are based on, and used with the</span> <a name="l00016"></a>00016 <span class="comment"> * permission of, the SIO stdio-replacement strx_* functions by Panos</span> <a name="l00017"></a>00017 <span class="comment"> * Tsirigotis <panos@alumni.cs.colorado.edu> for xinetd.</span> <a name="l00018"></a>00018 <span class="comment"> */</span> <a name="l00019"></a>00019 <span class="comment"></span> <a name="l00020"></a>00020 <span class="comment">/**</span> <a name="l00021"></a>00021 <span class="comment"> * @file apr_base64.h</span> <a name="l00022"></a>00022 <span class="comment"> * @brief APR-UTIL Base64 Encoding</span> <a name="l00023"></a>00023 <span class="comment"> */</span> <a name="l00024"></a>00024 <span class="preprocessor">#ifndef APR_BASE64_H</span> <a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define APR_BASE64_H</span> <a name="l00026"></a>00026 <span class="preprocessor"></span> <a name="l00027"></a>00027 <span class="preprocessor">#include "apu.h"</span> <a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="apr__general_8h.html" title="APR Miscellaneous library routines.">apr_general.h</a>"</span> <a name="l00029"></a>00029 <a name="l00030"></a>00030 <span class="preprocessor">#ifdef __cplusplus</span> <a name="l00031"></a>00031 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { <a name="l00032"></a>00032 <span class="preprocessor">#endif</span> <a name="l00033"></a>00033 <span class="preprocessor"></span><span class="comment"></span> <a name="l00034"></a>00034 <span class="comment">/**</span> <a name="l00035"></a>00035 <span class="comment"> * @defgroup APR_Util_Base64 Base64 Encoding</span> <a name="l00036"></a>00036 <span class="comment"> * @ingroup APR_Util</span> <a name="l00037"></a>00037 <span class="comment"> * @{</span> <a name="l00038"></a>00038 <span class="comment"> */</span> <a name="l00039"></a>00039 <a name="l00040"></a>00040 <span class="comment">/* Simple BASE64 encode/decode functions.</span> <a name="l00041"></a>00041 <span class="comment"> * </span> <a name="l00042"></a>00042 <span class="comment"> * As we might encode binary strings, hence we require the length of</span> <a name="l00043"></a>00043 <span class="comment"> * the incoming plain source. And return the length of what we decoded.</span> <a name="l00044"></a>00044 <span class="comment"> *</span> <a name="l00045"></a>00045 <span class="comment"> * The decoding function takes any non valid char (i.e. whitespace, \0</span> <a name="l00046"></a>00046 <span class="comment"> * or anything non A-Z,0-9 etc as terminal.</span> <a name="l00047"></a>00047 <span class="comment"> * </span> <a name="l00048"></a>00048 <span class="comment"> * plain strings/binary sequences are not assumed '\0' terminated. Encoded</span> <a name="l00049"></a>00049 <span class="comment"> * strings are neither. But probably should.</span> <a name="l00050"></a>00050 <span class="comment"> *</span> <a name="l00051"></a>00051 <span class="comment"> */</span> <a name="l00052"></a>00052 <span class="comment"></span> <a name="l00053"></a>00053 <span class="comment">/**</span> <a name="l00054"></a>00054 <span class="comment"> * Given the length of an un-encrypted string, get the length of the </span> <a name="l00055"></a>00055 <span class="comment"> * encrypted string.</span> <a name="l00056"></a>00056 <span class="comment"> * @param len the length of an unencrypted string.</span> <a name="l00057"></a>00057 <span class="comment"> * @return the length of the string after it is encrypted</span> <a name="l00058"></a>00058 <span class="comment"> */</span> <a name="l00059"></a>00059 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___base64.html#ga5dad9df13a7018e3946a54c8d2c27ae9">apr_base64_encode_len</a>(<span class="keywordtype">int</span> len); <a name="l00060"></a>00060 <span class="comment"></span> <a name="l00061"></a>00061 <span class="comment">/**</span> <a name="l00062"></a>00062 <span class="comment"> * Encode a text string using base64encoding.</span> <a name="l00063"></a>00063 <span class="comment"> * @param coded_dst The destination string for the encoded string.</span> <a name="l00064"></a>00064 <span class="comment"> * @param plain_src The original string in plain text</span> <a name="l00065"></a>00065 <span class="comment"> * @param len_plain_src The length of the plain text string</span> <a name="l00066"></a>00066 <span class="comment"> * @return the length of the encoded string</span> <a name="l00067"></a>00067 <span class="comment"> */</span> <a name="l00068"></a>00068 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___base64.html#ga6176124b05512773de40cc5e899058b9">apr_base64_encode</a>(<span class="keywordtype">char</span> * coded_dst, const <span class="keywordtype">char</span> *plain_src, <a name="l00069"></a>00069 <span class="keywordtype">int</span> len_plain_src); <a name="l00070"></a>00070 <span class="comment"></span> <a name="l00071"></a>00071 <span class="comment">/**</span> <a name="l00072"></a>00072 <span class="comment"> * Encode an EBCDIC string using base64encoding.</span> <a name="l00073"></a>00073 <span class="comment"> * @param coded_dst The destination string for the encoded string.</span> <a name="l00074"></a>00074 <span class="comment"> * @param plain_src The original string in plain text</span> <a name="l00075"></a>00075 <span class="comment"> * @param len_plain_src The length of the plain text string</span> <a name="l00076"></a>00076 <span class="comment"> * @return the length of the encoded string</span> <a name="l00077"></a>00077 <span class="comment"> */</span> <a name="l00078"></a>00078 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___base64.html#gae7480ce6b723e71cf91583217d96f1d7">apr_base64_encode_binary</a>(<span class="keywordtype">char</span> * coded_dst, <a name="l00079"></a>00079 const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *plain_src, <a name="l00080"></a>00080 <span class="keywordtype">int</span> len_plain_src); <a name="l00081"></a>00081 <span class="comment"></span> <a name="l00082"></a>00082 <span class="comment">/**</span> <a name="l00083"></a>00083 <span class="comment"> * Determine the maximum buffer length required to decode the plain text</span> <a name="l00084"></a>00084 <span class="comment"> * string given the encoded string.</span> <a name="l00085"></a>00085 <span class="comment"> * @param coded_src The encoded string</span> <a name="l00086"></a>00086 <span class="comment"> * @return the maximum required buffer length for the plain text string</span> <a name="l00087"></a>00087 <span class="comment"> */</span> <a name="l00088"></a>00088 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___base64.html#gad1ba714a6708376e6a21722a40a698a2">apr_base64_decode_len</a>(const <span class="keywordtype">char</span> * coded_src); <a name="l00089"></a>00089 <span class="comment"></span> <a name="l00090"></a>00090 <span class="comment">/**</span> <a name="l00091"></a>00091 <span class="comment"> * Decode a string to plain text</span> <a name="l00092"></a>00092 <span class="comment"> * @param plain_dst The destination string for the plain text</span> <a name="l00093"></a>00093 <span class="comment"> * @param coded_src The encoded string </span> <a name="l00094"></a>00094 <span class="comment"> * @return the length of the plain text string</span> <a name="l00095"></a>00095 <span class="comment"> */</span> <a name="l00096"></a>00096 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___base64.html#ga1f717903883e7405c2a0d0ec5814f865">apr_base64_decode</a>(<span class="keywordtype">char</span> * plain_dst, const <span class="keywordtype">char</span> *coded_src); <a name="l00097"></a>00097 <span class="comment"></span> <a name="l00098"></a>00098 <span class="comment">/**</span> <a name="l00099"></a>00099 <span class="comment"> * Decode an EBCDIC string to plain text</span> <a name="l00100"></a>00100 <span class="comment"> * @param plain_dst The destination string for the plain text</span> <a name="l00101"></a>00101 <span class="comment"> * @param coded_src The encoded string </span> <a name="l00102"></a>00102 <span class="comment"> * @return the length of the plain text string</span> <a name="l00103"></a>00103 <span class="comment"> */</span> <a name="l00104"></a>00104 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___base64.html#ga3d8f1517351d8b7a18b8396642b98975">apr_base64_decode_binary</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * plain_dst, <a name="l00105"></a>00105 const <span class="keywordtype">char</span> *coded_src); <a name="l00106"></a>00106 <span class="comment"></span> <a name="l00107"></a>00107 <span class="comment">/** @} */</span> <a name="l00108"></a>00108 <span class="preprocessor">#ifdef __cplusplus</span> <a name="l00109"></a>00109 <span class="preprocessor"></span>} <a name="l00110"></a>00110 <span class="preprocessor">#endif</span> <a name="l00111"></a>00111 <span class="preprocessor"></span> <a name="l00112"></a>00112 <span class="preprocessor">#endif </span><span class="comment">/* !APR_BASE64_H */</span> </pre></div></div> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small>Generated on Wed May 25 2011 for Apache Portable Runtime by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address> </body> </html>