auth

Documentation

Index

• func Authorize(ctx context.Context, requirements ...Requirement) error
• type CtxKey
• type GQLShieldClientRole
• type IsOwner
• type IsUser
• type RequestSession
• type Requirement

Functions

func Authorize

func Authorize(
	ctx context.Context,
	requirements ...Requirement,
) error

Authorize authorizes the client session taken from the provided context against the provided requirements

Types

type CtxKey

type CtxKey int

CtxKey represents a context.Context value key type

const CtxSession CtxKey = 1

CtxSession defines the context.Context session value key

type GQLShieldClientRole

type GQLShieldClientRole int

GQLShieldClientRole represents a GraphQL shield client role identifier

const (

	// GQLShieldClientGuest represents a guest API user
	GQLShieldClientGuest GQLShieldClientRole

	// GQLShieldClientDebug represents the debug API user
	GQLShieldClientDebug

	// GQLShieldClientRegular represents the regular API user
	GQLShieldClientRegular
)

type IsOwner

type IsOwner struct {
	Owner store.ID
}

IsOwner indicates that the client is required to be the owner of a resource

type IsUser

type IsUser struct{}

IsUser indicates that the client is required to be an authenticated user

type RequestSession

type RequestSession struct {
	IsDebug          bool
	UserID           store.ID
	Creation         time.Time
	ShieldClientRole GQLShieldClientRole
}

RequestSession represents a client session

type Requirement

type Requirement interface {
	// contains filtered or unexported methods
}

Requirement defines the authorization requirement implementation interface