| <!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."><meta name="keywords" content="rust, rustlang, rust-lang, symm"><title>openssl::symm - 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 symm</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</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="#">symm</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/symm.rs.html#1-1633">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>High level interface to certain symmetric ciphers.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></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="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.Cipher.html" title="openssl::symm::Cipher struct">Cipher</a></div><div class="item-right docblock-short">Represents a particular cipher algorithm.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Crypter.html" title="openssl::symm::Crypter struct">Crypter</a></div><div class="item-right docblock-short">Represents a symmetric cipher context.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Mode.html" title="openssl::symm::Mode enum">Mode</a></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.decrypt.html" title="openssl::symm::decrypt fn">decrypt</a></div><div class="item-right docblock-short">Decrypts data in one go, and returns the decrypted data.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.decrypt_aead.html" title="openssl::symm::decrypt_aead fn">decrypt_aead</a></div><div class="item-right docblock-short">Like <code>decrypt</code>, but for AEAD ciphers such as AES GCM.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.encrypt.html" title="openssl::symm::encrypt fn">encrypt</a></div><div class="item-right docblock-short">Encrypts data in one go, and returns the encrypted data.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.encrypt_aead.html" title="openssl::symm::encrypt_aead fn">encrypt_aead</a></div><div class="item-right docblock-short">Like <code>encrypt</code>, but for AEAD ciphers such as AES GCM.</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> |
