blob: 43ffec855b079fad843ad3c75f531cef93164557 [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="API documentation for the Rust `crypto_op` mod in crate `optee_utee`."><meta name="keywords" content="rust, rustlang, rust-lang, crypto_op"><title>optee_utee::crypto_op - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.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"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../../optee_utee/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Module crypto_op</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="crypto_op" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">optee_utee</a>::<wbr><a class="mod" href="#">crypto_op</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></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/optee_utee/crypto_op.rs.html#18-1765" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="struct" href="struct.AE.html" title="optee_utee::crypto_op::AE struct">AE</a></div><div class="item-right docblock-short"><p>An operation for conducting authenticated encryption / decryption.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.Asymmetric.html" title="optee_utee::crypto_op::Asymmetric struct">Asymmetric</a></div><div class="item-right docblock-short"><p>An operation for conducting asymmetric encryption /decryption or asymmetric sign / verify.
Note that asymmetric encryption is always “single-stage”,
which differs from <a href="struct.Cipher.html">Cipher</a> which are always “multi-stage”.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.Cipher.html" title="optee_utee::crypto_op::Cipher struct">Cipher</a></div><div class="item-right docblock-short"><p>An operation for conducting symmetric cipher encryption / decryption.
This operation defines the way to perform symmetric cipher operations, such as AES.
They cover both block ciphers and stream ciphers.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.DeriveKey.html" title="optee_utee::crypto_op::DeriveKey struct">DeriveKey</a></div><div class="item-right docblock-short"><p>An operation for derive a shared key object.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.Digest.html" title="optee_utee::crypto_op::Digest struct">Digest</a></div><div class="item-right docblock-short"><p>An operation for digest the message.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.Mac.html" title="optee_utee::crypto_op::Mac struct">Mac</a></div><div class="item-right docblock-short"><p>An operation for performing MAC (Message Authentication Code) operations, such as <code>HMAC</code>
or <code>AES-CMAC</code> operations. This operation is not used for Authenticated Encryption algorithms,
which SHALL use the functions defined in <a href="struct.AE.html">AE</a>.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.OperationHandle.html" title="optee_utee::crypto_op::OperationHandle struct">OperationHandle</a></div><div class="item-right docblock-short"><p>An opaque reference that identifies a particular cryptographic operation.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.OperationInfo.html" title="optee_utee::crypto_op::OperationInfo struct">OperationInfo</a></div><div class="item-right docblock-short"><p>Represent the information about a crypto information.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.OperationInfoMultiple.html" title="optee_utee::crypto_op::OperationInfoMultiple struct">OperationInfoMultiple</a></div><div class="item-right docblock-short"><p>Represent the information about a crypto information which uses multiple keys.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.Random.html" title="optee_utee::crypto_op::Random struct">Random</a></div><div class="item-right docblock-short"><p>An operation for generating random data.</p>
</div></div><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="enum" href="enum.AlgorithmId.html" title="optee_utee::crypto_op::AlgorithmId enum">AlgorithmId</a></div><div class="item-right docblock-short"><p>Algorithms that can be allocated as an crypto operation.</p>
</div><div class="item-left module-item"><a class="enum" href="enum.ElementId.html" title="optee_utee::crypto_op::ElementId enum">ElementId</a></div><div class="item-right docblock-short"><p>This specification defines support for optional cryptographic elements.</p>
</div><div class="item-left module-item"><a class="enum" href="enum.OperationConstant.html" title="optee_utee::crypto_op::OperationConstant enum">OperationConstant</a></div><div class="item-right docblock-short"><p>Define the supported crypto operation.</p>
</div><div class="item-left module-item"><a class="enum" href="enum.OperationMode.html" title="optee_utee::crypto_op::OperationMode enum">OperationMode</a></div><div class="item-right docblock-short"><p>Specify one of the available cryptographic operations.</p>
</div><div class="item-left module-item"><a class="enum" href="enum.OperationStates.html" title="optee_utee::crypto_op::OperationStates enum">OperationStates</a></div><div class="item-right docblock-short"><p>Every operation of <a href="struct.AE.html">AE</a>, <a href="struct.Asymmetric.html">Asymmetric</a>, <a href="struct.Cipher.html">Cipher</a>,
<a href="struct.DeriveKey.html">DeriveKey</a>, <a href="struct.Digest.html">Digest</a>, <a href="struct.Mac.html">Mac</a> can be either one of the two states.</p>
</div></div><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="trait" href="trait.OpHandle.html" title="optee_utee::crypto_op::OpHandle trait">OpHandle</a></div><div class="item-right docblock-short"><p>A trait for a crypto operation to return its handle.</p>
</div></div><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="fn" href="fn.is_algorithm_supported.html" title="optee_utee::crypto_op::is_algorithm_supported fn">is_algorithm_supported</a></div><div class="item-right docblock-short"><p>determine whether a combination of algId and element is supported</p>
</div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="optee_utee" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
<script src="../../main.js"></script>
</body></html>