<!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.5"/>
<title>PolarSSL v1.3.8: base64.h File Reference</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="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 style="padding-left: 0.5em;">
<div id="projectname">PolarSSL v1.3.8
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6a9bbd12bf4e19a18c45e270f8fae3fd.html">include</a></li><li class="navelem"><a class="el" href="dir_04272d44da4745cf8b8bfc767d6c6523.html">polarssl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">base64.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>RFC 1521 base64 encoding/decoding.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <string.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="#base64_8h" alt=""/></div>
<map name="base64_8h" id="base64_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 class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a9a778cc91797eec1df0548e1f4afd997"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a9a778cc91797eec1df0548e1f4afd997">POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL</a>   -0x002A</td></tr>
<tr class="memdesc:a9a778cc91797eec1df0548e1f4afd997"><td class="mdescLeft"> </td><td class="mdescRight">Output buffer too small. <a href="#a9a778cc91797eec1df0548e1f4afd997">More...</a><br/></td></tr>
<tr class="separator:a9a778cc91797eec1df0548e1f4afd997"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8fac8bb4d3ed57b1beb10bf617664a1d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a8fac8bb4d3ed57b1beb10bf617664a1d">POLARSSL_ERR_BASE64_INVALID_CHARACTER</a>   -0x002C</td></tr>
<tr class="memdesc:a8fac8bb4d3ed57b1beb10bf617664a1d"><td class="mdescLeft"> </td><td class="mdescRight">Invalid character in input. <a href="#a8fac8bb4d3ed57b1beb10bf617664a1d">More...</a><br/></td></tr>
<tr class="separator:a8fac8bb4d3ed57b1beb10bf617664a1d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7c33d8904e1ace023ffdebe04850f585"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a7c33d8904e1ace023ffdebe04850f585">base64_encode</a> (unsigned char *dst, size_t *dlen, const unsigned char *src, size_t slen)</td></tr>
<tr class="memdesc:a7c33d8904e1ace023ffdebe04850f585"><td class="mdescLeft"> </td><td class="mdescRight">Encode a buffer into base64 format. <a href="#a7c33d8904e1ace023ffdebe04850f585">More...</a><br/></td></tr>
<tr class="separator:a7c33d8904e1ace023ffdebe04850f585"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7f485e57a533e6d0573c406ffcab378"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#ab7f485e57a533e6d0573c406ffcab378">base64_decode</a> (unsigned char *dst, size_t *dlen, const unsigned char *src, size_t slen)</td></tr>
<tr class="memdesc:ab7f485e57a533e6d0573c406ffcab378"><td class="mdescLeft"> </td><td class="mdescRight">Decode a base64-formatted buffer. <a href="#ab7f485e57a533e6d0573c406ffcab378">More...</a><br/></td></tr>
<tr class="separator:ab7f485e57a533e6d0573c406ffcab378"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a469652530cde1badbb67385c2fe3b9ac"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a469652530cde1badbb67385c2fe3b9ac">base64_self_test</a> (int verbose)</td></tr>
<tr class="memdesc:a469652530cde1badbb67385c2fe3b9ac"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#a469652530cde1badbb67385c2fe3b9ac">More...</a><br/></td></tr>
<tr class="separator:a469652530cde1badbb67385c2fe3b9ac"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>RFC 1521 base64 encoding/decoding. </p>
<p>Copyright (C) 2006-2013, Brainspark B.V.</p>
<p>This file is part of PolarSSL (<a href="http://www.polarssl.org">http://www.polarssl.org</a>) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org></p>
<p>All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. </p>
<p>Definition in file <a class="el" href="base64_8h_source.html">base64.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a9a778cc91797eec1df0548e1f4afd997"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL   -0x002A</td>
</tr>
</table>
</div><div class="memdoc">
<p>Output buffer too small. </p>
<p>Definition at line <a class="el" href="base64_8h_source.html#l00032">32</a> of file <a class="el" href="base64_8h_source.html">base64.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8fac8bb4d3ed57b1beb10bf617664a1d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_BASE64_INVALID_CHARACTER   -0x002C</td>
</tr>
</table>
</div><div class="memdoc">
<p>Invalid character in input. </p>
<p>Definition at line <a class="el" href="base64_8h_source.html#l00033">33</a> of file <a class="el" href="base64_8h_source.html">base64.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ab7f485e57a533e6d0573c406ffcab378"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int base64_decode </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>dlen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>slen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode a base64-formatted buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>destination buffer (can be NULL for checking size) </td></tr>
<tr><td class="paramname">dlen</td><td>size of the buffer </td></tr>
<tr><td class="paramname">src</td><td>source buffer </td></tr>
<tr><td class="paramname">slen</td><td>amount of data to be decoded</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL, or POLARSSL_ERR_BASE64_INVALID_CHARACTER if the input data is not correct. *dlen is always updated to reflect the amount of data that has (or would have) been written.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Call this function with *dst = NULL or *dlen = 0 to obtain the required buffer size in *dlen </dd></dl>
</div>
</div>
<a class="anchor" id="a7c33d8904e1ace023ffdebe04850f585"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int base64_encode </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>dlen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>slen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode a buffer into base64 format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>destination buffer </td></tr>
<tr><td class="paramname">dlen</td><td>size of the buffer </td></tr>
<tr><td class="paramname">src</td><td>source buffer </td></tr>
<tr><td class="paramname">slen</td><td>amount of data to be encoded</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL. *dlen is always updated to reflect the amount of data that has (or would have) been written.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Call this function with *dlen = 0 to obtain the required buffer size in *dlen </dd></dl>
</div>
</div>
<a class="anchor" id="a469652530cde1badbb67385c2fe3b9ac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int base64_self_test </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>verbose</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checkup routine. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or 1 if the test failed </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:55 for PolarSSL v1.3.8 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
