mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-31 14:24:01 +01:00
75 lines
13 KiB
HTML
75 lines
13 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="HMAC is specified in RFC 2104."><title>ring::hmac - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ring" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../ring/index.html">ring</a><span class="version">0.16.20</span></h2></div><h2 class="location"><a href="#">Module hmac</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#statics">Statics</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crate ring</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../ring/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">ring</a>::<wbr><a class="mod" href="#">hmac</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/ring/hmac.rs.html#15-385">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>HMAC is specified in <a href="https://tools.ietf.org/html/rfc2104">RFC 2104</a>.</p>
|
||
<p>After a <code>Key</code> is constructed, it can be used for multiple signing or
|
||
verification operations. Separating the construction of the key from the
|
||
rest of the HMAC operation allows the per-key precomputation to be done
|
||
only once, instead of it being done in every HMAC operation.</p>
|
||
<p>Frequently all the data to be signed in a message is available in a single
|
||
contiguous piece. In that case, the module-level <code>sign</code> function can be
|
||
used. Otherwise, if the input is in multiple parts, <code>Context</code> should be
|
||
used.</p>
|
||
<h2 id="examples"><a href="#examples">Examples:</a></h2><h3 id="signing-a-value-and-verifying-it-wasnt-tampered-with"><a href="#signing-a-value-and-verifying-it-wasnt-tampered-with">Signing a value and verifying it wasn’t tampered with</a></h3>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ring::{hmac, rand};
|
||
|
||
<span class="kw">let </span>rng = rand::SystemRandom::new();
|
||
<span class="kw">let </span>key = hmac::Key::generate(hmac::HMAC_SHA256, <span class="kw-2">&</span>rng)<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">let </span>msg = <span class="string">"hello, world"</span>;
|
||
|
||
<span class="kw">let </span>tag = hmac::sign(<span class="kw-2">&</span>key, msg.as_bytes());
|
||
|
||
<span class="comment">// [We give access to the message to an untrusted party, and they give it
|
||
// back to us. We need to verify they didn't tamper with it.]
|
||
|
||
</span>hmac::verify(<span class="kw-2">&</span>key, msg.as_bytes(), tag.as_ref())<span class="question-mark">?</span>;
|
||
</code></pre></div>
|
||
<h3 id="using-the-one-shot-api"><a href="#using-the-one-shot-api">Using the one-shot API:</a></h3>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ring::{digest, hmac, rand};
|
||
<span class="kw">use </span>ring::rand::SecureRandom;
|
||
|
||
<span class="kw">let </span>msg = <span class="string">"hello, world"</span>;
|
||
|
||
<span class="comment">// The sender generates a secure key value and signs the message with it.
|
||
// Note that in a real protocol, a key agreement protocol would be used to
|
||
// derive `key_value`.
|
||
</span><span class="kw">let </span>rng = rand::SystemRandom::new();
|
||
<span class="kw">let </span>key_value: [u8; digest::SHA256_OUTPUT_LEN] = rand::generate(<span class="kw-2">&</span>rng)<span class="question-mark">?</span>.expose();
|
||
|
||
<span class="kw">let </span>s_key = hmac::Key::new(hmac::HMAC_SHA256, key_value.as_ref());
|
||
<span class="kw">let </span>tag = hmac::sign(<span class="kw-2">&</span>s_key, msg.as_bytes());
|
||
|
||
<span class="comment">// The receiver (somehow!) knows the key value, and uses it to verify the
|
||
// integrity of the message.
|
||
</span><span class="kw">let </span>v_key = hmac::Key::new(hmac::HMAC_SHA256, key_value.as_ref());
|
||
hmac::verify(<span class="kw-2">&</span>v_key, msg.as_bytes(), tag.as_ref())<span class="question-mark">?</span>;
|
||
</code></pre></div>
|
||
<h3 id="using-the-multi-part-api"><a href="#using-the-multi-part-api">Using the multi-part API:</a></h3>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ring::{digest, hmac, rand};
|
||
<span class="kw">use </span>ring::rand::SecureRandom;
|
||
|
||
<span class="kw">let </span>parts = [<span class="string">"hello"</span>, <span class="string">", "</span>, <span class="string">"world"</span>];
|
||
|
||
<span class="comment">// The sender generates a secure key value and signs the message with it.
|
||
// Note that in a real protocol, a key agreement protocol would be used to
|
||
// derive `key_value`.
|
||
</span><span class="kw">let </span>rng = rand::SystemRandom::new();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>key_value: [u8; digest::SHA384_OUTPUT_LEN] = rand::generate(<span class="kw-2">&</span>rng)<span class="question-mark">?</span>.expose();
|
||
|
||
<span class="kw">let </span>s_key = hmac::Key::new(hmac::HMAC_SHA384, key_value.as_ref());
|
||
<span class="kw">let </span><span class="kw-2">mut </span>s_ctx = hmac::Context::with_key(<span class="kw-2">&</span>s_key);
|
||
<span class="kw">for </span>part <span class="kw">in </span><span class="kw-2">&</span>parts {
|
||
s_ctx.update(part.as_bytes());
|
||
}
|
||
<span class="kw">let </span>tag = s_ctx.sign();
|
||
|
||
<span class="comment">// The receiver (somehow!) knows the key value, and uses it to verify the
|
||
// integrity of the message.
|
||
</span><span class="kw">let </span>v_key = hmac::Key::new(hmac::HMAC_SHA384, key_value.as_ref());
|
||
<span class="kw">let </span><span class="kw-2">mut </span>msg = Vec::<u8>::new();
|
||
<span class="kw">for </span>part <span class="kw">in </span><span class="kw-2">&</span>parts {
|
||
msg.extend(part.as_bytes());
|
||
}
|
||
hmac::verify(<span class="kw-2">&</span>v_key, <span class="kw-2">&</span>msg.as_ref(), tag.as_ref())<span class="question-mark">?</span>;
|
||
</code></pre></div>
|
||
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Algorithm.html" title="struct ring::hmac::Algorithm">Algorithm</a></div><div class="desc docblock-short">An HMAC algorithm.</div></li><li><div class="item-name"><a class="struct" href="struct.Context.html" title="struct ring::hmac::Context">Context</a></div><div class="desc docblock-short">A context for multi-step (Init-Update-Finish) HMAC signing.</div></li><li><div class="item-name"><a class="struct" href="struct.Key.html" title="struct ring::hmac::Key">Key</a></div><div class="desc docblock-short">A key to use for HMAC signing.</div></li><li><div class="item-name"><a class="struct" href="struct.Tag.html" title="struct ring::hmac::Tag">Tag</a></div><div class="desc docblock-short">An HMAC tag.</div></li></ul><h2 id="statics" class="section-header"><a href="#statics">Statics</a></h2><ul class="item-table"><li><div class="item-name"><a class="static" href="static.HMAC_SHA1_FOR_LEGACY_USE_ONLY.html" title="static ring::hmac::HMAC_SHA1_FOR_LEGACY_USE_ONLY">HMAC_SHA1_FOR_LEGACY_USE_ONLY</a></div><div class="desc docblock-short">HMAC using SHA-1. Obsolete.</div></li><li><div class="item-name"><a class="static" href="static.HMAC_SHA256.html" title="static ring::hmac::HMAC_SHA256">HMAC_SHA256</a></div><div class="desc docblock-short">HMAC using SHA-256.</div></li><li><div class="item-name"><a class="static" href="static.HMAC_SHA384.html" title="static ring::hmac::HMAC_SHA384">HMAC_SHA384</a></div><div class="desc docblock-short">HMAC using SHA-384.</div></li><li><div class="item-name"><a class="static" href="static.HMAC_SHA512.html" title="static ring::hmac::HMAC_SHA512">HMAC_SHA512</a></div><div class="desc docblock-short">HMAC using SHA-512.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.sign.html" title="fn ring::hmac::sign">sign</a></div><div class="desc docblock-short">Calculates the HMAC of <code>data</code> using the key <code>key</code> in one step.</div></li><li><div class="item-name"><a class="fn" href="fn.verify.html" title="fn ring::hmac::verify">verify</a></div><div class="desc docblock-short">Calculates the HMAC of <code>data</code> using the signing key <code>key</code>, and verifies
|
||
whether the resultant value equals <code>tag</code>, in one step.</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Signature.html" title="type ring::hmac::Signature">Signature</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">A deprecated alias for <code>Tag</code>.</div></li><li><div class="item-name"><a class="type" href="type.SigningContext.html" title="type ring::hmac::SigningContext">SigningContext</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short"><code>hmac::SigningContext</code> was renamed to <code>hmac::Context</code>.</div></li><li><div class="item-name"><a class="type" href="type.SigningKey.html" title="type ring::hmac::SigningKey">SigningKey</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short"><code>hmac::SigningKey</code> was renamed to <code>hmac::Key</code>.</div></li><li><div class="item-name"><a class="type" href="type.VerificationKey.html" title="type ring::hmac::VerificationKey">VerificationKey</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short"><code>hmac::VerificationKey</code> was merged into <code>hmac::Key</code>.</div></li></ul></section></div></main></body></html> |