Skip to content

OCM: implement new webapp protocol #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
glpatcern merged 3 commits into from
Jun 15, 2026
Merged

OCM: implement new webapp protocol #274

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
234a1d9
Add a hidden optional flag for OCM received shares
glpatcern Jun 11, 2026
6c20f8a
OCM: implement new webapp protocol
glpatcern Jun 10, 2026
da798a0
Align OCM webdav protocol to use resource permissions
glpatcern Jun 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 52 additions & 29 deletions cs3/sharing/ocm/v1beta1/resources.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ message Share {
cs3.sharing.ocm.v1beta1.RecipientType recipient_type = 15;
}

// The permissions for a share.
// The permissions for an OCM share.
// Deprecated: reshare is redundant with grant permissions.
message SharePermissions {
storage.provider.v1beta1.ResourcePermissions permissions = 1;
bool reshare = 2;
Expand Down Expand Up @@ -168,6 +169,9 @@ message ReceivedShare {
// Destination path of the share, in case the shared resource type is EMBEDDED
// or the access type is DATATX.
string destination = 18;
// OPTIONAL.
// Flag to hide the share, defaults to false.
bool hidden = 19;
}

// The state of the share.
Expand Down Expand Up @@ -238,17 +242,6 @@ message ShareReference {
}
}

// A share grant specifies the share permissions
// for a grantee.
message ShareGrant {
// REQUIRED.
// The grantee of the grant.
storage.provider.v1beta1.Grantee grantee = 1;
// REQUIRED.
// The share permissions for the grant.
SharePermissions permissions = 2;
}

// The protocol which is used to get access to a remote OCM resource.
message Protocol {
// REQUIRED.
Expand All @@ -267,36 +260,57 @@ message Protocol {
}
}

// Defines the options for the WebDAV protocol.
// Defines the options for the WebDAV protocol, mapping
// to the `webdav` protocol in the OCM specifications.
message WebDAVProtocol {
// REQUIRED.
// Secret used to access the resource.
string shared_secret = 1;
// Permissions of the shared resource. Deprecated: use share_permissions instead.
cs3.sharing.ocm.v1beta1.SharePermissions permissions = 2 [deprecated = true];
// REQUIRED.
// Permissions of the shared resource.
cs3.sharing.ocm.v1beta1.SharePermissions permissions = 2;
// REQUIRED.
// Path-only URI used to access the resource.
// URI used to access the resource.
string uri = 3;
// OPTIONAL.
// The requirements for the share.
repeated string requirements = 4;
// OPTIONAL.
// Access types for the share, e.g. remote or data transfer. Defaults to remote.
repeated cs3.sharing.ocm.v1beta1.AccessType access_types = 5;
// REQUIRED.
// Permissions of the shared resource.
storage.provider.v1beta1.ResourcePermissions share_permissions = 6;
}

// Defines the options for the Webapp protocol.
// Defines the options for the Webapp protocol, mapping
// to the `webapp` protocol in the OCM specifications.
message WebappProtocol {
// REQUIRED.
// Path-only URI to open the resource with a remote app.
string uri = 1;
// Secret used to access the resource.
string shared_secret = 1;
// REQUIRED.
// View mode for the remote app.
cs3.app.provider.v1beta1.ViewMode view_mode = 2;
// Permissions of the shared resource.
storage.provider.v1beta1.ResourcePermissions share_permissions = 2;
Comment thread
glpatcern marked this conversation as resolved.
// REQUIRED.
// URI to open the resource with the remote app.
string uri = 3;
// REQUIRED.
// The requirements for the share.
repeated string requirements = 4;
// REQUIRED.
// The targets that can be used to display the remote app.
repeated string targets = 5;
// OPTIONAL.
// Secret used to access the resource.
string shared_secret = 3;
// A descriptive name of the remote app in the user interface.
string app_name = 6;
// OPTIONAL.
// A hint in the form of a media (MIME) type of the icon
// representing the remote app in the user interface.
string app_icon_hint = 7;
// OPTIONAL.
// An array of media (MIME) types that the remote application
// can handle.
repeated string media_types = 8;
}

// Defines the options for the Embedded protocol.
Expand Down Expand Up @@ -350,7 +364,8 @@ enum AccessType {
ACCESS_TYPE_DATATX = 2;
}

// Defines how the remote OCM recipient accesses a local resource.
// Defines how a remote OCM recipient accesses a local resource when
// serving a share. This is a subset of the OCM protocol specifications.
message AccessMethod {
// REQUIRED.
// One of the access method MUST be specified.
Expand All @@ -365,7 +380,8 @@ message AccessMethod {
}
}

// Defines the options for the WebDAV access method.
// Defines the options for the WebDAV access method, representing
// how a remote user accesses a local resource via the `webdav` OCM protocol.
message WebDAVAccessMethod {
// REQUIRED.
// The permissions for the share.
Expand All @@ -378,9 +394,16 @@ message WebDAVAccessMethod {
repeated cs3.sharing.ocm.v1beta1.AccessType access_types = 3;
}

// Defines the options for the Webapp access method.
// Defines the options for the Webapp access method, representing
// how a remote user accesses a local app via the `webapp` OCM protocol.
message WebappAccessMethod {
// REQUIRED.
// The view mode for the share.
cs3.app.provider.v1beta1.ViewMode view_mode = 1;
// The permissions for the share.
storage.provider.v1beta1.ResourcePermissions permissions = 1;
// REQUIRED.
// The requirements for the share.
repeated string requirements = 2;
// OPTIONAL.
// A descriptive name of the app in the remote user interface.
string app_name = 3;
}
Loading