<!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: pkcs5.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="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pkcs5.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>PKCS#5 functions.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <string.h></code><br/>
<code>#include "<a class="el" href="asn1_8h_source.html">asn1.h</a>"</code><br/>
<code>#include "<a class="el" href="md_8h_source.html">md.h</a>"</code><br/>
<code>#include <inttypes.h></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for pkcs5.h:</div>
<div class="dyncontent">
<div class="center"><img src="pkcs5_8h__incl.png" border="0" usemap="#pkcs5_8h" alt=""/></div>
<map name="pkcs5_8h" id="pkcs5_8h">
</map>
</div>
</div>
<p><a href="pkcs5_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:a5779c8b6dc1e1046e852baf10d54dc2b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#a5779c8b6dc1e1046e852baf10d54dc2b">POLARSSL_ERR_PKCS5_BAD_INPUT_DATA</a>   -0x3f80</td></tr>
<tr class="memdesc:a5779c8b6dc1e1046e852baf10d54dc2b"><td class="mdescLeft"> </td><td class="mdescRight">Bad input parameters to function. <a href="#a5779c8b6dc1e1046e852baf10d54dc2b">More...</a><br/></td></tr>
<tr class="separator:a5779c8b6dc1e1046e852baf10d54dc2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a483cc034a7a2bc96ae1082a89d53c98d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#a483cc034a7a2bc96ae1082a89d53c98d">POLARSSL_ERR_PKCS5_INVALID_FORMAT</a>   -0x3f00</td></tr>
<tr class="memdesc:a483cc034a7a2bc96ae1082a89d53c98d"><td class="mdescLeft"> </td><td class="mdescRight">Unexpected ASN.1 data. <a href="#a483cc034a7a2bc96ae1082a89d53c98d">More...</a><br/></td></tr>
<tr class="separator:a483cc034a7a2bc96ae1082a89d53c98d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae557a501636e406bb37ed5f2c5fd8017"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#ae557a501636e406bb37ed5f2c5fd8017">POLARSSL_ERR_PKCS5_FEATURE_UNAVAILABLE</a>   -0x3e80</td></tr>
<tr class="memdesc:ae557a501636e406bb37ed5f2c5fd8017"><td class="mdescLeft"> </td><td class="mdescRight">Requested encryption or digest alg not available. <a href="#ae557a501636e406bb37ed5f2c5fd8017">More...</a><br/></td></tr>
<tr class="separator:ae557a501636e406bb37ed5f2c5fd8017"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a132ddd530ab43fa4d83923807b389f4a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#a132ddd530ab43fa4d83923807b389f4a">POLARSSL_ERR_PKCS5_PASSWORD_MISMATCH</a>   -0x3e00</td></tr>
<tr class="memdesc:a132ddd530ab43fa4d83923807b389f4a"><td class="mdescLeft"> </td><td class="mdescRight">Given private key password does not allow for correct decryption. <a href="#a132ddd530ab43fa4d83923807b389f4a">More...</a><br/></td></tr>
<tr class="separator:a132ddd530ab43fa4d83923807b389f4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb7e70622c3563f184286355e9408a35"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#abb7e70622c3563f184286355e9408a35">PKCS5_DECRYPT</a>   0</td></tr>
<tr class="separator:abb7e70622c3563f184286355e9408a35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5ad0d9541143890a55d7fc7b72d9709"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#ad5ad0d9541143890a55d7fc7b72d9709">PKCS5_ENCRYPT</a>   1</td></tr>
<tr class="separator:ad5ad0d9541143890a55d7fc7b72d9709"><td class="memSeparator" colspan="2"> </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:a109e9c28efba976ad6af1f702a924be1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#a109e9c28efba976ad6af1f702a924be1">pkcs5_pbes2</a> (<a class="el" href="asn1_8h.html#a494fbc8ee39d97c8118aa420070db04f">asn1_buf</a> *pbe_params, int mode, const unsigned char *pwd, size_t pwdlen, const unsigned char *data, size_t datalen, unsigned char *output)</td></tr>
<tr class="memdesc:a109e9c28efba976ad6af1f702a924be1"><td class="mdescLeft"> </td><td class="mdescRight">PKCS#5 PBES2 function. <a href="#a109e9c28efba976ad6af1f702a924be1">More...</a><br/></td></tr>
<tr class="separator:a109e9c28efba976ad6af1f702a924be1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acbff7ba1c4b49a208efcf8d6f4060153"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#acbff7ba1c4b49a208efcf8d6f4060153">pkcs5_pbkdf2_hmac</a> (<a class="el" href="structmd__context__t.html">md_context_t</a> *ctx, const unsigned char *password, size_t plen, const unsigned char *salt, size_t slen, unsigned int iteration_count, uint32_t key_length, unsigned char *output)</td></tr>
<tr class="memdesc:acbff7ba1c4b49a208efcf8d6f4060153"><td class="mdescLeft"> </td><td class="mdescRight">PKCS#5 PBKDF2 using HMAC. <a href="#acbff7ba1c4b49a208efcf8d6f4060153">More...</a><br/></td></tr>
<tr class="separator:acbff7ba1c4b49a208efcf8d6f4060153"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27acee27c97ca3b9ee3dfb9b88d52a0f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#a27acee27c97ca3b9ee3dfb9b88d52a0f">pkcs5_self_test</a> (int verbose)</td></tr>
<tr class="memdesc:a27acee27c97ca3b9ee3dfb9b88d52a0f"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#a27acee27c97ca3b9ee3dfb9b88d52a0f">More...</a><br/></td></tr>
<tr class="separator:a27acee27c97ca3b9ee3dfb9b88d52a0f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>PKCS#5 functions. </p>
<dl class="section author"><dt>Author</dt><dd>Mathias Olsson <a href="#" onclick="location.href='mai'+'lto:'+'mat'+'hi'+'as@'+'ko'+'mpe'+'te'+'nsu'+'m.'+'com'; return false;">mathi<span style="display: none;">.nosp@m.</span>as@k<span style="display: none;">.nosp@m.</span>ompet<span style="display: none;">.nosp@m.</span>ensu<span style="display: none;">.nosp@m.</span>m.com</a></dd></dl>
<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="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="abb7e70622c3563f184286355e9408a35"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PKCS5_DECRYPT   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pkcs5_8h_source.html#l00049">49</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad5ad0d9541143890a55d7fc7b72d9709"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PKCS5_ENCRYPT   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="pkcs5_8h_source.html#l00050">50</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5779c8b6dc1e1046e852baf10d54dc2b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PKCS5_BAD_INPUT_DATA   -0x3f80</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bad input parameters to function. </p>
<p>Definition at line <a class="el" href="pkcs5_8h_source.html#l00044">44</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae557a501636e406bb37ed5f2c5fd8017"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PKCS5_FEATURE_UNAVAILABLE   -0x3e80</td>
</tr>
</table>
</div><div class="memdoc">
<p>Requested encryption or digest alg not available. </p>
<p>Definition at line <a class="el" href="pkcs5_8h_source.html#l00046">46</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<a class="anchor" id="a483cc034a7a2bc96ae1082a89d53c98d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PKCS5_INVALID_FORMAT   -0x3f00</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unexpected ASN.1 data. </p>
<p>Definition at line <a class="el" href="pkcs5_8h_source.html#l00045">45</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<a class="anchor" id="a132ddd530ab43fa4d83923807b389f4a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_PKCS5_PASSWORD_MISMATCH   -0x3e00</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="pkcs5_8h_source.html#l00047">47</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a109e9c28efba976ad6af1f702a924be1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pkcs5_pbes2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="asn1_8h.html#a494fbc8ee39d97c8118aa420070db04f">asn1_buf</a> * </td>
<td class="paramname"><em>pbe_params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>pwd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>pwdlen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>datalen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>output</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>PKCS#5 PBES2 function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pbe_params</td><td>the ASN.1 algorithm parameters </td></tr>
<tr><td class="paramname">mode</td><td>either PKCS5_DECRYPT or PKCS5_ENCRYPT </td></tr>
<tr><td class="paramname">pwd</td><td>password to use when generating key </td></tr>
<tr><td class="paramname">pwdlen</td><td>length of password </td></tr>
<tr><td class="paramname">data</td><td>data to process </td></tr>
<tr><td class="paramname">datalen</td><td>length of data </td></tr>
<tr><td class="paramname">output</td><td>output buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, or a PolarSSL error code if verification fails. </dd></dl>
</div>
</div>
<a class="anchor" id="acbff7ba1c4b49a208efcf8d6f4060153"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pkcs5_pbkdf2_hmac </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmd__context__t.html">md_context_t</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>password</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>plen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>salt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>slen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>iteration_count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>key_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>output</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>PKCS#5 PBKDF2 using HMAC. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Generic HMAC context </td></tr>
<tr><td class="paramname">password</td><td>Password to use when generating key </td></tr>
<tr><td class="paramname">plen</td><td>Length of password </td></tr>
<tr><td class="paramname">salt</td><td>Salt to use when generating key </td></tr>
<tr><td class="paramname">slen</td><td>Length of salt </td></tr>
<tr><td class="paramname">iteration_count</td><td>Iteration count </td></tr>
<tr><td class="paramname">key_length</td><td>Length of generated key </td></tr>
<tr><td class="paramname">output</td><td>Generated key. Must be at least as big as key_length</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, or a PolarSSL error code if verification fails. </dd></dl>
</div>
</div>
<a class="anchor" id="a27acee27c97ca3b9ee3dfb9b88d52a0f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pkcs5_self_test </td>
<td>(</td>
<td class="paramtype">int </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 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>
