[#55] container: add a comment about signature restrictions

Signed-off-by: Evgenii Stratonikov <[email protected]>
nspcc-dev · Feb 22, 2022 · 478c388 · 478c388
1 parent 3302a53
commit 478c388
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 10 deletions.
diff --git a/container/service.proto b/container/service.proto
@@ -96,7 +96,8 @@ message PutRequest {
     // Container structure to register in NeoFS
     container.Container container = 1;
 
-    // Signature of a stable-marshalled container according to RFC-6979
+    // Signature of a stable-marshalled container according to RFC-6979.
+    // Signature scheme must be either UNSPECIFIED or ECDSA_RFC6979_SHA256.
     neo.fs.v2.refs.Signature signature =2;
   }
   // Body of container put request message.
@@ -144,7 +145,8 @@ message DeleteRequest {
     // Identifier of the container to delete from NeoFS
     neo.fs.v2.refs.ContainerID container_id = 1;
 
-    // `ContainerID` signed with the container owner's key according to RFC-6979
+    // `ContainerID` signed with the container owner's key according to RFC-6979.
+    // Signature scheme must be either UNSPECIFIED or ECDSA_RFC6979_SHA256.
     neo.fs.v2.refs.Signature signature = 2;
   }
   // Body of container delete request message.
@@ -207,7 +209,8 @@ message GetResponse {
     // Requested container structure
     Container container = 1;
 
-    // Signature of a stable-marshalled container according to RFC-6979
+    // Signature of a stable-marshalled container according to RFC-6979.
+    // Signature scheme must be either UNSPECIFIED or ECDSA_RFC6979_SHA256.
     neo.fs.v2.refs.Signature signature = 2;
 
     // Session token if the container was created within a session
@@ -275,7 +278,8 @@ message SetExtendedACLRequest {
     // Extended ACL table to set for container
     neo.fs.v2.acl.EACLTable eacl = 1;
 
-    // Signature of stable-marshalled Extended ACL table according to RFC-6979
+    // Signature of stable-marshalled Extended ACL table according to RFC-6979.
+    // Signature scheme must be either UNSPECIFIED or ECDSA_RFC6979_SHA256.
     neo.fs.v2.refs.Signature signature = 2;
   }
   // Body of set extended acl request message.
@@ -341,7 +345,8 @@ message GetExtendedACLResponse {
     // Extended ACL requested, if available
     neo.fs.v2.acl.EACLTable eacl = 1;
 
-    // Signature of stable-marshalled Extended ACL according to RFC-6979
+    // Signature of stable-marshalled Extended ACL according to RFC-6979.
+    // Signature scheme must be either UNSPECIFIED or ECDSA_RFC6979_SHA256.
     neo.fs.v2.refs.Signature signature = 2;
 
     // Session token if Extended ACL was set within a session

diff --git a/proto-docs/container.md b/proto-docs/container.md
@@ -259,7 +259,7 @@ smart contract, so signing algorithm must be supported by NeoVM.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) |  | Identifier of the container to delete from NeoFS |
-| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) |  | `ContainerID` signed with the container owner's key according to RFC-6979 |
+| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) |  | `ContainerID` signed with the container owner's key according to RFC-6979. Signature scheme must be either UNSPECIFIED or ECDSA_RFC6979_SHA256. |
 
 
 <a name="neo.fs.v2.container.DeleteResponse"></a>
@@ -332,7 +332,7 @@ container creation.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | eacl | [neo.fs.v2.acl.EACLTable](#neo.fs.v2.acl.EACLTable) |  | Extended ACL requested, if available |
-| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) |  | Signature of stable-marshalled Extended ACL according to RFC-6979 |
+| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) |  | Signature of stable-marshalled Extended ACL according to RFC-6979. Signature scheme must be either UNSPECIFIED or ECDSA_RFC6979_SHA256. |
 | session_token | [neo.fs.v2.session.SessionToken](#neo.fs.v2.session.SessionToken) |  | Session token if Extended ACL was set within a session |
 
 
@@ -383,7 +383,7 @@ was already verified on container creation.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | container | [Container](#neo.fs.v2.container.Container) |  | Requested container structure |
-| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) |  | Signature of a stable-marshalled container according to RFC-6979 |
+| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) |  | Signature of a stable-marshalled container according to RFC-6979. Signature scheme must be either UNSPECIFIED or ECDSA_RFC6979_SHA256. |
 | session_token | [neo.fs.v2.session.SessionToken](#neo.fs.v2.session.SessionToken) |  | Session token if the container was created within a session |
 
 
@@ -461,7 +461,7 @@ additional signature checks.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | container | [Container](#neo.fs.v2.container.Container) |  | Container structure to register in NeoFS |
-| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) |  | Signature of a stable-marshalled container according to RFC-6979 |
+| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) |  | Signature of a stable-marshalled container according to RFC-6979. Signature scheme must be either UNSPECIFIED or ECDSA_RFC6979_SHA256. |
 
 
 <a name="neo.fs.v2.container.PutResponse"></a>
@@ -514,7 +514,7 @@ reference. It will be taken from `EACLTable.container_id` field.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | eacl | [neo.fs.v2.acl.EACLTable](#neo.fs.v2.acl.EACLTable) |  | Extended ACL table to set for container |
-| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) |  | Signature of stable-marshalled Extended ACL table according to RFC-6979 |
+| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) |  | Signature of stable-marshalled Extended ACL table according to RFC-6979. Signature scheme must be either UNSPECIFIED or ECDSA_RFC6979_SHA256. |
 
 
 <a name="neo.fs.v2.container.SetExtendedACLResponse"></a>