blob: 6e3124649f4f341928fc645ce8d40c695e9a8619 [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="Define types of TransientObject with predefined maximum sizes."><meta name="keywords" content="rust, rustlang, rust-lang, TransientObjectType"><title>TransientObjectType in optee_utee::object - 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 enum"><!--[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">Enum TransientObjectType</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#variants">Variants</a></h3><div class="sidebar-links"><a href="#variant.Aes">Aes</a><a href="#variant.CorruptedObject">CorruptedObject</a><a href="#variant.Data">Data</a><a href="#variant.Des">Des</a><a href="#variant.Des3">Des3</a><a href="#variant.DhKeypair">DhKeypair</a><a href="#variant.DsaKeypair">DsaKeypair</a><a href="#variant.DsaPublicKey">DsaPublicKey</a><a href="#variant.EcdhKeypair">EcdhKeypair</a><a href="#variant.EcdhPublicKey">EcdhPublicKey</a><a href="#variant.EcdsaKeypair">EcdsaKeypair</a><a href="#variant.EcdsaPublicKey">EcdsaPublicKey</a><a href="#variant.GenericSecret">GenericSecret</a><a href="#variant.HmacMd5">HmacMd5</a><a href="#variant.HmacSha1">HmacSha1</a><a href="#variant.HmacSha224">HmacSha224</a><a href="#variant.HmacSha256">HmacSha256</a><a href="#variant.HmacSha384">HmacSha384</a><a href="#variant.HmacSha512">HmacSha512</a><a href="#variant.RsaKeypair">RsaKeypair</a><a href="#variant.RsaPublicKey">RsaPublicKey</a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow&lt;T&gt;</a><a href="#impl-BorrowMut%3CT%3E">BorrowMut&lt;T&gt;</a><a href="#impl-From%3CT%3E">From&lt;T&gt;</a><a href="#impl-Into%3CU%3E">Into&lt;U&gt;</a><a href="#impl-TryFrom%3CU%3E">TryFrom&lt;U&gt;</a><a href="#impl-TryInto%3CU%3E">TryInto&lt;U&gt;</a></div></div><h2 class="location">Other items in<br><a href="../index.html">optee_utee</a>::<wbr><a href="index.html">object</a></h2><div id="sidebar-vars" data-name="TransientObjectType" data-ty="enum" 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">Enum <a href="../index.html">optee_utee</a>::<wbr><a href="index.html">object</a>::<wbr><a class="enum" href="#">TransientObjectType</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/object.rs.html#414-472" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust enum"><code>#[repr(u32)]
pub enum TransientObjectType {
<details class="rustdoc-toggle type-contents-toggle"><summary class="hideme"><span>Show 21 variants</span></summary> Aes,
Des,
Des3,
HmacMd5,
HmacSha1,
HmacSha224,
HmacSha256,
HmacSha384,
HmacSha512,
RsaPublicKey,
RsaKeypair,
DsaPublicKey,
DsaKeypair,
DhKeypair,
EcdsaPublicKey,
EcdsaKeypair,
EcdhPublicKey,
EcdhKeypair,
GenericSecret,
CorruptedObject,
Data,
</details>}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Define types of <a href="struct.TransientObject.html">TransientObject</a> with predefined maximum sizes.</p>
</div></details><h2 id="variants" class="variants small-section-header">Variants<a href="#variants" class="anchor"></a></h2><div id="variant.Aes" class="variant small-section-header"><a href="#variant.Aes" class="anchor field"></a><code>Aes</code></div><div class="docblock"><p>128, 192, or 256 bits</p>
</div><div id="variant.Des" class="variant small-section-header"><a href="#variant.Des" class="anchor field"></a><code>Des</code></div><div class="docblock"><p>Always 64 bits including the parity bits. This gives an effective key size of 56 bits</p>
</div><div id="variant.Des3" class="variant small-section-header"><a href="#variant.Des3" class="anchor field"></a><code>Des3</code></div><div class="docblock"><p>128 or 192 bits including the parity bits. This gives effective key sizes of 112 or 168 bits</p>
</div><div id="variant.HmacMd5" class="variant small-section-header"><a href="#variant.HmacMd5" class="anchor field"></a><code>HmacMd5</code></div><div class="docblock"><p>Between 64 and 512 bits, multiple of 8 bits</p>
</div><div id="variant.HmacSha1" class="variant small-section-header"><a href="#variant.HmacSha1" class="anchor field"></a><code>HmacSha1</code></div><div class="docblock"><p>Between 80 and 512 bits, multiple of 8 bits</p>
</div><div id="variant.HmacSha224" class="variant small-section-header"><a href="#variant.HmacSha224" class="anchor field"></a><code>HmacSha224</code></div><div class="docblock"><p>Between 112 and 512 bits, multiple of 8 bits</p>
</div><div id="variant.HmacSha256" class="variant small-section-header"><a href="#variant.HmacSha256" class="anchor field"></a><code>HmacSha256</code></div><div class="docblock"><p>Between 192 and 1024 bits, multiple of 8 bits</p>
</div><div id="variant.HmacSha384" class="variant small-section-header"><a href="#variant.HmacSha384" class="anchor field"></a><code>HmacSha384</code></div><div class="docblock"><p>Between 256 and 1024 bits, multiple of 8 bits</p>
</div><div id="variant.HmacSha512" class="variant small-section-header"><a href="#variant.HmacSha512" class="anchor field"></a><code>HmacSha512</code></div><div class="docblock"><p>Between 256 and 1024 bits, multiple of 8 bits</p>
</div><div id="variant.RsaPublicKey" class="variant small-section-header"><a href="#variant.RsaPublicKey" class="anchor field"></a><code>RsaPublicKey</code></div><div class="docblock"><p>The number of bits in the modulus. 256, 512, 768, 1024, 1536 and 2048 bit keys SHALL be supported.
Support for other key sizes including bigger key sizes is
implementation-dependent. Minimum key size is 256 bits</p>
</div><div id="variant.RsaKeypair" class="variant small-section-header"><a href="#variant.RsaKeypair" class="anchor field"></a><code>RsaKeypair</code></div><div class="docblock"><p>Same as <a href="enum.TransientObjectType.html#variant.RsaPublicKey">RsaPublicKey</a> key size.</p>
</div><div id="variant.DsaPublicKey" class="variant small-section-header"><a href="#variant.DsaPublicKey" class="anchor field"></a><code>DsaPublicKey</code></div><div class="docblock"><p>Depends on Algorithm:</p>
<ol>
<li><a href="../crypto_op/enum.AlgorithmId.html#variant.DsaSha1">DsaSha1</a>:
Between 512 and 1024 bits, multiple of 64 bits</li>
<li><a href="../crypto_op/enum.AlgorithmId.html#variant.DsaSha224">DsaSha224</a>: 2048 bits</li>
<li><a href="../crypto_op/enum.AlgorithmId.html#variant.DsaSha256">DsaSha256</a>: 2048 or 3072 bits</li>
</ol>
</div><div id="variant.DsaKeypair" class="variant small-section-header"><a href="#variant.DsaKeypair" class="anchor field"></a><code>DsaKeypair</code></div><div class="docblock"><p>Same as <a href="enum.TransientObjectType.html#variant.DsaPublicKey">DsaPublicKey</a> key size.</p>
</div><div id="variant.DhKeypair" class="variant small-section-header"><a href="#variant.DhKeypair" class="anchor field"></a><code>DhKeypair</code></div><div class="docblock"><p>From 256 to 2048 bits, multiple of 8 bits.</p>
</div><div id="variant.EcdsaPublicKey" class="variant small-section-header"><a href="#variant.EcdsaPublicKey" class="anchor field"></a><code>EcdsaPublicKey</code></div><div class="docblock"><p>Between 160 and 521 bits. Conditional: Available only if at least
one of the ECC the curves defined in Table 6-14 with “generic”
equal to “Y” is supported.</p>
</div><div id="variant.EcdsaKeypair" class="variant small-section-header"><a href="#variant.EcdsaKeypair" class="anchor field"></a><code>EcdsaKeypair</code></div><div class="docblock"><p>Between 160 and 521 bits. Conditional: Available only if at least
one of the ECC curves defined in Table 6-14 with “generic” equal to
“Y” is supported. SHALL be same value as for ECDSA public key size.</p>
</div><div id="variant.EcdhPublicKey" class="variant small-section-header"><a href="#variant.EcdhPublicKey" class="anchor field"></a><code>EcdhPublicKey</code></div><div class="docblock"><p>Between 160 and 521 bits. Conditional: Available only if at least
one of the ECC curves defined in Table 6-14 with “generic” equal to
“Y” is supported.</p>
</div><div id="variant.EcdhKeypair" class="variant small-section-header"><a href="#variant.EcdhKeypair" class="anchor field"></a><code>EcdhKeypair</code></div><div class="docblock"><p>Between 160 and 521 bits. Conditional: Available only if at least
one of the ECC curves defined in Table 6-14 with “generic” equal to
“Y” is supported. SHALL be same value as for ECDH public key size</p>
</div><div id="variant.GenericSecret" class="variant small-section-header"><a href="#variant.GenericSecret" class="anchor field"></a><code>GenericSecret</code></div><div class="docblock"><p>Multiple of 8 bits, up to 4096 bits. This type is intended for secret
data that has been derived from a key derivation scheme.</p>
</div><div id="variant.CorruptedObject" class="variant small-section-header"><a href="#variant.CorruptedObject" class="anchor field"></a><code>CorruptedObject</code></div><div class="docblock"><p>Object is corrupted.</p>
</div><div id="variant.Data" class="variant small-section-header"><a href="#variant.Data" class="anchor field"></a><code>Data</code></div><div class="docblock"><p>0 – All data is in the associated data stream.</p>
</div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl RefUnwindSafe for <a class="enum" href="enum.TransientObjectType.html" title="enum optee_utee::object::TransientObjectType">TransientObjectType</a></h3></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl Send for <a class="enum" href="enum.TransientObjectType.html" title="enum optee_utee::object::TransientObjectType">TransientObjectType</a></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl Sync for <a class="enum" href="enum.TransientObjectType.html" title="enum optee_utee::object::TransientObjectType">TransientObjectType</a></h3></div><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl Unpin for <a class="enum" href="enum.TransientObjectType.html" title="enum optee_utee::object::TransientObjectType">TransientObjectType</a></h3></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl UnwindSafe for <a class="enum" href="enum.TransientObjectType.html" title="enum optee_utee::object::TransientObjectType">TransientObjectType</a></h3></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; Any for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,&nbsp;</span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="#tymethod.type_id">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; Borrow&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,&nbsp;</span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.borrow" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="#tymethod.borrow">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; BorrowMut&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,&nbsp;</span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="#tymethod.borrow_mut">Read more</a></p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; From&lt;T&gt; for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.from" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">from</a>(t: T) -&gt; T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;T, U&gt; Into&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,&nbsp;</span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.into" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">into</a>(self) -&gt; U</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,&nbsp;</span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Error" class="type">Error</a> = Infallible</h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.try_from" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;T, U&gt; TryInto&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,&nbsp;</span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Error" class="type">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_into" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.try_into" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
</div></details></div></details></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>