ape

Documentation

Index

• type ChainRouterError
  • func (e *ChainRouterError) Error() string
  • func (e *ChainRouterError) Operation() string
  • func (e *ChainRouterError) Status() apechain.Status
• type CheckCore
  • func New(localOverrideStorage policyengine.LocalOverrideStorage, ...) CheckCore
• type CheckPrm

Types

type ChainRouterError

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

ChainRouterError is returned when chain router validation prevents the APE request from being processed (no rule found, access denied, etc.).

func (*ChainRouterError) Error

func (e *ChainRouterError) Error() string

func (*ChainRouterError) Operation

func (e *ChainRouterError) Operation() string

func (*ChainRouterError) Status

func (e *ChainRouterError) Status() apechain.Status

type CheckCore

type CheckCore interface {
	// CheckAPE performs the common policy-engine check logic on a prepared request.
	CheckAPE(prm CheckPrm) error
}

CheckCore provides methods to perform the common logic of APE check.

func New

func New(localOverrideStorage policyengine.LocalOverrideStorage, morphChainStorage policyengine.MorphRuleChainStorageReader,
	frostFSSubjectProvider frostfsidcore.SubjectProvider, state netmap.State,
) CheckCore

type CheckPrm

type CheckPrm struct {
	// Request is an APE-request that is checked by policy engine.
	Request aperequest.Request

	Namespace string

	Container cid.ID

	// An encoded container's owner user ID.
	ContainerOwner user.ID

	// PublicKey is public key of the request sender.
	PublicKey *keys.PublicKey

	// The request's bearer token. It is used in order to check APE overrides with the token.
	BearerToken *bearer.Token
}