dns-server 4.3.1 · OCaml Package

DNS Server implementation

module Authentication : sig ... end

Authentication, stored in a Dns_trie with privileges to operations embedded in the name.

type t = private {

data : Dns_trie.t;
auth : Authentication.t;
unauthenticated_zone_transfer : bool;
rng : int -> Cstruct.t;
tsig_verify : Dns.Tsig_op.verify;
tsig_sign : Dns.Tsig_op.sign;

}

The state of a DNS server.

val with_data : t -> Dns_trie.t -> t

with_data t data is t' where the data field is updated with the provided value.

val text : 
  'a Domain_name.t ->
  Dns_trie.t ->
  (string, [> `Msg of string ]) Stdlib.result

text name trie results in a string representation (zonefile) of the trie.

val handle_question : 
  t ->
  Dns.Packet.Question.t ->
  (Dns.Packet.Flags.t * Dns.Packet.Answer.t * Dns.Name_rr_map.t option,
    Dns.Rcode.t * Dns.Packet.Answer.t option)
    Stdlib.result

handle_question t question handles the DNS query question by looking it up in the trie of t.

val handle_update : 
  t ->
  Dns.proto ->
  [ `raw ] Domain_name.t option ->
  Dns.Packet.Question.t ->
  Dns.Packet.Update.t ->
  (Dns_trie.t * ([ `raw ] Domain_name.t * Dns.Soa.t) list, Dns.Rcode.t)
    Stdlib.result

handle_update t proto keyname question update authenticates the update request and processes the update.

val handle_axfr_request : 
  t ->
  Dns.proto ->
  [ `raw ] Domain_name.t option ->
  Dns.Packet.Question.t ->
  (Dns.Packet.Axfr.t, Dns.Rcode.t) Stdlib.result

handle_axfr_request t proto keyname question authenticates the zone transfer request and processes it. If the request is valid, and the zone available, a zone transfer is returned.

val counter_metrics : 
  f:('a -> string) ->
  string ->
  (Metrics.field list, 'a -> Metrics.Data.t) Metrics.src

type trie_cache

val handle_ixfr_request : 
  t ->
  trie_cache ->
  Dns.proto ->
  [ `raw ] Domain_name.t option ->
  Dns.Packet.Question.t ->
  Dns.Soa.t ->
  (Dns.Packet.Ixfr.t, Dns.Rcode.t) Stdlib.result

handle_ixfr_request t cache proto keyname question soa authenticates the incremental zone transfer request and processes it. If valid, an incremental zone transfer is returned.

val handle_tsig : 
  ?mac:Cstruct.t ->
  t ->
  Ptime.t ->
  Dns.Packet.t ->
  Cstruct.t ->
  (([ `raw ] Domain_name.t * Dns.Tsig.t * Cstruct.t * Dns.Dnskey.t) option,
    Dns.Tsig_op.e * Cstruct.t option)
    Stdlib.result

handle_tsig ~mac t now packet buffer verifies the tsig signature if present, returning the keyname, tsig, mac, and used key.

module Primary : sig ... end

module Secondary : sig ... end

package dns-server