ape

Documentation

Index

• type Checker
  • func NewChecker(chainRouter policyengine.ChainRouter, headerProvider HeaderProvider) Checker
• type HeaderProvider
  • func NewStorageEngineHeaderProvider(e *engine.StorageEngine) HeaderProvider
• type Prm
• type Service
  • func NewService(log *logger.Logger, apeChecker Checker, next objectSvc.ServiceServer) *Service
  • func (c *Service) Delete(ctx context.Context, request *objectV2.DeleteRequest) (*objectV2.DeleteResponse, error)
  • func (c *Service) Get(request *objectV2.GetRequest, stream objectSvc.GetObjectStream) error
  • func (c *Service) GetRange(request *objectV2.GetRangeRequest, stream objectSvc.GetObjectRangeStream) error
  • func (c *Service) GetRangeHash(ctx context.Context, request *objectV2.GetRangeHashRequest) (*objectV2.GetRangeHashResponse, error)
  • func (c *Service) Head(ctx context.Context, request *objectV2.HeadRequest) (*objectV2.HeadResponse, error)
  • func (c *Service) Put() (objectSvc.PutObjectStream, error)
  • func (c *Service) PutSingle(ctx context.Context, request *objectV2.PutSingleRequest) (*objectV2.PutSingleResponse, error)
  • func (c *Service) Search(request *objectV2.SearchRequest, stream objectSvc.SearchStream) error

Types

type Checker

type Checker interface {
	CheckAPE(context.Context, Prm) error
}

Checker provides methods to check requests and responses with access policy engine.

func NewChecker

func NewChecker(chainRouter policyengine.ChainRouter, headerProvider HeaderProvider) Checker

type HeaderProvider

type HeaderProvider interface {
	GetHeader(ctx context.Context, cnr cid.ID, oid oid.ID) (*objectSDK.Object, error)
}

func NewStorageEngineHeaderProvider

func NewStorageEngineHeaderProvider(e *engine.StorageEngine) HeaderProvider

type Prm

type Prm struct {
	Namespace string

	Container cid.ID

	// Object ID is omitted for some methods.
	Object *oid.ID

	// If Header is set, then object attributes and properties will be parsed from
	// a request/response's header.
	Header *objectV2.Header

	// Method must be represented only as a constant represented in native schema.
	Method string

	// Role must be representedonly as a constant represented in native schema.
	Role string

	// An encoded sender's public key string.
	SenderKey string

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

	// If SoftAPECheck is set to true, then NoRuleFound is interpreted as allow.
	SoftAPECheck bool

	// If true, object headers will not retrieved from storage engine.
	WithoutHeaderRequest bool
}

type Service

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

func NewService

func NewService(log *logger.Logger, apeChecker Checker, next objectSvc.ServiceServer) *Service

func (*Service) Delete

func (c *Service) Delete(ctx context.Context, request *objectV2.DeleteRequest) (*objectV2.DeleteResponse, error)

func (*Service) Get

func (c *Service) Get(request *objectV2.GetRequest, stream objectSvc.GetObjectStream) error

func (*Service) GetRange

func (c *Service) GetRange(request *objectV2.GetRangeRequest, stream objectSvc.GetObjectRangeStream) error

func (*Service) GetRangeHash

func (c *Service) GetRangeHash(ctx context.Context, request *objectV2.GetRangeHashRequest) (*objectV2.GetRangeHashResponse, error)

func (*Service) Head

func (c *Service) Head(ctx context.Context, request *objectV2.HeadRequest) (*objectV2.HeadResponse, error)

func (*Service) Put

func (c *Service) Put() (objectSvc.PutObjectStream, error)

func (*Service) PutSingle

func (c *Service) PutSingle(ctx context.Context, request *objectV2.PutSingleRequest) (*objectV2.PutSingleResponse, error)

func (*Service) Search

func (c *Service) Search(request *objectV2.SearchRequest, stream objectSvc.SearchStream) error