middleware

type AuthHeader struct {
	AccessKeyID string
	Region      string
	SignatureV4 string
}

type Box struct {
	AccessBox   *accessbox.Box
	ClientTime  time.Time
	AuthHeaders *AuthHeader
	Attributes  []object.Attribute
}

type BucketResolveFunc func(ctx context.Context, bucket string) (*data.BucketInfo, error)

type Center interface {
	// Authenticate validate and authenticate request.
	// Must return ErrNoAuthorizationHeader if auth header is missed.
	// Authenticate uses a separate context so that the authorization
	// span middleware does not contain all subsequent spans.
	Authenticate(ctx context.Context, request *http.Request) (*Box, error)
}

type ErrorResponse struct {
	XMLName    xml.Name `xml:"Error" json:"-"`
	Code       string
	Message    string
	Key        string `xml:"Key,omitempty" json:"Key,omitempty"`
	BucketName string `xml:"BucketName,omitempty" json:"BucketName,omitempty"`
	Resource   string
	RequestID  string `xml:"RequestId" json:"RequestId"`
	HostID     string `xml:"HostId" json:"HostId"`

	// The region where the bucket is located. This header is returned
	// only in HEAD bucket and ListObjects response.
	Region string `xml:"Region,omitempty" json:"Region,omitempty"`

	// Captures the server string returned in response header.
	Server string `xml:"-" json:"-"`

	// Underlying HTTP status code for the returned error.
	StatusCode int `xml:"-" json:"-"`
}

type FrostFSIDInformer interface {
	GetNamespace(ns string) (*client.Namespace, error)
	GetUserGroupIDsAndClaims(userHash util.Uint160) ([]string, map[string]string, error)
}

type FrostFSIDValidator interface {
	GetUserNamespace(key *keys.PublicKey) (string, error)
}

type Func func(h http.Handler) http.Handler

type KeyVal struct {
	Key string
	Val string
}

type LogHTTPConfig struct {
	Enabled    bool
	MaxBody    int64
	MaxLogSize int
	OutputPath string
	UseGzip    bool
}

type LogHTTPSettings interface {
	LogHTTPConfig() LogHTTPConfig
}

type MetricsSettings interface {
	ResolveNamespaceAlias(namespace string) string
}

type ObjectRequest struct {
	Bucket string
	Object string
	Method string
}

type PolicyConfig struct {
	Storage   engine.ChainRouter
	FrostfsID FrostFSIDInformer
	Settings  PolicySettings
	Log       *zap.Logger
	Decoder   XMLDecoder
	Tagging   ResourceTagging
}

type PolicySettings interface {
	PolicyDenyByDefault() bool
	MirroringEnabled() bool
}

type PublicAccessBlockChecker interface {
	CheckRestrictPublicBuckets(context.Context) error
}

type ReqInfo struct {
	sync.RWMutex
	RemoteHost        string   // Client Host/IP
	Host              string   // Node Host/IP
	UserAgent         string   // User Agent
	DeploymentID      string   // random generated s3-deployment-id
	RequestID         string   // x-amz-request-id
	API               string   // API name -- GetObject PutObject NewMultipartUpload etc.
	BucketName        string   // Bucket name
	ObjectName        string   // Object name
	TraceID           string   // Trace ID
	URL               *url.URL // Request url
	Namespace         string
	User              string  // User owner id
	UserNamespace     *string // Namespace of user
	Tagging           *data.Tagging
	RequestVHSEnabled bool
	RequestType       ReqType
	BucketInfo        *data.BucketInfo

	AuditPostHandlerLogFields map[string]string
}

type ReqType int

type RequestSettings interface {
	NamespaceHeader() string
	ResolveNamespaceAlias(string) string
	SourceIPHeader() string
}

type ResourceTagging interface {
	GetBucketTagging(ctx context.Context, bktInfo *data.BucketInfo) (map[string]string, error)
	GetObjectTagging(ctx context.Context, p *data.GetObjectTaggingParams) (string, map[string]string, error)
}

type VHSSettings interface {
	Domains() []string
	GlobalVHS() bool
	VHSHeader() string
	ServernameHeader() string
	VHSNamespacesEnabled() map[string]bool
}

type XMLDecoder interface {
	NewXMLDecoder(io.Reader, string) *xml.Decoder
}