cbiedl
/
jose


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412
							<!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>José: Base64</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">José
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<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>
</div><!-- top -->
<!-- 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 class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Base64</div>  </div>
</div><!--header-->
<div class="contents">

<p>URL-safe Base64 Encoding &amp; Decoding.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf86ee58b51e590f9dac0bb29ee5800ff"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__b64.html#gaf86ee58b51e590f9dac0bb29ee5800ff">jose_b64_dec</a> (const json_t *i, void *o, size_t ol)</td></tr>
<tr class="memdesc:gaf86ee58b51e590f9dac0bb29ee5800ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decodes a URL-safe Base64 JSON string to a buffer.  <a href="#gaf86ee58b51e590f9dac0bb29ee5800ff">More...</a><br /></td></tr>
<tr class="separator:gaf86ee58b51e590f9dac0bb29ee5800ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8e16b78e3713aacb5bdcdc16730a3a98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structjose__io__t.html">jose_io_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__b64.html#ga8e16b78e3713aacb5bdcdc16730a3a98">jose_b64_dec_io</a> (<a class="el" href="structjose__io__t.html">jose_io_t</a> *next)</td></tr>
<tr class="memdesc:ga8e16b78e3713aacb5bdcdc16730a3a98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new IO object which performs URL-safe Base64 decoding.  <a href="#ga8e16b78e3713aacb5bdcdc16730a3a98">More...</a><br /></td></tr>
<tr class="separator:ga8e16b78e3713aacb5bdcdc16730a3a98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga75953a3138781b2ad2809395587b1f44"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__b64.html#ga75953a3138781b2ad2809395587b1f44">jose_b64_dec_buf</a> (const void *i, size_t il, void *o, size_t ol)</td></tr>
<tr class="memdesc:ga75953a3138781b2ad2809395587b1f44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decodes a URL-safe Base64 buffer to an output buffer.  <a href="#ga75953a3138781b2ad2809395587b1f44">More...</a><br /></td></tr>
<tr class="separator:ga75953a3138781b2ad2809395587b1f44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1fa229e6903d5cc41403a2b137fcff18"><td class="memItemLeft" align="right" valign="top">json_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__b64.html#ga1fa229e6903d5cc41403a2b137fcff18">jose_b64_dec_load</a> (const json_t *i)</td></tr>
<tr class="memdesc:ga1fa229e6903d5cc41403a2b137fcff18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decodes a JSON string from a URL-safe Base64 JSON string.  <a href="#ga1fa229e6903d5cc41403a2b137fcff18">More...</a><br /></td></tr>
<tr class="separator:ga1fa229e6903d5cc41403a2b137fcff18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab8e19831335f6990bfea85d21b946e72"><td class="memItemLeft" align="right" valign="top">json_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__b64.html#gab8e19831335f6990bfea85d21b946e72">jose_b64_enc</a> (const void *i, size_t il)</td></tr>
<tr class="memdesc:gab8e19831335f6990bfea85d21b946e72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes data to a URL-safe Base64 JSON string.  <a href="#gab8e19831335f6990bfea85d21b946e72">More...</a><br /></td></tr>
<tr class="separator:gab8e19831335f6990bfea85d21b946e72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad72c180de43c9da3456bdb0d166092ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structjose__io__t.html">jose_io_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__b64.html#gad72c180de43c9da3456bdb0d166092ff">jose_b64_enc_io</a> (<a class="el" href="structjose__io__t.html">jose_io_t</a> *next)</td></tr>
<tr class="memdesc:gad72c180de43c9da3456bdb0d166092ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new IO object which performs URL-safe Base64 encoding.  <a href="#gad72c180de43c9da3456bdb0d166092ff">More...</a><br /></td></tr>
<tr class="separator:gad72c180de43c9da3456bdb0d166092ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2a35d8159cc76af42482df6db36543b0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__b64.html#ga2a35d8159cc76af42482df6db36543b0">jose_b64_enc_buf</a> (const void *i, size_t il, void *o, size_t ol)</td></tr>
<tr class="memdesc:ga2a35d8159cc76af42482df6db36543b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes data to a URL-safe Base64 buffer.  <a href="#ga2a35d8159cc76af42482df6db36543b0">More...</a><br /></td></tr>
<tr class="separator:ga2a35d8159cc76af42482df6db36543b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga244aaa61d745e3eb3dfa5fb4a204fa68"><td class="memItemLeft" align="right" valign="top">json_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__b64.html#ga244aaa61d745e3eb3dfa5fb4a204fa68">jose_b64_enc_dump</a> (const json_t *i)</td></tr>
<tr class="memdesc:ga244aaa61d745e3eb3dfa5fb4a204fa68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes the input JSON as a URL-safe Base64 JSON string.  <a href="#ga244aaa61d745e3eb3dfa5fb4a204fa68">More...</a><br /></td></tr>
<tr class="separator:ga244aaa61d745e3eb3dfa5fb4a204fa68"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>URL-safe Base64 Encoding &amp; Decoding. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf86ee58b51e590f9dac0bb29ee5800ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf86ee58b51e590f9dac0bb29ee5800ff">&#9670;&nbsp;</a></span>jose_b64_dec()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t jose_b64_dec </td>
          <td>(</td>
          <td class="paramtype">const json_t *&#160;</td>
          <td class="paramname"><em>i</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>o</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>ol</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Decodes a URL-safe Base64 JSON string to a buffer. </p>
<p>If <code>o</code> is NULL, the number of output bytes necessary is returned.</p>
<p>This function will never write more than <code>ol</code> bytes. If the output buffer is too small, an error will occur.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">i</td><td>The input URL-safe Base64 JSON string. </td></tr>
    <tr><td class="paramname">o</td><td>The output buffer (may be NULL). </td></tr>
    <tr><td class="paramname">ol</td><td>The size of the output buffer. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes that were (or would be) written. If an error occurs, SIZE_MAX is returned. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structjose__io__t.html">jose_io_t</a>* jose_b64_dec_io </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structjose__io__t.html">jose_io_t</a> *&#160;</td>
          <td class="paramname"><em>next</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a new IO object which performs URL-safe Base64 decoding. </p>
<p>All data written to the returned IO object will be decoded before passing it on to the next IO object in the chain.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">next</td><td>The next IO object in the chain. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new IO object or NULL on error. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t jose_b64_dec_buf </td>
          <td>(</td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>i</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>il</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>o</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>ol</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Decodes a URL-safe Base64 buffer to an output buffer. </p>
<p>If <code>o</code> is NULL, the number of output bytes necessary is returned.</p>
<p>This function will never write more than <code>ol</code> bytes. If the output buffer is too small, an error will occur.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">i</td><td>The input URL-safe Base64 buffer. </td></tr>
    <tr><td class="paramname">il</td><td>The size of the data in the input buffer. </td></tr>
    <tr><td class="paramname">o</td><td>The output buffer. </td></tr>
    <tr><td class="paramname">ol</td><td>The size of the output buffer. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes that were (or would be) written. If an error occurs, SIZE_MAX is returned. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">json_t* jose_b64_dec_load </td>
          <td>(</td>
          <td class="paramtype">const json_t *&#160;</td>
          <td class="paramname"><em>i</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Decodes a JSON string from a URL-safe Base64 JSON string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">i</td><td>The input URL-safe Base64 JSON string containing JSON data. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The output JSON data. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">json_t* jose_b64_enc </td>
          <td>(</td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>i</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>il</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Encodes data to a URL-safe Base64 JSON string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">i</td><td>The input buffer. </td></tr>
    <tr><td class="paramname">il</td><td>The size of the data in the input buffer. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The decoded JSON data. If an error occurs, NULL is returned. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structjose__io__t.html">jose_io_t</a>* jose_b64_enc_io </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structjose__io__t.html">jose_io_t</a> *&#160;</td>
          <td class="paramname"><em>next</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a new IO object which performs URL-safe Base64 encoding. </p>
<p>All data written to the returned IO object will be encoded before passing it on to the next IO object in the chain.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">next</td><td>The next IO object in the chain. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new IO object or NULL on error. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t jose_b64_enc_buf </td>
          <td>(</td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>i</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>il</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>o</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>ol</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Encodes data to a URL-safe Base64 buffer. </p>
<p>If <code>o</code> is NULL, the number of output bytes necessary is returned.</p>
<p>This function will never write more than <code>ol</code> bytes. If the output buffer is too small, an error will occur.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">i</td><td>The input buffer. </td></tr>
    <tr><td class="paramname">il</td><td>The size of the data in the input buffer. </td></tr>
    <tr><td class="paramname">o</td><td>The output URL-safe Base64 buffer. </td></tr>
    <tr><td class="paramname">ol</td><td>The size of the output buffer. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes that were (or would be) written. If an error occurs, SIZE_MAX is returned. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">json_t* jose_b64_enc_dump </td>
          <td>(</td>
          <td class="paramtype">const json_t *&#160;</td>
          <td class="paramname"><em>i</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Encodes the input JSON as a URL-safe Base64 JSON string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">i</td><td>The input JSON data. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The output URL-safe Base64 JSON string. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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>