desec

Documentation

Overview

Package desec provides a high-level client to the deSEC API

Index

• func CalculateBatchWaitDuration(ml *slidingwindows.MultiLimiter, batchMinFillRatio float32) time.Duration
• func CompareSubnames(first, second string) bool
• func FilterAndSortRRsets(rrsets []desec.RRset, recordTypes []string) []desec.RRset
• func GetReverseDomainNameFragments(domainName string) []string
• func IsDeletionUpsertRRset(rrset desec.RRset) bool
• func SortSubnameRRsets(rrsets map[string][]desec.RRset, filterRecordTypes []string) (subnames []string, sorted [][]desec.RRset)
• type Cache
  • func (c *Cache) GetDomainByName(name string) (*desec.Domain, bool, error)
  • func (c *Cache) GetRRsetByNameAndType(domainName, subname, rrsetType string) (*desec.RRset, bool, error)
  • func (c *Cache) GetRRsetsByName(domainName, subname string) ([]desec.RRset, error)
  • func (c *Cache) GetSubnames(domainName string) ([]string, error)
  • func (c *Cache) HasSubname(domainName string, subname string) bool
  • func (c *Cache) SetDomainByName(name string, domain desec.Domain) error
  • func (c *Cache) SetNonexistentDomainByName(name string)
  • func (c *Cache) SetNonexistentRRsetByNameAndType(domainName, subname, rrsetType string)
  • func (c *Cache) SetRRsetByNameAndType(domainName, subname, rrsetType string, rrset desec.RRset) error
  • func (c *Cache) SetRRsetsByName(domainName, subname string, rrsets []desec.RRset) error
  • func (c *Cache) SetSubnames(domainName string, subnames []string) error
  • func (c *Cache) UnsetSubnames(domainName string)
• type Client
  • func NewClient(c Config, cache clientcache.Cache, l godest.Logger) *Client
  • func (c *Client) CreateRRset(ctx context.Context, subname, recordType string, ttl int64, records []string) (desec.RRset, error)
  • func (c *Client) DeleteRRset(ctx context.Context, subname, recordType string) error
  • func (c *Client) DeleteRRsets(ctx context.Context, keys ...RRsetKey) error
  • func (c *Client) GetDomain(ctx context.Context) (*desec.Domain, error)
  • func (c *Client) GetRRset(ctx context.Context, subname, recordType string) (*desec.RRset, error)
  • func (c *Client) GetRRsets(ctx context.Context) (map[string][]desec.RRset, error)
  • func (c *Client) GetSubnameRRsets(ctx context.Context, subname string) ([]desec.RRset, error)
  • func (c *Client) UpdateRRset(ctx context.Context, subname, recordType string, ttl int64, records []string) (*desec.RRset, error)
  • func (c *Client) UpsertRRsets(ctx context.Context, rrsets ...desec.RRset) ([]desec.RRset, error)
• type Config
  • func GetConfig(domainName string) (c Config, err error)
• type DesecAPISettings
  • func GetAPISettings() (s DesecAPISettings, err error)
• type RRsetKey
  • func NewRRsetKey(rrset desec.RRset) RRsetKey
  • func (k RRsetKey) AsDeletionUpsertRRset() desec.RRset

Functions

func CalculateBatchWaitDuration

func CalculateBatchWaitDuration(
	ml *slidingwindows.MultiLimiter, batchMinFillRatio float32,
) time.Duration

func CompareSubnames

func CompareSubnames(first, second string) bool

func FilterAndSortRRsets

func FilterAndSortRRsets(rrsets []desec.RRset, recordTypes []string) []desec.RRset

func GetReverseDomainNameFragments

func GetReverseDomainNameFragments(domainName string) []string

func IsDeletionUpsertRRset

func IsDeletionUpsertRRset(rrset desec.RRset) bool

func SortSubnameRRsets

func SortSubnameRRsets(
	rrsets map[string][]desec.RRset, filterRecordTypes []string,
) (subnames []string, sorted [][]desec.RRset)

Types

type Cache

