mirror of
https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git
synced 2025-12-29 00:22:19 +01:00
151 lines
No EOL
6.2 KiB
HTML
151 lines
No EOL
6.2 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="generator" content="rustdoc">
|
||
<meta name="description" content="API documentation for the Rust `hkdf` mod in crate `ring`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, hkdf">
|
||
|
||
<title>ring::hkdf - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../normalize.css">
|
||
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc mod">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'>Module hkdf</p><div class="block items"><ul><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>ring</a></p><script>window.sidebarCurrent = {name: 'hkdf', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>ring</a>::<wbr><a class="mod" href=''>hkdf</a></span><span class='out-of-band'><span id='render-detail'>
|
||
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
||
[<span class='inner'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../../src/ring/hkdf.rs.html#15-131' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>HMAC-based Extract-and-Expand Key Derivation Function.</p>
|
||
|
||
<p>HKDF is specified in <a href="https://tools.ietf.org/html/rfc5869">RFC 5869</a>.</p>
|
||
|
||
<p>In most situations, it is best to use <code>extract_and_expand</code> to do both the
|
||
HKDF-Extract and HKDF-Expand as one atomic operation. It is only necessary
|
||
to use the separate <code>expand</code> and <code>extract</code> functions if a single derived
|
||
<code>PRK</code> (defined in RFC 5869) is used more than once.</p>
|
||
|
||
<p>Salts have type <code>hmac::SigningKey</code> instead of <code>&[u8]</code> because they are
|
||
frequently used for multiple HKDF operations, and it is more efficient to
|
||
construct the <code>SigningKey</code> once and reuse it. Given a digest algorithm
|
||
<code>digest_alg</code> and a salt <code>salt: &[u8]</code>, the <code>SigningKey</code> should be
|
||
constructed as <code>hmac::SigningKey::new(digest_alg, salt)</code>.</p>
|
||
</div><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.expand.html"
|
||
title='fn ring::hkdf::expand'>expand</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Fills <code>out</code> with the output of the HKDF-Expand operation for the given
|
||
inputs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.extract.html"
|
||
title='fn ring::hkdf::extract'>extract</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The HKDF-Extract operation.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.extract_and_expand.html"
|
||
title='fn ring::hkdf::extract_and_expand'>extract_and_expand</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Fills <code>out</code> with the output of the HKDF Extract-and-Expand operation for
|
||
the given inputs.</p>
|
||
</td>
|
||
</tr></table></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt>+</dt>
|
||
<dd>Collapse/expand all sections</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../";
|
||
window.currentCrate = "ring";
|
||
</script>
|
||
<script src="../../jquery.js"></script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |