Documentation

Overview

    Package iij implements a DNS provider for solving the DNS-01 challenge using IIJ DNS.

    Index

    Constants

    View Source
    const (
    	EnvAPIAccessKey  = envNamespace + "API_ACCESS_KEY"
    	EnvAPISecretKey  = envNamespace + "API_SECRET_KEY"
    	EnvDoServiceCode = envNamespace + "DO_SERVICE_CODE"
    
    	EnvTTL                = envNamespace + "TTL"
    	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
    	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
    )

      Environment variables names.

      Variables

      This section is empty.

      Functions

      This section is empty.

      Types

      type Config

      type Config struct {
      	AccessKey          string
      	SecretKey          string
      	DoServiceCode      string
      	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 implements the challenge.Provider interface.

            func NewDNSProvider

            func NewDNSProvider() (*DNSProvider, error)

              NewDNSProvider returns a DNSProvider instance configured for IIJ DNS.

              func NewDNSProviderConfig

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

                NewDNSProviderConfig takes a given config and returns a custom configured DNSProvider instance.

                func (*DNSProvider) CleanUp

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

                  CleanUp removes the TXT record matching the specified parameters.

                  func (*DNSProvider) Present

                  func (d *DNSProvider) Present(domain, 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.

                      Source Files