lego/providers/dns/bluecat/bluecat.go

442 lines
12 KiB
Go
Raw Normal View History

2018-04-03 02:50:15 +00:00
// Package bluecat implements a DNS provider for solving the DNS-01 challenge
// using a self-hosted Bluecat Address Manager.
package bluecat
import (
"bytes"
"encoding/json"
"errors"
2018-04-03 02:50:15 +00:00
"fmt"
"io/ioutil"
2018-04-03 02:50:15 +00:00
"net/http"
"regexp"
"strconv"
"strings"
"time"
2018-05-30 17:53:04 +00:00
"github.com/xenolf/lego/acme"
"github.com/xenolf/lego/platform/config/env"
2018-04-03 02:50:15 +00:00
)
const configType = "Configuration"
const viewType = "View"
const txtType = "TXTRecord"
const zoneType = "Zone"
// Config is used to configure the creation of the DNSProvider
type Config struct {
BaseURL string
UserName string
Password string
ConfigName string
DNSView string
PropagationTimeout time.Duration
PollingInterval time.Duration
TTL int
HTTPClient *http.Client
}
// NewDefaultConfig returns a default configuration for the DNSProvider
func NewDefaultConfig() *Config {
return &Config{
TTL: env.GetOrDefaultInt("BLUECAT_TTL", 120),
PropagationTimeout: env.GetOrDefaultSecond("BLUECAT_PROPAGATION_TIMEOUT", acme.DefaultPropagationTimeout),
PollingInterval: env.GetOrDefaultSecond("BLUECAT_POLLING_INTERVAL", acme.DefaultPollingInterval),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond("BLUECAT_HTTP_TIMEOUT", 30*time.Second),
},
}
2018-04-03 02:50:15 +00:00
}
// DNSProvider is an implementation of the acme.ChallengeProvider interface that uses
// Bluecat's Address Manager REST API to manage TXT records for a domain.
type DNSProvider struct {
config *Config
token string
2018-04-03 02:50:15 +00:00
}
// NewDNSProvider returns a DNSProvider instance configured for Bluecat DNS.
// Credentials must be passed in the environment variables: BLUECAT_SERVER_URL, BLUECAT_USER_NAME and BLUECAT_PASSWORD.
// BLUECAT_SERVER_URL should have the scheme, hostname, and port (if required) of the authoritative Bluecat BAM server.
// The REST endpoint will be appended. In addition, the Configuration name
// and external DNS View Name must be passed in BLUECAT_CONFIG_NAME and BLUECAT_DNS_VIEW
2018-04-03 02:50:15 +00:00
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get("BLUECAT_SERVER_URL", "BLUECAT_USER_NAME", "BLUECAT_CONFIG_NAME", "BLUECAT_CONFIG_NAME", "BLUECAT_DNS_VIEW")
if err != nil {
return nil, fmt.Errorf("bluecat: %v", err)
}
config := NewDefaultConfig()
config.BaseURL = values["BLUECAT_SERVER_URL"]
config.UserName = values["BLUECAT_USER_NAME"]
config.Password = values["BLUECAT_PASSWORD"]
config.ConfigName = values["BLUECAT_CONFIG_NAME"]
config.DNSView = values["BLUECAT_DNS_VIEW"]
return NewDNSProviderConfig(config)
2018-04-03 02:50:15 +00:00
}
// NewDNSProviderCredentials uses the supplied credentials
// to return a DNSProvider instance configured for Bluecat DNS.
// Deprecated
func NewDNSProviderCredentials(baseURL, userName, password, configName, dnsView string, httpClient *http.Client) (*DNSProvider, error) {
config := NewDefaultConfig()
config.BaseURL = baseURL
config.UserName = userName
config.Password = password
config.ConfigName = configName
config.DNSView = dnsView
2018-04-03 02:50:15 +00:00
if httpClient != nil {
config.HTTPClient = httpClient
}
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for Bluecat DNS.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("bluecat: the configuration of the DNS provider is nil")
}
if config.BaseURL == "" || config.UserName == "" || config.Password == "" || config.ConfigName == "" || config.DNSView == "" {
return nil, fmt.Errorf("bluecat: credentials missing")
}
return &DNSProvider{config: config}, nil
}
// Present creates a TXT record using the specified parameters
// This will *not* create a subzone to contain the TXT record,
// so make sure the FQDN specified is within an extant zone.
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
fqdn, value, _ := acme.DNS01Record(domain, keyAuth)
err := d.login()
if err != nil {
return err
}
viewID, err := d.lookupViewID(d.config.DNSView)
if err != nil {
return err
}
parentZoneID, name, err := d.lookupParentZoneID(viewID, fqdn)
if err != nil {
return err
}
queryArgs := map[string]string{
"parentId": strconv.FormatUint(uint64(parentZoneID), 10),
}
body := bluecatEntity{
Name: name,
Type: "TXTRecord",
Properties: fmt.Sprintf("ttl=%d|absoluteName=%s|txt=%s|", d.config.TTL, fqdn, value),
}
resp, err := d.sendRequest(http.MethodPost, "addEntity", body, queryArgs)
if err != nil {
return err
}
defer resp.Body.Close()
addTxtBytes, _ := ioutil.ReadAll(resp.Body)
addTxtResp := string(addTxtBytes)
// addEntity responds only with body text containing the ID of the created record
_, err = strconv.ParseUint(addTxtResp, 10, 64)
if err != nil {
return fmt.Errorf("bluecat: addEntity request failed: %s", addTxtResp)
}
err = d.deploy(parentZoneID)
if err != nil {
return err
}
return d.logout()
}
// CleanUp removes the TXT record matching the specified parameters
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
fqdn, _, _ := acme.DNS01Record(domain, keyAuth)
err := d.login()
if err != nil {
return err
}
viewID, err := d.lookupViewID(d.config.DNSView)
if err != nil {
return err
}
parentID, name, err := d.lookupParentZoneID(viewID, fqdn)
if err != nil {
return err
}
queryArgs := map[string]string{
"parentId": strconv.FormatUint(uint64(parentID), 10),
"name": name,
"type": txtType,
}
resp, err := d.sendRequest(http.MethodGet, "getEntityByName", nil, queryArgs)
if err != nil {
return err
}
defer resp.Body.Close()
var txtRec entityResponse
err = json.NewDecoder(resp.Body).Decode(&txtRec)
if err != nil {
return fmt.Errorf("bluecat: %v", err)
}
queryArgs = map[string]string{
"objectId": strconv.FormatUint(uint64(txtRec.ID), 10),
}
resp, err = d.sendRequest(http.MethodDelete, http.MethodDelete, nil, queryArgs)
if err != nil {
return err
}
defer resp.Body.Close()
err = d.deploy(parentID)
if err != nil {
return err
}
return d.logout()
}
// Timeout returns the timeout and interval to use when checking for DNS propagation.
// Adjusting here to cope with spikes in propagation times.
func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
return d.config.PropagationTimeout, d.config.PollingInterval
2018-04-03 02:50:15 +00:00
}
// Send a REST request, using query parameters specified. The Authorization
// header will be set if we have an active auth token
func (d *DNSProvider) sendRequest(method, resource string, payload interface{}, queryArgs map[string]string) (*http.Response, error) {
url := fmt.Sprintf("%s/Services/REST/v1/%s", d.config.BaseURL, resource)
2018-04-03 02:50:15 +00:00
body, err := json.Marshal(payload)
if err != nil {
return nil, fmt.Errorf("bluecat: %v", err)
2018-04-03 02:50:15 +00:00
}
req, err := http.NewRequest(method, url, bytes.NewReader(body))
if err != nil {
return nil, fmt.Errorf("bluecat: %v", err)
2018-04-03 02:50:15 +00:00
}
req.Header.Set("Content-Type", "application/json")
if len(d.token) > 0 {
req.Header.Set("Authorization", d.token)
}
// Add all query parameters
q := req.URL.Query()
for argName, argVal := range queryArgs {
q.Add(argName, argVal)
}
req.URL.RawQuery = q.Encode()
resp, err := d.config.HTTPClient.Do(req)
2018-04-03 02:50:15 +00:00
if err != nil {
return nil, fmt.Errorf("bluecat: %v", err)
2018-04-03 02:50:15 +00:00
}
if resp.StatusCode >= 400 {
errBytes, _ := ioutil.ReadAll(resp.Body)
errResp := string(errBytes)
return nil, fmt.Errorf("bluecat: request failed with HTTP status code %d\n Full message: %s",
2018-04-03 02:50:15 +00:00
resp.StatusCode, errResp)
}
return resp, nil
}
// Starts a new Bluecat API Session. Authenticates using customerName, userName,
// password and receives a token to be used in for subsequent requests.
func (d *DNSProvider) login() error {
queryArgs := map[string]string{
"username": d.config.UserName,
"password": d.config.Password,
2018-04-03 02:50:15 +00:00
}
resp, err := d.sendRequest(http.MethodGet, "login", nil, queryArgs)
2018-04-03 02:50:15 +00:00
if err != nil {
return err
}
defer resp.Body.Close()
authBytes, err := ioutil.ReadAll(resp.Body)
if err != nil {
return fmt.Errorf("bluecat: %v", err)
}
2018-04-03 02:50:15 +00:00
authResp := string(authBytes)
if strings.Contains(authResp, "Authentication Error") {
msg := strings.Trim(authResp, "\"")
return fmt.Errorf("bluecat: request failed: %s", msg)
2018-04-03 02:50:15 +00:00
}
// Upon success, API responds with "Session Token-> BAMAuthToken: dQfuRMTUxNjc3MjcyNDg1ODppcGFybXM= <- for User : username"
d.token = regexp.MustCompile("BAMAuthToken: [^ ]+").FindString(authResp)
2018-04-03 02:50:15 +00:00
return nil
}
// Destroys Bluecat Session
func (d *DNSProvider) logout() error {
if len(d.token) == 0 {
// nothing to do
return nil
}
resp, err := d.sendRequest(http.MethodGet, "logout", nil, nil)
2018-04-03 02:50:15 +00:00
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
return fmt.Errorf("bluecat: request failed to delete session with HTTP status code %d", resp.StatusCode)
2018-05-30 17:53:04 +00:00
}
2018-04-03 02:50:15 +00:00
authBytes, err := ioutil.ReadAll(resp.Body)
if err != nil {
return err
}
2018-05-30 17:53:04 +00:00
authResp := string(authBytes)
if !strings.Contains(authResp, "successfully") {
msg := strings.Trim(authResp, "\"")
return fmt.Errorf("bluecat: request failed to delete session: %s", msg)
2018-04-03 02:50:15 +00:00
}
d.token = ""
return nil
}
// Lookup the entity ID of the configuration named in our properties
2018-05-30 17:53:04 +00:00
func (d *DNSProvider) lookupConfID() (uint, error) {
2018-04-03 02:50:15 +00:00
queryArgs := map[string]string{
"parentId": strconv.Itoa(0),
"name": d.config.ConfigName,
2018-04-03 02:50:15 +00:00
"type": configType,
}
resp, err := d.sendRequest(http.MethodGet, "getEntityByName", nil, queryArgs)
2018-04-03 02:50:15 +00:00
if err != nil {
return 0, err
}
defer resp.Body.Close()
var conf entityResponse
err = json.NewDecoder(resp.Body).Decode(&conf)
if err != nil {
return 0, fmt.Errorf("bluecat: %v", err)
2018-04-03 02:50:15 +00:00
}
2018-05-30 17:53:04 +00:00
return conf.ID, nil
2018-04-03 02:50:15 +00:00
}
// Find the DNS view with the given name within
2018-05-30 17:53:04 +00:00
func (d *DNSProvider) lookupViewID(viewName string) (uint, error) {
confID, err := d.lookupConfID()
2018-04-03 02:50:15 +00:00
if err != nil {
return 0, err
}
queryArgs := map[string]string{
2018-05-30 17:53:04 +00:00
"parentId": strconv.FormatUint(uint64(confID), 10),
"name": d.config.DNSView,
2018-04-03 02:50:15 +00:00
"type": viewType,
}
resp, err := d.sendRequest(http.MethodGet, "getEntityByName", nil, queryArgs)
2018-04-03 02:50:15 +00:00
if err != nil {
return 0, err
}
defer resp.Body.Close()
var view entityResponse
err = json.NewDecoder(resp.Body).Decode(&view)
if err != nil {
return 0, fmt.Errorf("bluecat: %v", err)
2018-04-03 02:50:15 +00:00
}
2018-05-30 17:53:04 +00:00
return view.ID, nil
2018-04-03 02:50:15 +00:00
}
// Return the entityId of the parent zone by recursing from the root view
// Also return the simple name of the host
2018-05-30 17:53:04 +00:00
func (d *DNSProvider) lookupParentZoneID(viewID uint, fqdn string) (uint, string, error) {
parentViewID := viewID
2018-04-03 02:50:15 +00:00
name := ""
if fqdn != "" {
zones := strings.Split(strings.Trim(fqdn, "."), ".")
last := len(zones) - 1
name = zones[0]
for i := last; i > -1; i-- {
2018-05-30 17:53:04 +00:00
zoneID, err := d.getZone(parentViewID, zones[i])
if err != nil || zoneID == 0 {
return parentViewID, name, err
2018-04-03 02:50:15 +00:00
}
2018-05-30 17:53:04 +00:00
if i > 0 {
name = strings.Join(zones[0:i], ".")
2018-04-03 02:50:15 +00:00
}
2018-05-30 17:53:04 +00:00
parentViewID = zoneID
2018-04-03 02:50:15 +00:00
}
}
2018-05-30 17:53:04 +00:00
return parentViewID, name, nil
2018-04-03 02:50:15 +00:00
}
// Get the DNS zone with the specified name under the parentId
2018-05-30 17:53:04 +00:00
func (d *DNSProvider) getZone(parentID uint, name string) (uint, error) {
2018-04-03 02:50:15 +00:00
queryArgs := map[string]string{
2018-05-30 17:53:04 +00:00
"parentId": strconv.FormatUint(uint64(parentID), 10),
2018-04-03 02:50:15 +00:00
"name": name,
"type": zoneType,
}
resp, err := d.sendRequest(http.MethodGet, "getEntityByName", nil, queryArgs)
2018-04-03 02:50:15 +00:00
// Return an empty zone if the named zone doesn't exist
if resp != nil && resp.StatusCode == 404 {
return 0, fmt.Errorf("bluecat: could not find zone named %s", name)
2018-04-03 02:50:15 +00:00
}
if err != nil {
return 0, err
}
defer resp.Body.Close()
var zone entityResponse
err = json.NewDecoder(resp.Body).Decode(&zone)
if err != nil {
return 0, fmt.Errorf("bluecat: %v", err)
2018-04-03 02:50:15 +00:00
}
2018-05-30 17:53:04 +00:00
return zone.ID, nil
2018-04-03 02:50:15 +00:00
}
// Deploy the DNS config for the specified entity to the authoritative servers
2018-05-30 17:53:04 +00:00
func (d *DNSProvider) deploy(entityID uint) error {
2018-04-03 02:50:15 +00:00
queryArgs := map[string]string{
2018-05-30 17:53:04 +00:00
"entityId": strconv.FormatUint(uint64(entityID), 10),
2018-04-03 02:50:15 +00:00
}
resp, err := d.sendRequest(http.MethodPost, "quickDeploy", nil, queryArgs)
2018-04-03 02:50:15 +00:00
if err != nil {
return err
}
defer resp.Body.Close()
return nil
}