type Cache struct {
	Cache       clientcache.Cache
	CostWeight  float32
	TTL         time.Duration
	RecordTypes []string
}

func (*Cache) GetDomainByName

func (c *Cache) GetDomainByName(name string) (*desec.Domain, bool, error)

func (*Cache) GetRRsetByNameAndType

func (c *Cache) GetRRsetByNameAndType(
	domainName, subname, rrsetType string,
) (*desec.RRset, bool, error)

func (*Cache) GetRRsetsByName

func (c *Cache) GetRRsetsByName(domainName, subname string) ([]desec.RRset, error)

func (*Cache) GetSubnames

func (c *Cache) GetSubnames(domainName string) ([]string, error)

func (*Cache) HasSubname

func (c *Cache) HasSubname(domainName string, subname string) bool

func (*Cache) SetDomainByName

func (c *Cache) SetDomainByName(name string, domain desec.Domain) error

func (*Cache) SetNonexistentDomainByName

func (c *Cache) SetNonexistentDomainByName(name string)

func (*Cache) SetNonexistentRRsetByNameAndType

func (c *Cache) SetNonexistentRRsetByNameAndType(domainName, subname, rrsetType string)

func (*Cache) SetRRsetByNameAndType

func (c *Cache) SetRRsetByNameAndType(
	domainName, subname, rrsetType string, rrset desec.RRset,
) error

func (*Cache) SetRRsetsByName

func (c *Cache) SetRRsetsByName(domainName, subname string, rrsets []desec.RRset) error

func (*Cache) SetSubnames

func (c *Cache) SetSubnames(domainName string, subnames []string) error

func (*Cache) UnsetSubnames

func (c *Cache) UnsetSubnames(domainName string)

type Client

type Client struct {
	Config       Config
	Logger       godest.Logger
	Cache        *Cache
	ReadLimiter  *slidingwindows.MultiLimiter
	WriteLimiter *slidingwindows.MultiLimiter
}

func NewClient

func NewClient(c Config, cache clientcache.Cache, l godest.Logger) *Client

func (*Client) CreateRRset

func (c *Client) CreateRRset(
	ctx context.Context, subname, recordType string, ttl int64, records []string,
) (desec.RRset, error)

func (*Client) DeleteRRset

func (c *Client) DeleteRRset(ctx context.Context, subname, recordType string) error

func (*Client) DeleteRRsets

func (c *Client) DeleteRRsets(ctx context.Context, keys ...RRsetKey) error

func (*Client) GetDomain

func (c *Client) GetDomain(ctx context.Context) (*desec.Domain, error)

func (*Client) GetRRset

func (c *Client) GetRRset(ctx context.Context, subname, recordType string) (*desec.RRset, error)

func (*Client) GetRRsets

func (c *Client) GetRRsets(ctx context.Context) (map[string][]desec.RRset, error)

func (*Client) GetSubnameRRsets

func (c *Client) GetSubnameRRsets(ctx context.Context, subname string) ([]desec.RRset, error)

func (*Client) UpdateRRset

func (c *Client) UpdateRRset(
	ctx context.Context, subname, recordType string, ttl int64, records []string,
) (*desec.RRset, error)

func (*Client) UpsertRRsets

func (c *Client) UpsertRRsets(ctx context.Context, rrsets ...desec.RRset) ([]desec.RRset, error)

type Config

type Config struct {
	DomainName  string
	DNSServer   models.DNSServer
	APISettings DesecAPISettings
	RecordTypes []string
}

func GetConfig

func GetConfig(domainName string) (c Config, err error)

type DesecAPISettings

type DesecAPISettings struct {
	ReadCacheTTL   time.Duration
	WriteSoftQuota float32
}

func GetAPISettings

func GetAPISettings() (s DesecAPISettings, err error)

type RRsetKey

type RRsetKey struct {
	Subname string
	Type    string
}

func NewRRsetKey

func NewRRsetKey(rrset desec.RRset) RRsetKey

func (RRsetKey) AsDeletionUpsertRRset

func (k RRsetKey) AsDeletionUpsertRRset() desec.RRset