package tls-async

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

The type for private keys
Constructing private keys
Operations on private keys
Cryptographic sign operation
Decoding and encoding in ASN.1 DER and PEM format

package tls-async

tls-async
- Tls_async
  - Session
    
    Fd
  - X509_async
    
    Authenticator
    
    Param
    
    CRL
    
    Certificate
    
    Distinguished_name
    
    OCSP
    
    Request
    
    Response
    
    PKCS12
    
    Private_key
    
    Public_key
    
    Signing_request

Legend:
Library
Module
Module type
Parameter
Class
Class type

Private keys

The type for private keys

type t = [

| `RSA of Mirage_crypto_pk.Rsa.priv
| `ED25519 of Mirage_crypto_ec.Ed25519.priv
| `P224 of Mirage_crypto_ec.P224.Dsa.priv
| `P256 of Mirage_crypto_ec.P256.Dsa.priv
| `P384 of Mirage_crypto_ec.P384.Dsa.priv
| `P521 of Mirage_crypto_ec.P521.Dsa.priv

]

The polymorphic variant of private keys.

Constructing private keys

val generate : ?seed:Cstruct.t -> ?bits:int -> X509.Key_type.t -> t

generate ~seed ~bits type generates a private key of the given key type. The argument bits is only used for the bit length of RSA keys. If seed is provided, this is used to seed the random number generator.

val of_cstruct : 
  Cstruct.t ->
  X509.Key_type.t ->
  (t, [> Rresult.R.msg ]) Rresult.result

of_cstruct data decodes the buffer as private key. Only supported for elliptic curve keys.

Operations on private keys

val key_type : t -> X509.Key_type.t

key_type priv is the key type of priv.

val public : t -> X509.Public_key.t

public priv is the corresponding public key of priv.

Cryptographic sign operation

Decoding and encoding in ASN.1 DER and PEM format

val encode_der : t -> Cstruct.t

encode_der key is der, the encoded private key as PKCS8 (RFC 5208, Section 5) PrivateKeyInfo structure.

val encode_pem : t -> Cstruct.t

encode_pem key is pem, the encoded private key (using PRIVATE KEY).

val sign : 
  Mirage_crypto.Hash.hash ->
  ?scheme:Key_type.signature_scheme ->
  t ->
  [ `Digest of Cstruct.t | `Message of Cstruct.t ] ->
  string Core.Or_error.t

val decode_der : contents:string -> t Core.Or_error.t

val decode_pem : contents:string -> t Core.Or_error.t

val of_pem_file : Core.Filename.t -> t Async.Deferred.Or_error.t