Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-updates > by-pkgid > f835bee5b8b7ec08e20fae17cab51e63 > files > 102

lib64mbedtls-devel-2.7.3-1.mga6.x86_64.rpm

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mbed TLS v2.7.3: 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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">mbed TLS v2.7.3
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b4d146e9a6d8dd56ed4afb2480a97fd3.html">mbedtls</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<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 &lt;stddef.h&gt;</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:aee2d8e14fac7a47751514356572b97e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#aee2d8e14fac7a47751514356572b97e5">MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL</a>&#160;&#160;&#160;-0x002A</td></tr>
<tr class="separator:aee2d8e14fac7a47751514356572b97e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a954f9cf059a6c6be1a3b93480f9a561d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a954f9cf059a6c6be1a3b93480f9a561d">MBEDTLS_ERR_BASE64_INVALID_CHARACTER</a>&#160;&#160;&#160;-0x002C</td></tr>
<tr class="separator:a954f9cf059a6c6be1a3b93480f9a561d"><td class="memSeparator" colspan="2">&#160;</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:a87c42fcb843b964e68015a46aad5bffd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a87c42fcb843b964e68015a46aad5bffd">mbedtls_base64_encode</a> (unsigned char *dst, size_t dlen, size_t *olen, const unsigned char *src, size_t slen)</td></tr>
<tr class="memdesc:a87c42fcb843b964e68015a46aad5bffd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a buffer into base64 format.  <a href="#a87c42fcb843b964e68015a46aad5bffd">More...</a><br /></td></tr>
<tr class="separator:a87c42fcb843b964e68015a46aad5bffd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e8abeb72a244acb346fc4ac3083886c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a1e8abeb72a244acb346fc4ac3083886c">mbedtls_base64_decode</a> (unsigned char *dst, size_t dlen, size_t *olen, const unsigned char *src, size_t slen)</td></tr>
<tr class="memdesc:a1e8abeb72a244acb346fc4ac3083886c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode a base64-formatted buffer.  <a href="#a1e8abeb72a244acb346fc4ac3083886c">More...</a><br /></td></tr>
<tr class="separator:a1e8abeb72a244acb346fc4ac3083886c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab24d0f315da798d7ea412f0e74411cd7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#ab24d0f315da798d7ea412f0e74411cd7">mbedtls_base64_self_test</a> (int verbose)</td></tr>
<tr class="memdesc:ab24d0f315da798d7ea412f0e74411cd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checkup routine.  <a href="#ab24d0f315da798d7ea412f0e74411cd7">More...</a><br /></td></tr>
<tr class="separator:ab24d0f315da798d7ea412f0e74411cd7"><td class="memSeparator" colspan="2">&#160;</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 class="definition">Definition in file <a class="el" href="base64_8h_source.html">base64.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aee2d8e14fac7a47751514356572b97e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee2d8e14fac7a47751514356572b97e5">&#9670;&nbsp;</a></span>MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL&#160;&#160;&#160;-0x002A</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Output buffer too small. </p>

<p class="definition">Definition at line <a class="el" href="base64_8h_source.html#l00029">29</a> of file <a class="el" href="base64_8h_source.html">base64.h</a>.</p>

</div>
</div>
<a id="a954f9cf059a6c6be1a3b93480f9a561d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a954f9cf059a6c6be1a3b93480f9a561d">&#9670;&nbsp;</a></span>MBEDTLS_ERR_BASE64_INVALID_CHARACTER</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define MBEDTLS_ERR_BASE64_INVALID_CHARACTER&#160;&#160;&#160;-0x002C</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Invalid character in input. </p>

<p class="definition">Definition at line <a class="el" href="base64_8h_source.html#l00030">30</a> of file <a class="el" href="base64_8h_source.html">base64.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a1e8abeb72a244acb346fc4ac3083886c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e8abeb72a244acb346fc4ac3083886c">&#9670;&nbsp;</a></span>mbedtls_base64_decode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mbedtls_base64_decode </td>
          <td>(</td>
          <td class="paramtype">unsigned char *&#160;</td>
          <td class="paramname"><em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>dlen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *&#160;</td>
          <td class="paramname"><em>olen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>slen</em>&#160;</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 destination buffer </td></tr>
    <tr><td class="paramname">olen</td><td>number of bytes written </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, MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL, or MBEDTLS_ERR_BASE64_INVALID_CHARACTER if the input data is not correct. *olen 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 *olen </dd></dl>

</div>
</div>
<a id="a87c42fcb843b964e68015a46aad5bffd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87c42fcb843b964e68015a46aad5bffd">&#9670;&nbsp;</a></span>mbedtls_base64_encode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mbedtls_base64_encode </td>
          <td>(</td>
          <td class="paramtype">unsigned char *&#160;</td>
          <td class="paramname"><em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>dlen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *&#160;</td>
          <td class="paramname"><em>olen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>slen</em>&#160;</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 destination buffer </td></tr>
    <tr><td class="paramname">olen</td><td>number of bytes written </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 MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL. *olen is always updated to reflect the amount of data that has (or would have) been written. If that length cannot be represented, then no data is written to the buffer and *olen is set to the maximum length representable as a size_t.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Call this function with dlen = 0 to obtain the required buffer size in *olen </dd></dl>

</div>
</div>
<a id="ab24d0f315da798d7ea412f0e74411cd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab24d0f315da798d7ea412f0e74411cd7">&#9670;&nbsp;</a></span>mbedtls_base64_self_test()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mbedtls_base64_self_test </td>
          <td>(</td>
          <td class="paramtype">int&#160;</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 Tue May 8 2018 21:08:41 for mbed TLS v2.7.3 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>