package
0.7.6
Repository: https://github.com/nspcc-dev/neofs-api-go.git
Documentation: pkg.go.dev

# Functions

AddSignatureWithKey calculates the data signature and adds it to accumulator with public key.
DataSignature returns the signature of data obtained using the private key.
IRNonForwarding condition that allows NonForwardingTTL only for IR.
NewSignedSessionToken wraps passed SessionToken in a component suitable for signing.
NewVerifiedSessionToken wraps passed SessionToken in a component suitable for signature verification.
ProcessRequestTTL validates and updates requests with TTL.
SignDataWithSessionToken calculates data with token signature and adds it to accumulator.
SignedDataFromReader allocates buffer and reads bytes from passed reader to it.
VerifyAccumulatedSignatures checks if accumulated key-signature pairs are valid.
VerifyAccumulatedSignaturesWithToken checks if accumulated key-signature pairs of data with token are valid.
VerifySignatures checks passed key-signature pairs for data from the passed container.
VerifySignatureWithKey checks data signature from the passed container with passed key.

# Constants

ErrCannotFindOwner is raised when signatures empty in GetOwner.
ErrEmptyDataWithSignature is returned by functions that expect a non-nil DataWithSignature, but received nil.
ErrInvalidPublicKeyBytes means that the public key could not be unmarshaled.
ErrInvalidTTL means that the TTL value does not satisfy a specific criterion.
ErrNegativeLength is returned by functions that received negative length for slice allocation.
ErrNilDataWithTokenSignAccumulator is returned by functions that expect a non-nil DataWithTokenSignAccumulator, but received nil.
ErrNilSignatureKeySource is returned by functions that expect a non-nil SignatureKeySource, but received nil.
ErrNilSignatureKeySourceWithToken is returned by functions that expect a non-nil SignatureKeySourceWithToken, but received nil.
ErrNilSignedDataReader is returned by functions that expect a non-nil SignedDataReader, but received nil.
ErrNilSignedDataSource returned by functions that expect a non-nil SignedDataSource, but received nil.
ErrNilToken is returned by functions that expect a non-nil token argument, but received nil.
ErrWrongOwner is raised when passed OwnerID not equal to present PublicKey.
InnerRingNode that work like IR node.
NonForwardingTTL is a TTL value that does not imply a request forwarding.
SingleForwardingTTL is a TTL value that imply potential forwarding with NonForwardingTTL.
StorageNode that work like a storage node.
Delete refers to object.Delete RPC call.
Get refers to object.Get RPC call.
Head refers to object.Head RPC call.
Put refers to object.Put RPC call.
Range refers to object.GetRange RPC call.
RangeHash refers to object.GetRangeHash RPC call.
Search refers to object.Search RPC call.
ZeroTTL is an upper bound of invalid TTL values.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

RequestMetaHeader contains information about request meta headers (should be embedded into message).
RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message).
No description provided by the author
ResponseMetaHeader contains meta information based on request processing by server (should be embedded into message).
No description provided by the author
User token granting rights for object manipulation.
No description provided by the author
TokenLifetime carries a group of lifetime parameters of the token.

# Interfaces

CreationEpochContainer is an interface of the container of a creation epoch number.
CreationEpochSource is an interface of the container of a creation epoch number with read access.
DataWithSignature is an interface of data-signature pair with read access.
DataWithSignKeyAccumulator is an interface of data and key-signature accumulator pair.
DataWithSignKeySource is an interface of data and key-signature source pair.
DataWithTokenSignAccumulator is an interface of data-token pair with signature write access.
DataWithTokenSignSource is an interface of data-token pair with signature read access.
EpochContainer is an interface of the container of a NeoFS epoch number.
EpochSource is an interface of the container of a NeoFS epoch number with read access.
ExpirationEpochContainer is an interface of the container of an expiration epoch number.
ExpirationEpochSource is an interface of the container of an expiration epoch number with read access.
LifetimeContainer is an interface of the container of creation-expiration epoch pair.
LifetimeSource is an interface of the container of creation-expiration epoch pair with read access.
OwnerKeyContainer is an interface of the container of owner key bytes.
OwnerKeySource is an interface of the container of owner key bytes with read access.
RawContainer is an interface of the container of a boolean Raw value.
RawSource is an interface of the container of a boolean Raw value with read access.
RequestMetaContainer is an interface of a fixed set of request meta value containers.
SeizedMetaHeaderContainer is an interface of container of RequestMetaHeader that can be cut and restored.
SeizedRequestMetaContainer is a RequestMetaContainer with seized meta.
SessionKeyContainer is an interface of the container of public session key bytes.
SessionKeySource is an interface of the container of session key bytes with read access.
SessionToken is an interface of token information and signature pair.
SessionTokenInfo is an interface of a fixed set of token information value containers.
SessionTokenSource is an interface of the container of a SessionToken with read access.
SignatureContainer is an interface of the container of signature bytes.
SignatureSource is an interface of the container of signature bytes with read access.
SignedDataReader is an interface of signed data reader.
SignedDataSource is an interface of the container of a data for signing.
SignedDataWithToken is an interface of data-token pair with read access.
SignKeyPair is an interface of key-signature pair with read access.
SignKeyPairAccumulator is an interface of a set of key-signature pairs with append access.
SignKeyPairSource is an interface of a set of key-signature pairs with read access.
TokenIDContainer is an interface of the container of a token ID value.
TokenIDSource is an interface of the container of a token ID value with read access.
TTLContainer is an interface of the container of a numerical TTL value.
TTLSource is an interface of the container of a numerical TTL value with read access.
VerbContainer is an interface of the container of a token verb value.
VerbSource is an interface of the container of a token verb value with read access.
VersionContainer is an interface of the container of a numerical Version value.
VersionSource is an interface of the container of a numerical Version value with read access.

# Type aliases

Address is a type alias of Address ref.
AddressContainer is a type alias of refs.AddressContainer.
NodeRole to identify in Bootstrap service.
OwnerID is a type alias of OwnerID ref.
OwnerIDContainer is a type alias of refs.OwnerIDContainer.
Verb is an enumeration of session request types.
TokenID is a type alias of UUID ref.
TTLCondition is a function type that used to verify that TTL values match a specific criterion.