caddy

README

loginsrv Caddy middleware

Login plugin for Caddy, based on tarent/loginsrv. The login is checked against a backend and then returned as JWT token. This middleware is designed to play together with the caddy-jwt plugin.

For a full documentation of loginsrv configuration and usage, visit the loginsrv README.md.

A small demo can also be found in the ./demo directory.

Configuration

To be compatible with caddy-jwt, the jwt secret is taken from the environment variable JWT_SECRET if such a variable is set. Otherwise, a random token is generated and set as environment variable JWT_SECRET, so that caddy-jwt looks up the same shared secret.

Basic configuration

Provide a login resource under /login, for user bob with password secret:

login / {
    simple bob=secret
}

Full configuration example

login / {
    success_url /after/login
    cookie_name alternativeName
    cookie_http_only true
    simple bob=secret
    osiam endpoint=http://localhost:8080,client_id=example-client,client_secret=secret
    htpasswd file=users
    github client_id=xxx,client_secret=yyy
}

Example caddyfile

127.0.0.1

root {$PWD}
browse

jwt {
    path /
    allow sub bob
}

login / {
         simple bob=secret,alice=secret
}

Documentation

Index

• type CaddyHandler
  • func NewCaddyHandler(next httpserver.Handler, loginHandler *login.Handler, config *login.Config) *CaddyHandler
  • func (h *CaddyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

Types

type CaddyHandler

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

CaddyHandler is the loginsrv handler wrapper for caddy

func NewCaddyHandler

func NewCaddyHandler(next httpserver.Handler, loginHandler *login.Handler, config *login.Config) *CaddyHandler

NewCaddyHandler create the handler

func (*CaddyHandler) ServeHTTP

func (h *CaddyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)