Skip to content

Commit 709cd61

Browse files
author
Matthias Kraus
committed
Specify the OCM Address format
Following discussion in #237 and #244
1 parent dced061 commit 709cd61

File tree

1 file changed

+32
-8
lines changed

1 file changed

+32
-8
lines changed

IETF-RFC.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,31 @@ related concepts from OAuth [RFC6749] and elsewhere:
139139
OCM API Discovery.
140140
* __Discoverable Server__ - A server that tries to supply information in
141141
OCM API Discovery.
142-
* __OCM Address__ - A string of the form
143-
`<Receiving Party's identifier>@<fqdn>` which can be used to uniquely
144-
identify a user or group "at" an OCM Server and MAY be referred to as
145-
Federated Cloud ID.
146-
`<Receiving Party's identifier>` is an opaque string, unique at the
147-
server. `<fqdn>` is the Fully Qualified Domain Name by which the
148-
server is identified. This MUST be the domain at which the
149-
`/.well-known/ocm` endpoint of that server is hosted.
142+
* __OCM Address__ - identifies a user or group "at" an OCM Server.
143+
The OCM Address contains a server specific Party identifier, a host
144+
locating the OCM Server and an optional port. The OCM Address is not a
145+
URI as it does not have scheme and the identifier may contain reserved
146+
characters.
147+
148+
ocm-address = identifier "@" host [ ":" port]
149+
150+
The identifier is an opaque, case-sensitive utf-8 string. It is
151+
separated from the host by the last "@" in the OCM Address.
152+
host is an IP literal encapsulated within square brackets, an IPv4
153+
address in dotted decimal form, or a registered name as described in
154+
[RFC3986].
155+
156+
host = IP-literal / IPv4address / reg-name
157+
158+
The optional port subcomponent can be used to specify a port to use for
159+
discovery. Implementers SHOULD omit the port component and its ":"
160+
delimiter if its value would be the same as the default ports "443" or
161+
"80" of HTTPS or HTTP.
162+
163+
The OCM Server MUST be discoverable at the given host and optional port
164+
via the Well-Known [RFC8615] path `/.well-known/ocm`. The OCM Address
165+
MUST NOT contain a path.
166+
150167
* __OCM Notification__ - A message from the Receiving Server to the
151168
Sending Server or vice versa, using the OCM Notifications endpoint.
152169
* __Invite Message__ - Out-of-band message used to establish contact
@@ -1001,6 +1018,13 @@ Key Words](https://datatracker.ietf.org/html/rfc8174)", May 2017.
10011018
[RFC9421] Backman, A., Richer, J. and Sporny, M. "[HTTP Message
10021019
Signatures](https://tools.ietf.org/html/rfc9421)", February 2024.
10031020

1021+
[RFC3986] Berners-Lee, T., Fielding, R. and Masinter, L. "[Uniform
1022+
Resource Identifier (URI): Generic Syntax]
1023+
(https://datatracker.ietf.org/doc/html/rfc3986)", January 2005
1024+
1025+
[RFC8615] Nottingham, M. "[Well-Known Uniform Resource Identifiers
1026+
(URIs)](https://datatracker.ietf.org/doc/html/rfc8615)", May 2019
1027+
10041028

10051029
## Informative References
10061030

0 commit comments

Comments
 (0)