NEW PROVIDER: OpenWrt

Author: huskyistaken

.github/workflows/pr_integration_tests.yml

@@ -65,7 +65,7 @@ jobs:
           Write-Host "Integration test providers: $Providers"
           echo "integration_test_providers=$(ConvertTo-Json -InputObject $Providers -Compress)" >> $env:GITHUB_OUTPUT
         env:
-          PROVIDERS: "['ALIDNS', 'AXFRDDNS', 'AXFRDDNS_DNSSEC', 'AZURE_DNS','BIND','BUNNY_DNS','CLOUDFLAREAPI','CLOUDNS','CNR','DIGITALOCEAN','FORTIGATE','GANDI_V5','GCLOUD','GIDINET','HEDNS','HETZNER_V2','HUAWEICLOUD','INWX','JOKER','MIKROTIK','MYTHICBEASTS', 'NAMEDOTCOM','NS1','POWERDNS','ROUTE53','SAKURACLOUD','TRANSIP','UNIFI']"
+          PROVIDERS: "['ALIDNS', 'AXFRDDNS', 'AXFRDDNS_DNSSEC', 'AZURE_DNS','BIND','BUNNY_DNS','CLOUDFLAREAPI','CLOUDNS','CNR','DIGITALOCEAN','FORTIGATE','GANDI_V5','GCLOUD','GIDINET','HEDNS','HETZNER_V2','HUAWEICLOUD','INWX','JOKER','MIKROTIK','MYTHICBEASTS', 'NAMEDOTCOM','NS1','OPENWRT','POWERDNS','ROUTE53','SAKURACLOUD','TRANSIP','UNIFI']"
           ENV_CONTEXT: ${{ toJson(env) }}
           VARS_CONTEXT: ${{ toJson(vars) }}
           SECRETS_CONTEXT: ${{ toJson(secrets) }}
@@ -109,6 +109,7 @@ jobs:
       MYTHICBEASTS_DOMAIN: ${{ vars.MYTHICBEASTS_DOMAIN }}
       NAMEDOTCOM_DOMAIN: ${{ vars.NAMEDOTCOM_DOMAIN }}
       NS1_DOMAIN: ${{ vars.NS1_DOMAIN }}
+      OPENWRT_DOMAIN: ${{ vars.OPENWRT_DOMAIN }}
       POWERDNS_DOMAIN: ${{ vars.POWERDNS_DOMAIN }}
       ROUTE53_DOMAIN: ${{ vars.ROUTE53_DOMAIN }}
       SAKURACLOUD_DOMAIN: ${{ vars.SAKURACLOUD_DOMAIN }}
@@ -199,6 +200,10 @@ jobs:
       #
       NS1_TOKEN: ${{ secrets.NS1_TOKEN }}
       #
+      OPENWRT_USERNAME: ${{ secrets.OPENWRT_USERNAME }}
+      OPENWRT_PASSWORD: ${{ secrets.OPENWRT_PASSWORD }}
+      OPENWRT_HOST: ${{ secrets.OPENWRT_HOST }}
+      #
       POWERDNS_APIKEY: ${{ secrets.POWERDNS_APIKEY }}
       POWERDNS_APIURL: ${{ secrets.POWERDNS_APIURL }}
       POWERDNS_SERVERNAME: ${{ secrets.POWERDNS_SERVERNAME }}

.goreleaser.yml

@@ -37,7 +37,7 @@ changelog:
       regexp: "(?i)^.*(major|new provider|feature)[(\\w)]*:+.*$"
       order: 1
     - title: 'Provider-specific changes:'
