tokens

Documentation

Overview

Package tokens manages token authentication

Index

• Constants
• Variables
• func TokenFlashMessage(renderer html.Renderer, w http.ResponseWriter, token []byte) error
• type GetOrCreateUser
• type GoogleIAPConfig
• type NewTokenOption
  • func WithExpiry(exp time.Time) NewTokenOption
• type Options
• type Service
  • func NewService(opts Options) (*Service, error)
  • func (r Service) GetSubject(ctx context.Context, jwtSubject resource.ID) (authz.Subject, error)
  • func (a *Service) Middleware() mux.MiddlewareFunc
  • func (f Service) NewToken(subjectID resource.ID, opts ...NewTokenOption) ([]byte, error)
  • func (r Service) RegisterKind(k resource.Kind, fn SubjectGetter)
  • func (r Service) RegisterSiteToken(token string, siteAdmin authz.Subject)
  • func (a *Service) StartSession(w http.ResponseWriter, r *http.Request, userID resource.ID) error
• type SubjectGetter

Constants

const (
	// session cookie stores the session token
	SessionCookie = "session"
)

Variables

var AuthenticatedPrefixes = []string{
	tfeapi.APIPrefixV2,
	tfeapi.ModuleV1Prefix,
	otfapi.DefaultBasePath,
	paths.UIPrefix,
}

AuthenticatedPrefixes are those URL path prefixes requiring authentication.

Functions

func TokenFlashMessage

func TokenFlashMessage(renderer html.Renderer, w http.ResponseWriter, token []byte) error

TokenFlashMessage is a helper for rendering a flash message with an authentication token.

Types

type GetOrCreateUser

type GetOrCreateUser func(ctx context.Context, username string) (authz.Subject, error)

GetOrCreateUser retrieves the user with the given username. If the user does not exist it is created.

type GoogleIAPConfig

type GoogleIAPConfig struct {
	Audience string
}

type NewTokenOption

type NewTokenOption func(*jwt.Builder) *jwt.Builder

func WithExpiry

func WithExpiry(exp time.Time) NewTokenOption

type Options

type Options struct {
	logr.Logger
	GoogleIAPConfig

	Secret []byte
}

type Service

type Service struct {
	logr.Logger
	// contains filtered or unexported fields
}

func NewService

func NewService(opts Options) (*Service, error)

func (Service) GetSubject

func (r Service) GetSubject(ctx context.Context, jwtSubject resource.ID) (authz.Subject, error)

func (*Service) Middleware

func (a *Service) Middleware() mux.MiddlewareFunc

Middleware returns middleware for authenticating tokens

func (Service) NewToken

func (f Service) NewToken(subjectID resource.ID, opts ...NewTokenOption) ([]byte, error)

func (Service) RegisterKind

func (r Service) RegisterKind(k resource.Kind, fn SubjectGetter)

RegisterKind registers a kind of authentication token, providing a func that can retrieve the OTF subject indicated in the token.

func (Service) RegisterSiteToken

func (r Service) RegisterSiteToken(token string, siteAdmin authz.Subject)

RegisterSiteToken registers a site token which the middleware, and the subject to return as the site admin upon successful authentication.

func (*Service) StartSession

func (a *Service) StartSession(w http.ResponseWriter, r *http.Request, userID resource.ID) error

type SubjectGetter

type SubjectGetter func(ctx context.Context, jwtSubject resource.ID) (authz.Subject, error)

SubjectGetter retrieves an OTF subject given the jwtSubject string, which is the value of the 'subject' field parsed from a JWT.