From cd9d6cba2a05189f793a8e2554bf0f057e0a9b6c Mon Sep 17 00:00:00 2001
From: David Christofas <dchristofas@owncloud.com>
Date: Fri, 12 Mar 2021 12:11:13 +0100
Subject: [PATCH] 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: https://github.com/cs3org/cs3apis/issues/110
---
 cs3/sharing/link/v1beta1/link_api.proto | 10 ++++++++++
 docs/index.html                         | 21 +++++++++++++++++++--
 2 files changed, 29 insertions(+), 2 deletions(-)

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 @@ <h3 id="cs3.sharing.link.v1beta1.GetPublicShareByTokenResponse">GetPublicShareBy
 The share. </p></td>
                 </tr>
               
+                <tr>
+                  <td>password</td>
+                  <td><a href="#string">string</a></td>
+                  <td></td>
+                  <td><p>OPTIONAL.
+The share password hash. </p></td>
+                </tr>
+              
             </tbody>
           </table>
 
@@ -8593,6 +8601,14 @@ <h3 id="cs3.sharing.link.v1beta1.GetPublicShareResponse">GetPublicShareResponse<
 The share. </p></td>
                 </tr>
               
+                <tr>
+                  <td>password</td>
+                  <td><a href="#string">string</a></td>
+                  <td></td>
+                  <td><p>OPTIONAL.
+The share password hash. </p></td>
+                </tr>
+              
             </tbody>
           </table>
 
@@ -8994,7 +9010,7 @@ <h3 id="cs3.sharing.link.v1beta1.UpdatePublicShareRequest.Update.Type">UpdatePub
 
       
         <h3 id="cs3.sharing.link.v1beta1.LinkAPI">LinkAPI</h3>
-        <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>
+        <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>
         <table class="enum-table">
           <thead>
             <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>
                   <td><a href="#string">string</a></td>
                   <td></td>
                   <td><p>REQUIRED.
-The original path of the deleted resource. </p></td>
+The original path of the deleted resource.
+MUST start with the slash character (/). </p></td>
                 </tr>
               
                 <tr>