session

package
v1.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 7, 2021 License: Apache-2.0 Imports: 12 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ObjectSessionContext_Verb_name = map[int32]string{
		0: "VERB_UNSPECIFIED",
		1: "PUT",
		2: "GET",
		3: "HEAD",
		4: "SEARCH",
		5: "DELETE",
		6: "RANGE",
		7: "RANGEHASH",
	}
	ObjectSessionContext_Verb_value = map[string]int32{
		"VERB_UNSPECIFIED": 0,
		"PUT":              1,
		"GET":              2,
		"HEAD":             3,
		"SEARCH":           4,
		"DELETE":           5,
		"RANGE":            6,
		"RANGEHASH":        7,
	}
)

Enum value maps for ObjectSessionContext_Verb.

View Source 
var ErrNilSessionServiceClient = errors.New("session gRPC client is nil")

ErrNilSessionServiceClient is returned by functions that expect a non-nil SessionServiceClient, but received nil.

View Source 
var File_v2_session_grpc_service_proto protoreflect.FileDescriptor
View Source 
var File_v2_session_grpc_types_proto protoreflect.FileDescriptor

Functions

func RegisterSessionServiceServer 

func RegisterSessionServiceServer(s *grpc1.Server, srv SessionServiceServer)

Types

type Client 

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

Client wraps SessionServiceClient with pre-defined configurations.

func NewClient 

func NewClient(c SessionServiceClient, opts ...Option) (*Client, error)

NewClient creates, initializes and returns a new Client instance.

Options are applied one by one in order.

func (*Client) Create 

func (c *Client) Create(ctx context.Context, req *CreateRequest) (*CreateResponse, error)

type CreateRequest 

