| <!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/jsonwebtoken-7.2.0/src/header.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>header.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="../../jsonwebtoken/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="../../jsonwebtoken/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> |
| </pre><pre class="rust"><code><span class="kw">use </span>serde::{Deserialize, Serialize}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::algorithms::Algorithm; |
| <span class="kw">use </span><span class="kw">crate</span>::errors::Result; |
| <span class="kw">use </span><span class="kw">crate</span>::serialization::b64_decode; |
| |
| <span class="doccomment">/// A basic JWT header, the alg defaults to HS256 and typ is automatically |
| /// set to `JWT`. All the other fields are optional. |
| </span><span class="attribute">#[derive(Debug, Clone, PartialEq, Hash, Serialize, Deserialize)] |
| </span><span class="kw">pub struct </span>Header { |
| <span class="doccomment">/// The type of JWS: it can only be "JWT" here |
| /// |
| /// Defined in [RFC7515#4.1.9](https://tools.ietf.org/html/rfc7515#section-4.1.9). |
| </span><span class="attribute">#[serde(skip_serializing_if = <span class="string">"Option::is_none"</span>)] |
| </span><span class="kw">pub </span>typ: <span class="prelude-ty">Option</span><String>, |
| <span class="doccomment">/// The algorithm used |
| /// |
| /// Defined in [RFC7515#4.1.1](https://tools.ietf.org/html/rfc7515#section-4.1.1). |
| </span><span class="kw">pub </span>alg: Algorithm, |
| <span class="doccomment">/// Content type |
| /// |
| /// Defined in [RFC7519#5.2](https://tools.ietf.org/html/rfc7519#section-5.2). |
| </span><span class="attribute">#[serde(skip_serializing_if = <span class="string">"Option::is_none"</span>)] |
| </span><span class="kw">pub </span>cty: <span class="prelude-ty">Option</span><String>, |
| <span class="doccomment">/// JSON Key URL |
| /// |
| /// Defined in [RFC7515#4.1.2](https://tools.ietf.org/html/rfc7515#section-4.1.2). |
| </span><span class="attribute">#[serde(skip_serializing_if = <span class="string">"Option::is_none"</span>)] |
| </span><span class="kw">pub </span>jku: <span class="prelude-ty">Option</span><String>, |
| <span class="doccomment">/// Key ID |
| /// |
| /// Defined in [RFC7515#4.1.4](https://tools.ietf.org/html/rfc7515#section-4.1.4). |
| </span><span class="attribute">#[serde(skip_serializing_if = <span class="string">"Option::is_none"</span>)] |
| </span><span class="kw">pub </span>kid: <span class="prelude-ty">Option</span><String>, |
| <span class="doccomment">/// X.509 URL |
| /// |
| /// Defined in [RFC7515#4.1.5](https://tools.ietf.org/html/rfc7515#section-4.1.5). |
| </span><span class="attribute">#[serde(skip_serializing_if = <span class="string">"Option::is_none"</span>)] |
| </span><span class="kw">pub </span>x5u: <span class="prelude-ty">Option</span><String>, |
| <span class="doccomment">/// X.509 certificate thumbprint |
| /// |
| /// Defined in [RFC7515#4.1.7](https://tools.ietf.org/html/rfc7515#section-4.1.7). |
| </span><span class="attribute">#[serde(skip_serializing_if = <span class="string">"Option::is_none"</span>)] |
| </span><span class="kw">pub </span>x5t: <span class="prelude-ty">Option</span><String>, |
| } |
| |
| <span class="kw">impl </span>Header { |
| <span class="doccomment">/// Returns a JWT header with the algorithm given |
| </span><span class="kw">pub fn </span>new(algorithm: Algorithm) -> <span class="self">Self </span>{ |
| Header { |
| typ: <span class="prelude-val">Some</span>(<span class="string">"JWT"</span>.to_string()), |
| alg: algorithm, |
| cty: <span class="prelude-val">None</span>, |
| jku: <span class="prelude-val">None</span>, |
| kid: <span class="prelude-val">None</span>, |
| x5u: <span class="prelude-val">None</span>, |
| x5t: <span class="prelude-val">None</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Converts an encoded part into the Header struct if possible |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_encoded(encoded_part: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>> { |
| <span class="kw">let </span>decoded = b64_decode(encoded_part)<span class="question-mark">?</span>; |
| <span class="kw">let </span>s = String::from_utf8(decoded)<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(serde_json::from_str(<span class="kw-2">&</span>s)<span class="question-mark">?</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>Header { |
| <span class="doccomment">/// Returns a JWT header using the default Algorithm, HS256 |
| </span><span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| Header::new(Algorithm::default()) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="jsonwebtoken" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
