dnsmadeeasy

Documentation

Overview

Package dnsmadeeasy implements a DNS provider for solving the DNS-01 challenge using DNS Made Easy.

Index

• type Client
  • func NewClient(apiKey string, apiSecret string) (*Client, error)
  • func (c *Client) CreateRecord(domain *Domain, record *Record) error
  • func (c *Client) DeleteRecord(record Record) error
  • func (c *Client) GetDomain(authZone string) (*Domain, error)
  • func (c *Client) GetRecords(domain *Domain, recordName, recordType string) (*[]Record, error)
• type Config
  • func NewDefaultConfig() *Config
• type DNSProvider
  • func NewDNSProvider() (*DNSProvider, error)
  • func NewDNSProviderConfig(config *Config) (*DNSProvider, error)
  • func NewDNSProviderCredentials(baseURL, apiKey, apiSecret string) (*DNSProvider, error)
  • func (d *DNSProvider) CleanUp(domainName, token, keyAuth string) error
  • func (d *DNSProvider) Present(domainName, token, keyAuth string) error
  • func (d *DNSProvider) Timeout() (timeout, interval time.Duration)
• type Domain
• type Record

Types

type Client

type Client struct {
	BaseURL    string
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

Client DNSMadeEasy client

func NewClient

func NewClient(apiKey string, apiSecret string) (*Client, error)

NewClient creates a DNSMadeEasy client

func (*Client) CreateRecord

func (c *Client) CreateRecord(domain *Domain, record *Record) error

CreateRecord creates a TXT records

func (*Client) DeleteRecord

func (c *Client) DeleteRecord(record Record) error

DeleteRecord deletes a TXT records

func (*Client) GetDomain

func (c *Client) GetDomain(authZone string) (*Domain, error)

GetDomain gets a domain

func (*Client) GetRecords

func (c *Client) GetRecords(domain *Domain, recordName, recordType string) (*[]Record, error)

GetRecords gets all TXT records

type Config

type Config struct {
	BaseURL            string
	APIKey             string
	APISecret          string
	Sandbox            bool
	HTTPClient         *http.Client
	PropagationTimeout time.Duration
	PollingInterval    time.Duration
	TTL                int
}

Config is used to configure the creation of the DNSProvider

func NewDefaultConfig

func NewDefaultConfig() *Config

NewDefaultConfig returns a default configuration for the DNSProvider

type DNSProvider

type DNSProvider struct {
	// contains filtered or unexported fields
}

DNSProvider is an implementation of the acme.ChallengeProvider interface that uses DNSMadeEasy's DNS API to manage TXT records for a domain.

func NewDNSProvider

func NewDNSProvider() (*DNSProvider, error)

NewDNSProvider returns a DNSProvider instance configured for DNSMadeEasy DNS. Credentials must be passed in the environment variables: DNSMADEEASY_API_KEY and DNSMADEEASY_API_SECRET.

func NewDNSProviderConfig

func NewDNSProviderConfig(config *Config) (*DNSProvider, error)

NewDNSProviderConfig return a DNSProvider instance configured for DNS Made Easy.

func NewDNSProviderCredentials

func NewDNSProviderCredentials(baseURL, apiKey, apiSecret string) (*DNSProvider, error)

NewDNSProviderCredentials uses the supplied credentials to return a DNSProvider instance configured for DNS Made Easy. Deprecated

func (*DNSProvider) CleanUp

func (d *DNSProvider) CleanUp(domainName, token, keyAuth string) error

CleanUp removes the TXT records matching the specified parameters

func (*DNSProvider) Present

func (d *DNSProvider) Present(domainName, token, keyAuth string) error

Present creates a TXT record using the specified parameters

func (*DNSProvider) Timeout

func (d *DNSProvider) Timeout() (timeout, interval time.Duration)

Timeout returns the timeout and interval to use when checking for DNS propagation. Adjusting here to cope with spikes in propagation times.

type Domain

type Domain struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
}

Domain holds the DNSMadeEasy API representation of a Domain

type Record

type Record struct {
	ID       int    `json:"id"`
	Type     string `json:"type"`
	Name     string `json:"name"`
	Value    string `json:"value"`
	TTL      int    `json:"ttl"`
	SourceID int    `json:"sourceId"`
}

Record holds the DNSMadeEasy API representation of a Domain Record