auth

Documentation

Overview

Package auth is for authorization logic

Index

• Constants
• func CtxWithAccessToken(ctx context.Context, at AccessToken) context.Context
• type AccessControlList
• type AccessToken
  • func AccessTokenFromRequest(r *http.Request) (AccessToken, error)
  • func NewAccessToken(token, tokenType string) AccessToken
  • func (at AccessToken) NewGoogleOauth2Token() *oauth2.Token
• type AccessTokenConverter
• type Authorizer
• type DefaultAuthorizer
  • func (a DefaultAuthorizer) Authorize(ctx context.Context, sub user.User, obj string, act string) error

Constants

const BearerTokenType string = "Bearer"

BearerTokenType is used in authorization to access a resource

Functions

func CtxWithAccessToken

func CtxWithAccessToken(ctx context.Context, at AccessToken) context.Context

CtxWithAccessToken sets the Access Token to the given context

Types

type AccessControlList

type AccessControlList struct {
	Subject string
	Object  string
	Action  string
}

AccessControlList (ACL) describes permissions for a given object

type AccessToken

type AccessToken struct {
	Token     string
	TokenType string
}

AccessToken represents an access token found in an HTTP header, typically a Bearer token for Oauth2

func AccessTokenFromRequest

func AccessTokenFromRequest(r *http.Request) (AccessToken, error)

AccessTokenFromRequest gets the access token from the request

func NewAccessToken

func NewAccessToken(token, tokenType string) AccessToken

NewAccessToken is an initializer for AccessToken

func (AccessToken) NewGoogleOauth2Token

func (at AccessToken) NewGoogleOauth2Token() *oauth2.Token

NewGoogleOauth2Token returns a Google Oauth2 token given an AccessToken

type AccessTokenConverter

type AccessTokenConverter interface {
	Convert(ctx context.Context, token AccessToken) (user.User, error)
}

AccessTokenConverter interface is used to convert an access token to a User

type Authorizer

type Authorizer interface {
	Authorize(ctx context.Context, sub user.User, obj string, act string) error
}

Authorizer interface authorizes access to a resource given a user and action

type DefaultAuthorizer

type DefaultAuthorizer struct{}

DefaultAuthorizer struct satisfies the Authorizer interface. The DefaultAuthorizer.Authorize method ensures a subject (user) can perform a particular action on an object. e.g. gilcrest can read (GET) the resource at the /ping path. This is obviously completely bogus right now, eventually need to look into something like Casbin for ACL/RBAC

func (DefaultAuthorizer) Authorize

func (a DefaultAuthorizer) Authorize(ctx context.Context, sub user.User, obj string, act string) error

Authorize authorizes a subject (user) can perform a particular action on an object. e.g. gilcrest can read (GET) the resource at the /ping path. This is obviously completely bogus right now, eventually need to look into something like Casbin for ACL/RBAC