va

Documentation

Index

• type VerificationAuthority
  • func New(opts *VerificationAuthorityOpts) *VerificationAuthority
  • func (va *VerificationAuthority) UserAgent() string
  • func (va VerificationAuthority) ValidateChallenge(ident acme.Identifier, chal *core.Challenge, acct *core.Account)
• type VerificationAuthorityOpts
  • func NewDefaultVerificationAuthorityOpts() *VerificationAuthorityOpts

Types

type VerificationAuthority

type VerificationAuthority struct {
	DnsClient *dns.Client
	// contains filtered or unexported fields
}

The internal verification authority implementation used to verify and validate records.

func New

func New(opts *VerificationAuthorityOpts) *VerificationAuthority

Generate a new Verification Authority.

func (*VerificationAuthority) UserAgent

func (va *VerificationAuthority) UserAgent() string

func (VerificationAuthority) ValidateChallenge

func (va VerificationAuthority) ValidateChallenge(ident acme.Identifier, chal *core.Challenge, acct *core.Account)

type VerificationAuthorityOpts

type VerificationAuthorityOpts struct {
	// The list of characters to use as a cutset for working with certificates.
	//   Defaults: "\n\r\t"
	WhitespaceCutset string

	// The user agent you want to use with your local Gravel instance.
	//   Defaults: "18f-Gravel-VA"
	UserAgentBase string

	// How long do valid authorizations last before expiring?
	//   Defaults: time.Hour
	ValidAuthzExpire time.Duration

	// How many vaTasks can be in the channel before the Web FrontEnd blocks on adding another?
	//   Defaults: 6
	TaskQueueSize int

	// How many concurrent validations are performed?
	//   Defaults: 3
	ConcurrentValidations int

	// NoSleep determines if the VA should *not* sleep between validation attempts. Set this to true when you invoke
	// Gravel if you wish validation to be done at full speed.
	//   Default: true
	NoSleep bool

	// VerificationSleepDuration determines the time the VA should sleep between validation attempts (if not disabled).
	//   Default: 0 * time.Second
	VerificationSleepDuration time.Duration

	// DefaultValidationAttemptSleepTime defines the default sleep time (in seconds) between validation attempts.
	//   Defaults: 5 * time.Second
	DefaultValidationAttemptSleepTime time.Duration

	// ValidationTimeout defines the timeout for validation attempts.
	//   Defaults: 15 * time.Second
	ValidationTimeout time.Duration

	// NoValidate sets the signal that the VA should *not* actually validate challenges.
	//   Defaults: false
	NoValidate bool

	// HTTP port used for the verification authority.
	//   Default: 5001
	HttpPort int

	// TLS port used for the verification.
	//   Defaults: 5002
	TlsPort int

	// A custom DNS resolver.
	//   Defaults: ""
	CustomResolverAddress string

	// Set to true if you want records automatically generated by Gravel to be added to the DNS server for automatic
	// verification.
	AutoUpdateAuthZRecords bool

	AutoUpdateAuthZRecordsNotifier chan interface{}

	// Logger
	Logger *logrus.Logger
}

Options used to define the Verification Authority component of Gravel. Use NewDefaultVerificationAuthorityOpts if you are interested in just using the defaults.

func NewDefaultVerificationAuthorityOpts

func NewDefaultVerificationAuthorityOpts() *VerificationAuthorityOpts

Generate a new set of default settings for the Verification Authority. See VerificationAuthorityOpts for the default values.