Merge branch 'develop'

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+.idea/

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+

LICENSE

@@ -671,4 +671,4 @@ into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -0,0 +1,161 @@
+# PowerDNS DNS Provider
+
+This is a drop-in provider for [apnscp](https://apnscp.com) to enable DNS support using PowerDNS. This module may use PostgreSQL or MySQL as a backend driver.
+
+## Nameserver installation
+
+Clone the repository into the Bootstrapper addin path. Note this requires either apnscp v3.1 or apnscp v3.0.47 minimum to work.
+
+```bash
+upcp
+cd /usr/local/apnscp/resources/playbooks
+git clone -b develop https://github.com/LithiumHosting/apnscp-powerdns.git addins/apnscp-powerdns
+ansible-playbook addin.yml --extra-vars=addin=apnscp-powerdns --extra-vars=powerdns_driver=mysql
+```
+
+*PostgreSQL can be used by specifying powerdns_driver=pgsql*
+
+PowerDNS is now setup to accept requests on port 8081. Requests require an authorization key that can be found in `/etc/pdns/pdns.conf`
+
+```
+# Install jq if not already installed
+yum install -y jq
+grep api= /etc/pdns/pdns.conf | cut -d= -f2
+# This is your API key
+curl -v -H 'X-API-Key: APIKEYABOVE' http://127.0.0.1:8081/api/v1/servers/localhost | jq .
+```
+
+apnscp provides a DNS-only license class that allows apnscp to run on a server without the capability to host sites. These licenses are free and may be requested via [my.apnscp.com](https://my.apnscp.com). Contact [email protected] if these licenses are not available at time of writing for manual issuance.
+
+### Idempotently changing configuration
+
+PowerDNS may be configured via files in `/etc/pdns/local.d`. In addition to this location, Bootstrapper supports injecting settings via `powerdns_custom_config`. For example,
+
+```bash
+cpcmd config:set apnscp.bootstrapper 'powerdns_custom_config' '["allow-axfr-ips":1.2.3.4,"also-notify":1.2.3.4]'
+cd /usr/local/apnscp/resources/playbooks
+ansible-playbook addin.yml --extra-vars=addin=apnscp-powerdns
+```
+
+allow-axfr-ips and also-notify directives will be set whenever the addin plays are run.
+
+### Restricting submission access
+
+In the above example, only local requests may submit DNS modifications to the server. None of the below examples affect querying; DNS queries occur over 53/UDP typically (or 53/TCP if packet size exceeds UDP limits). Depending upon infrastructure, there are a few options to securely accept record submission, *all of which require an API key for submission*.
+
+#### SSL + Apache
+
+Apache's `ProxyPass` directive send requests to the backend. Brute-force attempts are protected by [mod_evasive](https://github.com/apisnetworks/mod_evasive ) bundled with apnscp. Requests over this medium are protected by SSL, without HTTP/2 to ameliorate handshake overhead. In all but the very high volume API request environments, this will be acceptable.
+
+In this situation, the endpoint is https://myserver.apnscp.com/dns. Changes are made to `/etc/httpd/conf/httpd-custom.conf` within the `<VirtualHost ... :443>` bracket (with `SSLEngine On`!). After adding the below changes, `systemctl restart httpd`.
+
+```
+<Location /dns>
+	ProxyPass http://127.0.0.1:8081
+	ProxyPassReverse http://127.0.0.1:8081
+</Location>
+```
+
+**Downsides**: minor SSL overhead. Dependent upon Apache.  
+**Upsides**: easy to setup. Protected by threat deterrence. PowerDNS accessible remotely via an easily controlled URI.  
+
+In the above example, API requests can be made via https://myserver.apnscp.com/dns, e.g. 
+
+```bash
+curl -q -H 'X-API-Key: SOMEKEY' https://myserver.apnscp.com/dns/api/v1/servers/localhost 
+```
+
+##### Disabling brute-force throttling
+
+As hinted above, placing PowerDNS behind Apache confers brute-force protection by mod_evasive. By default, 10 of the same requests in 2 seconds can trigger a brute-force block. Two solutions exist, either  raise the same-page request threshold or disable mod_evasive.
+
+Working off the example above *<Location /dns> ... </Location>*
+```
+<Location /dns>
+	# Raise threshold to 30 same-page requests in 2 seconds
+	DOSPageCount 30
+	DOSPageInterval 2
+
+	# Or disable entirely
+	DOSEnabled off
+</Location>
+```
+
+#### Standalone server
+
+PowerDNS can also run by itself on a different port. In this situation, the network is configured to block all external requests to port 8081 except those whitelisted. For example, if the entire 32.12.1.1-32.12.1.255 network can be trusted and under your control, then whitelist the IP range:
+
+```bash
+cpcmd rampart:whitelist 32.12.1.1/24
+```
+
+Additionally, PowerDNS' whitelist must be updated as well. This can be quickly accomplished using the *apnscp.bootstrapper* Scope:
+
+```
+cpcmd config:set apnscp.bootstrapper powerdns_localonly false
+cd /usr/local/apnscp/resources/playbooks
+ansible-playbook addin.yml --extra-vars=addin=apnscp-powerdns
+```
+
+**Downsides**: requires whitelisting IP addresses for access to API server. Must run on port different than Apache.  
+**Upsides**: operates independently from Apache.  
+
+The server may be accessed once the source IP has been whitelisted,
+
+```bash
+curl -q -H 'X-API-Key: SOMEKEY' http://myserver.apnscp.com/api/v1/servers/localhost 
+```
+
+
+## apnscp DNS provider setup
+
+Every server that runs apnscp may delegate DNS authority to PowerDNS. This is ideal in distributed infrastructures in which coordination allows for seamless [server-to-server migrations](<https://hq.apnscp.com/account-migration-guide/> ).
+
+Taking the **API key** from above, configure `/usr/local/apnscp/config/auth.yaml`. Configuration within this file is secret and is not exposed via apnscp's API.
+
+```yaml
+pdns:
+  # This url may be different if using running PowerDNS in standalone
+  uri: https://myserver.apnscp.com/dns/api/v1/ 
+  key: your_api_key_here
+  ns: 
+    - ns1.yourdomain.com
+    - ns2.yourdomain.com
+    ## Optional additional nameservers
+```
+* `uri` value is the hostname of your master PowerDNS server running the HTTP API webserver (with a trailing slash)
+* `key` value is the **API Key** in `pdns.conf` on the master nameserver. 
+* `ns` value is a list of nameservers as in the example above.  Put nameservers on their own lines prefixed with a hyphen and indented accordingly.  There is not currently a limit for the number of nameservers you may use, 2-5 is typical and should be geographically distributed per RFC 2182.
+
+### Setting as default
+
+PowerDNS may be configured as the default provider for all sites using the `dns.default-provider` [Scope](https://gitlab.com/apisnetworks/apnscp/blob/master/docs/admin/Scopes.md). When adding a site in Nexus or [AddDomain](https://hq.apnscp.com/working-with-cli-helpers/#adddomain) the key will be replaced with "DEFAULT". This is substituted automatically on account creation.
+
+```bash
+cpcmd config_set dns.default-provider powerdns
+```
+
+> Do not set dns.default-provider-key. API key is configured via `config/auth.yaml`.
+
+## Components
+
+- Module- overrides [Dns_Module](https://github.com/apisnetworks/apnscp-modules/blob/master/modules/dns.php) behavior
+- Validator- service validator, checks input with AddDomain/EditDomain helpers
+
+### Minimal module methods
+
+All module methods can be overwritten. The following are the bare minimum that are overwritten for this DNS provider to work:
+
+- `atomicUpdate()` attempts a record modification, which must retain the original record if it fails
+- `zoneAxfr()` returns all DNS records
+- `add_record()` add a DNS record
+- `remove_record()` removes a DNS record
+- `get_hosting_nameservers()` returns nameservers for the DNS provider
+- `add_zone_backend()` creates DNS zone
+- `remove_zone_backend()` removes a DNS zone
+
+See also: [Creating a provider](https://hq.apnscp.com/apnscp-pre-alpha-technical-release/#creatingaprovider) (hq.apnscp.com)
+
+## Contributing
+
+Submit a PR and have fun!

plays/powerdns-authoritative-setup/defaults/main.yml

@@ -0,0 +1,54 @@
+---
+# PowerDNS API listens for local requests only
+# This can be put behind an Apache proxy or other means
+# See documentation for examples
+powerdns_localonly: true
+# Toggle installation of PowerDNS
+powerdns_enabled: true
+powerdns_version: 4.2
+powerdns_repo_uri: "https://repo.powerdns.com/repo-files/centos-rec-{{ powerdns_version | regex_replace('\\.','') }}.repo"
+powerdns_repo_config: /etc/yum.repos.d/powerdns.repo
+powerdns_packages:
+  - pdns
+  - "pdns-backend-{{ (powerdns_driver == 'pgsql') | ternary('postgresql', powerdns_driver) }}"
+
+powerdns_local_dir: "/etc/pdns/local.d"
+powerdns_config_file: /etc/pdns/pdns.conf
+powerdns_driver: mysql
+powerdns_api_port: 8081
+
+# Code installation
+addin_provider_name: Powerdns
+addin_integration_type: "{{ (apnscp_debug | bool) | ternary('link', 'copy') }}"
+
+powerdns_db_password: >-
+  {{ lookup('pipe', 'grep -e "^\s*g' + powerdns_driver + '-password\s*=" ' + (powerdns_config_file | quote) + ' | cut -d= -f2') | default(lookup('password', '/dev/null chars=ascii_letters length=24'), true) | trim }}
+powerdns_db_user: >-
+  {{ lookup('pipe', 'grep -e "^\s*g' + powerdns_driver + '-user\s*=" ' + (powerdns_config_file | quote) + ' | cut -d= -f2') | default('powerdns', true) | trim }}
+powerdns_db_name: >-
+  {{ lookup('pipe', 'grep -e "^\s*g' + powerdns_driver + '-dbname\s*=" ' + (powerdns_config_file | quote) + ' | cut -d= -f2') | default('powerdns', true) | trim }}
+powerdns_db_host: >-
+  {{ lookup('pipe', 'grep -e "^\s*g' + powerdns_driver + '-host\s*=" ' + (powerdns_config_file | quote) + ' | cut -d= -f2') | default('localhost', true) | trim }}
+powerdns_api_key: >-
+  {{ lookup('pipe', 'grep -e "^\s*api-key\s*=" ' + (powerdns_config_file | quote) + ' | cut -d= -f2') | default(lookup('password', '/dev/null chars=ascii_letters length=24'), true) | trim }}
+powerdns_config:
+  api: yes
+  "api-key": "{{ powerdns_api_key }}"
+  "include-dir": "{{ powerdns_local_dir }}"
+  webserver: "{{ powerdns_webserver_enable | default((powerdns_version is version('4.1', '>=')) | ternary('no', 'yes')) }}"
+  "webserver-address": >-
+    {{ powerdns_api_listen | default(powerdns_localonly | ternary('127.0.0.1', '0.0.0.0')) }}
+  "webserver-allow-from": >-
+    {{ powerdns_api_whitelist | default(powerdns_localonly | ternary('127.0.0.1,::1', '0.0.0.0,::/0')) }}
+  "webserver-port": "{{ powerdns_api_port }}"
+  launch: "g{{ powerdns_driver }}"
+  "g{{powerdns_driver}}-password": "{{ __powerdns_db_password }}"
+  "g{{powerdns_driver}}-user": "{{ powerdns_db_user }}"
+  "g{{powerdns_driver}}-dbname": "{{ powerdns_db_name }}"
+  "g{{powerdns_driver}}-host": "{{ powerdns_db_host }}"
+  version-string: anonymous
+
+# Inject overrides via powerdns_custom_config
+# powerdns_custom_config:
+#   "allow-axfr-ips": 1.2.3.4
+#   "also-notify": 2.3.4.5

plays/powerdns-authoritative-setup/files/mysql-4.0.sql

@@ -0,0 +1,90 @@
+CREATE TABLE domains (
+  id                    INT AUTO_INCREMENT,
+  name                  VARCHAR(255) NOT NULL,
+  master                VARCHAR(128) DEFAULT NULL,
+  last_check            INT DEFAULT NULL,
+  type                  VARCHAR(6) NOT NULL,
+  notified_serial       INT DEFAULT NULL,
+  account               VARCHAR(40) DEFAULT NULL,
+  PRIMARY KEY (id)
+) Engine=InnoDB;
+
+CREATE UNIQUE INDEX name_index ON domains(name);
+
+
+CREATE TABLE records (
+  id                    INT AUTO_INCREMENT,
+  domain_id             INT DEFAULT NULL,
+  name                  VARCHAR(255) DEFAULT NULL,
+  type                  VARCHAR(10) DEFAULT NULL,
+  content               VARCHAR(64000) DEFAULT NULL,
+  ttl                   INT DEFAULT NULL,
+  prio                  INT DEFAULT NULL,
+  change_date           INT DEFAULT NULL,
+  disabled              TINYINT(1) DEFAULT 0,
+  ordername             VARCHAR(255) BINARY DEFAULT NULL,
+  auth                  TINYINT(1) DEFAULT 1,
+  PRIMARY KEY (id)
+) Engine=InnoDB;
+
+CREATE INDEX nametype_index ON records(name,type);
+CREATE INDEX domain_id ON records(domain_id);
+CREATE INDEX recordorder ON records (domain_id, ordername);
+
+
+CREATE TABLE supermasters (
+  ip                    VARCHAR(64) NOT NULL,
+  nameserver            VARCHAR(255) NOT NULL,
+  account               VARCHAR(40) NOT NULL,
+  PRIMARY KEY (ip, nameserver)
+) Engine=InnoDB;
+
+
+CREATE TABLE comments (
+  id                    INT AUTO_INCREMENT,
+  domain_id             INT NOT NULL,
+  name                  VARCHAR(255) NOT NULL,
+  type                  VARCHAR(10) NOT NULL,
+  modified_at           INT NOT NULL,
+  account               VARCHAR(40) NOT NULL,
+  comment               VARCHAR(64000) NOT NULL,
+  PRIMARY KEY (id)
+) Engine=InnoDB;
+
+CREATE INDEX comments_domain_id_idx ON comments (domain_id);
+CREATE INDEX comments_name_type_idx ON comments (name, type);
+CREATE INDEX comments_order_idx ON comments (domain_id, modified_at);
+
+
+CREATE TABLE domainmetadata (
+  id                    INT AUTO_INCREMENT,
+  domain_id             INT NOT NULL,
+  kind                  VARCHAR(32),
+  content               TEXT,
+  PRIMARY KEY (id)
+) Engine=InnoDB;
+
+CREATE INDEX domainmetadata_idx ON domainmetadata (domain_id, kind);
+
+
+CREATE TABLE cryptokeys (
+  id                    INT AUTO_INCREMENT,
+  domain_id             INT NOT NULL,
+  flags                 INT NOT NULL,
+  active                BOOL,
+  content               TEXT,
+  PRIMARY KEY(id)
+) Engine=InnoDB;
+
+CREATE INDEX domainidindex ON cryptokeys(domain_id);
+
+
+CREATE TABLE tsigkeys (
+  id                    INT AUTO_INCREMENT,
+  name                  VARCHAR(255),
+  algorithm             VARCHAR(50),
+  secret                VARCHAR(255),
+  PRIMARY KEY (id)
+) Engine=InnoDB;
+
+CREATE UNIQUE INDEX namealgoindex ON tsigkeys(name, algorithm);