Skip to content

Commit f4b7131

Browse files
KrausMatthiasMatthias KrausMahdiBaghbani
authored
Identify values which are an OCM Address (#244)
* Identify values which are an OCM Address Clarify which values are OCM Addresses, so implementers know which can be used for discovery. * Fix it's to its * Fix line length to 72 chars * Revert OCM Address mentions where previously 'field' was used * Add Matthias Kraus to Acknowledgements --------- Co-authored-by: Matthias Kraus <info@opengeomesh.org> Co-authored-by: Mahdi Baghbani <Mahdi.baghbani1@gmail.com>
1 parent eea0498 commit f4b7131

2 files changed

Lines changed: 19 additions & 15 deletions

File tree

IETF-RFC.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,11 @@ Remote Resource if accepted by the Invite Receiver OCM Server.
9595
access rights to a Resource; it MAY also refer to a record in a
9696
database representing this rule.
9797
* __Sending Party__ - A person or party who is authorized to create
98-
Shares; similar to "Resource Owner" in OAuth.
98+
Shares; similar to "Resource Owner" in OAuth, identified by its
99+
OCM Address.
99100
* __Receiving Party__ - A person, group or party who is granted access
100101
to the Resource through the Share; similar to "Requesting Party / RqP"
101-
in OAuth-UMA.
102+
in OAuth-UMA, identified by its OCM Address.
102103
* __Share Creation Notification__ - A server-to-server request from the
103104
sending server to the receiving server, notifying the receiving server
104105
that a Share has been created.
@@ -146,8 +147,10 @@ Sending Server or vice versa, using the OCM Notifications endpoint.
146147
* __Invite Message__ - Out-of-band message used to establish contact
147148
between parties and servers in the Invite Flow, containing an Invite
148149
Token (see below) and the Invite Sender's OCM Address.
149-
* __Invite Sender__ - The party sending an Invite.
150-
* __Invite Receiver__ - The party receiving an Invite.
150+
* __Invite Sender__ - The party sending an Invite, identified by its
151+
OCM Address.
152+
* __Invite Receiver__ - The party receiving an Invite, identified by its
153+
OCM Address.
151154
* __Invite Sender OCM Server__ - The server holding an address book
152155
used by the Invite Sender, to which details of the Invite Receiver are
153156
to be added.
@@ -612,7 +615,7 @@ with the fields as described below
612615
## Fields
613616

614617
* REQUIRED shareWith (string)
615-
Consumer specific identifier of the user, group or federation
618+
OCM Address of the user, group or federation
616619
the provider wants to share the Resource with. This is known
617620
in advance. Please note that the consumer service endpoint is
618621
known in advance as well, so this is no part of the request
@@ -632,11 +635,11 @@ with the fields as described below
632635
repeated.
633636
Example: 7c084226-d9a1-11e6-bf26-cec0c932ce01
634637
* REQUIRED owner (string) -
635-
Provider specific identifier of the user who owns the
638+
OCM Address of the user who owns the
636639
Resource.
637640
Example: "6358b71804dfa8ab069cf05ed1b0ed2a@apiwise.nl"
638641
* REQUIRED sender (string) -
639-
Provider specific identifier of the user that wants to share
642+
OCM Address of the user that wants to share
640643
the Resource. Please note that the requesting provider is
641644
being identified on a higher level, so the former `remote`
642645
property is not part of the request body.
@@ -780,8 +783,8 @@ request body
780783
* no keypair is trusted or discoverable from the FQDN part of the
781784
`sender` field in the request body
782785
* the keypair used to generate the HTTP Signature doesn't match the one
783-
trusted or discoverable from the FQDN part of the `sender` field in the
784-
request body
786+
trusted or discoverable from the FQDN part of the `sender` field
787+
in the request body
785788
* the Sending Server is denylisted
786789
* the Sending Server is not allowlisted
787790
* the Sending Party is not trusted by the Receiving Party (e.g., no
@@ -1156,9 +1159,10 @@ Woojin Seok, Rogier Spoor, Christian Sprajc, Peter Szegedi,
11561159
Ron Trompert, Benedikt Wegmann and Johnatan Xu.
11571160

11581161
We would also like to thank Ishank Arora, Gianmaria Del Monte,
1159-
Jörn Friedrich Dreyer, Richard Freitag, Hugo González Labrador,
1160-
Maxence Lange, Lovisa Lugnegård, Sandro Mesterheide, Antoon Prins and
1161-
Björn Schießle for their direct contributions to the specification.
1162+
Jörn Friedrich Dreyer, Richard Freitag, Hugo González Labrador,
1163+
Matthias Kraus, Maxence Lange, Lovisa Lugnegård, Sandro Mesterheide,
1164+
Antoon Prins and Björn Schießle for their direct contributions
1165+
to the specification.
11621166

11631167
Over the years many more people have been involved in the development
11641168
of OCM. We would like to thank all of them for their contributions,

spec.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ components:
489489
shareWith:
490490
type: string
491491
description: >
492-
Consumer specific identifier of the user, group or federation the
492+
OCM Address of the user, group or federation the
493493
provider
494494
wants to share the resource with. This is known in advance.
495495
Please note that the consumer service endpoint is known in advance
@@ -515,12 +515,12 @@ components:
515515
example: 7c084226-d9a1-11e6-bf26-cec0c932ce01
516516
owner:
517517
description: |
518-
Provider specific identifier of the user who owns the resource.
518+
OCM Address of the user who owns the resource.
519519
type: string
520520
example: 6358b71804dfa8ab069cf05ed1b0ed2a@apiwise.nl
521521
sender:
522522
description: |
523-
Provider specific identifier of the user that wants to share the
523+
OCM Address of the user that wants to share the
524524
resource. Please note that the requesting provider is being
525525
identified on a higher level, so the former `remote` property
526526
is not part of the request body.

0 commit comments

Comments
 (0)