-
Notifications
You must be signed in to change notification settings - Fork 408
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
NEW PROVIDER: CentralNic Reseller (CNR) - formerly RRPProxy (#3203)
- Loading branch information
1 parent
be48b6e
commit b2ee265
Showing
15 changed files
with
778 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| CentralNic Reseller (CNR), formerly known as RRPProxy, is a prominent provider of domain registration and DNS solutions. Trusted by individuals, service providers, and registrars around the world, CNR is recognized for its cutting-edge technology, exceptional performance, and reliable uptime. | ||
|
|
||
| Our advanced DNS expertise is integral to our offering. With CentralNic Reseller, you benefit from a leading DNS platform that features robust DNS automation, DNSSEC for enhanced security, and PremiumDNS via our Anycast Network. Additionally, our platform supports a comprehensive set of features, as detailed by DNSControl. | ||
|
|
||
| This is based on API documents found at [https://kb.centralnicreseller.com/api/api-commands/api-command-reference#cat-dynamicdns](https://kb.centralnicreseller.com/api/api-commands/api-command-reference#cat-dynamicdns) | ||
|
|
||
| ## Configuration | ||
|
|
||
| To use this provider, add an entry to `creds.json` with `TYPE` set to `CNR` | ||
| along with your CentralNic Reseller login data. | ||
|
|
||
| Example: | ||
|
|
||
| {% code title="creds.json" %} | ||
| ```json | ||
| { | ||
| "CNR": { | ||
| "TYPE": "CNR", | ||
| "apilogin": "your-cnr-account-id", | ||
| "apipassword": "your-cnr-account-password", | ||
| "apientity": "LIVE", // for the LIVE system; use "OTE" for the OT&E system | ||
| "debugmode": "0", // set it to "1" to get debug output of the communication with our Backend System API | ||
| } | ||
| } | ||
| ``` | ||
| {% endcode %} | ||
|
|
||
| Here a working example for our OT&E System: | ||
|
|
||
| {% code title="creds.json" %} | ||
| ```json | ||
| { | ||
| "CNR": { | ||
| "TYPE": "CNR", | ||
| "apilogin": "YourUserName", | ||
| "apipassword": "YourPassword", | ||
| "apientity": "OTE", | ||
| "debugmode": "0" | ||
| } | ||
| } | ||
| ``` | ||
| {% endcode %} | ||
|
|
||
| {% hint style="info" %} | ||
| **NOTE**: The above credentials are known to the public. | ||
| {% endhint %} | ||
|
|
||
| With the above CentralNic Reseller entry in `creds.json`, you can run the | ||
| integration tests as follows: | ||
|
|
||
| ```shell | ||
| dnscontrol get-zones --format=nameonly cnr CNR all | ||
| ``` | ||
| ```shell | ||
| # Review the output. Pick one domain and set CNR_DOMAIN. | ||
| export CNR_DOMAIN=yodream.com # Pick a domain name. | ||
| export CNR_ENTITY=OTE | ||
| export CNR_UID=test.user | ||
| export CNR_PW=test.passw0rd | ||
| cd integrationTest # NOTE: Not needed if already in that subdirectory | ||
| go test -v -verbose -provider CNR | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Here's an example DNS Configuration `dnsconfig.js` using our provider module. | ||
| Even though it shows how you use us as Domain Registrar AND DNS Provider, we don't force you to do that. | ||
| You are free to decide if you want to use both of our provider technology or just one of them. | ||
|
|
||
| {% code title="dnsconfig.js" %} | ||
| ```javascript | ||
| var REG_CNR = NewRegistrar("CNR"); | ||
| var DSP_CNR = NewDnsProvider("CNR"); | ||
|
|
||
| // Set Default TTL for all RR to reflect our Backend API Default | ||
| // If you use additional DNS Providers, configure a default TTL | ||
| // per domain using the domain modifier DefaultTTL instead. | ||
| // also check this issue for [NAMESERVER TTL](https://github.com/StackExchange/dnscontrol/issues/176). | ||
| DEFAULTS( | ||
| {"ns_ttl":"3600"}, | ||
| DefaultTTL(3600) | ||
| ); | ||
|
|
||
| D("example.com", REG_CNR, DnsProvider(DSP_CNR), | ||
| NAMESERVER("ns1.rrpproxy.net"), | ||
| NAMESERVER("ns2.rrpproxy.net"), | ||
| NAMESERVER("ns3.rrpproxy.net"), | ||
| NAMESERVER("ns4.rrpproxy.net"), | ||
| A("elk1", "10.190.234.178"), | ||
| A("test", "56.123.54.12"), | ||
| END); | ||
| ``` | ||
| {% endcode %} | ||
|
|
||
| ## Metadata | ||
|
|
||
| This provider does not recognize any special metadata fields unique to CentralNic Reseller (CNR). | ||
|
|
||
| ## get-zones | ||
|
|
||
| `dnscontrol get-zones` is implemented for this provider. The list | ||
| includes both basic and premier zones. | ||
|
|
||
| ## New domains | ||
|
|
||
| If a dnszone does not exist in your CNR account, DNSControl will *not* automatically add it with the `dnscontrol push` or `dnscontrol preview` command. You'll need to do that via the control panel manually or using the command `dnscontrol create-domains`. | ||
| This is because it could lead to unwanted costs on customer-side that we want to avoid. | ||
|
|
||
| ## Debug Mode | ||
|
|
||
| As shown in the configuration examples above, this can be activated on demand and it can be used to check the API commands send to our system. | ||
| In general this is thought for our purpose to have an easy way to dive into issues. But if you're interested what's going on, feel free to activate it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| package cnr | ||
|
|
||
| import ( | ||
| "github.com/StackExchange/dnscontrol/v4/models" | ||
| "github.com/StackExchange/dnscontrol/v4/pkg/rejectif" | ||
| ) | ||
|
|
||
| // AuditRecords returns a list of errors corresponding to the records | ||
| // that aren't supported by this provider. If all records are | ||
| // supported, an empty list is returned. | ||
| func AuditRecords(records []*models.RecordConfig) []error { | ||
| a := rejectif.Auditor{} | ||
|
|
||
| a.Add("TXT", rejectif.TxtIsEmpty) // Last verified 2021-10-01 | ||
|
|
||
| a.Add("TXT", rejectif.TxtHasDoubleQuotes) // Last verified 2023-11-30 | ||
|
|
||
| a.Add("SRV", rejectif.SrvHasNullTarget) // Last verified 2020-12-28 | ||
|
|
||
| return a.Audit(records) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| // Package CNR implements a registrar that uses the CNR api to set name servers. It will self register it's providers when imported. | ||
| package cnr | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
|
|
||
| "github.com/StackExchange/dnscontrol/v4/providers" | ||
| cnrcl "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v5/apiclient" | ||
| ) | ||
|
|
||
| // GoReleaser: version | ||
| var ( | ||
| version = "dev" | ||
| ) | ||
|
|
||
| // CNRClient describes a connection to the CNR API. | ||
| type CNRClient struct { | ||
| conf map[string]string | ||
| APILogin string | ||
| APIPassword string | ||
| APIEntity string | ||
| client *cnrcl.APIClient | ||
| } | ||
|
|
||
| var features = providers.DocumentationNotes{ | ||
| // The default for unlisted capabilities is 'Cannot'. | ||
| // See providers/capabilities.go for the entire list of capabilities. | ||
| providers.CanGetZones: providers.Can(), | ||
| providers.CanConcur: providers.Can(), | ||
| providers.CanUseAlias: providers.Cannot("Not supported. You may use CNAME records instead. An Alternative solution is planned."), | ||
| providers.CanUseCAA: providers.Can(), | ||
| providers.CanUseLOC: providers.Unimplemented(), | ||
| providers.CanUsePTR: providers.Can(), | ||
| providers.CanUseSRV: providers.Can("SRV records with empty targets are not supported"), | ||
| providers.CanUseTLSA: providers.Can(), | ||
| providers.DocCreateDomains: providers.Can(), | ||
| providers.DocDualHost: providers.Can(), | ||
| providers.DocOfficiallySupported: providers.Cannot("Actively maintained provider module."), | ||
| } | ||
|
|
||
| func newProvider(conf map[string]string) (*CNRClient, error) { | ||
| api := &CNRClient{ | ||
| conf: conf, | ||
| client: cnrcl.NewAPIClient(), | ||
| } | ||
| api.client.SetUserAgent("DNSControl", version) | ||
| api.APILogin, api.APIPassword, api.APIEntity = conf["apilogin"], conf["apipassword"], conf["apientity"] | ||
| if conf["debugmode"] == "1" { | ||
| api.client.EnableDebugMode() | ||
| } | ||
| if api.APIEntity != "OTE" && api.APIEntity != "LIVE" { | ||
| return nil, fmt.Errorf("wrong api system entity used. use \"OTE\" for OT&E system or \"LIVE\" for Live system") | ||
| } | ||
| if api.APIEntity == "OTE" { | ||
| api.client.UseOTESystem() | ||
| } | ||
| if api.APILogin == "" || api.APIPassword == "" { | ||
| return nil, fmt.Errorf("missing login credentials apilogin or apipassword") | ||
| } | ||
| api.client.SetCredentials(api.APILogin, api.APIPassword) | ||
| return api, nil | ||
| } | ||
|
|
||
| func newReg(conf map[string]string) (providers.Registrar, error) { | ||
| return newProvider(conf) | ||
| } | ||
|
|
||
| func newDsp(conf map[string]string, meta json.RawMessage) (providers.DNSServiceProvider, error) { | ||
| return newProvider(conf) | ||
| } | ||
|
|
||
| func init() { | ||
| const providerName = "CNR" | ||
| const providerMaintainer = "@KaiSchwarz-cnic" | ||
| fns := providers.DspFuncs{ | ||
| Initializer: newDsp, | ||
| RecordAuditor: AuditRecords, | ||
| } | ||
| providers.RegisterRegistrarType(providerName, newReg) | ||
| providers.RegisterDomainServiceProviderType(providerName, fns, features) | ||
| providers.RegisterMaintainer(providerName, providerMaintainer) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| package cnr | ||
|
|
||
| // EnsureZoneExists returns an error | ||
| // * if access to dnszone is not allowed (not authorized) or | ||
| // * if it doesn't exist and creating it fails | ||
| func (n *CNRClient) EnsureZoneExists(domain string) error { | ||
| r := n.client.Request(map[string]interface{}{ | ||
| "COMMAND": "StatusDNSZone", | ||
| "DNSZONE": domain, | ||
| }) | ||
| code := r.GetCode() | ||
| if code == 545 { | ||
| command := map[string]interface{}{ | ||
| "COMMAND": "AddDNSZone", | ||
| "DNSZONE": domain, | ||
| } | ||
| if n.APIEntity == "OTE" { | ||
| command["SOATTL"] = "33200" | ||
| command["SOASERIAL"] = "0000000000" | ||
| } | ||
| // Create the zone | ||
| r = n.client.Request(command) | ||
| if !r.IsSuccess() { | ||
| return n.GetCNRApiError("Failed to create not existing zone ", domain, r) | ||
| } | ||
| } else if code == 531 { | ||
| return n.GetCNRApiError("Not authorized to manage dnszone", domain, r) | ||
| } else if r.IsError() || r.IsTmpError() { | ||
| return n.GetCNRApiError("Error while checking status of dnszone", domain, r) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // ListZones lists all the | ||
| func (n *CNRClient) ListZones() ([]string, error) { | ||
| var zones []string | ||
|
|
||
| // Basic | ||
|
|
||
| rs := n.client.RequestAllResponsePages(map[string]string{ | ||
| "COMMAND": "QueryDNSZoneList", | ||
| }) | ||
| for _, r := range rs { | ||
| if r.IsError() { | ||
| return nil, n.GetCNRApiError("Error while QueryDNSZoneList", "Basic", &r) | ||
| } | ||
| zoneColumn := r.GetColumn("DNSZONE") | ||
| if zoneColumn != nil { | ||
| //return nil, fmt.Errorf("failed getting DNSZONE BASIC column") | ||
| zones = append(zones, zoneColumn.GetData()...) | ||
| } | ||
| } | ||
|
|
||
| return zones, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| package cnr | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v5/response" | ||
| ) | ||
|
|
||
| // GetCNRApiError returns an error including API error code and error description. | ||
| func (n *CNRClient) GetCNRApiError(format string, objectid string, r *response.Response) error { | ||
| return fmt.Errorf(format+" %q. [%v %s]", objectid, r.GetCode(), r.GetDescription()) | ||
| } |
Oops, something went wrong.