authorization

Documentation

Index

• type AuthorizeManyOptions
• type Client
  • func NewClient(d Dependencies, opts ClientOptions) (Client, error)
  • func NewNoopClient() Client
• type ClientOption
  • func WithAuthorizationURL(x *url.URL) ClientOption
  • func WithAuthorizeManyPath(x string) ClientOption
  • func WithEntitiesPath(x string) ClientOption
  • func WithLoaded(x Loaded) ClientOption
  • func WithTimeout(x time.Duration) ClientOption
  • func WithUserIDHeaderKey(x string) ClientOption
• type ClientOptions
  • func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions
• type DefaultTool
  • func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool
  • func (d *DefaultTool) AuthorizeMany(ctx context.Context, opts AuthorizeManyOptions) ([]contract.Identifiable, error)
  • func (d *DefaultTool) DeleteOne(ctx context.Context, opts DeleteOneOptions) error
  • func (d *DefaultTool) FindOne(ctx context.Context, opts FindOneOptions) ([]*entity.Entity, error)
  • func (d *DefaultTool) InsertOne(ctx context.Context, opts InsertOneOptions) error
  • func (d *DefaultTool) ReplaceOne(ctx context.Context, opts ReplaceOneOptions) error
• type DeleteOneOptions
• type Dependencies
• type FindOneOptions
• type InsertOneOptions
• type Loaded
• type ReplaceOneOptions
• type Tool

Types

type AuthorizeManyOptions

type AuthorizeManyOptions struct {
	R    *http.Request
	I    []contract.Identifiable
	Role contract.Role
}

type Client

type Client interface {
	FindOne(ctx context.Context, opts FindOneOptions) ([]*entity.Entity, error)
	InsertOne(ctx context.Context, opts InsertOneOptions) error
	ReplaceOne(ctx context.Context, opts ReplaceOneOptions) error
	DeleteOne(ctx context.Context, opts DeleteOneOptions) error
	AuthorizeMany(ctx context.Context, opts AuthorizeManyOptions) ([]contract.Identifiable, error)
}

func NewClient

func NewClient(d Dependencies, opts ClientOptions) (Client, error)

func NewNoopClient

func NewNoopClient() Client

type ClientOption

type ClientOption = contract.Opt[ClientOptions]

func WithAuthorizationURL

func WithAuthorizationURL(x *url.URL) ClientOption

func WithAuthorizeManyPath

func WithAuthorizeManyPath(x string) ClientOption

func WithEntitiesPath

func WithEntitiesPath(x string) ClientOption

func WithLoaded

func WithLoaded(x Loaded) ClientOption

func WithTimeout

func WithTimeout(x time.Duration) ClientOption

func WithUserIDHeaderKey

func WithUserIDHeaderKey(x string) ClientOption

type ClientOptions

type ClientOptions struct {
	Loaded
	Timeout time.Duration
}

func ApplyClientOptions

func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions

type DefaultTool

type DefaultTool struct {
	T *contract.Tool[Client]
}

func NewTool

func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool

func (*DefaultTool) AuthorizeMany

func (d *DefaultTool) AuthorizeMany(ctx context.Context, opts AuthorizeManyOptions) ([]contract.Identifiable, error)

AuthorizeMany filters out unauthorized entities based on role and principal ID.

func (*DefaultTool) DeleteOne

func (d *DefaultTool) DeleteOne(ctx context.Context, opts DeleteOneOptions) error

DeleteOne deletes an authorized entity.

func (*DefaultTool) FindOne

func (d *DefaultTool) FindOne(ctx context.Context, opts FindOneOptions) ([]*entity.Entity, error)

FindOne finds one entity by ID.

func (*DefaultTool) InsertOne

func (d *DefaultTool) InsertOne(ctx context.Context, opts InsertOneOptions) error

InsertOne inserts one entity into the authorization system.

func (*DefaultTool) ReplaceOne

func (d *DefaultTool) ReplaceOne(ctx context.Context, opts ReplaceOneOptions) error

ReplaceOne replaces an existing authorized entity.

type DeleteOneOptions

type DeleteOneOptions struct {
	ID fmt.Stringer
	R  *http.Request
}

type Dependencies

type Dependencies struct {
	HD contract.HTTPDoer
	HR contract.HTTPRequester
	HU contract.HTTPUtil
	U  contract.Unmarshaler
	M  contract.Marshaler
	E  contract.EnvironmentOperator
}

type FindOneOptions

type FindOneOptions struct {
	ID fmt.Stringer
	R  *http.Request
}

type InsertOneOptions

type InsertOneOptions struct {
	E *entity.Core
	R *http.Request
}

type Loaded

type Loaded struct {
	AuthorizationURL  *url.URL
	EntitiesPath      string
	AuthorizeManyPath string
	UserIDHeaderKey   string
}

type ReplaceOneOptions

type ReplaceOneOptions struct {
	E  *entity.Core
	ID fmt.Stringer
	R  *http.Request
}

type Tool

type Tool interface {
	Client
}