Skip to content

Commit cde4315

Browse files
author
David Christofas
committed
get public share methods also return the share password now
For some alternative public share authentication methods we need to be able to access the public share password. Some more details are documented here: cs3org#110
1 parent 47a362d commit cde4315

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

cs3/sharing/link/v1beta1/link_api.proto

+10
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ import "cs3/types/v1beta1/types.proto";
3939
// The Public Share Provider API is meant to manipulate public shares
4040
// also called public links.
4141
//
42+
// Access to public shares can be limitted by a password. The share
43+
// provider must store this password in a secure manner e.g. hashed
44+
// with the bcrypt algorithm.
45+
//
4246
// The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
4347
// NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
4448
// "OPTIONAL" in this document are to be interpreted as described in
@@ -220,6 +224,9 @@ message GetPublicShareResponse {
220224
// REQUIRED.
221225
// The share.
222226
PublicShare share = 3;
227+
// OPTIONAL.
228+
// The share password hash.
229+
string password_hash = 4;
223230
}
224231

225232
message GetPublicShareByTokenRequest {
@@ -244,4 +251,7 @@ message GetPublicShareByTokenResponse {
244251
// REQUIRED.
245252
// The share.
246253
PublicShare share = 3;
254+
// OPTIONAL.
255+
// The share password hash.
256+
string password_hash = 4;
247257
}

docs/index.html

+19-2
Original file line numberDiff line numberDiff line change
@@ -8519,6 +8519,14 @@ <h3 id="cs3.sharing.link.v1beta1.GetPublicShareByTokenResponse">GetPublicShareBy
85198519
The share. </p></td>
85208520
</tr>
85218521

8522+
<tr>
8523+
<td>password_hash</td>
8524+
<td><a href="#string">string</a></td>
8525+
<td></td>
8526+
<td><p>OPTIONAL.
8527+
The share password hash. </p></td>
8528+
</tr>
8529+
85228530
</tbody>
85238531
</table>
85248532

@@ -8593,6 +8601,14 @@ <h3 id="cs3.sharing.link.v1beta1.GetPublicShareResponse">GetPublicShareResponse<
85938601
The share. </p></td>
85948602
</tr>
85958603

8604+
<tr>
8605+
<td>password_hash</td>
8606+
<td><a href="#string">string</a></td>
8607+
<td></td>
8608+
<td><p>OPTIONAL.
8609+
The share password hash. </p></td>
8610+
</tr>
8611+
85968612
</tbody>
85978613
</table>
85988614

@@ -8994,7 +9010,7 @@ <h3 id="cs3.sharing.link.v1beta1.UpdatePublicShareRequest.Update.Type">UpdatePub
89949010

89959011

89969012
<h3 id="cs3.sharing.link.v1beta1.LinkAPI">LinkAPI</h3>
8997-
<p>PublicShare Provider API</p><p>The Public Share Provider API is meant to manipulate public shares</p><p>also called public links.</p><p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL</p><p>NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and</p><p>"OPTIONAL" in this document are to be interpreted as described in</p><p>RFC 2119.</p><p>The following are global requirements that apply to all methods:</p><p>Any method MUST return CODE_OK on a succesful operation.</p><p>Any method MAY return NOT_IMPLEMENTED.</p><p>Any method MAY return INTERNAL.</p><p>Any method MAY return UNKNOWN.</p><p>Any method MAY return UNAUTHENTICATED.</p>
9013+
<p>PublicShare Provider API</p><p>The Public Share Provider API is meant to manipulate public shares</p><p>also called public links.</p><p>Access to public shares can be limitted by a password. The share</p><p>provider must store this password in a secure manner e.g. hashed</p><p>with the bcrypt algorithm.</p><p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL</p><p>NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and</p><p>"OPTIONAL" in this document are to be interpreted as described in</p><p>RFC 2119.</p><p>The following are global requirements that apply to all methods:</p><p>Any method MUST return CODE_OK on a succesful operation.</p><p>Any method MAY return NOT_IMPLEMENTED.</p><p>Any method MAY return INTERNAL.</p><p>Any method MAY return UNKNOWN.</p><p>Any method MAY return UNAUTHENTICATED.</p>
89989014
<table class="enum-table">
89999015
<thead>
90009016
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
@@ -13558,7 +13574,8 @@ <h3 id="cs3.storage.provider.v1beta1.RecycleItem">RecycleItem</h3>
1355813574
<td><a href="#string">string</a></td>
1355913575
<td></td>
1356013576
<td><p>REQUIRED.
13561-
The original path of the deleted resource. </p></td>
13577+
The original path of the deleted resource.
13578+
MUST start with the slash character (/). </p></td>
1356213579
</tr>
1356313580

1356413581
<tr>

0 commit comments

Comments
 (0)