mirror of
https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git
synced 2025-12-28 22:32:18 +01:00
161 lines
No EOL
6.8 KiB
HTML
161 lines
No EOL
6.8 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 `sha3` mod in crate `crypto`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, sha3">
|
||
|
||
<title>crypto::sha3 - 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 sha3</p><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../index.html'>crypto</a></p><script>window.sidebarCurrent = {name: 'sha3', 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'>crypto</a>::<wbr><a class="mod" href=''>sha3</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/crypto/sha3.rs.html#11-6770' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>An implementation of the SHA-3 cryptographic hash algorithms.</p>
|
||
|
||
<p>There are 6 standard algorithms specified in the SHA-3 standard:</p>
|
||
|
||
<ul>
|
||
<li><code>SHA3-224</code></li>
|
||
<li><code>SHA3-256</code></li>
|
||
<li><code>SHA3-384</code></li>
|
||
<li><code>SHA3-512</code></li>
|
||
<li><code>SHAKE128</code>, an extendable output function (XOF)</li>
|
||
<li><code>SHAKE256</code>, an extendable output function (XOF)</li>
|
||
<li><code>Keccak224</code>, <code>Keccak256</code>, <code>Keccak384</code>, <code>Keccak512</code> (NIST submission without padding changes)</li>
|
||
</ul>
|
||
|
||
<p>Based on an <a href="https://github.com/seb-m/crypto.rs/blob/master/src/sha3.rs">implementation by Sébastien Martini</a></p>
|
||
|
||
<h1 id='usage' class='section-header'><a href='#usage'>Usage</a></h1>
|
||
<p>An example of using <code>SHA3-256</code> is:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">crypto</span>::<span class="ident">digest</span>::<span class="ident">Digest</span>;
|
||
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">crypto</span>::<span class="ident">sha3</span>::<span class="ident">Sha3</span>;
|
||
|
||
<span class="comment">// create a SHA3-256 object</span>
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">hasher</span> <span class="op">=</span> <span class="ident">Sha3</span>::<span class="ident">sha3_256</span>();
|
||
|
||
<span class="comment">// write input message</span>
|
||
<span class="ident">hasher</span>.<span class="ident">input_str</span>(<span class="string">"abc"</span>);
|
||
|
||
<span class="comment">// read hash digest</span>
|
||
<span class="kw">let</span> <span class="ident">hex</span> <span class="op">=</span> <span class="ident">hasher</span>.<span class="ident">result_str</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">hex</span>, <span class="string">"3a985da74fe225b2045c172d6bd390bd855f086e3e9d525b46bfe24511431532"</span>);</pre>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Sha3.html"
|
||
title='struct crypto::sha3::Sha3'>Sha3</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.Sha3Mode.html"
|
||
title='enum crypto::sha3::Sha3Mode'>Sha3Mode</a></td>
|
||
<td class='docblock-short'>
|
||
<p>SHA-3 Modes.</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 = "crypto";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |