<!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>BeeCrypt: include/beecrypt/base64.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.7.3 -->
<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">BeeCrypt <span id="projectnumber">4.2.1</span></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="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></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>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<h1>include/beecrypt/base64.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Base64 encoding and decoding, headers.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include "beecrypt/beecrypt.h"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for base64.h:</div>
<div class="dyncontent">
<div class="center"><img src="base64_8h__incl.png" border="0" usemap="#include_2beecrypt_2base64_8h" alt=""/></div>
<map name="include_2beecrypt_2base64_8h" id="include_2beecrypt_2base64_8h">
</map>
</div>
</div>
<p><a href="base64_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a03c07933ddc4e5433298971545e0cc25">B64DECODE_WHITESPACE</a>   " \f\n\r\t\v"</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#af253d2a2aa49c121308c9673b6ad40d3">B64ENCODE_CHARS_PER_LINE</a>   72</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#aa0f9a215933ac9e105b3e62117736b7d">B64ENCODE_EOLSTR</a>   "\n"</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a6492c5e1dc7b8a53ce420d92f6ad6e67">b64encode</a> (const void *data, size_t ns)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a8420855d61134f07a28a1cf53dc7cafa">b64crc</a> (const unsigned char *data, size_t ns)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a0b3128126ca31a7187c998e81af1ff52">b64decode</a> (const char *s, void **datap, size_t *lenp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#ab0aa5a4c2d4d8d0321ac167397cac66f">b64enc</a> (const <a class="el" href="structmemchunk.html">memchunk</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmemchunk.html">memchunk</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a57a00a44d1f660a73edb5ceab221c091">b64dec</a> (const char *)</td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#aa6cc813df62a79a36d49ccc79283933b">b64decode_whitespace</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a2a178e7716aa573ae431466be5d88b29">b64encode_chars_per_line</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a4a1b983f10ce83151b0ef69e433f4b62">b64encode_eolstr</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base64 encoding and decoding, headers. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Bob Deblier <<a href="mailto:bob.deblier@telenet.be">bob.deblier@telenet.be</a>> </dd></dl>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a03c07933ddc4e5433298971545e0cc25"></a><!-- doxytag: member="base64.h::B64DECODE_WHITESPACE" ref="a03c07933ddc4e5433298971545e0cc25" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define B64DECODE_WHITESPACE   " \f\n\r\t\v"</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af253d2a2aa49c121308c9673b6ad40d3"></a><!-- doxytag: member="base64.h::B64ENCODE_CHARS_PER_LINE" ref="af253d2a2aa49c121308c9673b6ad40d3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define B64ENCODE_CHARS_PER_LINE   72</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa0f9a215933ac9e105b3e62117736b7d"></a><!-- doxytag: member="base64.h::B64ENCODE_EOLSTR" ref="aa0f9a215933ac9e105b3e62117736b7d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define B64ENCODE_EOLSTR   "\n"</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a8420855d61134f07a28a1cf53dc7cafa"></a><!-- doxytag: member="base64.h::b64crc" ref="a8420855d61134f07a28a1cf53dc7cafa" args="(const unsigned char *data, size_t ns)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* b64crc </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>ns</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encode crc of binary input data into 5 bytes of base64 output. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>binary data </td></tr>
<tr><td class="paramname">ns</td><td>no. bytes of binary data </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>(malloc'd) base64 string </dd></dl>
</div>
</div>
<a class="anchor" id="a57a00a44d1f660a73edb5ceab221c091"></a><!-- doxytag: member="base64.h::b64dec" ref="a57a00a44d1f660a73edb5ceab221c091" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmemchunk.html">memchunk</a>* b64dec </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0b3128126ca31a7187c998e81af1ff52"></a><!-- doxytag: member="base64.h::b64decode" ref="a0b3128126ca31a7187c998e81af1ff52" args="(const char *s, void **datap, size_t *lenp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int b64decode </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>datap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>lenp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode chunks of 4 bytes of base64 input into 3 bytes of binary output. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>base64 string </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">datap</td><td>address of (malloc'd) binary data </td></tr>
<tr><td class="paramname">lenp</td><td>address of no. bytes of binary data </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, 1: s == NULL, 2: bad length, 3: bad char </dd></dl>
</div>
</div>
<a class="anchor" id="ab0aa5a4c2d4d8d0321ac167397cac66f"></a><!-- doxytag: member="base64.h::b64enc" ref="ab0aa5a4c2d4d8d0321ac167397cac66f" args="(const memchunk *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* b64enc </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmemchunk.html">memchunk</a> * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6492c5e1dc7b8a53ce420d92f6ad6e67"></a><!-- doxytag: member="base64.h::b64encode" ref="a6492c5e1dc7b8a53ce420d92f6ad6e67" args="(const void *data, size_t ns)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* b64encode </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>ns</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encode chunks of 3 bytes of binary input into 4 bytes of base64 output. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>binary data </td></tr>
<tr><td class="paramname">ns</td><td>no. bytes of data (0 uses strlen(data)) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>(malloc'd) base64 string </dd></dl>
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="aa6cc813df62a79a36d49ccc79283933b"></a><!-- doxytag: member="base64.h::b64decode_whitespace" ref="aa6cc813df62a79a36d49ccc79283933b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="base64_8h.html#aa6cc813df62a79a36d49ccc79283933b">b64decode_whitespace</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>\ Decode white space character set (default). </p>
</div>
</div>
<a class="anchor" id="a2a178e7716aa573ae431466be5d88b29"></a><!-- doxytag: member="base64.h::b64encode_chars_per_line" ref="a2a178e7716aa573ae431466be5d88b29" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="base64_8h.html#a2a178e7716aa573ae431466be5d88b29">b64encode_chars_per_line</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>\ Encode 72 characters per line (default). </p>
</div>
</div>
<a class="anchor" id="a4a1b983f10ce83151b0ef69e433f4b62"></a><!-- doxytag: member="base64.h::b64encode_eolstr" ref="a4a1b983f10ce83151b0ef69e433f4b62" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="base64_8h.html#a4a1b983f10ce83151b0ef69e433f4b62">b64encode_eolstr</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>\ Encode end-of-line string (default). </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Apr 10 2011 20:49:30 for BeeCrypt 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>
