Imported Upstream version 4.14.1
[platform/upstream/rpm.git] / doc / librpm / html / rpmbase64_8h_source.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>rpm: rpmbase64.h Source File</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td id="projectalign" style="padding-left: 0.5em;">
21    <div id="projectname">rpm
22    &#160;<span id="projectnumber">4.14.1</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.13 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 $(function() {
35   initMenu('',false,false,'search.php','Search');
36 });
37 </script>
38 <div id="main-nav"></div>
39 <div id="nav-path" class="navpath">
40   <ul>
41 <li class="navelem"><a class="el" href="dir_14c931ba4d22b4eaaf008543ee4d9331.html">rpmio</a></li>  </ul>
42 </div>
43 </div><!-- top -->
44 <div class="header">
45   <div class="headertitle">
46 <div class="title">rpmbase64.h</div>  </div>
47 </div><!--header-->
48 <div class="contents">
49 <a href="rpmbase64_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/* base64 encoder/decoder based on public domain implementation</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * by Chris Venter */</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &lt;sys/types.h&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">/* returns malloced base64 encoded string</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * lines are split with \n characters to be nearest lower multiple of linelen</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * if linelen/4 == 0 lines are not split</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * if linelen &lt; 0 default line length (64) is used</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * the returned string is empty when len == 0</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * returns NULL on failures</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keywordtype">char</span> *<a class="code" href="rpmbase64_8h.html#af34119b8792447e0f6d3a2dc1c33cde8">rpmBase64Encode</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> len, <span class="keywordtype">int</span> linelen);</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">/* decodes from zero terminated base64 encoded string to a newly malloced buffer</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * ignores whitespace characters in the input string</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * return values:</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> *  0 - OK</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> *  1 - input is NULL</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> *  2 - invalid length</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"> *  3 - invalid characters on input</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"> *  4 - malloc failed</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="keywordtype">int</span> <a class="code" href="rpmbase64_8h.html#a6859a851a873b6709d259a3722513e41">rpmBase64Decode</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *in, <span class="keywordtype">void</span> **out, <span class="keywordtype">size_t</span> *outlen);</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">/* counts CRC24 and base64 encodes it in a malloced string</span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"> * returns NULL on failures</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="keywordtype">char</span> *<a class="code" href="rpmbase64_8h.html#a5be699da5ee56c925ba40e067968b67f">rpmBase64CRC</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> len);</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;}</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="rpmbase64_8h_html_a5be699da5ee56c925ba40e067968b67f"><div class="ttname"><a href="rpmbase64_8h.html#a5be699da5ee56c925ba40e067968b67f">rpmBase64CRC</a></div><div class="ttdeci">char * rpmBase64CRC(const unsigned char *data, size_t len)</div></div>
50 <div class="ttc" id="rpmbase64_8h_html_af34119b8792447e0f6d3a2dc1c33cde8"><div class="ttname"><a href="rpmbase64_8h.html#af34119b8792447e0f6d3a2dc1c33cde8">rpmBase64Encode</a></div><div class="ttdeci">char * rpmBase64Encode(const void *data, size_t len, int linelen)</div></div>
51 <div class="ttc" id="rpmbase64_8h_html_a6859a851a873b6709d259a3722513e41"><div class="ttname"><a href="rpmbase64_8h.html#a6859a851a873b6709d259a3722513e41">rpmBase64Decode</a></div><div class="ttdeci">int rpmBase64Decode(const char *in, void **out, size_t *outlen)</div></div>
52 </div><!-- fragment --></div><!-- contents -->
53 <!-- start footer part -->
54 <hr class="footer"/><address class="footer"><small>
55 Generated by &#160;<a href="http://www.doxygen.org/index.html">
56 <img class="footer" src="doxygen.png" alt="doxygen"/>
57 </a> 1.8.13
58 </small></address>
59 </body>
60 </html>