-      regexp: "(?i)((adguardhome|akamaiedgedns|alidns|autodns|axfrddns|azure_dns|azure_private_dns|bind|bunny_dns|cloudflare|cloudflareapi|cloudns|cnr|cscglobal|desec|digitalocean|dnscale|dnsimple|dnsmadeeasy|dnsoverhttps|domainnameshop|dynadot|easyname|exoscale|fortigate|gandi_v5|gcloud|gcore|gidinet|hedns|hetzner|hetzner_v2|hostingde|huaweicloud|infomaniak|internetbs|inwx|joker|linode|loopia|luadns|mikrotik|mythicbeasts|namecheap|namedotcom|netcup|netlify|ns1|opensrs|oracle|ovh|packetframe|porkbun|powerdns|realtimeregister|route53|rwth|sakuracloud|softlayer|transip|unifi|vercel|vultr).*:)+.*"
+      regexp: "(?i)((adguardhome|akamaiedgedns|alidns|autodns|axfrddns|azure_dns|azure_private_dns|bind|bunny_dns|cloudflare|cloudflareapi|cloudns|cnr|cscglobal|desec|digitalocean|dnscale|dnsimple|dnsmadeeasy|dnsoverhttps|domainnameshop|dynadot|easyname|exoscale|fortigate|gandi_v5|gcloud|gcore|gidinet|hedns|hetzner|hetzner_v2|hostingde|huaweicloud|infomaniak|internetbs|inwx|joker|linode|loopia|luadns|mikrotik|mythicbeasts|namecheap|namedotcom|netcup|netlify|ns1|opensrs|openwrt|oracle|ovh|packetframe|porkbun|powerdns|realtimeregister|route53|rwth|sakuracloud|softlayer|transip|unifi|vercel|vultr).*:)+.*"
       order: 2
     - title: 'Documentation:'
       regexp: "(?i)^.*(docs)[(\\w)]*:+.*$"

OWNERS

@@ -46,6 +46,7 @@ providers/netcup @kordianbruck
 providers/netlify @SphericalKat
 providers/ns1 @costasd
 # providers/opensrs NEEDS VOLUNTEER
+providers/openwrt @huskyistaken
 providers/oracle @kallsyms
 providers/ovh @masterzen
 providers/packetframe @hamptonmoore

README.md

@@ -59,6 +59,7 @@ Currently supported DNS providers:
 - Netcup
 - Netlify
 - NS1
+- OpenWrt
 - Oracle Cloud
 - OVH
 - Packetframe

documentation/SUMMARY.md

@@ -169,6 +169,7 @@
 * [Netcup](provider/netcup.md)
 * [Netlify](provider/netlify.md)
 * [NS1](provider/ns1.md)
+* [OpenWrt](provider/openwrt.md)
 * [OpenSRS](provider/opensrs.md)
 * [Oracle Cloud](provider/oracle.md)
 * [OVH](provider/ovh.md)

documentation/provider/index.md

@@ -73,6 +73,7 @@ Jump to a table:
 | [`NETLIFY`](netlify.md) | ❌ | ✅ | ❌ |
 | [`NS1`](ns1.md) | ❌ | ✅ | ❌ |
 | [`OPENSRS`](opensrs.md) | ❌ | ❌ | ✅ |
+| [`OPENWRT`](openwrt.md) | ❌ | ✅ | ❌ |
 | [`ORACLE`](oracle.md) | ❌ | ✅ | ❌ |
 | [`OVH`](ovh.md) | ❌ | ✅ | ✅ |
 | [`PACKETFRAME`](packetframe.md) | ❌ | ✅ | ❌ |
@@ -140,6 +141,7 @@ Jump to a table:
 | [`NETLIFY`](netlify.md) | ✅ | ❌ | ❌ | ✅ |
 | [`NS1`](ns1.md) | ✅ | ✅ | ✅ | ✅ |
 | [`OPENSRS`](opensrs.md) | ❔ | ❔ | ❌ | ❔ |
+| [`OPENWRT`](openwrt.md) | ❔ | ❔ | ❌ | ✅ |
 | [`ORACLE`](oracle.md) | ❔ | ✅ | ✅ | ✅ |
 | [`OVH`](ovh.md) | ❔ | ✅ | ❌ | ✅ |
 | [`PACKETFRAME`](packetframe.md) | ❔ | ❌ | ❌ | ❔ |
@@ -202,6 +204,7 @@ Jump to a table:
 | [`NETCUP`](netcup.md) | ❔ | ❔ | ❌ | ❌ | ❔ |
 | [`NETLIFY`](netlify.md) | ✅ | ❔ | ❌ | ❌ | ❔ |
 | [`NS1`](ns1.md) | ✅ | ✅ | ❌ | ✅ | ❔ |
+| [`OPENWRT`](openwrt.md) | ❌ | ❔ | ❔ | ❔ | ❔ |
 | [`ORACLE`](oracle.md) | ✅ | ❔ | ❔ | ✅ | ❔ |
 | [`OVH`](ovh.md) | ❌ | ❔ | ❔ | ❌ | ❔ |
 | [`PACKETFRAME`](packetframe.md) | ❔ | ❔ | ❔ | ✅ | ❔ |