type CreateRequest struct {

	// Body of create session token request message.
	Body *CreateRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *RequestMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *RequestVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Information necessary for opening a session.

func (*CreateRequest) Descriptor deprecated 

func (*CreateRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateRequest.ProtoReflect.Descriptor instead.

func (*CreateRequest) GetBody 

func (x *CreateRequest) GetBody() *CreateRequest_Body

func (*CreateRequest) GetMetaHeader 

func (x *CreateRequest) GetMetaHeader() *RequestMetaHeader

func (*CreateRequest) GetVerifyHeader 

func (x *CreateRequest) GetVerifyHeader() *RequestVerificationHeader

func (*CreateRequest) ProtoMessage 

func (*CreateRequest) ProtoMessage()

func (*CreateRequest) ProtoReflect 

func (x *CreateRequest) ProtoReflect() protoreflect.Message

func (*CreateRequest) Reset 

func (x *CreateRequest) Reset()

func (*CreateRequest) SetBody 

func (m *CreateRequest) SetBody(v *CreateRequest_Body)

SetBody sets body of the request.

func (*CreateRequest) SetMetaHeader 

func (m *CreateRequest) SetMetaHeader(v *RequestMetaHeader)

SetMetaHeader sets meta header of the request.

func (*CreateRequest) SetVerifyHeader 

func (m *CreateRequest) SetVerifyHeader(v *RequestVerificationHeader)

SetVerifyHeader sets verification header of the request.

func (*CreateRequest) String 

func (x *CreateRequest) String() string

type CreateRequest_Body 

type CreateRequest_Body struct {

	// Session initiating user's or node's key derived `OwnerID`
	OwnerId *grpc.OwnerID `protobuf:"bytes,1,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`
	// Session expiration `Epoch`
	Expiration uint64 `protobuf:"varint,2,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// contains filtered or unexported fields
}

Session creation request body

func (*CreateRequest_Body) Descriptor deprecated 

func (*CreateRequest_Body) Descriptor() ([]byte, []int)

Deprecated: Use CreateRequest_Body.ProtoReflect.Descriptor instead.

func (*CreateRequest_Body) GetExpiration 

func (x *CreateRequest_Body) GetExpiration() uint64

func (*CreateRequest_Body) GetOwnerId 

func (x *CreateRequest_Body) GetOwnerId() *grpc.OwnerID

func (*CreateRequest_Body) ProtoMessage 

func (*CreateRequest_Body) ProtoMessage()

func (*CreateRequest_Body) ProtoReflect 

func (x *CreateRequest_Body) ProtoReflect() protoreflect.Message

func (*CreateRequest_Body) Reset 

func (x *CreateRequest_Body) Reset()

func (*CreateRequest_Body) SetExpiration 

func (m *CreateRequest_Body) SetExpiration(v uint64)

SetExpiration sets lifetime of the session.

func (*CreateRequest_Body) SetOwnerId 

func (m *CreateRequest_Body) SetOwnerId(v *refs.OwnerID)

SetOwnerId sets identifier of the session initiator.

func (*CreateRequest_Body) String 

func (x *CreateRequest_Body) String() string

type CreateResponse 

type CreateResponse struct {

	// Body of create session token response message.
	Body *CreateResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *ResponseMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *ResponseVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Information about the opened session.

func (*CreateResponse) Descriptor deprecated 

func (*CreateResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateResponse.ProtoReflect.Descriptor instead.

func (*CreateResponse) GetBody 

func (x *CreateResponse) GetBody() *CreateResponse_Body

func (*CreateResponse) GetMetaHeader 

func (x *CreateResponse) GetMetaHeader() *ResponseMetaHeader

func (*CreateResponse) GetVerifyHeader 

func (x *CreateResponse) GetVerifyHeader() *ResponseVerificationHeader

func (*CreateResponse) ProtoMessage 

func (*CreateResponse) ProtoMessage()

func (*CreateResponse) ProtoReflect 

func (x *CreateResponse) ProtoReflect() protoreflect.Message

func (*CreateResponse) Reset 

func (x *CreateResponse) Reset()

func (*CreateResponse) SetBody 

func (m *CreateResponse) SetBody(v *CreateResponse_Body)

SetBody sets body of the response.

func (*CreateResponse) SetMetaHeader 

func (m *CreateResponse) SetMetaHeader(v *ResponseMetaHeader)

SetMetaHeader sets meta header of the response.

func (*CreateResponse) SetVerifyHeader 

func (m *CreateResponse) SetVerifyHeader(v *ResponseVerificationHeader)

SetVerifyHeader sets verification header of the response.

func (*CreateResponse) String 

func (x *CreateResponse) String() string

type CreateResponse_Body 

type CreateResponse_Body struct {

	// Identifier of a newly created session
	Id []byte `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Public key used for session
	SessionKey []byte `protobuf:"bytes,2,opt,name=session_key,json=sessionKey,proto3" json:"session_key,omitempty"`
	// contains filtered or unexported fields
}

Session creation response body

func (*CreateResponse_Body) Descriptor deprecated 

func (*CreateResponse_Body) Descriptor() ([]byte, []int)

Deprecated: Use CreateResponse_Body.ProtoReflect.Descriptor instead.

func (*CreateResponse_Body) GetId 

func (x *CreateResponse_Body) GetId() []byte

func (*CreateResponse_Body) GetSessionKey 

func (x *CreateResponse_Body) GetSessionKey() []byte

func (*CreateResponse_Body) ProtoMessage 

func (*CreateResponse_Body) ProtoMessage()

func (*CreateResponse_Body) ProtoReflect 

func (x *CreateResponse_Body) ProtoReflect() protoreflect.Message

func (*CreateResponse_Body) Reset 

func (x *CreateResponse_Body) Reset()

func (*CreateResponse_Body) SetId 

func (m *CreateResponse_Body) SetId(v []byte)

SetId sets identifier of the session token.

func (*CreateResponse_Body) SetSessionKey 

func (m *CreateResponse_Body) SetSessionKey(v []byte)

SetSessionKey sets session public key in a binary format.

func (*CreateResponse_Body) String 

func (x *CreateResponse_Body) String() string

type ObjectSessionContext 

type ObjectSessionContext struct {

	// Type of request for which the token is issued
	Verb ObjectSessionContext_Verb `protobuf:"varint,1,opt,name=verb,proto3,enum=neo.fs.v2.session.ObjectSessionContext_Verb" json:"verb,omitempty"`
	// Related Object address
	Address *grpc.Address `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// contains filtered or unexported fields
}

Context information for Session Tokens related to ObjectService requests

func (*ObjectSessionContext) Descriptor deprecated 

func (*ObjectSessionContext) Descriptor() ([]byte, []int)

Deprecated: Use ObjectSessionContext.ProtoReflect.Descriptor instead.

func (*ObjectSessionContext) GetAddress 

func (x *ObjectSessionContext) GetAddress() *grpc.Address

func (*ObjectSessionContext) GetVerb 

func (x *ObjectSessionContext) GetVerb() ObjectSessionContext_Verb

func (*ObjectSessionContext) ProtoMessage 

func (*ObjectSessionContext) ProtoMessage()

func (*ObjectSessionContext) ProtoReflect 

func (x *ObjectSessionContext) ProtoReflect() protoreflect.Message

func (*ObjectSessionContext) Reset 

func (x *ObjectSessionContext) Reset()

func (*ObjectSessionContext) SetAddress 

func (m *ObjectSessionContext) SetAddress(v *refs.Address)

SetObjectAddressContext sets object context of the session token.

func (*ObjectSessionContext) SetVerb 

func (m *ObjectSessionContext) SetVerb(v ObjectSessionContext_Verb)

SetObjectAddressContext sets object context of the session token.

func (*ObjectSessionContext) String 

func (x *ObjectSessionContext) String() string

type ObjectSessionContext_Verb 

type ObjectSessionContext_Verb int32

Object request verbs 

const (
	// Unknown verb
	ObjectSessionContext_VERB_UNSPECIFIED ObjectSessionContext_Verb = 0
	// Refers to object.Put RPC call
	ObjectSessionContext_PUT ObjectSessionContext_Verb = 1
	// Refers to object.Get RPC call
	ObjectSessionContext_GET ObjectSessionContext_Verb = 2
	// Refers to object.Head RPC call
	ObjectSessionContext_HEAD ObjectSessionContext_Verb = 3
	// Refers to object.Search RPC call
	ObjectSessionContext_SEARCH ObjectSessionContext_Verb = 4
	// Refers to object.Delete RPC call
	ObjectSessionContext_DELETE ObjectSessionContext_Verb = 5
	// Refers to object.GetRange RPC call
	ObjectSessionContext_RANGE ObjectSessionContext_Verb = 6
	// Refers to object.GetRangeHash RPC call
	ObjectSessionContext_RANGEHASH ObjectSessionContext_Verb = 7
)

func (ObjectSessionContext_Verb) Descriptor 

func (ObjectSessionContext_Verb) Descriptor() protoreflect.EnumDescriptor

func (ObjectSessionContext_Verb) Enum 

func (x ObjectSessionContext_Verb) Enum() *ObjectSessionContext_Verb

func (ObjectSessionContext_Verb) EnumDescriptor deprecated 

func (ObjectSessionContext_Verb) EnumDescriptor() ([]byte, []int)

Deprecated: Use ObjectSessionContext_Verb.Descriptor instead.

func (ObjectSessionContext_Verb) Number 

func (x ObjectSessionContext_Verb) Number() protoreflect.EnumNumber

func (ObjectSessionContext_Verb) String 

func (x ObjectSessionContext_Verb) String() string

func (ObjectSessionContext_Verb) Type 

func (ObjectSessionContext_Verb) Type() protoreflect.EnumType

type Option 

type Option func(*cfg)

Option represents Client option.

func WithCallOptions 

func WithCallOptions(opts []grpc.CallOption) Option

WithCallOptions returns Option that configures Client to attach call options to each rpc call.

type RequestMetaHeader 

type RequestMetaHeader struct {

	// Peer's API version used
	Version *grpc.Version `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Peer's local epoch number. Set to 0 if unknown.
	Epoch uint64 `protobuf:"varint,2,opt,name=epoch,proto3" json:"epoch,omitempty"`
	// Maximum number of intermediate nodes in the request route
	Ttl uint32 `protobuf:"varint,3,opt,name=ttl,proto3" json:"ttl,omitempty"`
	// Request X-Headers
	XHeaders []*XHeader `protobuf:"bytes,4,rep,name=x_headers,json=xHeaders,proto3" json:"x_headers,omitempty"`
	// Session token within which the request is sent
	SessionToken *SessionToken `protobuf:"bytes,5,opt,name=session_token,json=sessionToken,proto3" json:"session_token,omitempty"`
	// `BearerToken` with eACL overrides for the request
	BearerToken *grpc1.BearerToken `protobuf:"bytes,6,opt,name=bearer_token,json=bearerToken,proto3" json:"bearer_token,omitempty"`
	// `RequestMetaHeader` of the origin request
	Origin *RequestMetaHeader `protobuf:"bytes,7,opt,name=origin,proto3" json:"origin,omitempty"`
	// contains filtered or unexported fields
}

Meta information attached to the request. When forwarded between peers, request meta headers are folded in matryoshka style.

func (*RequestMetaHeader) Descriptor deprecated 

func (*RequestMetaHeader) Descriptor() ([]byte, []int)

Deprecated: Use RequestMetaHeader.ProtoReflect.Descriptor instead.

func (*RequestMetaHeader) GetBearerToken 

func (x *RequestMetaHeader) GetBearerToken() *grpc1.BearerToken

func (*RequestMetaHeader) GetEpoch 

func (x *RequestMetaHeader) GetEpoch() uint64

func (*RequestMetaHeader) GetOrigin 

func (x *RequestMetaHeader) GetOrigin() *RequestMetaHeader

func (*RequestMetaHeader) GetSessionToken 

func (x *RequestMetaHeader) GetSessionToken() *SessionToken

func (*RequestMetaHeader) GetTtl 

func (x *RequestMetaHeader) GetTtl() uint32

func (*RequestMetaHeader) GetVersion 

func (x *RequestMetaHeader) GetVersion() *grpc.Version

func (*RequestMetaHeader) GetXHeaders 

func (x *RequestMetaHeader) GetXHeaders() []*XHeader

func (*RequestMetaHeader) ProtoMessage 

func (*RequestMetaHeader) ProtoMessage()

func (*RequestMetaHeader) ProtoReflect 

func (x *RequestMetaHeader) ProtoReflect() protoreflect.Message

func (*RequestMetaHeader) Reset 

func (x *RequestMetaHeader) Reset()

func (*RequestMetaHeader) SetBearerToken 

func (m *RequestMetaHeader) SetBearerToken(v *acl.BearerToken)

SetBearerToken sets bearer token of the request.

func (*RequestMetaHeader) SetEpoch 

func (m *RequestMetaHeader) SetEpoch(v uint64)

SetEpoch sets client local epoch.

func (*RequestMetaHeader) SetOrigin 

func (m *RequestMetaHeader) SetOrigin(v *RequestMetaHeader)

SetOrigin sets origin request meta header.

func (*RequestMetaHeader) SetSessionToken 

func (m *RequestMetaHeader) SetSessionToken(v *SessionToken)

SetSessionToken sets session token of the request.

func (*RequestMetaHeader) SetTtl 

func (m *RequestMetaHeader) SetTtl(v uint32)

SetTtl sets request TTL.

func (*RequestMetaHeader) SetVersion 

func (m *RequestMetaHeader) SetVersion(v *refs.Version)

SetVersion sets client protocol version.

func (*RequestMetaHeader) SetXHeaders 

func (m *RequestMetaHeader) SetXHeaders(v []*XHeader)

SetXHeaders sets request X-Headers.

func (*RequestMetaHeader) String 

func (x *RequestMetaHeader) String() string

type RequestVerificationHeader 

type RequestVerificationHeader struct {

	// Request Body signature. Should be generated once by request initiator.
	BodySignature *grpc.Signature `protobuf:"bytes,1,opt,name=body_signature,json=bodySignature,proto3" json:"body_signature,omitempty"`
	// Request Meta signature is added and signed by each intermediate node
	MetaSignature *grpc.Signature `protobuf:"bytes,2,opt,name=meta_signature,json=metaSignature,proto3" json:"meta_signature,omitempty"`
	// Signature of previous hops
	OriginSignature *grpc.Signature `protobuf:"bytes,3,opt,name=origin_signature,json=originSignature,proto3" json:"origin_signature,omitempty"`
	// Chain of previous hops signatures
	Origin *RequestVerificationHeader `protobuf:"bytes,4,opt,name=origin,proto3" json:"origin,omitempty"`
	// contains filtered or unexported fields
}

Verification info for request signed by all intermediate nodes.

func (*RequestVerificationHeader) Descriptor deprecated 

func (*RequestVerificationHeader) Descriptor() ([]byte, []int)

Deprecated: Use RequestVerificationHeader.ProtoReflect.Descriptor instead.

func (*RequestVerificationHeader) GetBodySignature 

func (x *RequestVerificationHeader) GetBodySignature() *grpc.Signature

func (*RequestVerificationHeader) GetMetaSignature 

func (x *RequestVerificationHeader) GetMetaSignature() *grpc.Signature

func (*RequestVerificationHeader) GetOrigin 

func (x *RequestVerificationHeader) GetOrigin() *RequestVerificationHeader

func (*RequestVerificationHeader) GetOriginSignature 

func (x *RequestVerificationHeader) GetOriginSignature() *grpc.Signature

func (*RequestVerificationHeader) ProtoMessage 

func (*RequestVerificationHeader) ProtoMessage()

func (*RequestVerificationHeader) ProtoReflect 

func (x *RequestVerificationHeader) ProtoReflect() protoreflect.Message

func (*RequestVerificationHeader) Reset 

func (x *RequestVerificationHeader) Reset()

func (*RequestVerificationHeader) SetBodySignature 

func (m *RequestVerificationHeader) SetBodySignature(v *refs.Signature)

SetBodySignature sets signature of the request body.

func (*RequestVerificationHeader) SetMetaSignature 

func (m *RequestVerificationHeader) SetMetaSignature(v *refs.Signature)

SetMetaSignature sets signature of the request meta.

func (*RequestVerificationHeader) SetOrigin 

func (m *RequestVerificationHeader) SetOrigin(v *RequestVerificationHeader)

SetOrigin sets origin verification header of the request.

func (*RequestVerificationHeader) SetOriginSignature 

func (m *RequestVerificationHeader) SetOriginSignature(v *refs.Signature)

SetOriginSignature sets signature of the origin verification header of the request.

func (*RequestVerificationHeader) String 

func (x *RequestVerificationHeader) String() string

type ResponseMetaHeader 

type ResponseMetaHeader struct {

	// Peer's API version used
	Version *grpc.Version `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Peer's local epoch number
	Epoch uint64 `protobuf:"varint,2,opt,name=epoch,proto3" json:"epoch,omitempty"`
	// Maximum number of intermediate nodes in the request route
	Ttl uint32 `protobuf:"varint,3,opt,name=ttl,proto3" json:"ttl,omitempty"`
	// Response X-Headers
	XHeaders []*XHeader `protobuf:"bytes,4,rep,name=x_headers,json=xHeaders,proto3" json:"x_headers,omitempty"`
	// `ResponseMetaHeader` of the origin request
	Origin *ResponseMetaHeader `protobuf:"bytes,5,opt,name=origin,proto3" json:"origin,omitempty"`
	// contains filtered or unexported fields
}

Information about the response

func (*ResponseMetaHeader) Descriptor deprecated 

func (*ResponseMetaHeader) Descriptor() ([]byte, []int)

Deprecated: Use ResponseMetaHeader.ProtoReflect.Descriptor instead.

func (*ResponseMetaHeader) GetEpoch 

func (x *ResponseMetaHeader) GetEpoch() uint64

func (*ResponseMetaHeader) GetOrigin 

func (x *ResponseMetaHeader) GetOrigin() *ResponseMetaHeader

func (*ResponseMetaHeader) GetTtl 

func (x *ResponseMetaHeader) GetTtl() uint32

func (*ResponseMetaHeader) GetVersion 

func (x *ResponseMetaHeader) GetVersion() *grpc.Version

func (*ResponseMetaHeader) GetXHeaders 

func (x *ResponseMetaHeader) GetXHeaders() []*XHeader

func (*ResponseMetaHeader) ProtoMessage 

func (*ResponseMetaHeader) ProtoMessage()

func (*ResponseMetaHeader) ProtoReflect 

func (x *ResponseMetaHeader) ProtoReflect() protoreflect.Message

func (*ResponseMetaHeader) Reset 

func (x *ResponseMetaHeader) Reset()

func (*ResponseMetaHeader) SetEpoch 

func (m *ResponseMetaHeader) SetEpoch(v uint64)

SetEpoch sets server local epoch.

func (*ResponseMetaHeader) SetOrigin 

func (m *ResponseMetaHeader) SetOrigin(v *ResponseMetaHeader)

SetOrigin sets origin response meta header.

func (*ResponseMetaHeader) SetTtl 

func (m *ResponseMetaHeader) SetTtl(v uint32)

SetTtl sets response TTL.

func (*ResponseMetaHeader) SetVersion 

func (m *ResponseMetaHeader) SetVersion(v *refs.Version)

SetVersion sets server protocol version.

func (*ResponseMetaHeader) SetXHeaders 

func (m *ResponseMetaHeader) SetXHeaders(v []*XHeader)

SetXHeaders sets response X-Headers.

func (*ResponseMetaHeader) String 

func (x *ResponseMetaHeader) String() string

type ResponseVerificationHeader 

type ResponseVerificationHeader struct {

	// Response Body signature. Should be generated once by answering node.
	BodySignature *grpc.Signature `protobuf:"bytes,1,opt,name=body_signature,json=bodySignature,proto3" json:"body_signature,omitempty"`
	// Response Meta signature is added and signed by each intermediate node
	MetaSignature *grpc.Signature `protobuf:"bytes,2,opt,name=meta_signature,json=metaSignature,proto3" json:"meta_signature,omitempty"`
	// Signature of previous hops
	OriginSignature *grpc.Signature `protobuf:"bytes,3,opt,name=origin_signature,json=originSignature,proto3" json:"origin_signature,omitempty"`
	// Chain of previous hops signatures
	Origin *ResponseVerificationHeader `protobuf:"bytes,4,opt,name=origin,proto3" json:"origin,omitempty"`
	// contains filtered or unexported fields
}

Verification info for response signed by all intermediate nodes

func (*ResponseVerificationHeader) Descriptor deprecated 

func (*ResponseVerificationHeader) Descriptor() ([]byte, []int)

Deprecated: Use ResponseVerificationHeader.ProtoReflect.Descriptor instead.

func (*ResponseVerificationHeader) GetBodySignature 

func (x *ResponseVerificationHeader) GetBodySignature() *grpc.Signature

func (*ResponseVerificationHeader) GetMetaSignature 

func (x *ResponseVerificationHeader) GetMetaSignature() *grpc.Signature

func (*ResponseVerificationHeader) GetOrigin 

func (x *ResponseVerificationHeader) GetOrigin() *ResponseVerificationHeader

func (*ResponseVerificationHeader) GetOriginSignature 

func (x *ResponseVerificationHeader) GetOriginSignature() *grpc.Signature

func (*ResponseVerificationHeader) ProtoMessage 

func (*ResponseVerificationHeader) ProtoMessage()

func (*ResponseVerificationHeader) ProtoReflect 

func (x *ResponseVerificationHeader) ProtoReflect() protoreflect.Message

func (*ResponseVerificationHeader) Reset 

func (x *ResponseVerificationHeader) Reset()

func (*ResponseVerificationHeader) SetBodySignature 

func (m *ResponseVerificationHeader) SetBodySignature(v *refs.Signature)

SetBodySignature sets signature of the response body.

func (*ResponseVerificationHeader) SetMetaSignature 

func (m *ResponseVerificationHeader) SetMetaSignature(v *refs.Signature)

SetMetaSignature sets signature of the response meta.

func (*ResponseVerificationHeader) SetOrigin 

func (m *ResponseVerificationHeader) SetOrigin(v *ResponseVerificationHeader)

SetOrigin sets origin verification header of the response.

func (*ResponseVerificationHeader) SetOriginSignature 

func (m *ResponseVerificationHeader) SetOriginSignature(v *refs.Signature)

SetOriginSignature sets signature of the origin verification header of the response.

func (*ResponseVerificationHeader) String 

func (x *ResponseVerificationHeader) String() string

type SessionServiceClient 

type SessionServiceClient interface {
	// Opens a new session between two peers.
	Create(ctx context.Context, in *CreateRequest, opts ...grpc1.CallOption) (*CreateResponse, error)
}

SessionServiceClient is the client API for SessionService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewSessionServiceClient 

func NewSessionServiceClient(cc grpc1.ClientConnInterface) SessionServiceClient

type SessionServiceServer 

type SessionServiceServer interface {
	// Opens a new session between two peers.
	Create(context.Context, *CreateRequest) (*CreateResponse, error)
}

SessionServiceServer is the server API for SessionService service.

type SessionToken 

type SessionToken struct {

	// Session Token contains the proof of trust between peers to be attached in
	// requests for further verification. Please see corresponding section of
	// NeoFS Technical Specification for details.
	Body *SessionToken_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Signature of `SessionToken` information
	Signature *grpc.Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

NeoFS Session Token.

func (*SessionToken) Descriptor deprecated 

func (*SessionToken) Descriptor() ([]byte, []int)

Deprecated: Use SessionToken.ProtoReflect.Descriptor instead.

func (*SessionToken) GetBody 

func (x *SessionToken) GetBody() *SessionToken_Body

func (*SessionToken) GetSignature 

func (x *SessionToken) GetSignature() *grpc.Signature

func (*SessionToken) ProtoMessage 

func (*SessionToken) ProtoMessage()

func (*SessionToken) ProtoReflect 

func (x *SessionToken) ProtoReflect() protoreflect.Message

func (*SessionToken) Reset 

func (x *SessionToken) Reset()

func (*SessionToken) SetBody 

func (m *SessionToken) SetBody(v *SessionToken_Body)

SetBody sets session token body.

func (*SessionToken) SetSignature 

func (m *SessionToken) SetSignature(v *refs.Signature)

SetSignature sets session token signature.

func (*SessionToken) String 

func (x *SessionToken) String() string

type SessionToken_Body 

type SessionToken_Body struct {

	// Token identifier is a valid UUIDv4 in binary form
	Id []byte `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Identifier of the session initiator
	OwnerId *grpc.OwnerID `protobuf:"bytes,2,opt,name=owner_id,json=ownerID,proto3" json:"owner_id,omitempty"`
	// Lifetime of the session
	Lifetime *SessionToken_Body_TokenLifetime `protobuf:"bytes,3,opt,name=lifetime,proto3" json:"lifetime,omitempty"`
	// Public key used in session
	SessionKey []byte `protobuf:"bytes,4,opt,name=session_key,json=sessionKey,proto3" json:"session_key,omitempty"`
	// Session Context information
	//
	// Types that are assignable to Context:
	//	*SessionToken_Body_Object
	Context isSessionToken_Body_Context `protobuf_oneof:"context"`
	// contains filtered or unexported fields
}

Session Token body

func (*SessionToken_Body) Descriptor deprecated 

func (*SessionToken_Body) Descriptor() ([]byte, []int)

Deprecated: Use SessionToken_Body.ProtoReflect.Descriptor instead.

func (*SessionToken_Body) GetContext 

func (m *SessionToken_Body) GetContext() isSessionToken_Body_Context

func (*SessionToken_Body) GetId 

func (x *SessionToken_Body) GetId() []byte

func (*SessionToken_Body) GetLifetime 

func (x *SessionToken_Body) GetLifetime() *SessionToken_Body_TokenLifetime

func (*SessionToken_Body) GetObject 

func (x *SessionToken_Body) GetObject() *ObjectSessionContext

func (*SessionToken_Body) GetOwnerId 

func (x *SessionToken_Body) GetOwnerId() *grpc.OwnerID

func (*SessionToken_Body) GetSessionKey 

func (x *SessionToken_Body) GetSessionKey() []byte

func (*SessionToken_Body) ProtoMessage 

func (*SessionToken_Body) ProtoMessage()

func (*SessionToken_Body) ProtoReflect 

func (x *SessionToken_Body) ProtoReflect() protoreflect.Message

func (*SessionToken_Body) Reset 

func (x *SessionToken_Body) Reset()

func (*SessionToken_Body) SetId 

func (m *SessionToken_Body) SetId(v []byte)

SetId sets identifier of the session token.

func (*SessionToken_Body) SetLifetime 

func (m *SessionToken_Body) SetLifetime(v *SessionToken_Body_TokenLifetime)

SetLifetime sets lifetime of the session token.

func (*SessionToken_Body) SetObjectSessionContext 

func (m *SessionToken_Body) SetObjectSessionContext(v *ObjectSessionContext)

SetObjectAddressContext sets object context of the session token.

func (*SessionToken_Body) SetOwnerId 

func (m *SessionToken_Body) SetOwnerId(v *refs.OwnerID)

SetOwnerId sets identifier of the session token owner.

func (*SessionToken_Body) SetSessionKey 

func (m *SessionToken_Body) SetSessionKey(v []byte)

SetSessionKey sets public session key in a binary format.

func (*SessionToken_Body) String 

func (x *SessionToken_Body) String() string

type SessionToken_Body_Object 

type SessionToken_Body_Object struct {
	// ObjectService session context
	Object *ObjectSessionContext `protobuf:"bytes,5,opt,name=object,proto3,oneof"`
}

type SessionToken_Body_TokenLifetime 

type SessionToken_Body_TokenLifetime struct {

	// Expiration Epoch
	Exp uint64 `protobuf:"varint,1,opt,name=exp,proto3" json:"exp,omitempty"`
	// Not valid before Epoch
	Nbf uint64 `protobuf:"varint,2,opt,name=nbf,proto3" json:"nbf,omitempty"`
	// Issued at Epoch
	Iat uint64 `protobuf:"varint,3,opt,name=iat,proto3" json:"iat,omitempty"`
	// contains filtered or unexported fields
}

Lifetime parameters of the token. Field names taken from rfc7519.

func (*SessionToken_Body_TokenLifetime) Descriptor deprecated 

func (*SessionToken_Body_TokenLifetime) Descriptor() ([]byte, []int)

Deprecated: Use SessionToken_Body_TokenLifetime.ProtoReflect.Descriptor instead.

func (*SessionToken_Body_TokenLifetime) GetExp 

func (x *SessionToken_Body_TokenLifetime) GetExp() uint64

func (*SessionToken_Body_TokenLifetime) GetIat 

func (x *SessionToken_Body_TokenLifetime) GetIat() uint64

func (*SessionToken_Body_TokenLifetime) GetNbf 

func (x *SessionToken_Body_TokenLifetime) GetNbf() uint64

func (*SessionToken_Body_TokenLifetime) ProtoMessage 

func (*SessionToken_Body_TokenLifetime) ProtoMessage()

func (*SessionToken_Body_TokenLifetime) ProtoReflect 

func (x *SessionToken_Body_TokenLifetime) ProtoReflect() protoreflect.Message

func (*SessionToken_Body_TokenLifetime) Reset 

func (x *SessionToken_Body_TokenLifetime) Reset()

func (*SessionToken_Body_TokenLifetime) SetExp 

func (m *SessionToken_Body_TokenLifetime) SetExp(v uint64)

SetExp sets epoch number of the token expiration.

func (*SessionToken_Body_TokenLifetime) SetIat 

func (m *SessionToken_Body_TokenLifetime) SetIat(v uint64)

SetIat sets the number of the epoch in which the token was issued.

func (*SessionToken_Body_TokenLifetime) SetNbf 

func (m *SessionToken_Body_TokenLifetime) SetNbf(v uint64)

SetNbf sets starting epoch number of the token.

func (*SessionToken_Body_TokenLifetime) String 

func (x *SessionToken_Body_TokenLifetime) String() string

type UnimplementedSessionServiceServer 

type UnimplementedSessionServiceServer struct {
}

UnimplementedSessionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSessionServiceServer) Create 

func (*UnimplementedSessionServiceServer) Create(context.Context, *CreateRequest) (*CreateResponse, error)

type XHeader 

type XHeader struct {

	// Key of the X-Header
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Value of the X-Header
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Extended headers for Request/Response. May contain any user-defined headers to be interpreted on application level.

Key name must be unique valid UTF-8 string. Value can't be empty. Requests or Responses with duplicated header names or headers with empty values will be considered invalid.

There are some "well-known" headers starting with `__NEOFS__` prefix that affect system behaviour:

  • __NEOFS__NETMAP_EPOCH \ Netmap epoch to use for object placement calculation. The `value` is string encoded `uint64` in decimal presentation. If set to '0' or not set, the current epoch only will be used.
  • __NEOFS__NETMAP_LOOKUP_DEPTH \ If object can't be found using current epoch's netmap, this header limits how many past epochs back the node can lookup. The `value` is string encoded `uint64` in decimal presentation. If set to '0' or not set, the current epoch only will be used.

func (*XHeader) Descriptor deprecated 

func (*XHeader) Descriptor() ([]byte, []int)

Deprecated: Use XHeader.ProtoReflect.Descriptor instead.

func (*XHeader) GetKey 

func (x *XHeader) GetKey() string

func (*XHeader) GetValue 

func (x *XHeader) GetValue() string

func (*XHeader) ProtoMessage 

func (*XHeader) ProtoMessage()

func (*XHeader) ProtoReflect 

func (x *XHeader) ProtoReflect() protoreflect.Message

func (*XHeader) Reset 

func (x *XHeader) Reset()

func (*XHeader) SetKey 

func (m *XHeader) SetKey(v string)

SetKey sets key to the X-Header.

func (*XHeader) SetValue 

func (m *XHeader) SetValue(v string)

SetValue sets value of the X-Header.

func (*XHeader) String 

func (x *XHeader) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.