<!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.6: pem.h Source File</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.6 </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="headertitle"> <div class="title">pem.h</div> </div> </div><!--header--> <div class="contents"> <a href="pem_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> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/*</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * SPDX-License-Identifier: Apache-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * not use this file except in compliance with the License.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * This file is part of mbed TLS (https://tls.mbed.org)</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef MBEDTLS_PEM_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define MBEDTLS_PEM_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <stddef.h></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="pem_8h.html#a9fca39bb5d4a6845239221a53685a2dc"> 35</a></span> <span class="preprocessor">#define MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT -0x1080 </span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="pem_8h.html#a820cf2ffc66f354f3d8f621cac7b4eda"> 36</a></span> <span class="preprocessor">#define MBEDTLS_ERR_PEM_INVALID_DATA -0x1100 </span></div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="pem_8h.html#a97ca9753a0adeb688b3093506c60a41e"> 37</a></span> <span class="preprocessor">#define MBEDTLS_ERR_PEM_ALLOC_FAILED -0x1180 </span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="pem_8h.html#a7709c4b0616a4d6ec0184204ace4d4b3"> 38</a></span> <span class="preprocessor">#define MBEDTLS_ERR_PEM_INVALID_ENC_IV -0x1200 </span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="pem_8h.html#a28b7a955389ec2e9a8b7a7d3f13ad746"> 39</a></span> <span class="preprocessor">#define MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG -0x1280 </span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="pem_8h.html#ab883990c7b4a373519ab3b25ec945cd8"> 40</a></span> <span class="preprocessor">#define MBEDTLS_ERR_PEM_PASSWORD_REQUIRED -0x1300 </span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="pem_8h.html#aea98f44a528310c53398a49c90469861"> 41</a></span> <span class="preprocessor">#define MBEDTLS_ERR_PEM_PASSWORD_MISMATCH -0x1380 </span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="pem_8h.html#a58b1dec72e6a2586a1bda819ea768ad1"> 42</a></span> <span class="preprocessor">#define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE -0x1400 </span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="pem_8h.html#a5db6f46565c6078d041253c3a00d2ae6"> 43</a></span> <span class="preprocessor">#define MBEDTLS_ERR_PEM_BAD_INPUT_DATA -0x1480 </span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span><span class="comment">/* \} name */</span><span class="preprocessor"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#if defined(MBEDTLS_PEM_PARSE_C)</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf; </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">size_t</span> buflen; </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *info; </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> mbedtls_pem_context;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">void</span> mbedtls_pem_init( mbedtls_pem_context *ctx );</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">int</span> mbedtls_pem_read_buffer( mbedtls_pem_context *ctx, <span class="keyword">const</span> <span class="keywordtype">char</span> *header, <span class="keyword">const</span> <span class="keywordtype">char</span> *footer,</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data,</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *pwd,</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">size_t</span> pwdlen, <span class="keywordtype">size_t</span> *use_len );</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">void</span> mbedtls_pem_free( mbedtls_pem_context *ctx );</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#endif </span><span class="comment">/* MBEDTLS_PEM_PARSE_C */</span><span class="preprocessor"></span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">#if defined(MBEDTLS_PEM_WRITE_C)</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keywordtype">int</span> mbedtls_pem_write_buffer( <span class="keyword">const</span> <span class="keywordtype">char</span> *header, <span class="keyword">const</span> <span class="keywordtype">char</span> *footer,</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *der_data, <span class="keywordtype">size_t</span> der_len,</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> buf_len, <span class="keywordtype">size_t</span> *olen );</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#endif </span><span class="comment">/* MBEDTLS_PEM_WRITE_C */</span><span class="preprocessor"></span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> }</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor">#endif </span><span class="comment">/* pem.h */</span><span class="preprocessor"></span></div></div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Oct 12 2018 20:26:59 for mbed TLS v2.7.6 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.13 </small></address> </body> </html>