From 85a921ed915788b2dd40b2d536d6e097ef42c13e Mon Sep 17 00:00:00 2001 From: Micke Nordin Date: Sat, 27 Dec 2025 20:18:18 +0100 Subject: [PATCH 1/2] Change my-cloud-storage.org -> cloud.example.org According to the Internet-Draft Author Resources at: https://authors.ietf.org/en/example-addresses and RFC 2606: https://datatracker.ietf.org/doc/rfc2606/ we should use appointed example domain names and for these examples a second level example domain is appropriate, and .org is used here as the tld as in the previous examples. --- IETF-RFC.md | 18 +++++++++--------- spec.yaml | 12 ++++++------ 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/IETF-RFC.md b/IETF-RFC.md index dbf887d..6c587a7 100644 --- a/IETF-RFC.md +++ b/IETF-RFC.md @@ -131,7 +131,7 @@ related concepts from OAuth [RFC6749] and elsewhere: another reason. * __Sharing User__ - A user providing access to a Resource through a Share. -* __FQDN__ - Fully Qualified Domain Name, such as `"cloud.example.com"`. +* __FQDN__ - Fully Qualified Domain Name, such as `"cloud.example.org"`. * __OCM Server__ - A server that supports OCM. * __OCM API Discovery__ - Process of evaluating properties of a Remote Resource, after establishing contact with an OCM Server. @@ -439,8 +439,8 @@ and a `provider`. There are two recognized formats: joined by an `@` sign. Example: If the `token` is `a55a966e-15c1-4cb9-a39d-4e4c54399baf` and the - `provider` is `my-cloud-storage.org`, the combined string is - `a55a966e-15c1-4cb9-a39d-4e4c54399baf@my-cloud-storage.org`, + `provider` is `cloud.example.org`, the combined string is + `a55a966e-15c1-4cb9-a39d-4e4c54399baf@cloud.example.org`, which when base64-encoded becomes `YTU1YTk2NmUtMTVjMS00Y2I5LWEzOWQtNGU0YzU0Mzk5YmFmQG15LWNsb3VkLXN0b 3JhZ2Uub3Jn`. @@ -453,7 +453,7 @@ and a `provider`. There are two recognized formats: If the inviting OCM Server supports a WAYF page, the invite may be provided as a link with the token as a request parameter. Example: - `https://my-cloud-storage.org/wayf?token= + `https://cloud.example.org/wayf?token= a55a966e-15c1-4cb9-a39d-4e4c54399baf` Implementations MUST be able to accept invites in the invite string @@ -582,7 +582,7 @@ contain the following information about its OCM API: * REQUIRED: apiVersion (string) - The OCM API version this endpoint supports. Example: `"1.2.2"` * REQUIRED: endPoint (string) - The URI of the OCM API available at - this endpoint. Example: `"https://my-cloud-storage.org/ocm"` + this endpoint. Example: `"https://cloud.example.org/ocm"` * OPTIONAL: provider (string) - A friendly branding name of this endpoint. Example: `"MyCloudStorage"` * REQUIRED: resourceTypes (array) - A list of all resource types this @@ -683,7 +683,7 @@ contain the following information about its OCM API: - REQUIRED keyId (string) unique id of the key in URI format. The hostname set the origin of the request and MUST be identical to the current discovery endpoint. - Example: https://my-cloud-storage.org/ocm#signature + Example: https://cloud.example.org/ocm#signature - REQUIRED publicKeyPem (string) - PEM-encoded RSA public key for draft-cavage signatures. Example: @@ -695,7 +695,7 @@ contain the following information about its OCM API: is present. Each object in the array MUST contain: - REQUIRED keyId (string) - Unique identifier for this key in URI format. Hostname MUST match the discovery endpoint hostname. - Example: https://my-cloud-storage.org/ocm#key-1 + Example: https://cloud.example.org/ocm#key-1 - REQUIRED publicKeyPem (string) - PEM-encoded public key for [RFC9421] signatures. Example: @@ -716,7 +716,7 @@ contain the following information about its OCM API: Sending Server can exchange a secret for a short-lived bearer token. Implementations that offer the `"exchange-token"` capability MUST provide this URL as well. - Example: `"https://my-cloud-storage.org/ocm/token"`. + Example: `"https://cloud.example.org/ocm/token"`. # Share Creation Notification @@ -1070,7 +1070,7 @@ follows an example of such POST request: ``` POST {tokenEndPoint} HTTP/1.1 -Host: my-cloud-storage.org +Host: cloud.example.org Date: Wed, 05 Nov 2025 14:00:00 GMT Content-Type: application/x-www-form-urlencoded Digest: SHA-256=ok6mQ3WZzKc8nb7s/Jt2yY1uK7d2n8Zq7dhl3Q0s1xk= diff --git a/spec.yaml b/spec.yaml index 4c984ef..724066c 100644 --- a/spec.yaml +++ b/spec.yaml @@ -12,7 +12,7 @@ servers: - url: https://{discovery_fqdn} variables: discovery_fqdn: - default: my-cloud-storage.org + default: cloud.example.org paths: /.well-known/ocm: get: @@ -21,7 +21,7 @@ paths: Following [RFC8615], this endpoint returns the properties and capabilities offered by an OCM Server. This endpoint MUST be served at the OCM Server's root FQDN, e.g. as in - `https://my-cloud-storage.org/.well-known/ocm`. See [OCM API Discovery](https://github.com/cs3org/OCM-API/blob/develop/IETF-RFC.md#ocm-api-discovery) + `https://cloud.example.org/.well-known/ocm`. See [OCM API Discovery](https://github.com/cs3org/OCM-API/blob/develop/IETF-RFC.md#ocm-api-discovery) for more details. responses: "200": @@ -312,7 +312,7 @@ components: endPoint: type: string description: The URI of the OCM API available at this endpoint - example: https://my-cloud-storage.org/ocm + example: https://cloud.example.org/ocm provider: type: string description: A friendly branding name of this endpoint @@ -434,7 +434,7 @@ components: description: > unique id of the key in URI format. The hostname set the origin of the request and MUST be identical to the current discovery endpoint. - example: https://my-cloud-storage.org/ocm#signature + example: https://cloud.example.org/ocm#signature publicKeyPem: type: string description: | @@ -462,7 +462,7 @@ components: description: > Unique identifier for this key in URI format. Hostname MUST match the discovery endpoint hostname. - example: https://my-cloud-storage.org/ocm#key-1 + example: https://cloud.example.org/ocm#key-1 publicKeyPem: type: string description: | @@ -789,7 +789,7 @@ components: viewMode: read ssh: accessType: ['datatx'] - uri: extuser@my-cloud-storage.org:/7c084226-d9a1-11e6-bf26-cec0c932ce01 + uri: extuser@cloud.example.org:/7c084226-d9a1-11e6-bf26-cec0c932ce01 NewNotification: type: object required: From 068f3da9a8511ca06a72932b522cb04fd23d44a2 Mon Sep 17 00:00:00 2001 From: Giuseppe Lo Presti Date: Mon, 29 Dec 2025 09:13:59 +0100 Subject: [PATCH 2/2] One more example.com cleaned up --- IETF-RFC.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/IETF-RFC.md b/IETF-RFC.md index ed796a9..e6addf0 100644 --- a/IETF-RFC.md +++ b/IETF-RFC.md @@ -710,8 +710,8 @@ contain the following information about its OCM API: `"invites"` capability SHOULD provide this URL as well in order to enhance the UX of the Invite Flow. If for example `"/index.php/apps/sciencemesh/accept"` is specified here then a WAYF - Page SHOULD redirect the end-user to -`/index.php/apps/sciencemesh/accept?token=zi5kooKu3ivohr9a&providerDomain=example.com`. + Page SHOULD redirect the end-user to `/index.php/apps/sciencemesh/ + accept?token=zi5kooKu3ivohr9a&providerDomain=cloud.example.org`. * OPTIONAL: tokenEndPoint (string) - URL of the token endpoint where the Sending Server can exchange a secret for a short-lived bearer token. Implementations that offer the `"exchange-token"` capability MUST