blob: c7762ea3dbb3bffa274a170d53171cab2d9e3f7d [file] [log] [blame]
<!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="Message digest (hash) computation support."><meta name="keywords" content="rust, rustlang, rust-lang, hash"><title>openssl::hash - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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">&#9776;</button><a class="sidebar-logo" href="../../openssl/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../openssl/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module hash</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">openssl</a>::<wbr><a class="mod" href="#">hash</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/openssl/hash.rs.html#1-800">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Message digest (hash) computation support.</p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
<p>Calculate a hash in one go:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::hash::{hash, MessageDigest};
<span class="kw">let </span>data = <span class="string">b&quot;\x42\xF4\x97\xE0&quot;</span>;
<span class="kw">let </span>spec = <span class="string">b&quot;\x7c\x43\x0f\x17\x8a\xef\xdf\x14\x87\xfe\xe7\x14\x4e\x96\x41\xe2&quot;</span>;
<span class="kw">let </span>res = hash(MessageDigest::md5(), data)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;*</span>res, spec);</code></pre></div>
<p>Supply the input in chunks:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::hash::{Hasher, MessageDigest};
<span class="kw">let </span><span class="kw-2">mut </span>hasher = Hasher::new(MessageDigest::sha256())<span class="question-mark">?</span>;
hasher.update(<span class="string">b&quot;test&quot;</span>)<span class="question-mark">?</span>;
hasher.update(<span class="string">b&quot;this&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>digest: <span class="kw-2">&amp;</span>[u8] = <span class="kw-2">&amp;</span>hasher.finish()<span class="question-mark">?</span>;
<span class="kw">let </span>expected = hex::decode(<span class="string">&quot;9740e652ab5b4acd997a7cca13d6696702ccb2d441cca59fc6e285127f28cfe6&quot;</span>)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(digest, expected);</code></pre></div>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DigestBytes.html" title="openssl::hash::DigestBytes struct">DigestBytes</a></div><div class="item-right docblock-short">The resulting bytes of a digest.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Hasher.html" title="openssl::hash::Hasher struct">Hasher</a></div><div class="item-right docblock-short">Provides message digest (hash) computation.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MessageDigest.html" title="openssl::hash::MessageDigest struct">MessageDigest</a></div><div class="item-right docblock-short">A message digest algorithm.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.hash.html" title="openssl::hash::hash fn">hash</a></div><div class="item-right docblock-short">Computes the hash of the <code>data</code> with the non-XOF hasher <code>t</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.hash_xof.html" title="openssl::hash::hash_xof fn">hash_xof</a></div><div class="item-right docblock-short">Computes the hash of the <code>data</code> with the XOF hasher <code>t</code> and stores it in <code>buf</code>.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="openssl" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>