certauth

package module

v0.0.0-...-4d9adba Latest Latest Go to latest Published: Feb 16, 2021 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jaywalker/go-certauth

Links

Open Source Insights

README ¶

certauth

This package provides TLS certificate based authentication middleware. Only compatibile with httprouter.

Usage

Examples of usage with various http router libs in the ./examples directory. But they're broken right now.

Contributing

You can try, but probably better to just fork me like I did with this to start with. Unless you're very lucky, I'll probably ignore any pull requests or tickets.

Acknowledgments

Originally forked from https://github.com/pantheon-systems/go-certauth.

Their original acknowledgements:

A big thanks to the https://github.com/unrolled/secure project whose approach to writing middleware helped us figure out our approach to creating this project.

Documentation ¶

Index ¶

type Auth
- func NewAuth(authHandler AuthHandler) *Auth
type AuthHandler

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Auth ¶

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

Auth is an instance of the middleware

func NewAuth ¶

func NewAuth(authHandler AuthHandler) *Auth

NewAuth returns an auth

func (*Auth) Process ¶

func (a *Auth) Process(w http.ResponseWriter, r *http.Request, route string) (string, error)

Process is the main Entrypoint

func (*Auth) RouterHandler ¶

func (a *Auth) RouterHandler(h httprouter.Handle) httprouter.Handle

func (*Auth) SetAuthErrorHandler ¶

func (a *Auth) SetAuthErrorHandler(handler http.Handler)

func (*Auth) SetReqHeaderIdentifier ¶

func (a *Auth) SetReqHeaderIdentifier(ident string)

func (*Auth) SetReqHeaders ¶

func (a *Auth) SetReqHeaders(set bool)

func (*Auth) ValidateRequest ¶

func (a *Auth) ValidateRequest(r *http.Request) error

ValidateRequest perfomrs verification on the TLS certs and chain

type AuthHandler ¶

type AuthHandler interface {
	ValidateOU(ous []string, route string) (matched string, allowed bool)
	ValidateCN(cn, route string) (allowed bool)
}

Source Files ¶

View all Source files

certauth.go

Directories ¶

Path	Synopsis
certutils
examples
httprouter
net_http

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL