dns 9.1.0 · OCaml Package

DNS keys

A DNS key record (DNSKEY) specifies flags, algorithm, and key data.

type algorithm =

| RSA_SHA1
| RSASHA1_NSEC3_SHA1
| RSA_SHA256
| RSA_SHA512
| P256_SHA256
| P384_SHA384
| ED25519
| MD5
| SHA1
| SHA224
| SHA256
| SHA384
| SHA512
| Unknown of int
(*
The type of currently supported DNS key algorithms.
*)

val int_to_algorithm : int -> algorithm

int_to_algorithm i decodes i to an algorithm.

raises Invalid_argument
if i does not fit in one octet.

val algorithm_to_int : algorithm -> int

algorithm_to_int a encodes a to an integer.

val pp_algorithm : algorithm Fmt.t

pp_algorithm ppf a pretty-prints the algorithm.

type flag = [

| `Zone
| `Revoke
| `Secure_entry_point

]

The type of DNSKEY flags.

module F : Set.S with type elt = flag

The set of DNSKEY flags.

val decode_flags : int -> F.t

decode_flags x decodes x as a set of DNSKEY flags.

type t = {

flags : F.t;
algorithm : algorithm;
key : string;

}

The type of a DNSKEY record.

val pp : t Fmt.t

pp ppf t pretty-prints the DNSKEY.

val compare : t -> t -> int

compare a b compares the DNSKEY a with b.

val of_string : string -> (t, [> `Msg of string ]) result

of_string str attempts to parse str to a dnskey. The colon character (:) is used as separator, supported format is: algorithm:keydata. Flags are not supported.

val to_string : t -> string

to_string key is a string where the colon character (:) is used as separator. The output is algorithm:keydata. Flags are not supported.

val name_key_of_string : 
  string ->
  ([ `raw ] Domain_name.t * t, [> `Msg of string ]) result

name_key_of_string str attempts to parse str to a domain name and a dnskey. The colon character (:) is used as separator.

val name_key_to_string : ([ `raw ] Domain_name.t * t) -> string

name_key_to_string (name, key) is a string name:algorithm:keydata. The colon character (:) is used as separater.

val digest_prep : [ `raw ] Domain_name.t -> t -> string

digest_prep name key encodes name and key into a buffer, as preparation for computing its digest (for DS records).

val key_tag : t -> int

key_tag key computes the key tag (RFC 4034, Appendix B).

package dns