package capnp-rpc-net

You can search for identifiers within the package.

in-package search v0.2.0

capnp-rpc-net
- Capnp_rpc_net
  - Auth
    
    Digest
    
    Secret_key
  - Capnp_address
    
    Location
  - Endpoint
  - Networking
    
    CapTP
    
    N
    
    Address
    
    Vat
  - Restorer
    
    Id
    
    LOADER
    
    Table
  - S
    
    ADDRESS
    
    NETWORK
    
    Address
    
    VAT_NETWORK
    
    CapTP
    
    Network
    
    Address
    
    Vat
  - Tls_wrapper
    
    Make
  - Two_party_network
    
    Address
  - VAT_NETWORK
    
    CapTP
    
    Network
    
    Address
    
    Vat

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

A vat's secret_key allows it to prove its identity to other vats.

val generate : unit -> t

generate () is a fresh secret key. You must call the relevant entropy initialization function (e.g. Mirage_crypto_rng_lwt.initialize) before using this, or it will raise an error if you forget.

val digest : ?hash:hash -> t -> Digest.t

digest ~hash t is the digest of t's public key, using hash.

val of_pem_data : string -> t

of_pem_data data parses data as a PEM-encoded private key.

val to_pem_data : t -> string

to_pem_data t returns t as a PEM-encoded private key.

val tls_client_config : 
  t ->
  authenticator:X509.Authenticator.t ->
  Tls.Config.client

tls_client_config t ~authenticator is the TLS client configuration to use for a vat with secret key t, attempting to connect to a vat that can be authenticated with authenticator.

val tls_server_config : t -> Tls.Config.server

tls_server_config t is the TLS server configuration to use for a vat with secret key t.

val pp_fingerprint : hash -> t Fmt.t

pp_fingerprint hash formats the hash of t's public key.

val equal : t -> t -> bool