ocaml-rpc/capnp-rpc-net/Capnp_rpc_net/Auth/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Auth (capnp-rpc-net.Capnp_rpc_net.Auth)</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">capnp-rpc-net</a> &#x00BB; <a href="../index.html">Capnp_rpc_net</a> &#x00BB; Auth</nav><header class="odoc-preamble"><h1>Module <code><span>Capnp_rpc_net.Auth</span></code></h1><p>Vat-level authentication and encryption.</p><p>Unless your network provides a secure mechanism for establishing connections to other vats, where you can be sure of the identity of the other party, you'll probably want to enable cryptographic security.</p><p>Each vat (application instance) should generate a secret key when it is first deployed. For servers at least, this key must be saved to disk so that the server retains its identity over re-starts. Otherwise, clients will think it is an imposter and refuse to connect.</p><p>Clients that do not accept incoming connections, nor create SturdyRefs, can get away with creating a new key each time. However, it might be quicker to save and reload the key anyway.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-hash"><a href="#type-hash" class="anchor"></a><code><span><span class="keyword">type</span> hash</span><span> = </span><span>[ </span></code><ol><li id="type-hash.SHA256" class="def variant constructor anchored"><a href="#type-hash.SHA256" class="anchor"></a><code><span>| </span><span>`SHA256</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Supported hashes.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Digest"><a href="#module-Digest" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Digest/index.html">Digest</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Secret_key"><a href="#module-Secret_key" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Secret_key/index.html">Secret_key</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>