diff --git a/cs3/sharing/link/v1beta1/link_api.proto b/cs3/sharing/link/v1beta1/link_api.proto index 3244a84c..776ab86f 100644 --- a/cs3/sharing/link/v1beta1/link_api.proto +++ b/cs3/sharing/link/v1beta1/link_api.proto @@ -39,6 +39,10 @@ import "cs3/types/v1beta1/types.proto"; // The Public Share Provider API is meant to manipulate public shares // also called public links. // +// Access to public shares can be limitted by a password. The share +// provider must store this password in a secure manner e.g. hashed +// with the bcrypt algorithm. +// // The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL // NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and // "OPTIONAL" in this document are to be interpreted as described in @@ -220,6 +224,9 @@ message GetPublicShareResponse { // REQUIRED. // The share. PublicShare share = 3; + // OPTIONAL. + // The share password hash. + string password = 4; } message GetPublicShareByTokenRequest { @@ -244,4 +251,7 @@ message GetPublicShareByTokenResponse { // REQUIRED. // The share. PublicShare share = 3; + // OPTIONAL. + // The share password hash. + string password = 4; } diff --git a/docs/index.html b/docs/index.html index 9adaba33..13cc9461 100644 --- a/docs/index.html +++ b/docs/index.html @@ -8519,6 +8519,14 @@
OPTIONAL. +The share password hash.
OPTIONAL. +The share password hash.
PublicShare Provider API
The Public Share Provider API is meant to manipulate public shares
also called public links.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
RFC 2119.
The following are global requirements that apply to all methods:
Any method MUST return CODE_OK on a succesful operation.
Any method MAY return NOT_IMPLEMENTED.
Any method MAY return INTERNAL.
Any method MAY return UNKNOWN.
Any method MAY return UNAUTHENTICATED.
+PublicShare Provider API
The Public Share Provider API is meant to manipulate public shares
also called public links.
Access to public shares can be limitted by a password. The share
provider must store this password in a secure manner e.g. hashed
with the bcrypt algorithm.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
RFC 2119.
The following are global requirements that apply to all methods:
Any method MUST return CODE_OK on a succesful operation.
Any method MAY return NOT_IMPLEMENTED.
Any method MAY return INTERNAL.
Any method MAY return UNKNOWN.
Any method MAY return UNAUTHENTICATED.
Method Name | Request Type | Response Type | Description | string | REQUIRED. -The original path of the deleted resource. |
+The original path of the deleted resource.
+MUST start with the slash character (/).