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

The object ID passed in the Cap'n Proto Bootstrap message.

val generate : unit -> t

generate () is a fresh unguessable service ID. Note: you must initialise `Nocrypto`'s entropy before calling this (you will get a runtime error if you forget).

val derived : secret:string -> string -> t

derived ~secret name is a service ID based on secret and name. It is calculated as SHA256.hmac secret name. secret could be the hash of a private key file, for example.

val public : string -> t

public name is the service ID name. This may be useful for interoperability with non-secure clients that expect to use a plain-text service ID (e.g. "calculator"). It could also be useful if name is some unguessable token you have generated yourself.

val digest : Auth.hash -> t -> string

digest h id is the digest h id.

Since id is normally a secret token, we must be careful not to allow timing attacks (taking a slightly different amount of time to return an error depending on how much of the ID the caller guessed correctly). Taking a secure hash of the value first is one way to avoid this, since revealing the hash isn't helpful to the attacker.

val to_string : t -> string

to_string t is the raw bytes of t.

val pp : t Fmt.t

val equal : t -> t -> bool