authorization

Documentation

Overview

Package authorization is a generated GoMock package.

Index

• Variables
• func GetAuthProviderClient(privateKey string) (clientworker.AuthorizationProvider, error)
• type Attributes
• type Authorizer
  • func NewAuthorizer(authorization config.Authorization, logger log.Logger, ...) (Authorizer, error)
  • func NewNopAuthorizer() (Authorizer, error)
  • func NewOAuthAuthorizer(authorizationCfg config.OAuthAuthorizer, log log.Logger, ...) (Authorizer, error)
• type Decision
• type FilteredRequestBody
• type JWTClaims
  • func (j JWTClaims) GetGroups() []string
• type MockAuthorizer
  • func NewMockAuthorizer(ctrl *gomock.Controller) *MockAuthorizer
  • func (m *MockAuthorizer) Authorize(ctx context.Context, attributes *Attributes) (Result, error)
  • func (m *MockAuthorizer) EXPECT() *MockAuthorizerMockRecorder
• type MockAuthorizerMockRecorder
  • func (mr *MockAuthorizerMockRecorder) Authorize(ctx, attributes interface{}) *gomock.Call
• type MockFilteredRequestBody
  • func NewMockFilteredRequestBody(ctrl *gomock.Controller) *MockFilteredRequestBody
  • func (m *MockFilteredRequestBody) EXPECT() *MockFilteredRequestBodyMockRecorder
  • func (m *MockFilteredRequestBody) SerializeForLogging() (string, error)
• type MockFilteredRequestBodyMockRecorder
  • func (mr *MockFilteredRequestBodyMockRecorder) SerializeForLogging() *gomock.Call
• type Permission
  • func NewPermission(permission string) Permission
• type Result
• type XDGSCRAMClient
  • func (x *XDGSCRAMClient) Begin(userName, password, authzID string) (err error)
  • func (x *XDGSCRAMClient) Done() bool
  • func (x *XDGSCRAMClient) Step(challenge string) (response string, err error)

Variables

var SHA256 scram.HashGeneratorFcn = func() hash.Hash { return sha256.New() }

SHA256 algorithm

var SHA512 scram.HashGeneratorFcn = func() hash.Hash { return sha512.New() }

SHA512 algorithm

Functions

func GetAuthProviderClient

func GetAuthProviderClient(privateKey string) (clientworker.AuthorizationProvider, error)

Types

type Attributes

type Attributes struct {
	Actor        string
	APIName      string
	DomainName   string
	WorkflowType *types.WorkflowType
	TaskList     *types.TaskList
	Permission   Permission
	RequestBody  FilteredRequestBody // request object except for data inputs (PII)
}

Attributes is input for authority to make decision. It can be extended in future if required auth on resources like WorkflowType and TaskList

type Authorizer

type Authorizer interface {
	Authorize(ctx context.Context, attributes *Attributes) (Result, error)
}

Authorizer is an interface for authorization

func NewAuthorizer

func NewAuthorizer(authorization config.Authorization, logger log.Logger, domainCache cache.DomainCache) (Authorizer, error)

func NewNopAuthorizer

func NewNopAuthorizer() (Authorizer, error)

NewNopAuthorizer creates a no-op authority

func NewOAuthAuthorizer

func NewOAuthAuthorizer(
	authorizationCfg config.OAuthAuthorizer,
	log log.Logger,
	domainCache cache.DomainCache,
) (Authorizer, error)

NewOAuthAuthorizer creates a oauth authority

type Decision

type Decision int

Decision is enum type for auth decision

const (
	// DecisionDeny means auth decision is deny
	DecisionDeny Decision = iota + 1
	// DecisionAllow means auth decision is allow
	DecisionAllow
)

type FilteredRequestBody

type FilteredRequestBody interface {
	SerializeForLogging() (string, error)
}

FilteredRequestBody request object except for data inputs (PII)

type JWTClaims

type JWTClaims struct {
	jwt.RegisteredClaims

	Name   string
	Groups string // separated by space
	Admin  bool
	TTL    int64 // TODO should be removed. ExpiresAt should be used
}

JWTClaims is a Cadence specific claim with embeded Claims defined https://datatracker.ietf.org/doc/html/rfc7519#section-4.1

func (JWTClaims) GetGroups

func (j JWTClaims) GetGroups() []string

type MockAuthorizer

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

MockAuthorizer is a mock of Authorizer interface.

func NewMockAuthorizer

func NewMockAuthorizer(ctrl *gomock.Controller) *MockAuthorizer

NewMockAuthorizer creates a new mock instance.

func (*MockAuthorizer) Authorize

func (m *MockAuthorizer) Authorize(ctx context.Context, attributes *Attributes) (Result, error)

Authorize mocks base method.

func (*MockAuthorizer) EXPECT

func (m *MockAuthorizer) EXPECT() *MockAuthorizerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

type MockAuthorizerMockRecorder

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

MockAuthorizerMockRecorder is the mock recorder for MockAuthorizer.

func (*MockAuthorizerMockRecorder) Authorize

func (mr *MockAuthorizerMockRecorder) Authorize(ctx, attributes interface{}) *gomock.Call

Authorize indicates an expected call of Authorize.

type MockFilteredRequestBody

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

MockFilteredRequestBody is a mock of FilteredRequestBody interface.

func NewMockFilteredRequestBody

func NewMockFilteredRequestBody(ctrl *gomock.Controller) *MockFilteredRequestBody

NewMockFilteredRequestBody creates a new mock instance.

func (*MockFilteredRequestBody) EXPECT

func (m *MockFilteredRequestBody) EXPECT() *MockFilteredRequestBodyMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockFilteredRequestBody) SerializeForLogging

func (m *MockFilteredRequestBody) SerializeForLogging() (string, error)

SerializeForLogging mocks base method.

type MockFilteredRequestBodyMockRecorder

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

MockFilteredRequestBodyMockRecorder is the mock recorder for MockFilteredRequestBody.

func (*MockFilteredRequestBodyMockRecorder) SerializeForLogging

func (mr *MockFilteredRequestBodyMockRecorder) SerializeForLogging() *gomock.Call

SerializeForLogging indicates an expected call of SerializeForLogging.

type Permission

type Permission int

Permission is enum type for auth permission

const (
	// PermissionRead means the user can write on the domain level APIs
	PermissionRead Permission = iota + 1
	// PermissionWrite means the user can write on the domain level APIs
	PermissionWrite
	// PermissionAdmin means the user can read+write on the domain level APIs
	PermissionAdmin
)

func NewPermission

func NewPermission(permission string) Permission

type Result

type Result struct {
	Decision Decision
}

Result is result from authority.

type XDGSCRAMClient

type XDGSCRAMClient struct {
	*scram.Client
	*scram.ClientConversation
	scram.HashGeneratorFcn
}

XDGSCRAMClient is the scram client

func (*XDGSCRAMClient) Begin

func (x *XDGSCRAMClient) Begin(userName, password, authzID string) (err error)

Begin creates new client

func (*XDGSCRAMClient) Done

func (x *XDGSCRAMClient) Done() bool

Done stops the client

func (*XDGSCRAMClient) Step

func (x *XDGSCRAMClient) Step(challenge string) (response string, err error)

Step takes a string provided from a server (or just an empty string for the very first conversation step) and attempts to move the authentication conversation forward. It returns a string to be sent to the server or an error if the server message is invalid. Calling Step after a conversation completes is also an error.