Files
GopherGate/target/doc/openssl/sign/index.html
2026-02-26 12:00:21 -05:00

56 lines
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="Message signatures."><title>openssl::sign - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="openssl" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Module sign</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../openssl/index.html">openssl</a><span class="version">0.10.75</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module sign</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate openssl</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">openssl</a></div><h1>Module <span>sign</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/openssl/sign.rs.html#1-824">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Message signatures.</p>
<p>The <code>Signer</code> allows for the computation of cryptographic signatures of
data given a private key. The <code>Verifier</code> can then be used with the
corresponding public key to verify the integrity and authenticity of that
data given the signature.</p>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<p>Sign and verify data given an RSA keypair:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::sign::{Signer, Verifier};
<span class="kw">use </span>openssl::rsa::Rsa;
<span class="kw">use </span>openssl::pkey::PKey;
<span class="kw">use </span>openssl::hash::MessageDigest;
<span class="comment">// Generate a keypair
</span><span class="kw">let </span>keypair = Rsa::generate(<span class="number">2048</span>).unwrap();
<span class="kw">let </span>keypair = PKey::from_rsa(keypair).unwrap();
<span class="kw">let </span>data = <span class="string">b"hello, world!"</span>;
<span class="kw">let </span>data2 = <span class="string">b"hola, mundo!"</span>;
<span class="comment">// Sign the data
</span><span class="kw">let </span><span class="kw-2">mut </span>signer = Signer::new(MessageDigest::sha256(), <span class="kw-2">&amp;</span>keypair).unwrap();
signer.update(data).unwrap();
signer.update(data2).unwrap();
<span class="kw">let </span>signature = signer.sign_to_vec().unwrap();
<span class="comment">// Verify the data
</span><span class="kw">let </span><span class="kw-2">mut </span>verifier = Verifier::new(MessageDigest::sha256(), <span class="kw-2">&amp;</span>keypair).unwrap();
verifier.update(data).unwrap();
verifier.update(data2).unwrap();
<span class="macro">assert!</span>(verifier.verify(<span class="kw-2">&amp;</span>signature).unwrap());</code></pre></div>
<p>\</p>
<p>Compute an HMAC:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::hash::MessageDigest;
<span class="kw">use </span>openssl::memcmp;
<span class="kw">use </span>openssl::pkey::PKey;
<span class="kw">use </span>openssl::sign::Signer;
<span class="comment">// Create a PKey
</span><span class="kw">let </span>key = PKey::hmac(<span class="string">b"my secret"</span>).unwrap();
<span class="kw">let </span>data = <span class="string">b"hello, world!"</span>;
<span class="kw">let </span>data2 = <span class="string">b"hola, mundo!"</span>;
<span class="comment">// Compute the HMAC
</span><span class="kw">let </span><span class="kw-2">mut </span>signer = Signer::new(MessageDigest::sha256(), <span class="kw-2">&amp;</span>key).unwrap();
signer.update(data).unwrap();
signer.update(data2).unwrap();
<span class="kw">let </span>hmac = signer.sign_to_vec().unwrap();
<span class="comment">// `Verifier` cannot be used with HMACs; use the `memcmp::eq` function instead
//
// Do not simply check for equality with `==`!
</span><span class="macro">assert!</span>(memcmp::eq(<span class="kw-2">&amp;</span>hmac, <span class="kw-2">&amp;</span>target));</code></pre></div></div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.RsaPssSaltlen.html" title="struct openssl::sign::RsaPssSaltlen">RsaPss<wbr>Saltlen</a></dt><dd>Salt lengths that must be used with <code>set_rsa_pss_saltlen</code>.</dd><dt><a class="struct" href="struct.Signer.html" title="struct openssl::sign::Signer">Signer</a></dt><dd>A type which computes cryptographic signatures of data.</dd><dt><a class="struct" href="struct.Verifier.html" title="struct openssl::sign::Verifier">Verifier</a></dt><dd>A type which can be used to verify the integrity and authenticity
of data given the signature.</dd></dl></section></div></main></body></html>