-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
24ea294
commit 1df41cb
Showing
24 changed files
with
1,020 additions
and
182 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Header (jose.Jose.Header)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">jose</a> » <a href="../index.html">Jose</a> » Header</nav><header class="odoc-preamble"><h1>Module <code><span>Jose.Header</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span><span>{</span></code><ol><li id="type-t.alg" class="def record field anchored"><a href="#type-t.alg" class="anchor"></a><code><span>alg : <a href="../Jwa/index.html#type-alg">Jwa.alg</a>;</span></code></li><li id="type-t.jwk" class="def record field anchored"><a href="#type-t.jwk" class="anchor"></a><code><span>jwk : <span><span><a href="../Jwk/index.html#type-public">Jwk.public</a> <a href="../Jwk/index.html#type-t">Jwk.t</a></span> option</span>;</span></code></li><li id="type-t.kid" class="def record field anchored"><a href="#type-t.kid" class="anchor"></a><code><span>kid : <span>string option</span>;</span></code></li><li id="type-t.x5t" class="def record field anchored"><a href="#type-t.x5t" class="anchor"></a><code><span>x5t : <span>string option</span>;</span></code></li><li id="type-t.x5t256" class="def record field anchored"><a href="#type-t.x5t256" class="anchor"></a><code><span>x5t256 : <span>string option</span>;</span></code></li><li id="type-t.typ" class="def record field anchored"><a href="#type-t.typ" class="anchor"></a><code><span>typ : <span>string option</span>;</span></code></li><li id="type-t.cty" class="def record field anchored"><a href="#type-t.cty" class="anchor"></a><code><span>cty : <span>string option</span>;</span></code></li><li id="type-t.enc" class="def record field anchored"><a href="#type-t.enc" class="anchor"></a><code><span>enc : <span><a href="../Jwa/index.html#type-enc">Jwa.enc</a> option</span>;</span></code></li><li id="type-t.extra" class="def record field anchored"><a href="#type-t.extra" class="anchor"></a><code><span>extra : <span><span>(string * <span class="xref-unresolved">Yojson</span>.Safe.t)</span> list</span>;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>The <code>header</code> has the following properties:</p><ul><li><code>alg</code> <a href="../Jwa/index.html#type-alg"><code>Jwa.alg</code></a></li><li><code>jwk</code> JSON Web Key</li><li><code>kid</code> Key ID - We currently always expect this to be there, this can change in the future</li><li><code>x5t</code> X.509 Certificate SHA-1 Thumbprint -</li><li><code>x5t#S256</code> X.509 Certificate SHA-256 Thumbprint</li><li><code>typ</code> Type</li><li><code>cty</code> Content Type Not implemented</li></ul><p><a href="https://tools.ietf.org/html/rfc7515#section-4.1">Link to RFC</a></p><p><a href="https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-header-parameters">Complete list of registered header parameters</a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_header"><a href="#val-make_header" class="anchor"></a><code><span><span class="keyword">val</span> make_header : | ||
| <span>?typ:string <span class="arrow">-></span></span> | ||
| <span>?alg:<a href="../Jwa/index.html#type-alg">Jwa.alg</a> <span class="arrow">-></span></span> | ||
| <span>?enc:<a href="../Jwa/index.html#type-enc">Jwa.enc</a> <span class="arrow">-></span></span> | ||
| <span>?extra:<span><span>(string * <span class="xref-unresolved">Yojson</span>.Safe.t)</span> list</span> <span class="arrow">-></span></span> | ||
| <span>?jwk_header:bool <span class="arrow">-></span></span> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Header (jose.Jose.Header)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">jose</a> » <a href="../index.html">Jose</a> » Header</nav><header class="odoc-preamble"><h1>Module <code><span>Jose.Header</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span><span>{</span></code><ol><li id="type-t.alg" class="def record field anchored"><a href="#type-t.alg" class="anchor"></a><code><span>alg : <a href="../Jwa/index.html#type-alg">Jwa.alg</a>;</span></code></li><li id="type-t.jwk" class="def record field anchored"><a href="#type-t.jwk" class="anchor"></a><code><span>jwk : <span><span><a href="../Jwk/index.html#type-public">Jwk.public</a> <a href="../Jwk/index.html#type-t">Jwk.t</a></span> option</span>;</span></code></li><li id="type-t.kid" class="def record field anchored"><a href="#type-t.kid" class="anchor"></a><code><span>kid : <span>string option</span>;</span></code></li><li id="type-t.x5t" class="def record field anchored"><a href="#type-t.x5t" class="anchor"></a><code><span>x5t : <span>string option</span>;</span></code></li><li id="type-t.x5t256" class="def record field anchored"><a href="#type-t.x5t256" class="anchor"></a><code><span>x5t256 : <span>string option</span>;</span></code></li><li id="type-t.typ" class="def record field anchored"><a href="#type-t.typ" class="anchor"></a><code><span>typ : <span>string option</span>;</span></code></li><li id="type-t.cty" class="def record field anchored"><a href="#type-t.cty" class="anchor"></a><code><span>cty : <span>string option</span>;</span></code></li><li id="type-t.enc" class="def record field anchored"><a href="#type-t.enc" class="anchor"></a><code><span>enc : <span><a href="../Jwa/index.html#type-enc">Jwa.enc</a> option</span>;</span></code></li><li id="type-t.extra" class="def record field anchored"><a href="#type-t.extra" class="anchor"></a><code><span>extra : <span><span>(string * <span class="xref-unresolved">Yojson</span>.Safe.t)</span> list</span>;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>The <code>header</code> has the following properties:</p><ul><li><code>alg</code> <a href="../Jwa/index.html#type-alg"><code>Jwa.alg</code></a></li><li><code>jwk</code> JSON Web Key</li><li><code>kid</code> Key ID - We currently always expect this to be there, this can change in the future</li><li><code>x5t</code> X.509 Certificate SHA-1 Thumbprint -</li><li><code>x5t#S256</code> X.509 Certificate SHA-256 Thumbprint</li><li><code>typ</code> Type</li><li><code>cty</code> Content Type Not implemented</li></ul><p><a href="https://tools.ietf.org/html/rfc7515#section-4.1">Link to RFC</a></p><p><a href="https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-header-parameters">Complete list of registered header parameters</a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_header"><a href="#val-make_header" class="anchor"></a><code><span><span class="keyword">val</span> make_header : | ||
| <span><span class="optlabel">?typ</span>:string <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?alg</span>:<a href="../Jwa/index.html#type-alg">Jwa.alg</a> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?enc</span>:<a href="../Jwa/index.html#type-enc">Jwa.enc</a> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?extra</span>:<span><span>(string * <span class="xref-unresolved">Yojson</span>.Safe.t)</span> list</span> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?jwk_header</span>:bool <span class="arrow">-></span></span> | ||
| <span><span><a href="../Jwk/index.html#type-priv">Jwk.priv</a> <a href="../Jwk/index.html#type-t">Jwk.t</a></span> <span class="arrow">-></span></span> | ||
| <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>make_header typ alg enc jwk</code> if <code>alg</code> is not provided it will be derived from <code>jwk</code>. <code>jwk_header</code> decides if the jwk should be put in the header.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string"><a href="#val-of_string" class="anchor"></a><code><span><span class="keyword">val</span> of_string : <span>string <span class="arrow">-></span></span> <span><span>(<a href="#type-t">t</a>, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span><span class="keyword">val</span> to_string : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_json"><a href="#val-to_json" class="anchor"></a><code><span><span class="keyword">val</span> to_json : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Yojson</span>.Safe.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_json"><a href="#val-of_json" class="anchor"></a><code><span><span class="keyword">val</span> of_json : <span><span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">-></span></span> <span><span>(<a href="#type-t">t</a>, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div></div></body></html> | ||
| <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>make_header typ alg enc jwk</code> if <code>alg</code> is not provided it will be derived from <code>jwk</code>. <code>jwk_header</code> decides if the jwk should be put in the header.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string"><a href="#val-of_string" class="anchor"></a><code><span><span class="keyword">val</span> of_string : <span>string <span class="arrow">-></span></span> <span><span>(<a href="#type-t">t</a>, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span><span class="keyword">val</span> to_string : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_json"><a href="#val-to_json" class="anchor"></a><code><span><span class="keyword">val</span> to_json : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Yojson</span>.Safe.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_json"><a href="#val-of_json" class="anchor"></a><code><span><span class="keyword">val</span> of_json : <span><span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">-></span></span> <span><span>(<a href="#type-t">t</a>, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div></div></body></html> |
Oops, something went wrong.