2020-01-30 11:41:24 +00:00
# Protocol Documentation
< a name = "top" > < / a >
## Table of Contents
- [service/meta.proto ](#service/meta.proto )
- Messages
- [RequestMetaHeader ](#service.RequestMetaHeader )
2020-03-31 07:17:52 +00:00
- [ResponseMetaHeader ](#service.ResponseMetaHeader )
2020-01-30 11:41:24 +00:00
- [service/verify.proto ](#service/verify.proto )
- Messages
- [RequestVerificationHeader ](#service.RequestVerificationHeader )
- [RequestVerificationHeader.Signature ](#service.RequestVerificationHeader.Signature )
2020-04-24 16:18:28 +00:00
- [Token ](#service.Token )
- [Token.Info ](#service.Token.Info )
2020-01-30 11:41:24 +00:00
- [Scalar Value Types ](#scalar-value-types )
< a name = "service/meta.proto" > < / a >
< p align = "right" > < a href = "#top" > Top< / a > < / p >
## service/meta.proto
<!-- end services -->
< a name = "service.RequestMetaHeader" > < / a >
### Message RequestMetaHeader
RequestMetaHeader contains information about request meta headers
(should be embedded into message)
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| TTL | [uint32 ](#uint32 ) | | TTL must be larger than zero, it decreased in every NeoFS Node |
| Epoch | [uint64 ](#uint64 ) | | Epoch for user can be empty, because node sets epoch to the actual value |
| Version | [uint32 ](#uint32 ) | | Version defines protocol version TODO: not used for now, should be implemented in future |
2020-04-23 10:34:06 +00:00
| Raw | [bool ](#bool ) | | Raw determines whether the request is raw or not |
2020-01-30 11:41:24 +00:00
2020-03-31 07:17:52 +00:00
< a name = "service.ResponseMetaHeader" > < / a >
### Message ResponseMetaHeader
ResponseMetaHeader contains meta information based on request processing by server
(should be embedded into message)
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Epoch | [uint64 ](#uint64 ) | | Current NeoFS epoch on server |
| Version | [uint32 ](#uint32 ) | | Version defines protocol version TODO: not used for now, should be implemented in future |
2020-01-30 11:41:24 +00:00
<!-- end messages -->
<!-- end enums -->
< a name = "service/verify.proto" > < / a >
< p align = "right" > < a href = "#top" > Top< / a > < / p >
## service/verify.proto
<!-- end services -->
< a name = "service.RequestVerificationHeader" > < / a >
### Message RequestVerificationHeader
RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request
(should be embedded into message).
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Signatures | [RequestVerificationHeader.Signature ](#service.RequestVerificationHeader.Signature ) | repeated | Signatures is a set of signatures of every passed NeoFS Node |
2020-04-24 16:18:28 +00:00
| Token | [Token ](#service.Token ) | | Token is a token of the session within which the request is sent |
2020-01-30 11:41:24 +00:00
< a name = "service.RequestVerificationHeader.Signature" > < / a >
### Message RequestVerificationHeader.Signature
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
2020-04-23 10:44:21 +00:00
| Sign | [bytes ](#bytes ) | | Sign is signature of the request or session key. |
| Peer | [bytes ](#bytes ) | | Peer is compressed public key used for signature. |
2020-01-30 11:41:24 +00:00
2020-04-24 16:18:28 +00:00
< a name = "service.Token" > < / a >
### Message Token
User token granting rights for object manipulation
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| info | [Token.Info ](#service.Token.Info ) | | Info is a grouped information about token |
| Signature | [bytes ](#bytes ) | | Signature is a signature of session token information |
< a name = "service.Token.Info" > < / a >
### Message Token.Info
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ID | [bytes ](#bytes ) | | ID is a token identifier. valid UUIDv4 represented in bytes |
| OwnerID | [bytes ](#bytes ) | | OwnerID is an owner of manipulation object |
| verb | [Token.Info.Verb ](#service.Token.Info.Verb ) | | Verb is a type of request for which the token is issued |
| Address | [refs.Address ](#refs.Address ) | | Address is an object address for which token is issued |
| Created | [uint64 ](#uint64 ) | | Created is an initial epoch of token lifetime |
| ValidUntil | [uint64 ](#uint64 ) | | ValidUntil is a last epoch of token lifetime |
| SessionKey | [bytes ](#bytes ) | | SessionKey is a public key of session key |
2020-01-30 11:41:24 +00:00
<!-- end messages -->
2020-04-24 16:18:28 +00:00
< a name = "service.Token.Info.Verb" > < / a >
### Token.Info.Verb
Verb is an enumeration of session request types
| Name | Number | Description |
| ---- | ------ | ----------- |
| Put | 0 | Put refers to object.Put RPC call |
| Get | 1 | Get refers to object.Get RPC call |
| Head | 2 | Head refers to object.Head RPC call |
| Search | 3 | Search refers to object.Search RPC call |
| Delete | 4 | Delete refers to object.Delete RPC call |
| Range | 5 | Range refers to object.GetRange RPC call |
| RangeHash | 6 | RangeHash refers to object.GetRangeHash RPC call |
2020-01-30 11:41:24 +00:00
<!-- end enums -->
## Scalar Value Types
| .proto Type | Notes | C++ Type | Java Type | Python Type |
| ----------- | ----- | -------- | --------- | ----------- |
| < a name = "double" / > double | | double | double | float |
| < a name = "float" / > float | | float | float | float |
| < a name = "int32" / > 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 |
| < a name = "int64" / > 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 |
| < a name = "uint32" / > uint32 | Uses variable-length encoding. | uint32 | int | int/long |
| < a name = "uint64" / > uint64 | Uses variable-length encoding. | uint64 | long | int/long |
| < a name = "sint32" / > sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
| < a name = "sint64" / > sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
| < a name = "fixed32" / > fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
| < a name = "fixed64" / > fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
| < a name = "sfixed32" / > sfixed32 | Always four bytes. | int32 | int | int |
| < a name = "sfixed64" / > sfixed64 | Always eight bytes. | int64 | long | int/long |
| < a name = "bool" / > bool | | bool | boolean | boolean |
| < a name = "string" / > string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
| < a name = "bytes" / > bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
