diff --git a/contrib/README.md b/contrib/README.md new file mode 100644 index 0000000..690573d --- /dev/null +++ b/contrib/README.md @@ -0,0 +1,45 @@ +# Contrib +This collection of scripts and files helps us further configure our unbounds and unbound_exporters. + +## unbound-control-setup.sh + +From [Golang 1.15 docs:](https://golang.google.cn/doc/go1.15#commonname) +> X.509 CommonName deprecation +> The deprecated, legacy behavior of treating the CommonName field on X.509 certificates as a host name when no Subject Alternative Names are present is now disabled by default. It can be temporarily re-enabled by adding the value x509ignoreCN=0 to the GODEBUG environment variable. +> Note that if the CommonName is an invalid host name, it's always ignored, regardless of GODEBUG settings. Invalid names include those with any characters other than letters, digits, hyphens and underscores, and those with empty labels or trailing dots. + +Unbound still ships with an `unbound-control-setup` that generates a problematic keypair. This script will generate a keypair that satisfies newer versions of Golang. + +Generate the new keypair +``` +$ bash unbound-control-setup.sh +``` + +You'll then want to configure `/etc/unbound/unbound.conf` with the following stanza + +``` +$ cat /etc/unbound/unbound.conf +... +remote-control: + control-enable: yes + control-use-cert: yes + server-key-file: "/etc/unbound/unbound_server_ec.key" + server-cert-file: "/etc/unbound/unbound_server_ec.pem" + control-key-file: "/etc/unbound/unbound_control_ec.key" + control-cert-file: "/etc/unbound/unbound_control_ec.pem" +``` + +Test that you can still communicate with unbound via `unbound_control`. You should be able to see metrics. +``` +$ unbound-control stats_noreset +thread0.num.queries=35 +thread0.num.queries_ip_ratelimited=0 +thread0.num.cachehits=25 +thread0.num.cachemiss=10 +thread0.num.prefetch=0 +thread0.num.expired=0 +... + +``` + +To reconfigure `unbound_exporter` as a systemd service, see [this file](unbound_exporter.service). diff --git a/contrib/unbound-cert-setup.sh b/contrib/unbound-cert-setup.sh new file mode 100755 index 0000000..4805fde --- /dev/null +++ b/contrib/unbound-cert-setup.sh @@ -0,0 +1,147 @@ +#!/usr/bin/env bash + +# Generally based on /usr/sbin/unbound-control-setup but adapted to catch +# up to ~2010. You know, x509v3, secp384r1, AKIs, stuff like that. + +# directory for files +DESTDIR="${UNBOUND_CONFIG_DIR:-/etc/unbound}" + +# validity period for certificates +DAYS="${UNBOUND_CERT_LIFETIME:-397}" + +# hash algorithm +HASH=sha256 + +# base name for unbound CA keys +CA_BASE=unbound_ca_ec + +# base name for unbound server keys +SVR_BASE=unbound_server_ec + +# base name for unbound-control keys +CTL_BASE=unbound_control_ec + +# we want -rw-r----- access (say you run this as root: grp=yes (server), all=no). +umask 0027 + +# end of options + +# functions: +error ( ) { + echo "$0 fatal error: ${1}" + exit 1 +} + +# go!: +echo "setup in directory ${DESTDIR}" +cd "${DESTDIR}" || error "could not cd to ${DESTDIR}" + +# create certificate keys; do not recreate if they already exist. +if test -f "${CA_BASE}.key"; then + echo "${CA_BASE}.key exists" +else + echo "generating ${CA_BASE}.key" + openssl ecparam -genkey -name secp384r1 > ${CA_BASE}.key || error "could not gen ecdsa" +fi +if test -f "${SVR_BASE}.key"; then + echo "${SVR_BASE}.key exists" +else + echo "generating ${SVR_BASE}.key" + openssl ecparam -genkey -name secp384r1 > ${SVR_BASE}.key || error "could not gen ecdsa" +fi +if test -f "${CTL_BASE}.key"; then + echo "${CTL_BASE}.key exists" +else + echo "generating ${CTL_BASE}.key" + openssl ecparam -genkey -name secp384r1 > ${CTL_BASE}.key || error "could not gen ecdsa" +fi + +# create self-signed cert CSR for server +cat > ca_request.cfg < server_request.cfg < server_exts.cfg < client_request.cfg < client_exts.cfg <> "${SVR_BASE}.pem" + +echo "Setup success. Certificates created." diff --git a/contrib/unbound_exporter.service b/contrib/unbound_exporter.service new file mode 100644 index 0000000..730807d --- /dev/null +++ b/contrib/unbound_exporter.service @@ -0,0 +1,15 @@ +[Unit] +Description=Prometheus exporter for Unbound metrics, written in Go with pluggable metric collectors. The metrics exporter converts Unbound metric names to Prometheus metric names and labels by using a set of regular expressions. +Documentation=https://github.com/letsencrypt/unbound_exporter +After=network.target + +[Service] +Type=simple +ExecStart=/bin/unbound_exporter \ + -unbound.ca "/etc/unbound/unbound_ca_ec.pem" \ + -unbound.cert "/etc/unbound/unbound_control_ec.pem" \ + -unbound.key "/etc/unbound/unbound_control_ec.key" \ + -unbound.host "tcp://localhost:8953" + +[Install] +WantedBy=multi-user.target