blob: 5cc3b99a057f592de63f070465e14a558ffe4a5a [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="Source of the Rust file `/root/.cargo/git/checkouts/yasna.rs-156132176fc4750e/5680982/src/models/der.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>der.rs - source</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="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../yasna/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../yasna/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
</pre><pre class="rust"><code><span class="comment">// Copyright 2017 Fortanix, Inc.
//
// Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license
// &lt;LICENSE-MIT or http://opensource.org/licenses/MIT&gt;, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
</span><span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::{PCBit, Tag};
<span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::tags::<span class="kw-2">*</span>;
<span class="doccomment">/// Container for a tag and arbitrary DER value.
///
/// When obtained by `BERReader::read_tagged_der` in DER mode,
/// the reader verifies that the payload is actually valid DER.
/// When constructed from bytes, the caller is responsible for
/// providing valid DER.
</span><span class="attribute">#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
</span><span class="kw">pub struct </span>TaggedDerValue {
tag: Tag,
pcbit: PCBit,
value: Vec&lt;u8&gt;,
}
<span class="kw">impl </span>TaggedDerValue {
<span class="doccomment">/// Constructs a new `TaggedDerValue` as an octet string
</span><span class="kw">pub fn </span>from_octetstring(bytes: Vec&lt;u8&gt;) -&gt; <span class="self">Self </span>{
TaggedDerValue {
tag: TAG_OCTETSTRING,
pcbit: PCBit::Primitive,
value: bytes,
}
}
<span class="doccomment">/// Constructs a new `TaggedDerValue` from its tag and content
</span><span class="kw">pub fn </span>from_tag_and_bytes(tag: Tag, bytes: Vec&lt;u8&gt;) -&gt; <span class="self">Self </span>{
<span class="kw">let </span>pcbit = <span class="kw">match </span>tag {
TAG_SEQUENCE | TAG_SET =&gt; PCBit::Constructed,
<span class="kw">_ </span>=&gt; PCBit::Primitive,
};
TaggedDerValue {
tag,
pcbit,
value: bytes,
}
}
<span class="doccomment">/// Constructs a new `TaggedDerValue` from its tag,
/// primitive/constructed bit, and content
</span><span class="kw">pub fn </span>from_tag_pc_and_bytes(tag: Tag, pcbit: PCBit, bytes: Vec&lt;u8&gt;) -&gt; <span class="self">Self </span>{
TaggedDerValue {
tag,
pcbit,
value: bytes,
}
}
<span class="doccomment">/// Returns the tag
</span><span class="kw">pub fn </span>tag(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Tag {
<span class="self">self</span>.tag
}
<span class="doccomment">/// Returns the primitive/constructed bit
</span><span class="kw">pub fn </span>pcbit(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; PCBit {
<span class="self">self</span>.pcbit
}
<span class="doccomment">/// Returns the value
</span><span class="kw">pub fn </span>value(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[u8] {
<span class="kw-2">&amp;</span><span class="self">self</span>.value
}
<span class="doccomment">/// If the value is something that contains raw bytes,
/// returns its content.
///
/// # Examples
/// ```
/// use yasna::models::TaggedDerValue;
/// let value = TaggedDerValue::from_octetstring(vec![1, 2, 3, 4, 5, 6]);
/// assert!(value.as_bytes() == Some(&amp;[1, 2, 3, 4, 5, 6]));
/// ```
</span><span class="kw">pub fn </span>as_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>[u8]&gt; {
<span class="kw">match </span>(<span class="self">self</span>.tag, <span class="self">self</span>.pcbit) {
(TAG_BITSTRING, PCBit::Primitive) =&gt; {
<span class="comment">// First byte of bitstring value is number of unused bits.
// We only accept bitstrings that are multiples of bytes.
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="number">0</span>) = <span class="self">self</span>.value.first() {
<span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.value[<span class="number">1</span>..])
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
},
(TAG_OCTETSTRING, PCBit::Primitive) =&gt; <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.value),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None
</span>}
}
<span class="doccomment">/// If the value is something string-like, returns it as string.
</span><span class="kw">pub fn </span>as_str(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt; {
<span class="kw">use </span>std::str::from_utf8;
<span class="kw">match </span>(<span class="self">self</span>.tag, <span class="self">self</span>.pcbit) {
(TAG_IA5STRING, PCBit::Primitive) =&gt; from_utf8(<span class="kw-2">&amp;</span><span class="self">self</span>.value).ok(),
(TAG_PRINTABLESTRING, PCBit::Primitive) =&gt; from_utf8(<span class="kw-2">&amp;</span><span class="self">self</span>.value).ok(),
(TAG_UTF8STRING, PCBit::Primitive) =&gt; from_utf8(<span class="kw-2">&amp;</span><span class="self">self</span>.value).ok(),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None
</span>}
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="yasna" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>