package x509

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 x509

x509
- X509
  - Authenticator
  - CRL
  - Certificate
  - Distinguished_name
  - Extension
  - General_name
  - Host
    
    Set
  - Key_type
  - OCSP
    
    Request
    
    Response
  - PKCS12
  - Private_key
  - Public_key
  - Signing_request
    
    Ext
  - Validation

Legend:
Library
Module
Module type
Parameter
Class
Class type

Public keys

Public keys as specified in PKCS 8 are supported in this module.

The type for public keys

type t = [

| `RSA of Mirage_crypto_pk.Rsa.pub
| `ED25519 of Mirage_crypto_ec.Ed25519.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 -> string

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:Digestif.hash' -> t -> string

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 -> Key_type.t

key_type public_key is its key_type.

Cryptographic verify operation

val verify : 
  Digestif.hash' ->
  ?scheme:Key_type.signature_scheme ->
  signature:string ->
  t ->
  [ `Message of string | `Digest of string ] ->
  (unit, [> `Msg of string ]) Stdlib.result

verify hash ~scheme ~signature key data verifies whether the signature on data is valid using the key, or not. The signature must be in ASN.1 DER encoding. The scheme defaults to `RSA_PSS for RSA, `ED25519 for ED25519, and `ECDSA for other EC keys.

Decoding and encoding in ASN.1 DER and PEM format

val encode_der : t -> string

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

val decode_der : string -> (t, [> `Msg of string ]) Stdlib.result

decode_der buffer is pubkey, the public key of the ASN.1 encoded buffer.

val decode_pem : string -> (t, [> `Msg of string ]) Stdlib.result

decode_pem pem is t, where the public key of pem is extracted

val encode_pem : t -> string

encode_pem public_key is pem, the pem encoded public key.