authz

package
v0.0.0-...-bc4752d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 26, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package authz is a generated GoMock package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthorizationConfiguration

type AuthorizationConfiguration interface {
	// AddPolicy registers a named policy.
	AddPolicy(name string, configure func(PolicyConfiguration)) AuthorizationConfiguration

	// WithDefaultPolicy sets the default policy.
	// This policy is used when no policy names are specified for the Authorize() method.
	WithDefaultPolicy(configure func(PolicyConfiguration)) AuthorizationConfiguration
}

AuthorizationConfiguration configures the authorizer.

type AuthorizationContext

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

AuthorizationContext used as arguments to policies and requirements

func (*AuthorizationContext) GinCtx

func (ctx *AuthorizationContext) GinCtx() *gin.Context

GinCtx returnes the Gin context for the request

func (*AuthorizationContext) User

User returns the user for the request

type Authorizer

type Authorizer interface {
	// Authorize returns a Gin middleware that validates the incoming request with the specified policies.
	// The middlesware aborts the Gin context if any of the policies fails validation.
	Authorize(policies ...string) gin.HandlerFunc
}

Authorizer is used to create authorization middlewares using the Authorize() method.

func NewAuthorizer

func NewAuthorizer(configure func(AuthorizationConfiguration)) Authorizer

NewAuthorizer creates a new Authorizer

type MockPolicy

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

MockPolicy is a mock of Policy interface.

func NewMockPolicy

func NewMockPolicy(ctrl *gomock.Controller) *MockPolicy

NewMockPolicy creates a new mock instance.

func (*MockPolicy) EXPECT

func (m *MockPolicy) EXPECT() *MockPolicyMockRecorder

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

func (*MockPolicy) ValidatePolicy

func (m *MockPolicy) ValidatePolicy(ctx *AuthorizationContext) error

ValidatePolicy mocks base method.

type MockPolicyConfiguration

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

MockPolicyConfiguration is a mock of PolicyConfiguration interface.

func NewMockPolicyConfiguration

func NewMockPolicyConfiguration(ctrl *gomock.Controller) *MockPolicyConfiguration

NewMockPolicyConfiguration creates a new mock instance.

func (*MockPolicyConfiguration) AddRequirement

AddRequirement mocks base method.

func (*MockPolicyConfiguration) EXPECT

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

func (*MockPolicyConfiguration) RequireAuthenticatedUser

func (m *MockPolicyConfiguration) RequireAuthenticatedUser() PolicyConfiguration

RequireAuthenticatedUser mocks base method.

type MockPolicyConfigurationMockRecorder

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

MockPolicyConfigurationMockRecorder is the mock recorder for MockPolicyConfiguration.

func (*MockPolicyConfigurationMockRecorder) AddRequirement

func (mr *MockPolicyConfigurationMockRecorder) AddRequirement(arg0 interface{}) *gomock.Call

AddRequirement indicates an expected call of AddRequirement.

func (*MockPolicyConfigurationMockRecorder) RequireAuthenticatedUser

func (mr *MockPolicyConfigurationMockRecorder) RequireAuthenticatedUser() *gomock.Call

RequireAuthenticatedUser indicates an expected call of RequireAuthenticatedUser.

type MockPolicyMockRecorder

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

MockPolicyMockRecorder is the mock recorder for MockPolicy.

func (*MockPolicyMockRecorder) ValidatePolicy

func (mr *MockPolicyMockRecorder) ValidatePolicy(ctx interface{}) *gomock.Call

ValidatePolicy indicates an expected call of ValidatePolicy.

type Policy

type Policy interface {
	// ValidatePolicy validates the requirements defined for the policy.
	// Returns an error if one or more requirements fails.
	ValidatePolicy(ctx *AuthorizationContext) error
}

Policy defines a set of requirements that must be fulfilled in order to process the request.

type PolicyConfiguration

type PolicyConfiguration interface {
	// RequireAuthenticatedUser adds a requirement to require an authenticated user in the request.
	RequireAuthenticatedUser() PolicyConfiguration

	// AddRequirement adds a requirement to the policy
	AddRequirement(Requirement) PolicyConfiguration
}

PolicyConfiguration configures a policy.

type Requirement

type Requirement interface {
	// ValidateRequirement validates the requirement.
	// Returns an error if the requirement fails.
	ValidateRequirement(ctx *AuthorizationContext) error
}

Requirement defines a requirement for use with policies.

type RequirementFunc

type RequirementFunc func(ctx *AuthorizationContext) error

RequirementFunc wraps a function as a Requirement.

func (RequirementFunc) ValidateRequirement

func (f RequirementFunc) ValidateRequirement(ctx *AuthorizationContext) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL