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

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Secret_key (capnp-rpc-net.Capnp_rpc_net.Auth.Secret_key)</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; <a href="../index.html">Auth</a> &#x00BB; Secret_key</nav><header class="odoc-preamble"><h1>Module <code><span>Auth.Secret_key</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></code></div><div class="spec-doc"><p>A vat's <code>secret_key</code> allows it to prove its identity to other vats.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-generate"><a href="#val-generate" class="anchor"></a><code><span><span class="keyword">val</span> generate : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>generate ()</code> is a fresh secret key. You must use e.g. <code>Mirage_crypto_rng_eio.run</code> to set a source of randomness before using this (it will raise an error if you forget).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-digest"><a href="#val-digest" class="anchor"></a><code><span><span class="keyword">val</span> digest : <span><span class="optlabel">?hash</span>:<a href="../index.html#type-hash">hash</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Digest/index.html#type-t">Digest.t</a></span></code></div><div class="spec-doc"><p><code>digest ~hash t</code> is the digest of <code>t</code>'s public key, using <code>hash</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_pem_data"><a href="#val-of_pem_data" class="anchor"></a><code><span><span class="keyword">val</span> of_pem_data : <span>string <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>of_pem_data data</code> parses <code>data</code> as a PEM-encoded private key.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_pem_data"><a href="#val-to_pem_data" class="anchor"></a><code><span><span class="keyword">val</span> to_pem_data : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p><code>to_pem_data t</code> returns <code>t</code> as a PEM-encoded private key.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tls_client_config"><a href="#val-tls_client_config" class="anchor"></a><code><span><span class="keyword">val</span> tls_client_config : 
  <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="label">authenticator</span>:<span class="xref-unresolved">X509</span>.Authenticator.t <span class="arrow">&#45;&gt;</span></span>
  <span class="xref-unresolved">Tls</span>.Config.client</span></code></div><div class="spec-doc"><p><code>tls_client_config t ~authenticator</code> is the TLS client configuration to use for a vat with secret key <code>t</code>, attempting to connect to a vat that can be authenticated with <code>authenticator</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tls_server_config"><a href="#val-tls_server_config" class="anchor"></a><code><span><span class="keyword">val</span> tls_server_config : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Tls</span>.Config.server</span></code></div><div class="spec-doc"><p><code>tls_server_config t</code> is the TLS server configuration to use for a vat with secret key <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_fingerprint"><a href="#val-pp_fingerprint" class="anchor"></a><code><span><span class="keyword">val</span> pp_fingerprint : <span><a href="../index.html#type-hash">hash</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div><div class="spec-doc"><p><code>pp_fingerprint hash</code> formats the hash of <code>t</code>'s public key.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div></div></body></html>