identifier

Documentation

Overview

The identifier package defines types for RFC 8555 ACME identifiers. It exists as a separate package to prevent an import loop between the core and probs packages.

Index

• Constants
• type ACMEIdentifier
  • func NewDNS(domain string) ACMEIdentifier
  • func NewIP(ip netip.Addr) ACMEIdentifier
  • func (i ACMEIdentifier) AsProto() *corepb.Identifier
• type IdentifierType

Constants

const (
	// TypeDNS is specified in RFC 8555 for TypeDNS type identifiers.
	TypeDNS = IdentifierType("dns")
	// TypeIP is specified in RFC 8738
	TypeIP = IdentifierType("ip")
)

Types

type ACMEIdentifier

type ACMEIdentifier struct {
	// Type is the registered IdentifierType of the identifier.
	Type IdentifierType `json:"type"`
	// Value is the value of the identifier. For a DNS type identifier it is
	// a domain name.
	Value string `json:"value"`
}

ACMEIdentifier is a struct encoding an identifier that can be validated. The protocol allows for different types of identifier to be supported (DNS names, IP addresses, etc.), but currently we only support RFC 8555 DNS type identifiers for domain names.

func NewDNS

func NewDNS(domain string) ACMEIdentifier

NewDNS is a convenience function for creating an ACMEIdentifier with Type "dns" for a given domain name.

func NewIP

func NewIP(ip netip.Addr) ACMEIdentifier

NewIP is a convenience function for creating an ACMEIdentifier with Type "ip" for a given IP address.

func (ACMEIdentifier) AsProto

func (i ACMEIdentifier) AsProto() *corepb.Identifier

type IdentifierType

type IdentifierType string

IdentifierType is a named string type for registered ACME identifier types. See https://tools.ietf.org/html/rfc8555#section-9.7.7