portal

README

caddy-auth-portal

Authentication Plugin for Caddy v2 implementing Form-Based, Basic, Local, LDAP, OpenID Connect, OAuth 2.0, SAML Authentication.

Documentation: authp.github.io

Security Policy: SECURITY.md

Please show your appreciation for this work and ⭐ ⭐ ⭐

Please ask questions either here or via LinkedIn. I am happy to help you! @greenpau

Please see other plugins:

• caddy-authorize
• caddy-trace
• caddy-systemd

Download Caddy with the plugins enabled:

• windows/amd64
• linux/amd64

Documentation

Index

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

Functions

func GetRequestID

func GetRequestID(r *http.Request) string

GetRequestID returns request ID.

Types

type AuthMiddleware

type AuthMiddleware struct {
	Portal *authn.Authenticator `json:"authp,omitempty"`
}

AuthMiddleware implements Form-Based, Basic, Local, LDAP, OpenID Connect, OAuth 2.0, SAML Authentication.

func (AuthMiddleware) CaddyModule

func (AuthMiddleware) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*AuthMiddleware) Provision

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

Provision provisions authentication portal provider

func (AuthMiddleware) ServeHTTP

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

ServeHTTP authorizes access based on the presense and content of JWT token.

func (*AuthMiddleware) UnmarshalCaddyfile

func (m *AuthMiddleware) UnmarshalCaddyfile(d *caddyfile.Dispenser) (err error)

UnmarshalCaddyfile unmarshals a caddyfile

func (*AuthMiddleware) Validate

func (m *AuthMiddleware) Validate() error

Validate implements caddy.Validator.