trapi

Name

trapi - Temporary resource record API

Description

The trapi plugin allows adding temporary resource records that are held in memory of the server instance for a given amount of time. Temporary resource records (TRRs) are served on top of the underlying backend-plugin (e.g. file or kubernetes). It increases the serial number for every added added record, as well as after record expiry to make zone transfer possible. Slaves are notified on every API call and shortly after TRR expiry

Syntax

trapi LISTEN_ADDRESS {
  token API_TOKEN
  certFile [SSL_CERTIFICATE_FILE]
  keyFile [SSL_KEY_FILE]
}

Parameters in [] are optional.

Health

This plugin implements dynamic health checking. It will always return healthy though.

API

The API is just a simple POST request with keys origin (required), rr (required) and ttl, where rr can be specified multiple times and must be a resource record string parsable by github.com/miekg/dns:NewRR. If ttl is not specified the ttl of the resource record is taken instead.

Examples

In this configuration, we are able to insert temporary resource records with an authentication token via the API, accessible by HTTP on 127.0.0.1:53080 and serve the zone(s) specified in example.org.db.

. {
  trapi 127.0.0.1:53080 {
    token abc
  }
  file example.org.db {
    transfer to 192.0.2.1
  }
}

Insert a resource record via the API (with multipart/form-data):

curl -v -F 'token=abc' -F 'ttl=60' -F 'origin=example.org' -F 'rr=example.org. 7200 IN TXT foo' 127.0.0.1:53080

Or alternatively (with application/x-www-form-urlencoded):

curl -v -d 'token=abc&ttl=60&origin=example.org&rr=example.org. 7200 IN TXT foo' 127.0.0.1:53080

Compilation

The plugin should be above the file plugin and below the dnssec plugin in plugin.cfg.