blob: c793c2fdac160af8943d2dbd0b6583586dd753e5 [file] [log] [blame]
<!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 symmetric encryption context."><meta name="keywords" content="rust, rustlang, rust-lang, cipher_ctx"><title>openssl::cipher_ctx - 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">&#9776;</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 cipher_ctx</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="#">cipher_ctx</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/cipher_ctx.rs.html#1-918">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The symmetric encryption context.</p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
<p>Encrypt data with AES128 CBC</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::cipher::Cipher;
<span class="kw">use </span>openssl::cipher_ctx::CipherCtx;
<span class="kw">let </span>cipher = Cipher::aes_128_cbc();
<span class="kw">let </span>data = <span class="string">b&quot;Some Crypto Text&quot;</span>;
<span class="kw">let </span>key = <span class="string">b&quot;\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F&quot;</span>;
<span class="kw">let </span>iv = <span class="string">b&quot;\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07&quot;</span>;
<span class="kw">let </span><span class="kw-2">mut </span>ctx = CipherCtx::new().unwrap();
ctx.encrypt_init(<span class="prelude-val">Some</span>(cipher), <span class="prelude-val">Some</span>(key), <span class="prelude-val">Some</span>(iv)).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>ciphertext = <span class="macro">vec!</span>[];
ctx.cipher_update_vec(data, <span class="kw-2">&amp;mut </span>ciphertext).unwrap();
ctx.cipher_final_vec(<span class="kw-2">&amp;mut </span>ciphertext).unwrap();
<span class="macro">assert_eq!</span>(
<span class="string">b&quot;\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&quot;</span>,
<span class="kw-2">&amp;</span>ciphertext[..],
);</code></pre></div>
<p>Decrypt data with AES128 CBC</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::cipher::Cipher;
<span class="kw">use </span>openssl::cipher_ctx::CipherCtx;
<span class="kw">let </span>cipher = Cipher::aes_128_cbc();
<span class="kw">let </span>data = <span class="string">b&quot;\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&quot;</span>;
<span class="kw">let </span>key = <span class="string">b&quot;\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F&quot;</span>;
<span class="kw">let </span>iv = <span class="string">b&quot;\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07&quot;</span>;
<span class="kw">let </span><span class="kw-2">mut </span>ctx = CipherCtx::new().unwrap();
ctx.decrypt_init(<span class="prelude-val">Some</span>(cipher), <span class="prelude-val">Some</span>(key), <span class="prelude-val">Some</span>(iv)).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>plaintext = <span class="macro">vec!</span>[];
ctx.cipher_update_vec(data, <span class="kw-2">&amp;mut </span>plaintext).unwrap();
ctx.cipher_final_vec(<span class="kw-2">&amp;mut </span>plaintext).unwrap();
<span class="macro">assert_eq!</span>(<span class="string">b&quot;Some Crypto Text&quot;</span>, <span class="kw-2">&amp;</span>plaintext[..]);</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.CipherCtx.html" title="openssl::cipher_ctx::CipherCtx struct">CipherCtx</a></div><div class="item-right docblock-short">A context object used to perform symmetric encryption operations.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CipherCtxRef.html" title="openssl::cipher_ctx::CipherCtxRef struct">CipherCtxRef</a></div><div class="item-right docblock-short">A reference to a <a href="struct.CipherCtx.html" title="CipherCtx"><code>CipherCtx</code></a>.</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>