dnscontrol/providers/cnr/cnrProvider.go
James O'Gorman cd8892f9bb
BUG: User-Agent should include DNSControl version (#3653)
Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
2025-07-09 10:56:38 -04:00

96 lines
4.2 KiB
Go

package cnr
// Package CNR implements a registrar that uses the CNR api to set name servers. It will self register it's providers when imported.
import (
"encoding/json"
"errors"
"github.com/StackExchange/dnscontrol/v4/pkg/version"
"github.com/StackExchange/dnscontrol/v4/providers"
cnrcl "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v5/apiclient"
)
// Client describes a connection to the CNR API.
type Client struct {
conf map[string]string
APILogin string
APIPassword string
APIEntity string
client *cnrcl.APIClient
}
var features = providers.DocumentationNotes{
// See providers/capabilities.go for the entire list of capabilities.
// The default for unlisted capabilities is 'Cannot'.
// --- Supported Features ---
providers.CanAutoDNSSEC: providers.Unimplemented("Ask for this feature."),
providers.CanConcur: providers.Can(),
providers.CanGetZones: providers.Can(),
providers.DocCreateDomains: providers.Can(),
providers.DocDualHost: providers.Can(),
providers.DocOfficiallySupported: providers.Cannot("Actively maintained provider module."),
// --- Supported record types ---
// providers.CanUseAKAMAICDN: providers.Cannot(), // can only be supported by Akamai EdgeDns provider
providers.CanUseAlias: providers.Can(),
// providers.CanUseAzureAlias: providers.Cannot(), // can only be supported by Azure provider
providers.CanUseCAA: providers.Can(),
providers.CanUseDHCID: providers.Cannot("Ask for this feature."),
providers.CanUseDNAME: providers.Cannot("Ask for this feature."),
providers.CanUseDNSKEY: providers.Unimplemented("Ask for this feature."),
providers.CanUseDS: providers.Unimplemented("Ask for this feature."),
providers.CanUseDSForChildren: providers.Unimplemented("Ask for this feature."), // CanUseDS implies CanUseDSForChildren
providers.CanUseHTTPS: providers.Cannot("Managed via (Query|Add|Modify|Delete)WebFwd API call. Data not accessible via the resource records list. Hard to integrate this into DNSControl by that."),
providers.CanUseLOC: providers.Cannot("Ask for this feature."),
providers.CanUseNAPTR: providers.Can(),
providers.CanUsePTR: providers.Can(),
// providers.CanUseRoute53Alias: providers.Cannot(), // can only be supported by AWS Route53 provider
providers.CanUseSOA: providers.Cannot("The SOA record is managed on the DNSZone directly. Data only accessible via StatusDNSZone Request, not via the resource records list. Hard to integrate this into DNSControl by that."), // supported by bind, honstingde
providers.CanUseSRV: providers.Can("SRV records with empty targets are not supported"),
providers.CanUseSSHFP: providers.Can(),
providers.CanUseSVCB: providers.Cannot("Ask for this feature."),
providers.CanUseTLSA: providers.Can(),
}
func newProvider(conf map[string]string) (*Client, error) {
api := &Client{
conf: conf,
client: cnrcl.NewAPIClient(),
}
api.client.SetUserAgent("DNSControl", version.Version())
api.APILogin, api.APIPassword, api.APIEntity = conf["apilogin"], conf["apipassword"], conf["apientity"]
if conf["debugmode"] == "2" {
api.client.EnableDebugMode()
}
if api.APIEntity != "OTE" && api.APIEntity != "LIVE" {
return nil, errors.New("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, errors.New("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)
}