validate

README

caddy-validate-github

Caddy v2 middleware for validating a GitHub webhook request

Installation

xcaddy build \
    --with github.com/awoodbeck/caddy-validate-github

Usage

This middleware functions as a gatekeeper for any succeeding directives in a route. The request is only passed on to the next directive if its signature is valid. Otherwise, the client receives a 403 status code.

Caddyfile

validate_github <secret>

• secret - shared secret between you and GitHub

You could use something like this bash command to generate a secure secret:

LC_ALL=C tr -dc '[:alnum:]' < /dev/urandom | head -c32; echo

Copy and paste the results into your Caddyfile.

Example

validate_github is middleware meant to precede other directives.

An example of this directive in context looks like this:

route /update {
    validate_github KcuP9N0iEqYHFBRUda6oHLP4UUub6EMz
    exec * /path/to/bin/update.sh
}

Here, you're using validate_github to validate the request before passing it along to caddy-exec, runs the /path/to/bin/update.sh script. Since caddy-exec does not support chaining commands at this time, it's necessary to perform multiple commands in a script or Go binary and invoke it from the exec directive.

JSON

The validate_github JSON look like this, minus succeeding middleware:

{
  "routes": [
    {
      "handle": [
        {
          "handler": "validate_github",
          "secret": "KcuP9N0iEqYHFBRUda6oHLP4UUub6EMz"
        }
      ],
      "match": [
        {
          "path": [
            "/refresh"
          ]
        }
      ]
    }
  ]
}

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 {
	Secret string `json:"secret,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 the caddy.Provisioner interface.

func (Middleware) ServeHTTP

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

ServeHTTP implements the caddy.Handler interface.

func (*Middleware) UnmarshalCaddyfile

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

UnmarshalCaddyfile implements caddyfile.Unmarshaler. Syntax:

validate_github <secret>

func (*Middleware) Validate

func (m *Middleware) Validate() error