@@ -263,6 +266,7 @@ Jump to a table:
 | [`NETCUP`](netcup.md) | ❔ | ❔ | ✅ | ❔ |
 | [`NETLIFY`](netlify.md) | ❔ | ❌ | ✅ | ❔ |
 | [`NS1`](ns1.md) | ✅ | ✅ | ✅ | ✅ |
+| [`OPENWRT`](openwrt.md) | ❔ | ❔ | ✅ | ❔ |
 | [`ORACLE`](oracle.md) | ❔ | ✅ | ✅ | ❔ |
 | [`OVH`](ovh.md) | ❔ | ❔ | ✅ | ❔ |
 | [`PACKETFRAME`](packetframe.md) | ❔ | ❔ | ✅ | ❔ |
@@ -460,6 +464,7 @@ Providers in this category and their maintainers are:
 |[`NETLIFY`](netlify.md)|@SphericalKat|
 |[`NS1`](ns1.md)|@costasd|
 |[`OPENSRS`](opensrs.md)|@philhug|
+|[`OPENWRT`](openwrt.md)|@huskyistaken|
 |[`ORACLE`](oracle.md)|@kallsyms|
 |[`OVH`](ovh.md)|@masterzen|
 |[`PACKETFRAME`](packetframe.md)|@hamptonmoore|

documentation/provider/openwrt.md

@@ -0,0 +1,54 @@
+This is the provider for [OpenWrt](https://openwrt.org/).
+
+## Important notes
+
+This provider only supports the following record types.
+
+* [A](../language-reference/domain-modifiers/A.md)
+* [AAAA](../language-reference/domain-modifiers/AAAA.md)
+* [CNAME](../language-reference/domain-modifiers/CNAME.md)
+* [MX](../language-reference/domain-modifiers/MX.md)
+* [SRV](../language-reference/domain-modifiers/SRV.md)
+
+## Configuration
+
+To use this provider, add an entry to `creds.json` with `TYPE` set to `OPENWRT`.
+
+Required fields include:
+
+* `username` and `password`: Authentication information
+* `host`: The hostname/address of OpenWrt instance
+
+Example:
+
+{% code title="creds.json" %}
+```json
+{
+  "openwrt": {
+    "TYPE": "OPENWRT",
+    "username": "root",
+    "password": "your-password",
+    "host": "http://192.168.1.1"
+  }
+}
+```
+{% endcode %}
+
+## Usage
+
+An example configuration:
+
+{% code title="dnsconfig.js" %}
+```javascript
+var REG_NONE = NewRegistrar("none");
+var DSP_OPENWRT = NewDnsProvider("openwrt");
+
+D("example.com", REG_NONE, DnsProvider(DSP_OPENWRT),
+    A("foo", "1.2.3.4"),
+    AAAA("another", "2003::1"),
+    CNAME("myalias", "www.example.com."),
+    MX("@", 5, "mail"),
+    SRV("_sip._tcp", 10, 60, 5060, "pbx.example.com."),
+);
+```
+{% endcode %}

integrationTest/profiles.json

@@ -290,6 +290,13 @@
     "api_token": "$NS1_TOKEN",
     "domain": "$NS1_DOMAIN"
   },
+  "OPENWRT": {
+    "TYPE": "OPENWRT",
+    "domain": "$OPENWRT_DOMAIN",
+    "host": "$OPENWRT_HOST",
+    "username": "$OPENWRT_USERNAME",
+    "password": "$OPENWRT_PASSWORD"
+  },
   "ORACLE": {
     "TYPE": "ORACLE",
     "compartment": "$ORACLE_COMPARTMENT",

pkg/providers/_all/all.go

@@ -50,6 +50,7 @@ import (
 	_ "github.com/StackExchange/dnscontrol/v4/providers/netcup"
 	_ "github.com/StackExchange/dnscontrol/v4/providers/netlify"
 	_ "github.com/StackExchange/dnscontrol/v4/providers/ns1"
+	_ "github.com/StackExchange/dnscontrol/v4/providers/openwrt"
 	_ "github.com/StackExchange/dnscontrol/v4/providers/opensrs"
 	_ "github.com/StackExchange/dnscontrol/v4/providers/oracle"
 	_ "github.com/StackExchange/dnscontrol/v4/providers/ovh"