46 lines
8.1 KiB
HTML
46 lines
8.1 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="High level interface to certain symmetric ciphers."><title>openssl::symm - 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 symm</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 symm</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><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</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>symm</span> <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/symm.rs.html#1-1776">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>High level interface to certain symmetric ciphers.</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<p>Encrypt data in AES128 CBC mode</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::symm::{encrypt, Cipher};
|
|
|
|
<span class="kw">let </span>cipher = Cipher::aes_128_cbc();
|
|
<span class="kw">let </span>data = <span class="string">b"Some Crypto Text"</span>;
|
|
<span class="kw">let </span>key = <span class="string">b"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F"</span>;
|
|
<span class="kw">let </span>iv = <span class="string">b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07"</span>;
|
|
<span class="kw">let </span>ciphertext = encrypt(
|
|
cipher,
|
|
key,
|
|
<span class="prelude-val">Some</span>(iv),
|
|
data).unwrap();
|
|
|
|
<span class="macro">assert_eq!</span>(
|
|
<span class="string">b"\xB4\xB9\xE7\x30\xD6\xD6\xF7\xDE\x77\x3F\x1C\xFF\xB3\x3E\x44\x5A\x91\xD7\x27\x62\x87\x4D\
|
|
\xFB\x3C\x5E\xC4\x59\x72\x4A\xF4\x7C\xA1"</span>,
|
|
<span class="kw-2">&</span>ciphertext[..]);</code></pre></div>
|
|
<p>Encrypting an asymmetric key with a symmetric cipher</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::rsa::{Padding, Rsa};
|
|
<span class="kw">use </span>openssl::symm::Cipher;
|
|
|
|
<span class="comment">// Generate keypair and encrypt private key:
|
|
</span><span class="kw">let </span>keypair = Rsa::generate(<span class="number">2048</span>).unwrap();
|
|
<span class="kw">let </span>cipher = Cipher::aes_256_cbc();
|
|
<span class="kw">let </span>pubkey_pem = keypair.public_key_to_pem_pkcs1().unwrap();
|
|
<span class="kw">let </span>privkey_pem = keypair.private_key_to_pem_passphrase(cipher, <span class="string">b"Rust"</span>).unwrap();
|
|
<span class="comment">// pubkey_pem and privkey_pem could be written to file here.
|
|
|
|
// Load private and public key from string:
|
|
</span><span class="kw">let </span>pubkey = Rsa::public_key_from_pem_pkcs1(<span class="kw-2">&</span>pubkey_pem).unwrap();
|
|
<span class="kw">let </span>privkey = Rsa::private_key_from_pem_passphrase(<span class="kw-2">&</span>privkey_pem, <span class="string">b"Rust"</span>).unwrap();
|
|
|
|
<span class="comment">// Use the asymmetric keys to encrypt and decrypt a short message:
|
|
</span><span class="kw">let </span>msg = <span class="string">b"Foo bar"</span>;
|
|
<span class="kw">let </span><span class="kw-2">mut </span>encrypted = <span class="macro">vec!</span>[<span class="number">0</span>; pubkey.size() <span class="kw">as </span>usize];
|
|
<span class="kw">let </span><span class="kw-2">mut </span>decrypted = <span class="macro">vec!</span>[<span class="number">0</span>; privkey.size() <span class="kw">as </span>usize];
|
|
<span class="kw">let </span>len = pubkey.public_encrypt(msg, <span class="kw-2">&mut </span>encrypted, Padding::PKCS1).unwrap();
|
|
<span class="macro">assert!</span>(len > msg.len());
|
|
<span class="kw">let </span>len = privkey.private_decrypt(<span class="kw-2">&</span>encrypted, <span class="kw-2">&mut </span>decrypted, Padding::PKCS1).unwrap();
|
|
<span class="kw">let </span>output_string = String::from_utf8(decrypted[..len].to_vec()).unwrap();
|
|
<span class="macro">assert_eq!</span>(<span class="string">"Foo bar"</span>, output_string);
|
|
<span class="macro">println!</span>(<span class="string">"Decrypted: '{}'"</span>, output_string);</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.Cipher.html" title="struct openssl::symm::Cipher">Cipher</a></dt><dd>Represents a particular cipher algorithm.</dd><dt><a class="struct" href="struct.Crypter.html" title="struct openssl::symm::Crypter">Crypter</a></dt><dd>Represents a symmetric cipher context.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Mode.html" title="enum openssl::symm::Mode">Mode</a></dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.decrypt.html" title="fn openssl::symm::decrypt">decrypt</a></dt><dd>Decrypts data in one go, and returns the decrypted data.</dd><dt><a class="fn" href="fn.decrypt_aead.html" title="fn openssl::symm::decrypt_aead">decrypt_<wbr>aead</a></dt><dd>Like <code>decrypt</code>, but for AEAD ciphers such as AES GCM.</dd><dt><a class="fn" href="fn.encrypt.html" title="fn openssl::symm::encrypt">encrypt</a></dt><dd>Encrypts data in one go, and returns the encrypted data.</dd><dt><a class="fn" href="fn.encrypt_aead.html" title="fn openssl::symm::encrypt_aead">encrypt_<wbr>aead</a></dt><dd>Like <code>encrypt</code>, but for AEAD ciphers such as AES GCM.</dd></dl></section></div></main></body></html> |