hsdpsigner

README

caddy-hsdpsigner

Caddy module to sign HTTP requests

building

xcaddy build \
  --with github.com/loafoe/caddy-hsdpsigner@v0.3.0 \
  --with github.com/caddy-dns/route53@v1.3.0 \
  --with github.com/gr33nbl00d/caddy-revocation-validator \
  --with github.com/caddyserver/caddy/v2=github.com/caddyserver/caddy/v2@v2.8.4

updating OCI image

The build process is captured in a set of Github Actions. These workflows can be executed locally with the help of the act tool. Install it locally and then simply run act

secrets

The docker flows require HSP Docker registry credentials. Create a .secrets file and add the following lines

HSDP_DOCKER_USERNAME=replace-with-registry-username
HSDP_DOCKER_PASSWORD=replace-with-registry-password

updating tagged builds

After tagging the repository you can build and publish new OCI images as follows:

act -W .github/workflows/docker_tagged.yml

license

License is MIT

Documentation

Index

• type Middleware
  • func (Middleware) CaddyModule() caddy.ModuleInfo
  • func (m *Middleware) Provision(ctx caddy.Context) error
  • func (m Middleware) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error
  • func (m *Middleware) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
  • func (m Middleware) Validate() error

Types

type Middleware

type Middleware struct {
	SharedKey string `json:"shared_key,omitempty"`
	SecretKey string `json:"secret_key,omitempty"`
	// contains filtered or unexported fields
}

func (Middleware) CaddyModule

func (Middleware) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Middleware) Provision

func (m *Middleware) Provision(ctx caddy.Context) error

Provision implements caddy.Provisioner.

func (Middleware) ServeHTTP

func (m Middleware) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error

ServeHTTP implements caddyhttp.MiddlewareHandler.

func (*Middleware) UnmarshalCaddyfile

func (m *Middleware) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile implements caddyfile.Unmarshaler.

func (Middleware) Validate

func (m Middleware) Validate() error

Validate implements caddy.Validator.