frostfs-api/proto-docs/session.md

Protocol Documentation

Table of Contents

• session/service.proto

• Services

  • SessionService

• Messages

  • CreateRequest
  • CreateRequest.Body
  • CreateResponse
  • CreateResponse.Body

• Scalar Value Types

Top

session/service.proto

Service "neo.fs.v2.session.SessionService"

Create Session record on Node side

rpc Create(CreateRequest) returns (CreateResponse);

Method Create

Create opens new session between the client and the server.

Name	Input	Output
Create	CreateRequest	CreateResponse

Message CreateRequest

CreateRequest carries an information necessary for opening a session.

Field	Type	Label	Description
body	CreateRequest.Body		Body of create session token request message.
meta_header	neo.fs.v2.service.RequestMetaHeader		Carries request meta information. Header data is used only to regulate message transport and does not affect request execution.
verify_header	neo.fs.v2.service.RequestVerificationHeader		Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission.

Message CreateRequest.Body

Request body

Field	Type	Label	Description
owner_id	neo.fs.v2.refs.OwnerID		Carries an identifier of a session initiator.
lifetime	neo.fs.v2.service.TokenLifetime		Carries a lifetime of the session.

Message CreateResponse

CreateResponse carries an information about the opened session.

Field	Type	Label	Description
body	CreateResponse.Body		Body of create session token response message.
meta_header	neo.fs.v2.service.ResponseMetaHeader		Carries response meta information. Header data is used only to regulate message transport and does not affect request execution.
verify_header	neo.fs.v2.service.ResponseVerificationHeader		Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission.

Message CreateResponse.Body

Response body

Field	Type	Label	Description
id	bytes		id carries an identifier of session token.
session_key	bytes		session_key carries a session public key.

Scalar Value Types

.proto Type	Notes	C++ Type	Java Type	Python Type
double		double	double	float
float		float	float	float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long
uint32	Uses variable-length encoding.	uint32	int	int/long
uint64	Uses variable-length encoding.	uint64	long	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long
sfixed32	Always four bytes.	int32	int	int
sfixed64	Always eight bytes.	int64	long	int/long
bool		bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str