mirror of
https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git
synced 2025-12-28 20:42:18 +01:00
144 lines
No EOL
8.9 KiB
HTML
144 lines
No EOL
8.9 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 `Mac` trait in crate `crypto`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Mac">
|
||
|
||
<title>crypto::mac::Mac - 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 trait">
|
||
<!--[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'>Trait Mac</p><div class="block items"><ul><li><a href="#required-methods">Required Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='../index.html'>crypto</a>::<wbr><a href='index.html'>mac</a></p><script>window.sidebarCurrent = {name: 'Mac', ty: 'trait', 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'>Trait <a href='../index.html'>crypto</a>::<wbr><a href='index.html'>mac</a>::<wbr><a class="trait" href=''>Mac</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/mac.rs.html#16-47' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait Mac {
|
||
fn <a href='#tymethod.input' class='fnname'>input</a>(&mut self, data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>);
|
||
fn <a href='#tymethod.reset' class='fnname'>reset</a>(&mut self);
|
||
fn <a href='#tymethod.result' class='fnname'>result</a>(&mut self) -> <a class="struct" href="../../crypto/mac/struct.MacResult.html" title="struct crypto::mac::MacResult">MacResult</a>;
|
||
fn <a href='#tymethod.raw_result' class='fnname'>raw_result</a>(&mut self, output: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>);
|
||
fn <a href='#tymethod.output_bytes' class='fnname'>output_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
||
}</pre><div class='docblock'><p>The Mac trait defines methods for a Message Authentication function.</p>
|
||
</div>
|
||
<h2 id='required-methods'>Required Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.input' class='method'><span id='input.v' class='invisible'><code>fn <a href='#tymethod.input' class='fnname'>input</a>(&mut self, data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>)</code></span></h3><div class='docblock'><p>Process input data.</p>
|
||
|
||
<h1 id='arguments' class='section-header'><a href='#arguments'>Arguments</a></h1>
|
||
<ul>
|
||
<li>data - The input data to process.</li>
|
||
</ul>
|
||
</div><h3 id='tymethod.reset' class='method'><span id='reset.v' class='invisible'><code>fn <a href='#tymethod.reset' class='fnname'>reset</a>(&mut self)</code></span></h3><div class='docblock'><p>Reset the Mac state to begin processing another input stream.</p>
|
||
</div><h3 id='tymethod.result' class='method'><span id='result.v' class='invisible'><code>fn <a href='#tymethod.result' class='fnname'>result</a>(&mut self) -> <a class="struct" href="../../crypto/mac/struct.MacResult.html" title="struct crypto::mac::MacResult">MacResult</a></code></span></h3><div class='docblock'><p>Obtain the result of a Mac computation as a MacResult.</p>
|
||
</div><h3 id='tymethod.raw_result' class='method'><span id='raw_result.v' class='invisible'><code>fn <a href='#tymethod.raw_result' class='fnname'>raw_result</a>(&mut self, output: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>)</code></span></h3><div class='docblock'><p>Obtain the result of a Mac computation as [u8]. This method should be used very carefully
|
||
since incorrect use of the Mac code could result in permitting a timing attack which defeats
|
||
the security provided by a Mac function.</p>
|
||
</div><h3 id='tymethod.output_bytes' class='method'><span id='output_bytes.v' class='invisible'><code>fn <a href='#tymethod.output_bytes' class='fnname'>output_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h3><div class='docblock'><p>Get the size of the Mac code, in bytes.</p>
|
||
</div></div>
|
||
<h2 id='implementors'>Implementors</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><code>impl Mac for <a class="struct" href="../../crypto/blake2b/struct.Blake2b.html" title="struct crypto::blake2b::Blake2b">Blake2b</a></code></li>
|
||
<li><code>impl Mac for <a class="struct" href="../../crypto/blake2s/struct.Blake2s.html" title="struct crypto::blake2s::Blake2s">Blake2s</a></code></li>
|
||
<li><code>impl Mac for <a class="struct" href="../../crypto/ghash/struct.Ghash.html" title="struct crypto::ghash::Ghash">Ghash</a></code></li>
|
||
<li><code>impl<D: <a class="trait" href="../../crypto/digest/trait.Digest.html" title="trait crypto::digest::Digest">Digest</a>> Mac for <a class="struct" href="../../crypto/hmac/struct.Hmac.html" title="struct crypto::hmac::Hmac">Hmac</a><D></code></li>
|
||
<li><code>impl Mac for <a class="struct" href="../../crypto/poly1305/struct.Poly1305.html" title="struct crypto::poly1305::Poly1305">Poly1305</a></code></li>
|
||
</ul><script type="text/javascript" async
|
||
src="../../implementors/crypto/mac/trait.Mac.js">
|
||
</script></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> |