From 627a0dfcc7ba37586e5b6e3485176c35887641a8 Mon Sep 17 00:00:00 2001 From: Michiel de Jong Date: Thu, 5 Sep 2024 10:11:46 +0200 Subject: [PATCH] Consolidate assumptions about dynamically registering a Receiving Server a trusted, ref #26 --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 3e94a26..b595ae2 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,6 @@ the equivalent [OpenAPI](https://github.com/OAI/OpenAPI-Specification) (fka Swag ## Scope and assumptions -* For the core sharing functionality, the provider knows the consumer (both endpoint and user) when it creates a share with the consumer (also see [#26](https://github.com/cs3org/OCM-API/issues/26)). In addition, an optional invitation workflow is available in this specification (see below), which gives the consumer a way to automatically trust a provider (and vice versa). The [ScienceMesh](https://sciencemesh.io) infrastructure provides a managed white list of trusted federated sites. * Consumer doesn't have to accept a share, the resource will be available to the consumer immediately ([#25](https://github.com/cs3org/OCM-API/issues/25)). * Dealing with incoming shares is a vendor specific implementation. One vendor might use an 'accept before' process while another vendor might use a 'decline after' approach. This is considered part of the UX and thus not part of the interaction between different vendors. However, the consumer could notify the provider by using the introduced `/notifications` endpoint (also see [#27](https://github.com/cs3org/OCM-API/issues/27)). * Reverting access to outgoing shares is a vendor specific implementation. One vendor might delete an entire share while another might invalidate an access token. This is considered part of vendor-specific internals and thus not part of the interaction between different vendors. However, the provider could notify the consumer by using the introduced `/notifications` endpoint (also see [#27](https://github.com/cs3org/OCM-API/issues/27)). @@ -169,7 +168,7 @@ If the FQDN passes the denylist and/or allowlist checks, but no details about it This process MAY be influenced by a VPN connection and/or IP allowlisting. Otherwise, for instance -when a sending server allows sharing to any internet-hosted receiving server, then discovery can happen from the Receiving Server FQDN, using `https:///.well-known/ocm` (or `https:///ocm-provider`, for backwards compatibility) as the URL. The Receiving Server SHOULD provide both of these. See the [API specification](https://cs3org.github.io/OCM-API/docs.html?branch=develop&repo=OCM-API&user=cs3org#/paths/~1.well-known~1ocm/get) for a normative definition of both endpoints. +when a sending server allows sharing to any internet-hosted receiving server, then trust can be established dynamically, and OCM API discovery can happen from the Receiving Server FQDN, using `https:///.well-known/ocm` (or `https:///ocm-provider`, for backwards compatibility) as the URL. The Receiving Server SHOULD provide both of these. See the [API specification](https://cs3org.github.io/OCM-API/docs.html?branch=develop&repo=OCM-API&user=cs3org#/paths/~1.well-known~1ocm/get) for a normative definition of both endpoints. To help with situations where hosting `https:///.well-known/ocm` or `https:///ocm-provider` is impractical, a further discovery mechanism MAY be provided, based on DNS `SRV` Service Records.