Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / openssl / base64.rs.html
blob: e69324a110288aa7b3319f6b7bd2b0770cde2723 [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/registry/src/github.com-1ecc6299db9ec823/openssl-0.10.54/src/base64.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>base64.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="../../openssl/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="../../openssl/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>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
</pre><pre class="rust"><code><span class="doccomment">//! Base64 encoding support.
</span><span class="kw">use </span><span class="kw">crate</span>::error::ErrorStack;
<span class="kw">use crate</span>::{cvt_n, LenType};
<span class="kw">use </span>libc::c_int;
<span class="kw">use </span>openssl_macros::corresponds;
<span class="doccomment">/// Encodes a slice of bytes to a base64 string.
///
/// # Panics
///
/// Panics if the input length or computed output length overflow a signed C integer.
</span><span class="attribute">#[corresponds(EVP_EncodeBlock)]
</span><span class="kw">pub fn </span>encode_block(src: <span class="kw-2">&amp;</span>[u8]) -&gt; String {
<span class="macro">assert!</span>(src.len() &lt;= c_int::max_value() <span class="kw">as </span>usize);
<span class="kw">let </span>src_len = src.len() <span class="kw">as </span>LenType;
<span class="kw">let </span>len = encoded_len(src_len).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>out = Vec::with_capacity(len <span class="kw">as </span>usize);
<span class="comment">// SAFETY: `encoded_len` ensures space for 4 output characters
// for every 3 input bytes including padding and nul terminator.
// `EVP_EncodeBlock` will write only single byte ASCII characters.
// `EVP_EncodeBlock` will only write to not read from `out`.
</span><span class="kw">unsafe </span>{
<span class="kw">let </span>out_len = ffi::EVP_EncodeBlock(out.as_mut_ptr(), src.as_ptr(), src_len);
out.set_len(out_len <span class="kw">as </span>usize);
String::from_utf8_unchecked(out)
}
}
<span class="doccomment">/// Decodes a base64-encoded string to bytes.
///
/// # Panics
///
/// Panics if the input length or computed output length overflow a signed C integer.
</span><span class="attribute">#[corresponds(EVP_DecodeBlock)]
</span><span class="kw">pub fn </span>decode_block(src: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;, ErrorStack&gt; {
<span class="kw">let </span>src = src.trim();
<span class="comment">// https://github.com/openssl/openssl/issues/12143
</span><span class="kw">if </span>src.is_empty() {
<span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="macro">vec!</span>[]);
}
<span class="macro">assert!</span>(src.len() &lt;= c_int::max_value() <span class="kw">as </span>usize);
<span class="kw">let </span>src_len = src.len() <span class="kw">as </span>LenType;
<span class="kw">let </span>len = decoded_len(src_len).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>out = Vec::with_capacity(len <span class="kw">as </span>usize);
<span class="comment">// SAFETY: `decoded_len` ensures space for 3 output bytes
// for every 4 input characters including padding.
// `EVP_DecodeBlock` can write fewer bytes after stripping
// leading and trailing whitespace, but never more.
// `EVP_DecodeBlock` will only write to not read from `out`.
</span><span class="kw">unsafe </span>{
<span class="kw">let </span>out_len = cvt_n(ffi::EVP_DecodeBlock(
out.as_mut_ptr(),
src.as_ptr(),
src_len,
))<span class="question-mark">?</span>;
out.set_len(out_len <span class="kw">as </span>usize);
}
<span class="kw">if </span>src.ends_with(<span class="string">&#39;=&#39;</span>) {
out.pop();
<span class="kw">if </span>src.ends_with(<span class="string">&quot;==&quot;</span>) {
out.pop();
}
}
<span class="prelude-val">Ok</span>(out)
}
<span class="kw">fn </span>encoded_len(src_len: LenType) -&gt; <span class="prelude-ty">Option</span>&lt;LenType&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>len = (src_len / <span class="number">3</span>).checked_mul(<span class="number">4</span>)<span class="question-mark">?</span>;
<span class="kw">if </span>src_len % <span class="number">3 </span>!= <span class="number">0 </span>{
len = len.checked_add(<span class="number">4</span>)<span class="question-mark">?</span>;
}
len = len.checked_add(<span class="number">1</span>)<span class="question-mark">?</span>;
<span class="prelude-val">Some</span>(len)
}
<span class="kw">fn </span>decoded_len(src_len: LenType) -&gt; <span class="prelude-ty">Option</span>&lt;LenType&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>len = (src_len / <span class="number">4</span>).checked_mul(<span class="number">3</span>)<span class="question-mark">?</span>;
<span class="kw">if </span>src_len % <span class="number">4 </span>!= <span class="number">0 </span>{
len = len.checked_add(<span class="number">3</span>)<span class="question-mark">?</span>;
}
<span class="prelude-val">Some</span>(len)
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_encode_block() {
<span class="macro">assert_eq!</span>(<span class="string">&quot;&quot;</span>.to_string(), encode_block(<span class="string">b&quot;&quot;</span>));
<span class="macro">assert_eq!</span>(<span class="string">&quot;Zg==&quot;</span>.to_string(), encode_block(<span class="string">b&quot;f&quot;</span>));
<span class="macro">assert_eq!</span>(<span class="string">&quot;Zm8=&quot;</span>.to_string(), encode_block(<span class="string">b&quot;fo&quot;</span>));
<span class="macro">assert_eq!</span>(<span class="string">&quot;Zm9v&quot;</span>.to_string(), encode_block(<span class="string">b&quot;foo&quot;</span>));
<span class="macro">assert_eq!</span>(<span class="string">&quot;Zm9vYg==&quot;</span>.to_string(), encode_block(<span class="string">b&quot;foob&quot;</span>));
<span class="macro">assert_eq!</span>(<span class="string">&quot;Zm9vYmE=&quot;</span>.to_string(), encode_block(<span class="string">b&quot;fooba&quot;</span>));
<span class="macro">assert_eq!</span>(<span class="string">&quot;Zm9vYmFy&quot;</span>.to_string(), encode_block(<span class="string">b&quot;foobar&quot;</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_decode_block() {
<span class="macro">assert_eq!</span>(<span class="string">b&quot;&quot;</span>.to_vec(), decode_block(<span class="string">&quot;&quot;</span>).unwrap());
<span class="macro">assert_eq!</span>(<span class="string">b&quot;f&quot;</span>.to_vec(), decode_block(<span class="string">&quot;Zg==&quot;</span>).unwrap());
<span class="macro">assert_eq!</span>(<span class="string">b&quot;fo&quot;</span>.to_vec(), decode_block(<span class="string">&quot;Zm8=&quot;</span>).unwrap());
<span class="macro">assert_eq!</span>(<span class="string">b&quot;foo&quot;</span>.to_vec(), decode_block(<span class="string">&quot;Zm9v&quot;</span>).unwrap());
<span class="macro">assert_eq!</span>(<span class="string">b&quot;foob&quot;</span>.to_vec(), decode_block(<span class="string">&quot;Zm9vYg==&quot;</span>).unwrap());
<span class="macro">assert_eq!</span>(<span class="string">b&quot;fooba&quot;</span>.to_vec(), decode_block(<span class="string">&quot;Zm9vYmE=&quot;</span>).unwrap());
<span class="macro">assert_eq!</span>(<span class="string">b&quot;foobar&quot;</span>.to_vec(), decode_block(<span class="string">&quot;Zm9vYmFy&quot;</span>).unwrap());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_strip_whitespace() {
<span class="macro">assert_eq!</span>(<span class="string">b&quot;foobar&quot;</span>.to_vec(), decode_block(<span class="string">&quot; Zm9vYmFy\n&quot;</span>).unwrap());
<span class="macro">assert_eq!</span>(<span class="string">b&quot;foob&quot;</span>.to_vec(), decode_block(<span class="string">&quot; Zm9vYg==\n&quot;</span>).unwrap());
}
}
</code></pre></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>