frostfs-api-go/service/types.go

package service

import (
	"crypto/ecdsa"
)

// NodeRole to identify in Bootstrap service.
type NodeRole int32

// TTLCondition is a function type that used to verify that TTL values match a specific criterion.
// Nil error indicates compliance with the criterion.
type TTLCondition func(uint32) error

// RawSource is an interface of the container of a boolean Raw value with read access.
type RawSource interface {
	GetRaw() bool
}

// RawContainer is an interface of the container of a boolean Raw value.
type RawContainer interface {
	RawSource
	SetRaw(bool)
}

// VersionSource is an interface of the container of a numerical Version value with read access.
type VersionSource interface {
	GetVersion() uint32
}

// VersionContainer is an interface of the container of a numerical Version value.
type VersionContainer interface {
	VersionSource
	SetVersion(uint32)
}

// EpochSource is an interface of the container of a NeoFS epoch number with read access.
type EpochSource interface {
	GetEpoch() uint64
}

// EpochContainer is an interface of the container of a NeoFS epoch number.
type EpochContainer interface {
	EpochSource
	SetEpoch(uint64)
}

// TTLSource is an interface of the container of a numerical TTL value with read access.
type TTLSource interface {
	GetTTL() uint32
}

// TTLContainer is an interface of the container of a numerical TTL value.
type TTLContainer interface {
	TTLSource
	SetTTL(uint32)
}

// SeizedMetaHeaderContainer is an interface of container of RequestMetaHeader that can be cut and restored.
type SeizedMetaHeaderContainer interface {
	CutMeta() RequestMetaHeader
	RestoreMeta(RequestMetaHeader)
}

// RequestMetaContainer is an interface of a fixed set of request meta value containers.
// Contains:
// - TTL value;
// - NeoFS epoch number;
// - Protocol version;
// - Raw toggle option.
type RequestMetaContainer interface {
	TTLContainer
	EpochContainer
	VersionContainer
	RawContainer
}

// SeizedRequestMetaContainer is a RequestMetaContainer with seized meta.
type SeizedRequestMetaContainer interface {
	RequestMetaContainer
	SeizedMetaHeaderContainer
}

// VerbSource is an interface of the container of a token verb value with read access.
type VerbSource interface {
	GetVerb() Token_Info_Verb
}

// VerbContainer is an interface of the container of a token verb value.
type VerbContainer interface {
	VerbSource
	SetVerb(Token_Info_Verb)
}

// TokenIDSource is an interface of the container of a token ID value with read access.
type TokenIDSource interface {
	GetID() TokenID
}

// TokenIDContainer is an interface of the container of a token ID value.
type TokenIDContainer interface {
	TokenIDSource
	SetID(TokenID)
}

// CreationEpochSource is an interface of the container of a creation epoch number with read access.
type CreationEpochSource interface {
	CreationEpoch() uint64
}

// CreationEpochContainer is an interface of the container of a creation epoch number.
type CreationEpochContainer interface {
	CreationEpochSource
	SetCreationEpoch(uint64)
}

// ExpirationEpochSource is an interface of the container of an expiration epoch number with read access.
type ExpirationEpochSource interface {
	ExpirationEpoch() uint64
}

// ExpirationEpochContainer is an interface of the container of an expiration epoch number.
type ExpirationEpochContainer interface {
	ExpirationEpochSource
	SetExpirationEpoch(uint64)
}

// LifetimeSource is an interface of the container of creation-expiration epoch pair with read access.
type LifetimeSource interface {
	CreationEpochSource
	ExpirationEpochSource
}

// LifetimeContainer is an interface of the container of creation-expiration epoch pair.
type LifetimeContainer interface {
	CreationEpochContainer
	ExpirationEpochContainer
}

// SessionKeySource is an interface of the container of session key bytes with read access.
type SessionKeySource interface {
	GetSessionKey() []byte
}

// SessionKeyContainer is an interface of the container of public session key bytes.
type SessionKeyContainer interface {
	SessionKeySource
	SetSessionKey([]byte)
}

// SignatureSource is an interface of the container of signature bytes with read access.
type SignatureSource interface {
	GetSignature() []byte
}

// SignatureContainer is an interface of the container of signature bytes.
type SignatureContainer interface {
	SignatureSource
	SetSignature([]byte)
}

