acme

Documentation

Index

• Constants
• type Account
• type Authorization
• type Challenge
• type Identifier
• type Order
• type ProblemDetails
  • func AccountDoesNotExistProblem(detail string) *ProblemDetails
  • func AgreementRequiredProblem(detail string) *ProblemDetails
  • func BadNonceProblem(detail string) *ProblemDetails
  • func Conflict(detail string) *ProblemDetails
  • func ConnectionProblem(detail string) *ProblemDetails
  • func InternalErrorProblem(detail string) *ProblemDetails
  • func InvalidContactProblem(detail string) *ProblemDetails
  • func MalformedProblem(detail string) *ProblemDetails
  • func MethodNotAllowed() *ProblemDetails
  • func NotFoundProblem(detail string) *ProblemDetails
  • func UnauthorizedProblem(detail string) *ProblemDetails
  • func UnsupportedContactProblem(detail string) *ProblemDetails
  • func UnsupportedMediaTypeProblem(detail string) *ProblemDetails
  • func (pd *ProblemDetails) Error() string
• type Resource

Constants

const (
	StatusPending     = "pending"
	StatusInvalid     = "invalid"
	StatusValid       = "valid"
	StatusProcessing  = "processing"
	StatusDeactivated = "deactivated"

	IdentifierDNS = "dns"

	ChallengeHTTP01    = "http-01"
	ChallengeTLSALPN01 = "tls-alpn-01"
	ChallengeDNS01     = "dns-01"

	HTTP01BaseURL = ".well-known/acme-challenge/"

	ACMETLS1Protocol = "acme-tls/1"
)

Types

type Account

type Account struct {
	Status  string   `json:"status"`
	Contact []string `json:"contact"`
	Orders  string   `json:"orders,omitempty"`
}

type Authorization

type Authorization struct {
	Status     string       `json:"status"`
	Identifier Identifier   `json:"identifier"`
	Challenges []*Challenge `json:"challenges"`
	Expires    string       `json:"expires"`
	// Wildcard is a Let's Encrypt specific Authorization field that indicates the
	// authorization was created as a result of an order containing a name with
	// a `*.`wildcard prefix. This will help convey to users that an
	// Authorization with the identifier `example.com` and one DNS-01 challenge
	// corresponds to a name `*.example.com` from an associated order.
	Wildcard bool `json:"wildcard,omitempty"`
}

An Authorization is created for each identifier in an order

type Challenge

type Challenge struct {
	Type      string          `json:"type"`
	URL       string          `json:"url"`
	Token     string          `json:"token"`
	Status    string          `json:"status"`
	Validated string          `json:"validated,omitempty"`
	Error     *ProblemDetails `json:"error,omitempty"`
}

A Challenge is used to validate an Authorization

type Identifier

type Identifier struct {
	Type  string `json:"type"`
	Value string `json:"value"`
}

type Order

type Order struct {
	Status         string       `json:"status"`
	Expires        string       `json:"expires"`
	Identifiers    []Identifier `json:"identifiers,omitempty"`
	Finalize       string       `json:"finalize"`
	NotBefore      string       `json:"notBefore,omitempty"`
	NotAfter       string       `json:"notAfter,omitempty"`
	Authorizations []string     `json:"authorizations"`
	Certificate    string       `json:"certificate,omitempty"`
}

An Order is created to request issuance for a CSR

type ProblemDetails

type ProblemDetails struct {
	Type       string `json:"type,omitempty"`
	Detail     string `json:"detail,omitempty"`
	HTTPStatus int    `json:"status,omitempty"`
}

func AccountDoesNotExistProblem

func AccountDoesNotExistProblem(detail string) *ProblemDetails

func AgreementRequiredProblem

func AgreementRequiredProblem(detail string) *ProblemDetails

func BadNonceProblem

func BadNonceProblem(detail string) *ProblemDetails

func Conflict

func Conflict(detail string) *ProblemDetails

func ConnectionProblem

func ConnectionProblem(detail string) *ProblemDetails

func InternalErrorProblem

func InternalErrorProblem(detail string) *ProblemDetails

func InvalidContactProblem

func InvalidContactProblem(detail string) *ProblemDetails

func MalformedProblem

func MalformedProblem(detail string) *ProblemDetails

func MethodNotAllowed

func MethodNotAllowed() *ProblemDetails

func NotFoundProblem

func NotFoundProblem(detail string) *ProblemDetails

func UnauthorizedProblem

func UnauthorizedProblem(detail string) *ProblemDetails

func UnsupportedContactProblem

func UnsupportedContactProblem(detail string) *ProblemDetails

func UnsupportedMediaTypeProblem

func UnsupportedMediaTypeProblem(detail string) *ProblemDetails

func (*ProblemDetails) Error

func (pd *ProblemDetails) Error() string

type Resource

type Resource string

acme.Resource values identify different types of ACME resources