mirror of
https://github.com/trussed-dev/trussed.git
synced 2026-05-10 06:02:27 +00:00
robin-nitrokey
74 lines
22 KiB
HTML
74 lines
22 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="Encrypt-only functionality for block ciphers."><title>BlockEncrypt in cipher - 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-77263533.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="cipher" data-themes="" data-resource-suffix="" data-rustdoc-version="1.94.0 (4a4ef493e 2026-03-02)" data-channel="1.94.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-b897f86f.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-7bab91a1.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-ffcac47a.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"></head><body class="rustdoc trait"><!--[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="#">BlockEncrypt</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../cipher/index.html"><img src="https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg" alt="logo"></a><h2><a href="../cipher/index.html">cipher</a><span class="version">0.4.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Block<wbr>Encrypt</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.encrypt_with_backend" title="encrypt_with_backend">encrypt_with_backend</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.encrypt_block" title="encrypt_block">encrypt_block</a></li><li><a href="#method.encrypt_block_b2b" title="encrypt_block_b2b">encrypt_block_b2b</a></li><li><a href="#method.encrypt_block_inout" title="encrypt_block_inout">encrypt_block_inout</a></li><li><a href="#method.encrypt_blocks" title="encrypt_blocks">encrypt_blocks</a></li><li><a href="#method.encrypt_blocks_b2b" title="encrypt_blocks_b2b">encrypt_blocks_b2b</a></li><li><a href="#method.encrypt_blocks_inout" title="encrypt_blocks_inout">encrypt_blocks_inout</a></li><li><a href="#method.encrypt_padded" title="encrypt_padded">encrypt_padded</a></li><li><a href="#method.encrypt_padded_b2b" title="encrypt_padded_b2b">encrypt_padded_b2b</a></li><li><a href="#method.encrypt_padded_inout" title="encrypt_padded_inout">encrypt_padded_inout</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-BlockEncrypt-for-%26Alg" title="&Alg">&Alg</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate cipher</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">cipher</a></div><h1>Trait <span class="trait">Block<wbr>Encrypt</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/cipher/block.rs.html#80-192">Source</a> </span></div><pre class="rust item-decl"><code>pub trait BlockEncrypt: <a class="trait" href="trait.BlockSizeUser.html" title="trait cipher::BlockSizeUser">BlockSizeUser</a> + <a class="trait" href="https://doc.rust-lang.org/1.94.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
// Required method
|
|
fn <a href="#tymethod.encrypt_with_backend" class="fn">encrypt_with_backend</a>(
|
|
&self,
|
|
f: impl <a class="trait" href="trait.BlockClosure.html" title="trait cipher::BlockClosure">BlockClosure</a><BlockSize = Self::<a class="associatedtype" href="trait.BlockSizeUser.html#associatedtype.BlockSize" title="type cipher::BlockSizeUser::BlockSize">BlockSize</a>>,
|
|
);
|
|
|
|
// Provided methods
|
|
fn <a href="#method.encrypt_block_inout" class="fn">encrypt_block_inout</a>(&self, block: <a class="struct" href="../inout/inout/struct.InOut.html" title="struct inout::inout::InOut">InOut</a><'_, '_, <a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>>) { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.encrypt_blocks_inout" class="fn">encrypt_blocks_inout</a>(&self, blocks: <a class="struct" href="../inout/inout_buf/struct.InOutBuf.html" title="struct inout::inout_buf::InOutBuf">InOutBuf</a><'_, '_, <a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>>) { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.encrypt_block" class="fn">encrypt_block</a>(&self, block: &mut <a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>) { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.encrypt_block_b2b" class="fn">encrypt_block_b2b</a>(
|
|
&self,
|
|
in_block: &<a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>,
|
|
out_block: &mut <a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>,
|
|
) { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.encrypt_blocks" class="fn">encrypt_blocks</a>(&self, blocks: &mut [<a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>]) { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.encrypt_blocks_b2b" class="fn">encrypt_blocks_b2b</a>(
|
|
&self,
|
|
in_blocks: &[<a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>],
|
|
out_blocks: &mut [<a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>],
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.unit.html">()</a>, <a class="struct" href="../inout/errors/struct.NotEqualError.html" title="struct inout::errors::NotEqualError">NotEqualError</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.encrypt_padded_inout" class="fn">encrypt_padded_inout</a><'inp, 'out, P: <a class="trait" href="../block_padding/trait.Padding.html" title="trait block_padding::Padding">Padding</a><Self::<a class="associatedtype" href="trait.BlockSizeUser.html#associatedtype.BlockSize" title="type cipher::BlockSizeUser::BlockSize">BlockSize</a>>>(
|
|
&self,
|
|
data: <a class="struct" href="../inout/reserved/struct.InOutBufReserved.html" title="struct inout::reserved::InOutBufReserved">InOutBufReserved</a><'inp, 'out, <a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&'out [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>], <a class="struct" href="../inout/errors/struct.PadError.html" title="struct inout::errors::PadError">PadError</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.encrypt_padded" class="fn">encrypt_padded</a><'a, P: <a class="trait" href="../block_padding/trait.Padding.html" title="trait block_padding::Padding">Padding</a><Self::<a class="associatedtype" href="trait.BlockSizeUser.html#associatedtype.BlockSize" title="type cipher::BlockSizeUser::BlockSize">BlockSize</a>>>(
|
|
&self,
|
|
buf: &'a mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
|
|
msg_len: <a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.usize.html">usize</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&'a [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>], <a class="struct" href="../inout/errors/struct.PadError.html" title="struct inout::errors::PadError">PadError</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.encrypt_padded_b2b" class="fn">encrypt_padded_b2b</a><'a, P: <a class="trait" href="../block_padding/trait.Padding.html" title="trait block_padding::Padding">Padding</a><Self::<a class="associatedtype" href="trait.BlockSizeUser.html#associatedtype.BlockSize" title="type cipher::BlockSizeUser::BlockSize">BlockSize</a>>>(
|
|
&self,
|
|
msg: &[<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
|
|
out_buf: &'a mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&'a [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>], <a class="struct" href="../inout/errors/struct.PadError.html" title="struct inout::errors::PadError">PadError</a>> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Encrypt-only functionality for block ciphers.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.encrypt_with_backend" class="method"><a class="src rightside" href="../src/cipher/block.rs.html#82">Source</a><h4 class="code-header">fn <a href="#tymethod.encrypt_with_backend" class="fn">encrypt_with_backend</a>(
|
|
&self,
|
|
f: impl <a class="trait" href="trait.BlockClosure.html" title="trait cipher::BlockClosure">BlockClosure</a><BlockSize = Self::<a class="associatedtype" href="trait.BlockSizeUser.html#associatedtype.BlockSize" title="type cipher::BlockSizeUser::BlockSize">BlockSize</a>>,
|
|
)</h4></section></summary><div class="docblock"><p>Encrypt data using backend provided to the rank-2 closure.</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.encrypt_block_inout" class="method"><a class="src rightside" href="../src/cipher/block.rs.html#86-88">Source</a><h4 class="code-header">fn <a href="#method.encrypt_block_inout" class="fn">encrypt_block_inout</a>(&self, block: <a class="struct" href="../inout/inout/struct.InOut.html" title="struct inout::inout::InOut">InOut</a><'_, '_, <a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>>)</h4></section></summary><div class="docblock"><p>Encrypt single <code>inout</code> block.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.encrypt_blocks_inout" class="method"><a class="src rightside" href="../src/cipher/block.rs.html#92-94">Source</a><h4 class="code-header">fn <a href="#method.encrypt_blocks_inout" class="fn">encrypt_blocks_inout</a>(&self, blocks: <a class="struct" href="../inout/inout_buf/struct.InOutBuf.html" title="struct inout::inout_buf::InOutBuf">InOutBuf</a><'_, '_, <a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>>)</h4></section></summary><div class="docblock"><p>Encrypt <code>inout</code> blocks.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.encrypt_block" class="method"><a class="src rightside" href="../src/cipher/block.rs.html#98-101">Source</a><h4 class="code-header">fn <a href="#method.encrypt_block" class="fn">encrypt_block</a>(&self, block: &mut <a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>)</h4></section></summary><div class="docblock"><p>Encrypt single block in-place.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.encrypt_block_b2b" class="method"><a class="src rightside" href="../src/cipher/block.rs.html#105-108">Source</a><h4 class="code-header">fn <a href="#method.encrypt_block_b2b" class="fn">encrypt_block_b2b</a>(&self, in_block: &<a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>, out_block: &mut <a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>)</h4></section></summary><div class="docblock"><p>Encrypt <code>in_block</code> and write result to <code>out_block</code>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.encrypt_blocks" class="method"><a class="src rightside" href="../src/cipher/block.rs.html#112-115">Source</a><h4 class="code-header">fn <a href="#method.encrypt_blocks" class="fn">encrypt_blocks</a>(&self, blocks: &mut [<a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>])</h4></section></summary><div class="docblock"><p>Encrypt blocks in-place.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.encrypt_blocks_b2b" class="method"><a class="src rightside" href="../src/cipher/block.rs.html#122-129">Source</a><h4 class="code-header">fn <a href="#method.encrypt_blocks_b2b" class="fn">encrypt_blocks_b2b</a>(
|
|
&self,
|
|
in_blocks: &[<a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>],
|
|
out_blocks: &mut [<a class="type" href="type.Block.html" title="type cipher::Block">Block</a><Self>],
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.unit.html">()</a>, <a class="struct" href="../inout/errors/struct.NotEqualError.html" title="struct inout::errors::NotEqualError">NotEqualError</a>></h4></section></summary><div class="docblock"><p>Encrypt blocks buffer-to-buffer.</p>
|
|
<p>Returns <a href="../inout/errors/struct.NotEqualError.html" title="struct inout::errors::NotEqualError"><code>NotEqualError</code></a> if provided <code>in_blocks</code> and <code>out_blocks</code>
|
|
have different lengths.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.encrypt_padded_inout" class="method"><a class="src rightside" href="../src/cipher/block.rs.html#137-147">Source</a><h4 class="code-header">fn <a href="#method.encrypt_padded_inout" class="fn">encrypt_padded_inout</a><'inp, 'out, P: <a class="trait" href="../block_padding/trait.Padding.html" title="trait block_padding::Padding">Padding</a><Self::<a class="associatedtype" href="trait.BlockSizeUser.html#associatedtype.BlockSize" title="type cipher::BlockSizeUser::BlockSize">BlockSize</a>>>(
|
|
&self,
|
|
data: <a class="struct" href="../inout/reserved/struct.InOutBufReserved.html" title="struct inout::reserved::InOutBufReserved">InOutBufReserved</a><'inp, 'out, <a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&'out [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>], <a class="struct" href="../inout/errors/struct.PadError.html" title="struct inout::errors::PadError">PadError</a>></h4></section></summary><div class="docblock"><p>Pad input and encrypt. Returns resulting ciphertext slice.</p>
|
|
<p>Returns <a href="../inout/errors/struct.PadError.html" title="struct inout::errors::PadError"><code>PadError</code></a> if length of output buffer is not sufficient.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.encrypt_padded" class="method"><a class="src rightside" href="../src/cipher/block.rs.html#155-162">Source</a><h4 class="code-header">fn <a href="#method.encrypt_padded" class="fn">encrypt_padded</a><'a, P: <a class="trait" href="../block_padding/trait.Padding.html" title="trait block_padding::Padding">Padding</a><Self::<a class="associatedtype" href="trait.BlockSizeUser.html#associatedtype.BlockSize" title="type cipher::BlockSizeUser::BlockSize">BlockSize</a>>>(
|
|
&self,
|
|
buf: &'a mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
|
|
msg_len: <a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.usize.html">usize</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&'a [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>], <a class="struct" href="../inout/errors/struct.PadError.html" title="struct inout::errors::PadError">PadError</a>></h4></section></summary><div class="docblock"><p>Pad input and encrypt in-place. Returns resulting ciphertext slice.</p>
|
|
<p>Returns <a href="../inout/errors/struct.PadError.html" title="struct inout::errors::PadError"><code>PadError</code></a> if length of output buffer is not sufficient.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.encrypt_padded_b2b" class="method"><a class="src rightside" href="../src/cipher/block.rs.html#170-177">Source</a><h4 class="code-header">fn <a href="#method.encrypt_padded_b2b" class="fn">encrypt_padded_b2b</a><'a, P: <a class="trait" href="../block_padding/trait.Padding.html" title="trait block_padding::Padding">Padding</a><Self::<a class="associatedtype" href="trait.BlockSizeUser.html#associatedtype.BlockSize" title="type cipher::BlockSizeUser::BlockSize">BlockSize</a>>>(
|
|
&self,
|
|
msg: &[<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
|
|
out_buf: &'a mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&'a [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>], <a class="struct" href="../inout/errors/struct.PadError.html" title="struct inout::errors::PadError">PadError</a>></h4></section></summary><div class="docblock"><p>Pad input and encrypt buffer-to-buffer. Returns resulting ciphertext slice.</p>
|
|
<p>Returns <a href="../inout/errors/struct.PadError.html" title="struct inout::errors::PadError"><code>PadError</code></a> if length of output buffer is not sufficient.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.94.0/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-BlockEncrypt-for-%26Alg" class="impl"><a class="src rightside" href="../src/cipher/block.rs.html#583-587">Source</a><a href="#impl-BlockEncrypt-for-%26Alg" class="anchor">§</a><h3 class="code-header">impl<Alg: <a class="trait" href="trait.BlockEncrypt.html" title="trait cipher::BlockEncrypt">BlockEncrypt</a>> <a class="trait" href="trait.BlockEncrypt.html" title="trait cipher::BlockEncrypt">BlockEncrypt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.reference.html">&Alg</a></h3></section></summary><div class="impl-items"><section id="method.encrypt_with_backend" class="method trait-impl"><a class="src rightside" href="../src/cipher/block.rs.html#584-586">Source</a><a href="#method.encrypt_with_backend" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.encrypt_with_backend" class="fn">encrypt_with_backend</a>(
|
|
&self,
|
|
f: impl <a class="trait" href="trait.BlockClosure.html" title="trait cipher::BlockClosure">BlockClosure</a><BlockSize = Self::<a class="associatedtype" href="trait.BlockSizeUser.html#associatedtype.BlockSize" title="type cipher::BlockSizeUser::BlockSize">BlockSize</a>>,
|
|
)</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/cipher/block/trait.BlockEncrypt.js" async></script></section></div></main></body></html> |