package paf-le

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package paf-le

paf-le
- LE
  - Make
    
    Stack
    
    IP
    
    TCP
    
    UDP
    
    Time
paf-le.mirage
- LE_mirage
  - Make
    
    Paf
    
    TCP
    
    TLS
    
    Stack
    
    IP
    
    TCP
    
    UDP
    
    Time

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Time : Mirage_time.S

module Stack : Tcpip.Stack.V4V6

Signature

type nonrec configuration = configuration = {

email : Emile.mailbox option;
certificate_seed : string option;
certificate_key_type : X509.Key_type.t;
certificate_key_bits : int option;
hostname : [ `host ] Domain_name.t;
account_seed : string option;
account_key_type : X509.Key_type.t;
account_key_bits : int option;

}

val request_handler : 
  (Ipaddr.t * int) ->
  Httpaf.Server_connection.request_handler

val provision_certificate : 
  ?tries:int ->
  ?production:bool ->
  configuration ->
  Mimic.ctx ->
  (Tls.Config.own_cert, [> `Msg of string ]) Stdlib.result Lwt.t

val ctx : 
  gethostbyname:
    ('dns ->
      [ `host ] Domain_name.t ->
      (Ipaddr.t, [> `Msg of string ]) Stdlib.result Lwt.t) ->
  authenticator:X509.Authenticator.t ->
  'dns ->
  Stack.t ->
  Mimic.ctx

val with_uri : Uri.t -> Mimic.ctx -> Mimic.ctx

val initialise : 
  ?ctx:Mimic.ctx ->
  endpoint:Uri.t ->
  ?email:string ->
  X509.Private_key.t ->
  (Letsencrypt.Client.t, [> `Msg of string ]) Stdlib.result Lwt.t

initialise ~ctx ~endpoint ~email priv constructs a Letsencrypt.Client.t by looking up the directory and account of priv at endpoint. If no account is registered yet, a new account is created with contact information of email. The terms of service are agreed on.

val sign_certificate : 
  ?ctx:Mimic.ctx ->
  Letsencrypt.Client.solver ->
  Letsencrypt.Client.t ->
  (int -> unit Lwt.t) ->
  X509.Signing_request.t ->
  (X509.Certificate.t list, [> `Msg of string ]) Stdlib.result Lwt.t

sign_certificate ~ctx solver t sleep csr orders a certificate for the names in the signing request csr, and solves the requested challenges.