| <!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 encryption."><meta name="keywords" content="rust, rustlang, rust-lang, encrypt"><title>openssl::encrypt - 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 encrypt</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</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="#">encrypt</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/encrypt.rs.html#1-578">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>Message encryption.</p> |
| <p>The <a href="struct.Encrypter.html" title="Encrypter"><code>Encrypter</code></a> allows for encryption of data given a public key. The <a href="struct.Decrypter.html" title="Decrypter"><code>Decrypter</code></a> can be |
| used with the corresponding private key to decrypt the data.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <p>Encrypt and decrypt data given an RSA keypair:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::encrypt::{Encrypter, Decrypter}; |
| <span class="kw">use </span>openssl::rsa::{Rsa, Padding}; |
| <span class="kw">use </span>openssl::pkey::PKey; |
| |
| <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="comment">// Encrypt the data with RSA PKCS1 |
| </span><span class="kw">let </span><span class="kw-2">mut </span>encrypter = Encrypter::new(<span class="kw-2">&</span>keypair).unwrap(); |
| encrypter.set_rsa_padding(Padding::PKCS1).unwrap(); |
| <span class="comment">// Create an output buffer |
| </span><span class="kw">let </span>buffer_len = encrypter.encrypt_len(data).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>encrypted = <span class="macro">vec!</span>[<span class="number">0</span>; buffer_len]; |
| <span class="comment">// Encrypt and truncate the buffer |
| </span><span class="kw">let </span>encrypted_len = encrypter.encrypt(data, <span class="kw-2">&mut </span>encrypted).unwrap(); |
| encrypted.truncate(encrypted_len); |
| |
| <span class="comment">// Decrypt the data |
| </span><span class="kw">let </span><span class="kw-2">mut </span>decrypter = Decrypter::new(<span class="kw-2">&</span>keypair).unwrap(); |
| decrypter.set_rsa_padding(Padding::PKCS1).unwrap(); |
| <span class="comment">// Create an output buffer |
| </span><span class="kw">let </span>buffer_len = decrypter.decrypt_len(<span class="kw-2">&</span>encrypted).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>decrypted = <span class="macro">vec!</span>[<span class="number">0</span>; buffer_len]; |
| <span class="comment">// Encrypt and truncate the buffer |
| </span><span class="kw">let </span>decrypted_len = decrypter.decrypt(<span class="kw-2">&</span>encrypted, <span class="kw-2">&mut </span>decrypted).unwrap(); |
| decrypted.truncate(decrypted_len); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>decrypted, data);</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.Decrypter.html" title="openssl::encrypt::Decrypter struct">Decrypter</a></div><div class="item-right docblock-short">A type which decrypts data.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Encrypter.html" title="openssl::encrypt::Encrypter struct">Encrypter</a></div><div class="item-right docblock-short">A type which encrypts 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> |
