conoha

Documentation

Overview

Package conoha implements a DNS provider for solving the DNS-01 challenge using ConoHa DNS.

Index

• type Access
• type Auth
• type Client
  • func NewClient(region string, auth Auth, httpClient *http.Client) (*Client, error)
  • func (c *Client) CreateRecord(domainID string, record Record) error
  • func (c *Client) DeleteRecord(domainID, recordID string) error
  • func (c *Client) GetDomainID(domainName string) (string, error)
  • func (c *Client) GetRecordID(domainID, recordName, recordType, data string) (string, error)
• type Config
  • func NewDefaultConfig() *Config
• type DNSProvider
  • func NewDNSProvider() (*DNSProvider, error)
  • func NewDNSProviderConfig(config *Config) (*DNSProvider, error)
  • func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error
  • func (d *DNSProvider) Present(domain, token, keyAuth string) error
  • func (d *DNSProvider) Timeout() (timeout, interval time.Duration)
• type Domain
• type DomainListResponse
• type IdentityRequest
• type IdentityResponse
• type PasswordCredentials
• type Record
• type RecordListResponse
• type Token

Types

type Access

type Access struct {
	Token Token `json:"token"`
}

Access is an identity information.

type Auth

type Auth struct {
	TenantID            string              `json:"tenantId"`
	PasswordCredentials PasswordCredentials `json:"passwordCredentials"`
}

Auth is an authentication information.

type Client

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

Client is a ConoHa API client.

func NewClient

func NewClient(region string, auth Auth, httpClient *http.Client) (*Client, error)

NewClient returns a client instance logged into the ConoHa service.

func (*Client) CreateRecord

func (c *Client) CreateRecord(domainID string, record Record) error

CreateRecord adds new record.

func (*Client) DeleteRecord

func (c *Client) DeleteRecord(domainID, recordID string) error

DeleteRecord removes specified record.

func (*Client) GetDomainID

func (c *Client) GetDomainID(domainName string) (string, error)

GetDomainID returns an ID of specified domain.

func (*Client) GetRecordID

func (c *Client) GetRecordID(domainID, recordName, recordType, data string) (string, error)

GetRecordID returns an ID of specified record.

type Config

type Config struct {
	Region             string
	TenantID           string
	Username           string
	Password           string
	TTL                int
	PropagationTimeout time.Duration
	PollingInterval    time.Duration
	HTTPClient         *http.Client
}

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

func NewDNSProvider

func NewDNSProvider() (*DNSProvider, error)

NewDNSProvider returns a DNSProvider instance configured for ConoHa DNS. Credentials must be passed in the environment variables: CONOHA_TENANT_ID, CONOHA_API_USERNAME, CONOHA_API_PASSWORD

func NewDNSProviderConfig

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

NewDNSProviderConfig return a DNSProvider instance configured for ConoHa DNS.

func (*DNSProvider) CleanUp

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

CleanUp clears ConoHa DNS TXT record

func (*DNSProvider) Present

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

Present creates a TXT record to fulfill the dns-01 challenge.

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   string `json:"id"`
	Name string `json:"name"`
}

Domain is a hosted domain entry.

type DomainListResponse

type DomainListResponse struct {
	Domains []Domain `json:"domains"`
}

DomainListResponse is a response of a domain listing request.

type IdentityRequest

type IdentityRequest struct {
	Auth Auth `json:"auth"`
}

IdentityRequest is an authentication request body.

type IdentityResponse

type IdentityResponse struct {
	Access Access `json:"access"`
}

IdentityResponse is an authentication response body.

type PasswordCredentials

type PasswordCredentials struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

PasswordCredentials is API-user's credentials.

type Record

type Record struct {
	ID   string `json:"id,omitempty"`
	Name string `json:"name"`
	Type string `json:"type"`
	Data string `json:"data"`
	TTL  int    `json:"ttl"`
}

Record is a record entry.

type RecordListResponse

type RecordListResponse struct {
	Records []Record `json:"records"`
}

RecordListResponse is a response of record listing request.

type Token

type Token struct {
	ID string `json:"id"`
}

Token is an api access token.