// OwnerKeySource is an interface of the container of owner key bytes with read access.
type OwnerKeySource interface {
	GetOwnerKey() []byte
}

// OwnerKeyContainer is an interface of the container of owner key bytes.
type OwnerKeyContainer interface {
	OwnerKeySource
	SetOwnerKey([]byte)
}

// SessionTokenSource is an interface of the container of a SessionToken with read access.
type SessionTokenSource interface {
	GetSessionToken() SessionToken
}

// SessionTokenInfo is an interface of a fixed set of token information value containers.
// Contains:
// - ID of the token;
// - ID of the token's owner;
// - verb of the session;
// - address of the session object;
// - token lifetime;
// - public session key bytes;
// - owner's public key bytes.
type SessionTokenInfo interface {
	TokenIDContainer
	OwnerIDContainer
	VerbContainer
	AddressContainer
	LifetimeContainer
	SessionKeyContainer
	OwnerKeyContainer
}

// SessionToken is an interface of token information and signature pair.
type SessionToken interface {
	SessionTokenInfo
	SignatureContainer
}

// SignedDataSource is an interface of the container of a data for signing.
type SignedDataSource interface {
	// Must return the required for signature byte slice.
	// A non-nil error indicates that the data is not ready for signature.
	SignedData() ([]byte, error)
}

// SignedDataReader is an interface of signed data reader.
type SignedDataReader interface {
	// Must return the minimum length of the slice for full reading.
	// Must return a negative value if the length cannot be calculated.
	SignedDataSize() int

	// Must behave like Read method of io.Reader and differ only in the reading of the signed data.
	ReadSignedData([]byte) (int, error)
}

// SignKeyPairAccumulator is an interface of a set of key-signature pairs with append access.
type SignKeyPairAccumulator interface {
	AddSignKey([]byte, *ecdsa.PublicKey)
}

// SignKeyPairSource is an interface of a set of key-signature pairs with read access.
type SignKeyPairSource interface {
	GetSignKeyPairs() []SignKeyPair
}

// SignKeyPair is an interface of key-signature pair with read access.
type SignKeyPair interface {
	SignatureSource
	GetPublicKey() *ecdsa.PublicKey
}

// DataWithSignature is an interface of data-signature pair with read access.
type DataWithSignature interface {
	SignedDataSource
	SignatureSource
}

// DataWithSignKeyAccumulator is an interface of data and key-signature accumulator pair.
type DataWithSignKeyAccumulator interface {
	SignedDataSource
	SignKeyPairAccumulator
}

// DataWithSignKeySource is an interface of data and key-signature source pair.
type DataWithSignKeySource interface {
	SignedDataSource
	SignKeyPairSource
}

// RequestData is an interface of the request information with read access.
type RequestData interface {
	SignedDataSource
	SessionTokenSource
	BearerTokenSource
	ExtendedHeadersSource
}

// RequestSignedData is an interface of request information with signature write access.
type RequestSignedData interface {
	RequestData
	SignKeyPairAccumulator
}

// RequestVerifyData is an interface of request information with signature read access.
type RequestVerifyData interface {
	RequestData
	SignKeyPairSource
}

// ACLRulesSource is an interface of the container of binary extended ACL rules with read access.
type ACLRulesSource interface {
	GetACLRules() []byte
}

// ACLRulesContainer is an interface of the container of binary extended ACL rules.
type ACLRulesContainer interface {
	ACLRulesSource
	SetACLRules([]byte)
}

// BearerTokenInfo is an interface of a fixed set of Bearer token information value containers.
// Contains:
// - binary extended ACL rules;
// - expiration epoch number;
// - ID of the token's owner.
type BearerTokenInfo interface {
	ACLRulesContainer
	ExpirationEpochContainer
	OwnerIDContainer
}

// BearerToken is an interface of Bearer token information and key-signature pair.
type BearerToken interface {
	BearerTokenInfo
	OwnerKeyContainer
	SignatureContainer
}

// BearerTokenSource is an interface of the container of a BearerToken with read access.
type BearerTokenSource interface {
	GetBearerToken() BearerToken
}

// ExtendedHeader is an interface of string key-value pair with read access.
type ExtendedHeader interface {
	Key() string
	Value() string
}

// ExtendedHeadersSource is an interface of ExtendedHeader list with read access.
type ExtendedHeadersSource interface {
	ExtendedHeaders() []ExtendedHeader
}