Skip to content

Commit

Permalink
Update dns doc to 8.0.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
hannesm committed May 29, 2024
1 parent 7280416 commit d5437be
Show file tree
Hide file tree
Showing 157 changed files with 1,413 additions and 521 deletions.
Empty file removed dns-certify/Dns_certify/.dummy
Empty file.
18 changes: 9 additions & 9 deletions dns-certify/Dns_certify/index.html

Large diffs are not rendered by default.

Empty file.
18 changes: 9 additions & 9 deletions dns-certify/Dns_certify_mirage/Make/index.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (dns-certify.Dns_certify_mirage.Make)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">dns-certify</a> &#x00BB; <a href="../index.html">Dns_certify_mirage</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>Dns_certify_mirage.Make</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-R"><a href="#argument-1-R" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>R</span><span> : <span class="xref-unresolved">Mirage_random</span>.S</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-2-P"><a href="#argument-2-P" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>P</span><span> : <span class="xref-unresolved">Mirage_clock</span>.PCLOCK</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-3-T"><a href="#argument-3-T" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>T</span><span> : <span class="xref-unresolved">Mirage_time</span>.S</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-4-S"><a href="#argument-4-S" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>S</span><span> : <span class="xref-unresolved">Tcpip</span>.Stack.V4V6</span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value anchored" id="val-retrieve_certificate"><a href="#val-retrieve_certificate" class="anchor"></a><code><span><span class="keyword">val</span> retrieve_certificate :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (dns-certify.Dns_certify_mirage.Make)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">dns-certify</a> &#x00BB; <a href="../index.html">Dns_certify_mirage</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>Dns_certify_mirage.Make</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-R"><a href="#argument-1-R" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>R</span><span> : <span class="xref-unresolved">Mirage_random</span>.S</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-2-P"><a href="#argument-2-P" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>P</span><span> : <span class="xref-unresolved">Mirage_clock</span>.PCLOCK</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-3-T"><a href="#argument-3-T" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>T</span><span> : <span class="xref-unresolved">Mirage_time</span>.S</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-4-S"><a href="#argument-4-S" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>S</span><span> : <span class="xref-unresolved">Tcpip</span>.Stack.V4V6</span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value anchored" id="val-retrieve_certificate"><a href="#val-retrieve_certificate" class="anchor"></a><code><span><span class="keyword">val</span> retrieve_certificate :
<span><span class="xref-unresolved">S</span>.t <span class="arrow">&#45;&gt;</span></span>
<span>dns_key:string <span class="arrow">&#45;&gt;</span></span>
<span>hostname:<span><span>[ `host ]</span> <span class="xref-unresolved">Domain_name</span>.t</span> <span class="arrow">&#45;&gt;</span></span>
<span>?additional_hostnames:<span><span><span>[ `raw ]</span> <span class="xref-unresolved">Domain_name</span>.t</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>?key_type:<span class="xref-unresolved">X509</span>.Key_type.t <span class="arrow">&#45;&gt;</span></span>
<span>?key_data:string <span class="arrow">&#45;&gt;</span></span>
<span>?key_seed:string <span class="arrow">&#45;&gt;</span></span>
<span>?bits:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">dns_key</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">hostname</span>:<span><span>[ `host ]</span> <span class="xref-unresolved">Domain_name</span>.t</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?additional_hostnames</span>:<span><span><span>[ `raw ]</span> <span class="xref-unresolved">Domain_name</span>.t</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?key_type</span>:<span class="xref-unresolved">X509</span>.Key_type.t <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?key_data</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?key_seed</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?bits</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">S</span>.TCP.ipaddr <span class="arrow">&#45;&gt;</span></span>
<span>int <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<span><span class="xref-unresolved">X509</span>.Certificate.t list</span> * <span class="xref-unresolved">X509</span>.Private_key.t, <span>[ <span>`Msg of string</span> ]</span>)</span>
<span class="xref-unresolved">Stdlib</span>.result</span>
<span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p><code>retrieve_certificate stack ~dns_key ~hostname ~key_type ~key_data ~key_seed ~bits server_ip port</code> generates a private key (using <code>key_type</code>, <code>key_data</code>, <code>key_seed</code>, and <code>bits</code>), a certificate signing request for the given <code>hostname</code> and <code>additional_hostnames</code>, and sends <code>server_ip</code> an nsupdate (DNS-TSIG with <code>dns_key</code>) with the csr as TLSA record, awaiting for a matching certificate as TLSA record. Requires a service that interacts with let's encrypt to transform the CSR into a signed certificate. If something fails, an exception (via <code>Lwt.fail</code>) is raised. This is meant for unikernels that require a valid TLS certificate before they can start their service (i.e. most web servers, mail servers).</p></div></div></div></body></html>
<span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p><code>retrieve_certificate stack ~dns_key ~hostname ~key_type ~key_data ~key_seed ~bits server_ip port</code> generates a private key (using <code>key_type</code>, <code>key_data</code>, <code>key_seed</code>, and <code>bits</code>), a certificate signing request for the given <code>hostname</code> and <code>additional_hostnames</code>, and sends <code>server_ip</code> an nsupdate (DNS-TSIG with <code>dns_key</code>) with the csr as TLSA record, awaiting for a matching certificate as TLSA record. Requires a service that interacts with let's encrypt to transform the CSR into a signed certificate. If something fails, an exception (via <code>Lwt.fail</code>) is raised. This is meant for unikernels that require a valid TLS certificate before they can start their service (i.e. most web servers, mail servers).</p></div></div></div></body></html>
4 changes: 2 additions & 2 deletions dns-certify/Dns_certify_mirage/index.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Dns_certify_mirage (dns-certify.Dns_certify_mirage)</title><link rel="stylesheet" href="../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">dns-certify</a> &#x00BB; Dns_certify_mirage</nav><header class="odoc-preamble"><h1>Module <code><span>Dns_certify_mirage</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Dns_certify_mirage (dns-certify.Dns_certify_mirage)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">dns-certify</a> &#x00BB; Dns_certify_mirage</nav><header class="odoc-preamble"><h1>Module <code><span>Dns_certify_mirage</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span>
(<a href="Make/index.html#argument-1-R">R</a> : <span class="xref-unresolved">Mirage_random</span>.S)
(<a href="Make/index.html#argument-2-P">P</a> : <span class="xref-unresolved">Mirage_clock</span>.PCLOCK)
(<a href="Make/index.html#argument-3-T">T</a> : <span class="xref-unresolved">Mirage_time</span>.S)
(<a href="Make/index.html#argument-4-S">S</a> : <span class="xref-unresolved">Tcpip</span>.Stack.V4V6) :
<span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
<span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dns-certify/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (dns-certify.index)</title><link rel="stylesheet" href="../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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> – dns-certify</nav><header class="odoc-preamble"><h1 id="dns-certify-index"><a href="#dns-certify-index" class="anchor"></a>dns-certify index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-dns-certify">Library dns-certify</a></li><li><a href="#library-dns-certify.mirage">Library dns-certify.mirage</a></li></ul></nav><div class="odoc-content"><h2 id="library-dns-certify"><a href="#library-dns-certify" class="anchor"></a>Library dns-certify</h2><p>The entry point of this library is the module: <a href="Dns_certify/index.html"><code>Dns_certify</code></a>.</p><h2 id="library-dns-certify.mirage"><a href="#library-dns-certify.mirage" class="anchor"></a>Library dns-certify.mirage</h2><p>The entry point of this library is the module: <a href="Dns_certify_mirage/index.html"><code>Dns_certify_mirage</code></a>.</p></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (dns-certify.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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> – dns-certify</nav><header class="odoc-preamble"><h1 id="dns-certify-index"><a href="#dns-certify-index" class="anchor"></a>dns-certify index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-dns-certify">Library dns-certify</a></li><li><a href="#library-dns-certify.mirage">Library dns-certify.mirage</a></li></ul></nav><div class="odoc-content"><h2 id="library-dns-certify"><a href="#library-dns-certify" class="anchor"></a>Library dns-certify</h2><p>The entry point of this library is the module: <a href="Dns_certify/index.html"><code>Dns_certify</code></a>.</p><h2 id="library-dns-certify.mirage"><a href="#library-dns-certify.mirage" class="anchor"></a>Library dns-certify.mirage</h2><p>The entry point of this library is the module: <a href="Dns_certify_mirage/index.html"><code>Dns_certify_mirage</code></a>.</p></div></body></html>
Empty file removed dns-cli/Dns_cli/.dummy
Empty file.
Loading

0 comments on commit d5437be

Please sign in to comment.