authsvc

README

authsvc

Authentication Service

Developing

This project is written in Go, and follows standard Go development practices.

Vendoring of dependencies is done with the dep tool.

There is a git pre-push hook for running some basic sanity tests before pushing. Please run .bin/install-pre-push-hook to install the hook.

Typical deployment of this service will be done with docker. The Dockerfile and related files are in docker/api/.

Documentation

Overview

Package authsvc provides an OAuth2 server wrapping LDAP backend

Index

• Constants
• Variables
• func Decode(hash string) ([]byte, error)
• func Generate(keysize int) string
• func RegisterAPI(root string, verbose bool) http.Handler
• func RegisterOAuth(root string) http.Handler
• type AuthenticationMiddleware
  • func NewAuthenticationMiddleware(realm string, root string, seeder Seeder) (*AuthenticationMiddleware, error)
  • func (m *AuthenticationMiddleware) LoginHandler() http.Handler
  • func (m *AuthenticationMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request, n http.HandlerFunc)
• type DebugMiddleware
  • func NewDebugMiddleware(w io.Writer, verbose bool) *DebugMiddleware
  • func (l *DebugMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)
• type Seeder
  • func NewSeeder(hash string, block string) (Seeder, error)

Constants

const (
	// HashKeySize is optimally 64 bytes
	HashKeySize = 64
	// BlockKeySize is optimally 32 bytes
	BlockKeySize = 32
)

Variables

var (
	ErrInvalidRequest    = errors.New("invalid_request")
	ErrInvalidToken      = errors.New("invalid_token")
	ErrInsufficientScope = errors.New("insufficient_scope")
	ErrNoAuthToken       = errors.New("no_auth")
)

Exported Errors

Functions

func Decode

func Decode(hash string) ([]byte, error)

Decode extracts a byte slice from a base64 encoded string.

func Generate

func Generate(keysize int) string

Generate creates a random key of keysize length, and returns it in base64 encoded text.

func RegisterAPI

func RegisterAPI(root string, verbose bool) http.Handler

RegisterAPI returns a router for the api.

func RegisterOAuth

func RegisterOAuth(root string) http.Handler

RegisterOAuth returns a router that handles OAuth routes.

Types

type AuthenticationMiddleware

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

AuthenticationMiddleware enforces authentication on protected routes.

func NewAuthenticationMiddleware

func NewAuthenticationMiddleware(realm string, root string, seeder Seeder) (*AuthenticationMiddleware, error)

NewAuthenticationMiddleware returns a middlware suitable for authentication.

func (*AuthenticationMiddleware) LoginHandler

func (m *AuthenticationMiddleware) LoginHandler() http.Handler

LoginHandler returns a router that handles the login and logout routes.

func (*AuthenticationMiddleware) ServeHTTP

func (m *AuthenticationMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request, n http.HandlerFunc)

type DebugMiddleware

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

DebugMiddleware provides request/response logging.

func NewDebugMiddleware

func NewDebugMiddleware(w io.Writer, verbose bool) *DebugMiddleware

NewDebugMiddleware provides middleware suitable for exhaustive request/response logging.

func (*DebugMiddleware) ServeHTTP

func (l *DebugMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)

type Seeder

type Seeder interface {
	HashKey() []byte
	BlockKey() []byte
}

Seeder describes functions needed for encrypted cookies.

func NewSeeder

func NewSeeder(hash string, block string) (Seeder, error)

NewSeeder creates a default Seeder from base64 encoded seed values.