package tls-async

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

The type for public keys
Operations on public keys
Cryptographic verify 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

Public keys

The type for public keys

type t = [

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

]

The polymorphic variant of public keys, with PKCS 8 encoding and decoding to PEM.

Operations on public keys

val pp : t Fmt.t

pp ppf pub pretty-prints the public key pub on ppf.

val id : t -> Cstruct.t

id public_key is digest, the 160-bit `SHA1 hash of the BIT STRING subjectPublicKey (excluding tag, length, and number of unused bits) for publicKeyInfo of public_key.

RFC 5280, 4.2.1.2, variant (1)

val fingerprint : ?hash:Mirage_crypto.Hash.hash -> t -> Cstruct.t

fingerprint ?hash public_key is digest, the hash (by default SHA256) of the DER encoded public key (equivalent to openssl x509 -noout -pubkey | openssl pkey -pubin -outform DER | openssl dgst -HASH).

val key_type : t -> X509.Key_type.t

key_type public_key is its key_type.

Cryptographic verify operation

Decoding and encoding in ASN.1 DER and PEM format

val encode_der : t -> Cstruct.t

encode_der pk is buffer, the ASN.1 encoding of the given public key.

val encode_pem : t -> Cstruct.t

encode_pem public_key is pem, the pem encoded public key.

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

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

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