Skip to content

Commit

Permalink
Deploying to gh-pages from @ caee538 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@ulrikstrid
ulrikstrid committed Feb 13, 2025
1 parent 8de2f6f commit 8400cca
Show file tree
Hide file tree
Showing 11 changed files with 573 additions and 273 deletions.
2 changes: 1 addition & 1 deletion jose/Jose/Header/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<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> &#x00BB; <a href="../index.html">Jose</a> &#x00BB; 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 :
<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 3.0.0_beta1"/><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">🏠</a> &#x00BB; <a href="../../index.html">jose</a> &#x00BB; <a href="../index.html">Jose</a> &#x00BB; 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">&#45;&gt;</span></span>
<span><span class="optlabel">?alg</span>:<a href="../Jwa/index.html#type-alg">Jwa.alg</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?enc</span>:<a href="../Jwa/index.html#type-enc">Jwa.enc</a> <span class="arrow">&#45;&gt;</span></span>
Expand Down
2 changes: 1 addition & 1 deletion jose/Jose/Jwa/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion jose/Jose/Jwe/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jwe (jose.Jose.Jwe)</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> &#x00BB; <a href="../index.html">Jose</a> &#x00BB; Jwe</nav><header class="odoc-preamble"><h1>Module <code><span>Jose.Jwe</span></code></h1><p><a href="https://tools.ietf.org/html/rfc7516">Link to RFC</a></p></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.header" class="def record field anchored"><a href="#type-t.header" class="anchor"></a><code><span>header : <a href="../Header/index.html#type-t">Header.t</a>;</span></code></li><li id="type-t.cek" class="def record field anchored"><a href="#type-t.cek" class="anchor"></a><code><span>cek : string;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Content Encryption Key</p><span class="comment-delim">*)</span></div></li><li id="type-t.iv" class="def record field anchored"><a href="#type-t.iv" class="anchor"></a><code><span>iv : string;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Initialization Vector</p><span class="comment-delim">*)</span></div></li><li id="type-t.payload" class="def record field anchored"><a href="#type-t.payload" class="anchor"></a><code><span>payload : string;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>plaintext to be encrypted</p><span class="comment-delim">*)</span></div></li><li id="type-t.aad" class="def record field anchored"><a href="#type-t.aad" class="anchor"></a><code><span>aad : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Additional Authentication Data, for future use</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>A JWE ready for encryption</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jwe (jose.Jose.Jwe)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 3.0.0_beta1"/><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">🏠</a> &#x00BB; <a href="../../index.html">jose</a> &#x00BB; <a href="../index.html">Jose</a> &#x00BB; Jwe</nav><header class="odoc-preamble"><h1>Module <code><span>Jose.Jwe</span></code></h1><p><a href="https://tools.ietf.org/html/rfc7516">Link to RFC</a></p></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.header" class="def record field anchored"><a href="#type-t.header" class="anchor"></a><code><span>header : <a href="../Header/index.html#type-t">Header.t</a>;</span></code></li><li id="type-t.cek" class="def record field anchored"><a href="#type-t.cek" class="anchor"></a><code><span>cek : string;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Content Encryption Key</p><span class="comment-delim">*)</span></div></li><li id="type-t.iv" class="def record field anchored"><a href="#type-t.iv" class="anchor"></a><code><span>iv : string;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Initialization Vector</p><span class="comment-delim">*)</span></div></li><li id="type-t.payload" class="def record field anchored"><a href="#type-t.payload" class="anchor"></a><code><span>payload : string;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>plaintext to be encrypted</p><span class="comment-delim">*)</span></div></li><li id="type-t.aad" class="def record field anchored"><a href="#type-t.aad" class="anchor"></a><code><span>aad : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Additional Authentication Data, for future use</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>A JWE ready for encryption</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
<span><span class="label">header</span>:<a href="../Header/index.html#type-t">Header.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="#type-t">t</a>, <span>[&gt; `Missing_enc <span>| `Unsupported_alg</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>make header payload</code> creates a JWE from a <a href="../Header/index.html#type-t"><code>Header.t</code></a> and the plaintext that you want to encrypt</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encrypt"><a href="#val-encrypt" class="anchor"></a><code><span><span class="keyword">val</span> encrypt :
Expand Down
Loading

0 comments on commit 8400cca

Please sign in to comment.