authz

Documentation

Index

• type BatchAuthorizeInput
• type BatchAuthorizeResponse
  • func (r BatchAuthorizeResponse) GetDecision(key string) (*authzv1alpha1.Evaluation, error)
• type Client
  • func NewClient(opts Opts) Client
  • func NewFromConfig(cfg *config.Context) Client
  • func (c *Client) BatchAuthorize(ctx context.Context, input BatchAuthorizeInput) (BatchAuthorizeResponse, error)
  • func (c *Client) RawClient() authzv1alpha1connect.AuthzServiceClient
• type DecisionNotFoundError
  • func (e DecisionNotFoundError) Error() string
• type Opts
• type Request
  • func (r Request) ToAPI(key string) (*authzv1alpha1.Request, error)

Types

type BatchAuthorizeInput

type BatchAuthorizeInput struct {
	Requests map[string]Request
}

type BatchAuthorizeResponse

type BatchAuthorizeResponse struct {
	// Decisions in the response.
	// Usually you'll want GetDecision() to look up a specific decision
	// which checks it exists.
	Decisions map[string]*authzv1alpha1.Evaluation
}

func (BatchAuthorizeResponse) GetDecision

func (r BatchAuthorizeResponse) GetDecision(key string) (*authzv1alpha1.Evaluation, error)

GetDecision looks up a decision by the client key. The client key is the key to the map that you provided in BatchAuthorizeInput.

type Client

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

func NewClient

func NewClient(opts Opts) Client

func NewFromConfig

func NewFromConfig(cfg *config.Context) Client

func (*Client) BatchAuthorize

func (c *Client) BatchAuthorize(ctx context.Context, input BatchAuthorizeInput) (BatchAuthorizeResponse, error)

func (*Client) RawClient

func (c *Client) RawClient() authzv1alpha1connect.AuthzServiceClient

RawClient returns the underlying Buf Connect client.

type DecisionNotFoundError

type DecisionNotFoundError struct {
	Key string
}

func (DecisionNotFoundError) Error

func (e DecisionNotFoundError) Error() string

type Opts

type Opts struct {
	HTTPClient    connect.HTTPClient
	BaseURL       string
	ClientOptions []connect.ClientOption
	// AttrCacheExpiration defaults to 24h if not provided
	AttrCacheExpiration time.Duration
	// AttrCleanupInterval defaults to 48h if not provided
	AttrCleanupInterval time.Duration
}

type Request

type Request struct {
	Principal       eid.EID                `json:"principal"`
	Action          eid.EID                `json:"action"`
	Resource        eid.EID                `json:"resource"`
	OverlayEntities []entity.Entity        `json:"overlay_entities,omitempty"`
	OverlayChildren []entity.ChildRelation `json:"overlay_children,omitempty"`
}

func (Request) ToAPI

func (r Request) ToAPI(key string) (*authzv1alpha1.Request, error)