package dns

You can search for identifiers within the package.

in-package search v0.2.0

package dns

dns
- Dns
  - A
  - Aaaa
  - Caa
  - Cname
  - Dnskey
  - Edns
  - Mx
  - Name_rr_map
  - Ns
  - Opcode
  - Packet
    
    Answer
    
    Axfr
    
    Flag
    
    Header
    
    Ixfr
    
    Question
    
    Update
  - Ptr
  - Rcode
  - Rr_map
    
    I
  - Soa
  - Srv
  - Sshfp
  - Tlsa
  - Tsig
  - Tsig_op
  - Txt
dns.cache
- Dns_cache

Legend:
Library
Module
Module type
Parameter
Class
Class type

DNS keys

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

type algorithm =

| MD5
| SHA1
| SHA224
| SHA256
| SHA384
| SHA512
(*
The type of currently supported DNS key algorithms.
*)

val int_to_algorithm : 
  ?off:int ->
  int ->
  (algorithm, [> `Not_implemented of int * string ]) Stdlib.result

int_to_algorithm ~off i tries to decode i to an algorithm.

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 t = {

flags : int;
algorithm : algorithm;
key : Cstruct.t;

}

The type of a DNSKEY record.

val pp : t Fmt.t

pp ppf t pretty-prints the DNSKEY.

val compare : t -> t -> int

comapre a b compares the DNSKEY a with b.

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

of_string str attempts to parse str to a dnskey. The colon character (:) is used as separator, supported formats are: algo:keydata and flags:algo:keydata, where keydata is a base64 string.

val name_key_of_string : 
  string ->
  ([ `raw ] Domain_name.t * t, [> `Msg of string ]) Stdlib.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 pp_name_key : ([ `raw ] Domain_name.t * t) Fmt.t

pp_name_key (name, key) pretty-prints the dnskey and name pair.