| <!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="The SHA family of hashes."><meta name="keywords" content="rust, rustlang, rust-lang, sha"><title>openssl::sha - 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">☰</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 sha</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="#">sha</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/sha.rs.html#1-463">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The SHA family of hashes.</p> |
| <p>SHA, or Secure Hash Algorithms, are a family of cryptographic hashing algorithms published by |
| the National Institute of Standards and Technology (NIST). Hash algorithms such as those in |
| the SHA family are used to map data of an arbitrary size to a fixed-size string of bytes. |
| As cryptographic hashing algorithms, these mappings have the property of being irreversible. |
| This property makes hash algorithms like these excellent for uses such as verifying the |
| contents of a file- if you know the hash you expect beforehand, then you can verify that the |
| data you have is correct if it hashes to the same value.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <p>When dealing with data that becomes available in chunks, such as while buffering data from IO, |
| you can create a hasher that you can repeatedly update to add bytes to.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::sha; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>hasher = sha::Sha256::new(); |
| |
| hasher.update(<span class="string">b"Hello, "</span>); |
| hasher.update(<span class="string">b"world"</span>); |
| |
| <span class="kw">let </span>hash = hasher.finish(); |
| <span class="macro">println!</span>(<span class="string">"Hashed \"Hello, world\" to {}"</span>, hex::encode(hash));</code></pre></div> |
| <p>On the other hand, if you already have access to all of the data you would like to hash, you |
| may prefer to use the slightly simpler method of simply calling the hash function corresponding |
| to the algorithm you want to use.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::sha::sha256; |
| |
| <span class="kw">let </span>hash = sha256(<span class="string">b"your data or message"</span>); |
| <span class="macro">println!</span>(<span class="string">"Hash = {}"</span>, hex::encode(hash));</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.Sha1.html" title="openssl::sha::Sha1 struct">Sha1</a></div><div class="item-right docblock-short">An object which calculates a SHA1 hash of some data.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Sha224.html" title="openssl::sha::Sha224 struct">Sha224</a></div><div class="item-right docblock-short">An object which calculates a SHA224 hash of some data.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Sha256.html" title="openssl::sha::Sha256 struct">Sha256</a></div><div class="item-right docblock-short">An object which calculates a SHA256 hash of some data.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Sha384.html" title="openssl::sha::Sha384 struct">Sha384</a></div><div class="item-right docblock-short">An object which calculates a SHA384 hash of some data.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Sha512.html" title="openssl::sha::Sha512 struct">Sha512</a></div><div class="item-right docblock-short">An object which calculates a SHA512 hash of some data.</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.sha1.html" title="openssl::sha::sha1 fn">sha1</a></div><div class="item-right docblock-short">Computes the SHA1 hash of some data.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sha224.html" title="openssl::sha::sha224 fn">sha224</a></div><div class="item-right docblock-short">Computes the SHA224 hash of some data.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sha256.html" title="openssl::sha::sha256 fn">sha256</a></div><div class="item-right docblock-short">Computes the SHA256 hash of some data.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sha384.html" title="openssl::sha::sha384 fn">sha384</a></div><div class="item-right docblock-short">Computes the SHA384 hash of some data.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sha512.html" title="openssl::sha::sha512 fn">sha512</a></div><div class="item-right docblock-short">Computes the SHA512 hash of some data.</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> |
