<!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.3: 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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mbed TLS v2.7.3
</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="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 "<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 <stddef.h></code><br />
<code>#include <stdint.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:a12ca62fa36fecf6a6d9d9218601255f7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#a12ca62fa36fecf6a6d9d9218601255f7">MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA</a>   -0x2f80</td></tr>
<tr class="separator:a12ca62fa36fecf6a6d9d9218601255f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1258962a0e536ca372ee144565f108a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#ab1258962a0e536ca372ee144565f108a">MBEDTLS_ERR_PKCS5_INVALID_FORMAT</a>   -0x2f00</td></tr>
<tr class="separator:ab1258962a0e536ca372ee144565f108a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2162372c89339c4a6da1b9d01e08ee90"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#a2162372c89339c4a6da1b9d01e08ee90">MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE</a>   -0x2e80</td></tr>
<tr class="separator:a2162372c89339c4a6da1b9d01e08ee90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb5b742465ef7f4fb9f282880ceecfeb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#adb5b742465ef7f4fb9f282880ceecfeb">MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH</a>   -0x2e00</td></tr>
<tr class="separator:adb5b742465ef7f4fb9f282880ceecfeb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a306c6ad661f0f626dc76769571c84ad1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#a306c6ad661f0f626dc76769571c84ad1">MBEDTLS_PKCS5_DECRYPT</a>   0</td></tr>
<tr class="separator:a306c6ad661f0f626dc76769571c84ad1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8405a6ac15d294e3d9f5efb48284a4ca"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#a8405a6ac15d294e3d9f5efb48284a4ca">MBEDTLS_PKCS5_ENCRYPT</a>   1</td></tr>
<tr class="separator:a8405a6ac15d294e3d9f5efb48284a4ca"><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:aaeb7b4b406e07afe3d8aa807a30d28cd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#aaeb7b4b406e07afe3d8aa807a30d28cd">mbedtls_pkcs5_pbes2</a> (const <a class="el" href="structmbedtls__asn1__buf.html">mbedtls_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:aaeb7b4b406e07afe3d8aa807a30d28cd"><td class="mdescLeft"> </td><td class="mdescRight">PKCS#5 PBES2 function. <a href="#aaeb7b4b406e07afe3d8aa807a30d28cd">More...</a><br /></td></tr>
<tr class="separator:aaeb7b4b406e07afe3d8aa807a30d28cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73ec933de2a4f010604b525640338b1e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#a73ec933de2a4f010604b525640338b1e">mbedtls_pkcs5_pbkdf2_hmac</a> (<a class="el" href="structmbedtls__md__context__t.html">mbedtls_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:a73ec933de2a4f010604b525640338b1e"><td class="mdescLeft"> </td><td class="mdescRight">PKCS#5 PBKDF2 using HMAC. <a href="#a73ec933de2a4f010604b525640338b1e">More...</a><br /></td></tr>
<tr class="separator:a73ec933de2a4f010604b525640338b1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a918e7f20c7ad1204980e7ec69869deb3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="pkcs5_8h.html#a918e7f20c7ad1204980e7ec69869deb3">mbedtls_pkcs5_self_test</a> (int verbose)</td></tr>
<tr class="memdesc:a918e7f20c7ad1204980e7ec69869deb3"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#a918e7f20c7ad1204980e7ec69869deb3">More...</a><br /></td></tr>
<tr class="separator:a918e7f20c7ad1204980e7ec69869deb3"><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 class="definition">Definition in file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a12ca62fa36fecf6a6d9d9218601255f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12ca62fa36fecf6a6d9d9218601255f7">◆ </a></span>MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA   -0x2f80</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bad input parameters to function. </p>
<p class="definition">Definition at line <a class="el" href="pkcs5_8h_source.html#l00035">35</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<a id="a2162372c89339c4a6da1b9d01e08ee90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2162372c89339c4a6da1b9d01e08ee90">◆ </a></span>MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE   -0x2e80</td>
</tr>
</table>
</div><div class="memdoc">
<p>Requested encryption or digest alg not available. </p>
<p class="definition">Definition at line <a class="el" href="pkcs5_8h_source.html#l00037">37</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<a id="ab1258962a0e536ca372ee144565f108a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1258962a0e536ca372ee144565f108a">◆ </a></span>MBEDTLS_ERR_PKCS5_INVALID_FORMAT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_PKCS5_INVALID_FORMAT   -0x2f00</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unexpected ASN.1 data. </p>
<p class="definition">Definition at line <a class="el" href="pkcs5_8h_source.html#l00036">36</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<a id="adb5b742465ef7f4fb9f282880ceecfeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb5b742465ef7f4fb9f282880ceecfeb">◆ </a></span>MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH   -0x2e00</td>
</tr>
</table>
</div><div class="memdoc">
<p>Given private key password does not allow for correct decryption. </p>
<p class="definition">Definition at line <a class="el" href="pkcs5_8h_source.html#l00038">38</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<a id="a306c6ad661f0f626dc76769571c84ad1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a306c6ad661f0f626dc76769571c84ad1">◆ </a></span>MBEDTLS_PKCS5_DECRYPT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_PKCS5_DECRYPT   0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pkcs5_8h_source.html#l00040">40</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<a id="a8405a6ac15d294e3d9f5efb48284a4ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8405a6ac15d294e3d9f5efb48284a4ca">◆ </a></span>MBEDTLS_PKCS5_ENCRYPT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_PKCS5_ENCRYPT   1</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="pkcs5_8h_source.html#l00041">41</a> of file <a class="el" href="pkcs5_8h_source.html">pkcs5.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aaeb7b4b406e07afe3d8aa807a30d28cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaeb7b4b406e07afe3d8aa807a30d28cd">◆ </a></span>mbedtls_pkcs5_pbes2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_pkcs5_pbes2 </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmbedtls__asn1__buf.html">mbedtls_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 MBEDTLS_PKCS5_DECRYPT or MBEDTLS_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 MBEDTLS_ERR_XXX code if verification fails. </dd></dl>
</div>
</div>
<a id="a73ec933de2a4f010604b525640338b1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73ec933de2a4f010604b525640338b1e">◆ </a></span>mbedtls_pkcs5_pbkdf2_hmac()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_pkcs5_pbkdf2_hmac </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__md__context__t.html">mbedtls_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 in bytes </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 MBEDTLS_ERR_XXX code if verification fails. </dd></dl>
</div>
</div>
<a id="a918e7f20c7ad1204980e7ec69869deb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a918e7f20c7ad1204980e7ec69869deb3">◆ </a></span>mbedtls_pkcs5_self_test()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_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 Tue May 8 2018 21:08:41 for mbed TLS v2.7.3 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>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
f835bee5b8b7ec08e20fae17cab51e63
>
files
>
426
