<!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/html; charset=utf-8" />
<title>Key Derivation Functions — Botan</title>
<link rel="stylesheet" href="_static/agogo.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.10.17',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="Botan" href="contents.html" />
<link rel="next" title="PBKDF Algorithms" href="pbkdf.html" />
<link rel="prev" title="Secure Memory Containers" href="secmem.html" />
</head>
<body role="document">
<div class="header-wrapper">
<div class="header">
<h1>Botan</h1>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="key-derivation-functions">
<span id="key-derivation-function"></span><h1>Key Derivation Functions<a class="headerlink" href="#key-derivation-functions" title="Permalink to this headline">¶</a></h1>
<p>Key derivation functions are used to turn some amount of shared secret
material into uniform random keys suitable for use with symmetric
algorithms. An example of an input which is useful for a KDF is a
shared secret created using Diffie-Hellman key agreement.</p>
<dl class="class">
<dt id="_CPPv23KDF">
<span id="KDF"></span><em class="property">class </em><code class="descclassname"></code><code class="descname">KDF</code><a class="headerlink" href="#_CPPv23KDF" title="Permalink to this definition">¶</a></dt>
<dd><dl class="function">
<dt id="_CPPv2NK3KDF10derive_keyE6size_tRK12MemoryRegionI4byteERKNSt6stringE">
<span id="KDF::derive_key__s.MemoryRegion:byte:CR.ssCRC"></span>SecureVector<byte> <code class="descclassname"></code><code class="descname">derive_key</code><span class="sig-paren">(</span>size_t <em>key_len</em>, <em class="property">const</em> MemoryRegion<byte> &<em>secret</em>, <em class="property">const</em> std::string &<em>salt</em> = ""<span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv2NK3KDF10derive_keyE6size_tRK12MemoryRegionI4byteERKNSt6stringE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="_CPPv2NK3KDF10derive_keyE6size_tRK12MemoryRegionI4byteERK12MemoryRegionI4byteE">
<span id="KDF::derive_key__s.MemoryRegion:byte:CR.MemoryRegion:byte:CRC"></span>SecureVector<byte> <code class="descclassname"></code><code class="descname">derive_key</code><span class="sig-paren">(</span>size_t <em>key_len</em>, <em class="property">const</em> MemoryRegion<byte> &<em>secret</em>, <em class="property">const</em> MemoryRegion<byte> &<em>salt</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv2NK3KDF10derive_keyE6size_tRK12MemoryRegionI4byteERK12MemoryRegionI4byteE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="_CPPv2NK3KDF10derive_keyE6size_tRK12MemoryRegionI4byteEPK4byte6size_t">
<span id="KDF::derive_key__s.MemoryRegion:byte:CR.byteCP.sC"></span>SecureVector<byte> <code class="descclassname"></code><code class="descname">derive_key</code><span class="sig-paren">(</span>size_t <em>key_len</em>, <em class="property">const</em> MemoryRegion<byte> &<em>secret</em>, <em class="property">const</em> byte *<em>salt</em>, size_t <em>salt_len</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv2NK3KDF10derive_keyE6size_tRK12MemoryRegionI4byteEPK4byte6size_t" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="_CPPv2NK3KDF10derive_keyE6size_tPK4byte6size_tRKNSt6stringE">
<span id="KDF::derive_key__s.byteCP.s.ssCRC"></span>SecureVector<byte> <code class="descclassname"></code><code class="descname">derive_key</code><span class="sig-paren">(</span>size_t <em>key_len</em>, <em class="property">const</em> byte *<em>secret</em>, size_t <em>secret_len</em>, <em class="property">const</em> std::string &<em>salt</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv2NK3KDF10derive_keyE6size_tPK4byte6size_tRKNSt6stringE" title="Permalink to this definition">¶</a></dt>
<dd><p>All variations on the same theme. Deterministically creates a
uniform random value from <em>secret</em> and <em>salt</em>. Typically <em>salt</em> is
a lable or identifier, such as a session id.</p>
</dd></dl>
</dd></dl>
<p>You can create a <a class="reference internal" href="#_CPPv23KDF" title="KDF"><code class="xref cpp cpp-class docutils literal"><span class="pre">KDF</span></code></a> using</p>
<dl class="function">
<dt id="_CPPv27get_kdfRKNSt6stringE">
<span id="get_kdf__ssCR"></span><a class="reference internal" href="#_CPPv23KDF" title="KDF">KDF</a> *<code class="descclassname"></code><code class="descname">get_kdf</code><span class="sig-paren">(</span><em class="property">const</em> std::string &<em>algo_spec</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv27get_kdfRKNSt6stringE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sidebar">
<h3>Table Of Contents</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Welcome</a></li>
<li class="toctree-l1"><a class="reference internal" href="reading.html">Recommended Reading</a></li>
<li class="toctree-l1"><a class="reference internal" href="building.html">Building The Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="firststep.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="filters.html">Information Flow: Pipes and Filters</a></li>
<li class="toctree-l1"><a class="reference internal" href="pubkey.html">Public Key Cryptography</a></li>
<li class="toctree-l1"><a class="reference internal" href="x509.html">Certificate Handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssl.html">SSL and TLS</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigint.html">BigInt</a></li>
<li class="toctree-l1"><a class="reference internal" href="lowlevel.html">The Low-Level Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="secmem.html">Secure Memory Containers</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Key Derivation Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="pbkdf.html">PBKDF Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="passhash.html">Password Hashing</a></li>
<li class="toctree-l1"><a class="reference internal" href="rng.html">Random Number Generators</a></li>
<li class="toctree-l1"><a class="reference internal" href="fpe.html">Format Preserving Encryption</a></li>
<li class="toctree-l1"><a class="reference internal" href="python.html">Python Binding</a></li>
</ul>
<div role="search">
<h3 style="margin-top: 1.5em;">Search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<div role="navigation" aria-label="related navigaton">
<a href="secmem.html" title="Secure Memory Containers"
accesskey="P">previous</a> |
<a href="pbkdf.html" title="PBKDF Algorithms"
accesskey="N">next</a> |
<a href="genindex.html" title="General Index"
accesskey="I">index</a>
</div>
<div role="note" aria-label="source link">
<br/>
<a href="_sources/kdf.txt"
rel="nofollow">Show Source</a>
</div>
</div>
<div class="right">
<div class="footer" role="contentinfo">
© Copyright 2000-2011, Jack Lloyd.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</body>
</html>
