diff --git a/proto-docs/service.md b/proto-docs/service.md index 3d01579..c2cdd29 100644 --- a/proto-docs/service.md +++ b/proto-docs/service.md @@ -8,6 +8,7 @@ - Messages - [BearerToken](#neo.fs.v2.service.BearerToken) - [BearerToken.Body](#neo.fs.v2.service.BearerToken.Body) + - [ObjectServiceContext](#neo.fs.v2.service.ObjectServiceContext) - [RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) - [ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) - [SessionToken](#neo.fs.v2.service.SessionToken) @@ -63,6 +64,18 @@ Bearer Token body | lifetime | [TokenLifetime](#neo.fs.v2.service.TokenLifetime) | | Token expiration and valid time period parameters | + + +### Message ObjectServiceContext +Context information for Session Tokens related to ObjectService requests + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| verb | [ObjectServiceContext.Verb](#neo.fs.v2.service.ObjectServiceContext.Verb) | | Verb is a type of request for which the token is issued | +| address | [neo.fs.v2.refs.Address](#neo.fs.v2.refs.Address) | | Related Object address | + + ### Message RequestMetaHeader @@ -117,10 +130,9 @@ Session token body | ----- | ---- | ----- | ----------- | | id | [bytes](#bytes) | | ID is a token identifier. valid UUIDv4 represented in bytes | | owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | OwnerID carries identifier of the session initiator. | -| verb | [SessionToken.Body.Verb](#neo.fs.v2.service.SessionToken.Body.Verb) | | Verb is a type of request for which the token is issued | | lifetime | [TokenLifetime](#neo.fs.v2.service.TokenLifetime) | | Lifetime is a lifetime of the session | | session_key | [bytes](#bytes) | | SessionKey is a public key of session key | -| object_address | [neo.fs.v2.refs.Address](#neo.fs.v2.refs.Address) | | object_address represents the object session context. | +| object_service | [ObjectServiceContext](#neo.fs.v2.service.ObjectServiceContext) | | ObjectService session context. | @@ -162,21 +174,21 @@ Extended headers for Request/Response - + -### SessionToken.Body.Verb -Verb is an enumeration of session request types +### ObjectServiceContext.Verb +Object request verbs | Name | Number | Description | | ---- | ------ | ----------- | | VERB_UNSPECIFIED | 0 | Unknown verb | -| OBJECT_PUT | 1 | Refers to object.Put RPC call | -| OBJECT_GET | 2 | Refers to object.Get RPC call | -| OBJECT_HEAD | 3 | Refers to object.Head RPC call | -| OBJECT_SEARCH | 4 | Refers to object.Search RPC call | -| OBJECT_DELETE | 5 | Refers to object.Delete RPC call | -| OBJECT_RANGE | 6 | Refers to object.GetRange RPC call | -| OBJECT_RANGEHASH | 7 | Refers to object.GetRangeHash RPC call | +| PUT | 1 | Refers to object.Put RPC call | +| GET | 2 | Refers to object.Get RPC call | +| HEAD | 3 | Refers to object.Head RPC call | +| SEARCH | 4 | Refers to object.Search RPC call | +| DELETE | 5 | Refers to object.Delete RPC call | +| RANGE | 6 | Refers to object.GetRange RPC call | +| RANGEHASH | 7 | Refers to object.GetRangeHash RPC call | diff --git a/service/meta.proto b/service/meta.proto index e74a606..5cfe6d1 100644 --- a/service/meta.proto +++ b/service/meta.proto @@ -39,6 +39,41 @@ message TokenLifetime { uint64 iat = 3; } +// Context information for Session Tokens related to ObjectService requests +message ObjectServiceContext { + // Object request verbs + enum Verb { + // Unknown verb + VERB_UNSPECIFIED = 0; + + // Refers to object.Put RPC call + PUT = 1; + + // Refers to object.Get RPC call + GET = 2; + + // Refers to object.Head RPC call + HEAD = 3; + + // Refers to object.Search RPC call + SEARCH = 4; + + // Refers to object.Delete RPC call + DELETE = 5; + + // Refers to object.GetRange RPC call + RANGE = 6; + + // Refers to object.GetRangeHash RPC call + RANGEHASH = 7; + } + // Verb is a type of request for which the token is issued + Verb verb = 1; + + // Related Object address + neo.fs.v2.refs.Address address = 2; +} + // NeoFS session token. message SessionToken { // Session token body @@ -49,45 +84,16 @@ message SessionToken { // OwnerID carries identifier of the session initiator. neo.fs.v2.refs.OwnerID owner_id = 2; - // Verb is an enumeration of session request types - enum Verb { - // Unknown verb - VERB_UNSPECIFIED = 0; - - // Refers to object.Put RPC call - OBJECT_PUT = 1; - - // Refers to object.Get RPC call - OBJECT_GET = 2; - - // Refers to object.Head RPC call - OBJECT_HEAD = 3; - - // Refers to object.Search RPC call - OBJECT_SEARCH = 4; - - // Refers to object.Delete RPC call - OBJECT_DELETE = 5; - - // Refers to object.GetRange RPC call - OBJECT_RANGE = 6; - - // Refers to object.GetRangeHash RPC call - OBJECT_RANGEHASH = 7; - } - // Verb is a type of request for which the token is issued - Verb verb = 3; - // Lifetime is a lifetime of the session - TokenLifetime lifetime = 4; + TokenLifetime lifetime = 3; // SessionKey is a public key of session key - bytes session_key = 5; + bytes session_key = 4; // Carries context of the session. oneof context { - // object_address represents the object session context. - neo.fs.v2.refs.Address object_address = 6; + // ObjectService session context. + ObjectServiceContext object_service = 5; } } // Session Token body diff --git a/service/verify.proto b/service/verify.proto index 77745c6..ecfab78 100644 --- a/service/verify.proto +++ b/service/verify.proto @@ -5,9 +5,6 @@ package neo.fs.v2.service; option go_package = "github.com/nspcc-dev/neofs-api-go/v2/service;service"; option csharp_namespace = "NeoFS.API.v2.Service"; -import "acl/types.proto"; -import "refs/types.proto"; - // Signature of something in NeoFS message Signature { // Public key used for signing.