| <!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/encoding.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>encoding.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> |
| <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> |
| </pre><pre class="rust"><code><span class="kw">use </span>serde::ser::Serialize; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::algorithms::AlgorithmFamily; |
| <span class="kw">use </span><span class="kw">crate</span>::crypto; |
| <span class="kw">use </span><span class="kw">crate</span>::errors::{new_error, ErrorKind, <span class="prelude-ty">Result</span>}; |
| <span class="kw">use </span><span class="kw">crate</span>::header::Header; |
| <span class="kw">use </span><span class="kw">crate</span>::pem::decoder::PemEncodedKey; |
| <span class="kw">use </span><span class="kw">crate</span>::serialization::b64_encode_part; |
| |
| <span class="doccomment">/// A key to encode a JWT with. Can be a secret, a PEM-encoded key or a DER-encoded key. |
| /// This key can be re-used so make sure you only initialize it once if you can for better performance |
| </span><span class="attribute">#[derive(Debug, Clone, PartialEq)] |
| </span><span class="kw">pub struct </span>EncodingKey { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) family: AlgorithmFamily, |
| content: Vec<u8>, |
| } |
| |
| <span class="kw">impl </span>EncodingKey { |
| <span class="doccomment">/// If you're using a HMAC secret that is not base64, use that. |
| </span><span class="kw">pub fn </span>from_secret(secret: <span class="kw-2">&</span>[u8]) -> <span class="self">Self </span>{ |
| EncodingKey { family: AlgorithmFamily::Hmac, content: secret.to_vec() } |
| } |
| |
| <span class="doccomment">/// If you have a base64 HMAC secret, use that. |
| </span><span class="kw">pub fn </span>from_base64_secret(secret: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>> { |
| <span class="kw">let </span>out = base64::decode(<span class="kw-2">&</span>secret)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(EncodingKey { family: AlgorithmFamily::Hmac, content: out }) |
| } |
| |
| <span class="doccomment">/// If you are loading a RSA key from a .pem file. |
| /// This errors if the key is not a valid RSA key. |
| </span><span class="kw">pub fn </span>from_rsa_pem(key: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>> { |
| <span class="kw">let </span>pem_key = PemEncodedKey::new(key)<span class="question-mark">?</span>; |
| <span class="kw">let </span>content = pem_key.as_rsa_key()<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(EncodingKey { family: AlgorithmFamily::Rsa, content: content.to_vec() }) |
| } |
| |
| <span class="doccomment">/// If you are loading a ECDSA key from a .pem file |
| /// This errors if the key is not a valid private EC key |
| </span><span class="kw">pub fn </span>from_ec_pem(key: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>> { |
| <span class="kw">let </span>pem_key = PemEncodedKey::new(key)<span class="question-mark">?</span>; |
| <span class="kw">let </span>content = pem_key.as_ec_private_key()<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(EncodingKey { family: AlgorithmFamily::Ec, content: content.to_vec() }) |
| } |
| |
| <span class="doccomment">/// If you know what you're doing and have the DER-encoded key, for RSA only |
| </span><span class="kw">pub fn </span>from_rsa_der(der: <span class="kw-2">&</span>[u8]) -> <span class="self">Self </span>{ |
| EncodingKey { family: AlgorithmFamily::Rsa, content: der.to_vec() } |
| } |
| |
| <span class="doccomment">/// If you know what you're doing and have the DER-encoded key, for ECDSA |
| </span><span class="kw">pub fn </span>from_ec_der(der: <span class="kw-2">&</span>[u8]) -> <span class="self">Self </span>{ |
| EncodingKey { family: AlgorithmFamily::Ec, content: der.to_vec() } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>inner(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="kw-2">&</span><span class="self">self</span>.content |
| } |
| } |
| |
| <span class="doccomment">/// Encode the header and claims given and sign the payload using the algorithm from the header and the key. |
| /// If the algorithm given is RSA or EC, the key needs to be in the PEM format. |
| /// |
| /// ```rust |
| /// use serde::{Deserialize, Serialize}; |
| /// use jsonwebtoken::{encode, Algorithm, Header, EncodingKey}; |
| /// |
| /// #[derive(Debug, Serialize, Deserialize)] |
| /// struct Claims { |
| /// sub: String, |
| /// company: String |
| /// } |
| /// |
| /// let my_claims = Claims { |
| /// sub: "b@b.com".to_owned(), |
| /// company: "ACME".to_owned() |
| /// }; |
| /// |
| /// // my_claims is a struct that implements Serialize |
| /// // This will create a JWT using HS256 as algorithm |
| /// let token = encode(&Header::default(), &my_claims, &EncodingKey::from_secret("secret".as_ref())).unwrap(); |
| /// ``` |
| </span><span class="kw">pub fn </span>encode<T: Serialize>(header: <span class="kw-2">&</span>Header, claims: <span class="kw-2">&</span>T, key: <span class="kw-2">&</span>EncodingKey) -> <span class="prelude-ty">Result</span><String> { |
| <span class="kw">if </span>key.family != header.alg.family() { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(new_error(ErrorKind::InvalidAlgorithm)); |
| } |
| <span class="kw">let </span>encoded_header = b64_encode_part(<span class="kw-2">&</span>header)<span class="question-mark">?</span>; |
| <span class="kw">let </span>encoded_claims = b64_encode_part(<span class="kw-2">&</span>claims)<span class="question-mark">?</span>; |
| <span class="kw">let </span>message = [encoded_header.as_ref(), encoded_claims.as_ref()].join(<span class="string">"."</span>); |
| <span class="kw">let </span>signature = crypto::sign(<span class="kw-2">&*</span>message, key, header.alg)<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>([message, signature].join(<span class="string">"."</span>)) |
| } |
| </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> |
