<!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: pem.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="headertitle">
<div class="title">pem.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Privacy Enhanced Mail (PEM) 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 pem.h:</div>
<div class="dyncontent">
<div class="center"><img src="pem_8h__incl.png" border="0" usemap="#pem_8h" alt=""/></div>
<map name="pem_8h" id="pem_8h">
</map>
</div>
</div>
<p><a href="pem_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><td colspan="2"><div class="groupHeader">PEM Error codes</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>These error codes are returned in case of errors reading the PEM data. </p>
</div></td></tr>
<tr class="memitem:aba55809b3ae6781d4ab92ccdfbe54a9c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pem_8h.html#aba55809b3ae6781d4ab92ccdfbe54a9c">POLARSSL_ERR_PEM_NO_HEADER_FOOTER_PRESENT</a>   -0x1080</td></tr>
<tr class="memdesc:aba55809b3ae6781d4ab92ccdfbe54a9c"><td class="mdescLeft"> </td><td class="mdescRight">No PEM header or footer found. <a href="#aba55809b3ae6781d4ab92ccdfbe54a9c">More...</a><br/></td></tr>
<tr class="separator:aba55809b3ae6781d4ab92ccdfbe54a9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf162457129ad95e973e02b4c72effdc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pem_8h.html#abf162457129ad95e973e02b4c72effdc">POLARSSL_ERR_PEM_INVALID_DATA</a>   -0x1100</td></tr>
<tr class="memdesc:abf162457129ad95e973e02b4c72effdc"><td class="mdescLeft"> </td><td class="mdescRight">PEM string is not as expected. <a href="#abf162457129ad95e973e02b4c72effdc">More...</a><br/></td></tr>
<tr class="separator:abf162457129ad95e973e02b4c72effdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5881696f05e65e7aa94883c933917f5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pem_8h.html#aa5881696f05e65e7aa94883c933917f5">POLARSSL_ERR_PEM_MALLOC_FAILED</a>   -0x1180</td></tr>
<tr class="memdesc:aa5881696f05e65e7aa94883c933917f5"><td class="mdescLeft"> </td><td class="mdescRight">Failed to allocate memory. <a href="#aa5881696f05e65e7aa94883c933917f5">More...</a><br/></td></tr>
<tr class="separator:aa5881696f05e65e7aa94883c933917f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee09ae2e237315b0fa0ad7071f07abcf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pem_8h.html#aee09ae2e237315b0fa0ad7071f07abcf">POLARSSL_ERR_PEM_INVALID_ENC_IV</a>   -0x1200</td></tr>
<tr class="memdesc:aee09ae2e237315b0fa0ad7071f07abcf"><td class="mdescLeft"> </td><td class="mdescRight">RSA IV is not in hex-format. <a href="#aee09ae2e237315b0fa0ad7071f07abcf">More...</a><br/></td></tr>
<tr class="separator:aee09ae2e237315b0fa0ad7071f07abcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8094fdb48782e6b5ffeebc8912f94597"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pem_8h.html#a8094fdb48782e6b5ffeebc8912f94597">POLARSSL_ERR_PEM_UNKNOWN_ENC_ALG</a>   -0x1280</td></tr>
<tr class="memdesc:a8094fdb48782e6b5ffeebc8912f94597"><td class="mdescLeft"> </td><td class="mdescRight">Unsupported key encryption algorithm. <a href="#a8094fdb48782e6b5ffeebc8912f94597">More...</a><br/></td></tr>
<tr class="separator:a8094fdb48782e6b5ffeebc8912f94597"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc5d820a2b2e902f0761de2172cc3ad4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pem_8h.html#afc5d820a2b2e902f0761de2172cc3ad4">POLARSSL_ERR_PEM_PASSWORD_REQUIRED</a>   -0x1300</td></tr>
<tr class="memdesc:afc5d820a2b2e902f0761de2172cc3ad4"><td class="mdescLeft"> </td><td class="mdescRight">Private key password can't be empty. <a href="#afc5d820a2b2e902f0761de2172cc3ad4">More...</a><br/></td></tr>
<tr class="separator:afc5d820a2b2e902f0761de2172cc3ad4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa950405345e1ae27eb5f7c91f3be1f04"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pem_8h.html#aa950405345e1ae27eb5f7c91f3be1f04">POLARSSL_ERR_PEM_PASSWORD_MISMATCH</a>   -0x1380</td></tr>
<tr class="memdesc:aa950405345e1ae27eb5f7c91f3be1f04"><td class="mdescLeft"> </td><td class="mdescRight">Given private key password does not allow for correct decryption. <a href="#aa950405345e1ae27eb5f7c91f3be1f04">More...</a><br/></td></tr>
<tr class="separator:aa950405345e1ae27eb5f7c91f3be1f04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a944af87c629fac2a22082a49be42ae3e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pem_8h.html#a944af87c629fac2a22082a49be42ae3e">POLARSSL_ERR_PEM_FEATURE_UNAVAILABLE</a>   -0x1400</td></tr>
<tr class="memdesc:a944af87c629fac2a22082a49be42ae3e"><td class="mdescLeft"> </td><td class="mdescRight">Unavailable feature, e.g. <a href="#a944af87c629fac2a22082a49be42ae3e">More...</a><br/></td></tr>
<tr class="separator:a944af87c629fac2a22082a49be42ae3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae178eb5fe3590fc7bb43c16ba1874c2f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pem_8h.html#ae178eb5fe3590fc7bb43c16ba1874c2f">POLARSSL_ERR_PEM_BAD_INPUT_DATA</a>   -0x1480</td></tr>
<tr class="memdesc:ae178eb5fe3590fc7bb43c16ba1874c2f"><td class="mdescLeft"> </td><td class="mdescRight">Bad input parameters to function. <a href="#ae178eb5fe3590fc7bb43c16ba1874c2f">More...</a><br/></td></tr>
<tr class="separator:ae178eb5fe3590fc7bb43c16ba1874c2f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Privacy Enhanced Mail (PEM) 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="pem_8h_source.html">pem.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ae178eb5fe3590fc7bb43c16ba1874c2f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PEM_BAD_INPUT_DATA   -0x1480</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bad input parameters to function. </p>
<p>Definition at line <a class="el" href="pem_8h_source.html#l00046">46</a> of file <a class="el" href="pem_8h_source.html">pem.h</a>.</p>
</div>
</div>
<a class="anchor" id="a944af87c629fac2a22082a49be42ae3e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PEM_FEATURE_UNAVAILABLE   -0x1400</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unavailable feature, e.g. </p>
<p>hashing/encryption combination. </p>
<p>Definition at line <a class="el" href="pem_8h_source.html#l00045">45</a> of file <a class="el" href="pem_8h_source.html">pem.h</a>.</p>
</div>
</div>
<a class="anchor" id="abf162457129ad95e973e02b4c72effdc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PEM_INVALID_DATA   -0x1100</td>
</tr>
</table>
</div><div class="memdoc">
<p>PEM string is not as expected. </p>
<p>Definition at line <a class="el" href="pem_8h_source.html#l00039">39</a> of file <a class="el" href="pem_8h_source.html">pem.h</a>.</p>
</div>
</div>
<a class="anchor" id="aee09ae2e237315b0fa0ad7071f07abcf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PEM_INVALID_ENC_IV   -0x1200</td>
</tr>
</table>
</div><div class="memdoc">
<p>RSA IV is not in hex-format. </p>
<p>Definition at line <a class="el" href="pem_8h_source.html#l00041">41</a> of file <a class="el" href="pem_8h_source.html">pem.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa5881696f05e65e7aa94883c933917f5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PEM_MALLOC_FAILED   -0x1180</td>
</tr>
</table>
</div><div class="memdoc">
<p>Failed to allocate memory. </p>
<p>Definition at line <a class="el" href="pem_8h_source.html#l00040">40</a> of file <a class="el" href="pem_8h_source.html">pem.h</a>.</p>
</div>
</div>
<a class="anchor" id="aba55809b3ae6781d4ab92ccdfbe54a9c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PEM_NO_HEADER_FOOTER_PRESENT   -0x1080</td>
</tr>
</table>
</div><div class="memdoc">
<p>No PEM header or footer found. </p>
<p>Definition at line <a class="el" href="pem_8h_source.html#l00038">38</a> of file <a class="el" href="pem_8h_source.html">pem.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa950405345e1ae27eb5f7c91f3be1f04"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PEM_PASSWORD_MISMATCH   -0x1380</td>
</tr>
</table>
</div><div class="memdoc">
<p>Given private key password does not allow for correct decryption. </p>
<p>Definition at line <a class="el" href="pem_8h_source.html#l00044">44</a> of file <a class="el" href="pem_8h_source.html">pem.h</a>.</p>
</div>
</div>
<a class="anchor" id="afc5d820a2b2e902f0761de2172cc3ad4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PEM_PASSWORD_REQUIRED   -0x1300</td>
</tr>
</table>
</div><div class="memdoc">
<p>Private key password can't be empty. </p>
<p>Definition at line <a class="el" href="pem_8h_source.html#l00043">43</a> of file <a class="el" href="pem_8h_source.html">pem.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8094fdb48782e6b5ffeebc8912f94597"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PEM_UNKNOWN_ENC_ALG   -0x1280</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unsupported key encryption algorithm. </p>
<p>Definition at line <a class="el" href="pem_8h_source.html#l00042">42</a> of file <a class="el" href="pem_8h_source.html">pem.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:56 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>
