package conex

You can search for identifiers within the package.

in-package search v0.2.0

package conex

conex
- Conex
  - Make
    
    C
    
    L
    
    Tag
- Conex_diff
- Conex_diff_provider
- Conex_io
- Conex_opam_encoding
- Conex_private
  - FS
  - Make
    
    C
    
    F
  - S
  - S_RSA_BACK
- Conex_repository
- Conex_resource
  - Delegation
  - Digest
  - Digest_map
  - Expression
  - Header
  - Key
  - Root
  - Signature
  - Target
  - Targets
  - Wire
- Conex_utils
  - LOGS
    
    Tag
  - M
  - S
  - String
  - Tree
  - Uint
  - Uint_map
- Conex_verify
  - Make
    
    C
  - S
  - S_RSA_BACK
conex.openssl
- Conex_openssl
  - O_V
  - V
conex.unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

The private key module type

type t

The type of a private key

val ids : unit -> Conex_resource.identifier list

ids () is the list of all available private keys.

type r_err = [

| `Decode of string
| `Read of string
| `None
| `Multiple of string list

]

val pp_r_err : r_err Conex_utils.fmt

val read : 
  (float -> Conex_resource.timestamp option) ->
  Conex_resource.identifier ->
  (t, r_err) Stdlib.result

read id is either Ok priv, the private key corresponding to id, or an Error.

val bits : t -> int

bits t is the number of bits of the private key t.

val created : t -> Conex_resource.timestamp

created t is the timestamp when t was created.

val id : t -> Conex_resource.identifier

id t is the identifier of t.

val generate : 
  ?bits:int ->
  (float -> Conex_resource.timestamp option) ->
  Conex_resource.Key.alg ->
  Conex_resource.identifier ->
  unit ->
  (t, string) Stdlib.result

generate ~bits alg id () generates a fresh private key using alg for id, or an error. Generate also ensures to persistently store the generated key if desired.

val pub_of_priv : t -> Conex_resource.Key.t

pub_of_priv priv extracts the public key out of priv.

val sign : 
  Conex_resource.Wire.t ->
  Conex_resource.timestamp ->
  Conex_resource.identifier ->
  Conex_resource.Signature.alg ->
  t ->
  (Conex_resource.Signature.t, string) Stdlib.result

sign wire now id alg priv signs wire with priv using alg, and evaluates to a signature, or an error.