s3

Documentation

Overview

package s3 solves the ACMEv2 HTTP-01 challenge. The workflow is as follows:

1. client requests a certificate from the remote CA, using the Solver as the HTTP-01 challenge 2. Solver populates the Challenge in S3 and notifies the CA that the challenge is ready 3. remote CA requests the keyauth from the well known path in S3 4. s3 presents the keyauth to the remote CA

In order for s3 to route to your bucket using http, the bucket name will need to match the domain name for which you are creating a certificate

Index

• type Solver
  • func New(client s3iface.S3API) *Solver
  • func (s *Solver) CleanUp(domain, token, keyAuth string) error
  • func (s *Solver) Present(domain, token, keyAuth string) error
  • func (s *Solver) WithDelay(t time.Duration) *Solver

Types

type Solver

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

Solver implements lego's challenge.Provider

func New

func New(client s3iface.S3API) *Solver

New returns a pointer to a Solver, initialised with an s3 client

func (*Solver) CleanUp

func (s *Solver) CleanUp(domain, token, keyAuth string) error

CleanUp removes the challenge information from S3

func (*Solver) Present

func (s *Solver) Present(domain, token, keyAuth string) error

Present writes the challenge information into S3 so that we can respond to HTTP queries with the correct value

func (*Solver) WithDelay

func (s *Solver) WithDelay(t time.Duration) *Solver

WithDelay allows you to introduce a delay between uploading to S3 and continuing with the validation process. This is helpful if you are doing something with S3 replication, for example