Skip to content

Commit ff9e33f

Browse files
committed
Address feedback from @KrausMatthias
1 parent 75c89ee commit ff9e33f

File tree

1 file changed

+16
-36
lines changed

1 file changed

+16
-36
lines changed

IETF-RFC.md

Lines changed: 16 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,12 @@ take on: the _Sending Server_ role and the _Receiving Server_ role.
111111

112112
A Sending Server is an OCM Provider that holds Resources and exposes
113113
APIs to allow access to them. It allows its users to create _Shares_
114-
or _Invites_ to give other users access to those Resources. A Sending
115-
Server MAY provide its users with the ability to generate _Invites_ to
116-
establish contact with other users on other OCM Providers. When doing
117-
so it MAY provide a _WAYF Page_ to facilitate the Invite Flow. The WAYF
118-
page MAY be limited to a set of trusted OCM Providers, for instance
119-
those in the same _Federation_.
114+
to give other users access to those Resources. A Sending Server MAY
115+
provide its users with the ability to generate _Invites_ to establish
116+
contact with other users on other OCM Providers. When doing so it MAY
117+
provide a _WAYF Page_ to facilitate the Invite Flow. The WAYF page MAY
118+
be limited to a set of trusted OCM Providers, for instance those in the
119+
same _Federation_.
120120

121121

122122
### Receiving Server
@@ -139,8 +139,8 @@ the concepts and their relationships.
139139
An _OCM Provider_ MAY offer its _Users_ an address book tool, where OCM
140140
Addresses can be stored over time in a labeled and/or searchable way.
141141
This decouples the act by which the OCM Address string is passed into
142-
the Sending Server's database from the selection of the Receiving Party
143-
in preparation for Share Creation.
142+
the Sending Server's database from the selection of the _Receiving
143+
Party_ in preparation for Share Creation.
144144

145145
The Address Book entity maintains a collection of contacts for a user
146146
within the OCM provider. It serves as the primary mechanism for managing
@@ -181,7 +181,7 @@ A Contact represents a federated user relationship established through
181181
the OCM protocol. Contacts are stored in _Address Books_ and may be
182182
created through the Invite process or via direct entry. A Contact MAY
183183
of course contain much more detailed information about the referenced
184-
user.
184+
user such as if it was added via _Invites_ or direct entry.
185185

186186
```
187187
+-----------------+
@@ -190,8 +190,8 @@ user.
190190
| - addedDate |
191191
| - email |
192192
| - name |
193-
| - ocmAddress |
194-
| - trusted |
193+
| - provider |
194+
| - userID |
195195
+-----------------+
196196
^
197197
| referenced by
@@ -205,17 +205,8 @@ user.
205205
* __addedDate__: Timestamp of when contact was added
206206
* __email__: Contact email address (informational)
207207
* __name__: Human-readable display name
208-
* __ocmAddress__: Full OCM Address
209-
* __trusted__: Indicates if contact has been added through the
210-
Invite flow (trusted), via direct entry (untrusted)
211-
or is blocked
212208
* __userID__: The identifier of the contact at their OCM Server
213-
214-
##### Contact States
215-
216-
* __Blocked__: Contact blocked from sending Shares
217-
* __Trusted__: Established through completed Invite flow
218-
* __Untrusted__: Added directly without Invite verification
209+
* __provider__: The FQDN of the contact's OCM Server
219210

220211
#### Relationships
221212

@@ -234,7 +225,6 @@ on different OCM Servers.
234225
| - acceptedTime |
235226
| - createdTime |
236227
| - sender: User |
237-
| - status |
238228
| - token |
239229
+-----------------+
240230
|
@@ -250,17 +240,9 @@ on different OCM Servers.
250240
* __acceptedTime__: Timestamp of invite acceptance (if accepted)
251241
* __createdTime__: Timestamp of invite creation
252242
* __sender__: Reference to the User who sent the Invite
253-
* __status__: Current state (pending, accepted, expired, revoked)
254243
* __token__: Unique, hard-to-guess string generated by Invite Sender
255244
OCM Server
256245

257-
##### Invite States
258-
259-
* __Accepted__: Invite successfully accepted by Invite Receiver
260-
* __Expired__: Invite no longer valid after a certain time
261-
* __Pending__: Invite created but not yet accepted
262-
* __Revoked__: Invite invalidated by Invite Sender before acceptance
263-
264246
#### Relationships
265247

266248
* An Invite is generated by an Address Book entry action.
@@ -344,11 +326,10 @@ from a Sending Party to a Receiving Party.
344326
+------------------+ +------------------+
345327
| - expiration | |
346328
| - name | | mediates access to
347-
| - owner | v
348-
| - permissions[] | +------------------+
349-
| - protocol | | Resource (remote)|
350-
| - providerId | +------------------+
351-
| - requirements[] |
329+
| - owner | v
330+
| - protocol | +------------------+
331+
| - providerId | | Resource (remote)|
332+
| - requirements[] | +------------------+
352333
| - resourceType |
353334
| - sender |
354335
| - shareType |
@@ -368,7 +349,6 @@ from a Sending Party to a Receiving Party.
368349
* __expiration__: Optional expiration timestamp
369350
* __name__: Human-readable name of the shared Resource
370351
* __owner__: OCM Address of the Resource owner
371-
* __permissions__: Array of granted permissions (read, write, share)
372352
* __protocol__: Access protocol configuration (webdav, webapp, datatx)
373353
* __providerId__: Unique identifier for the Share at the provider
374354
* __requirements__: Array of access requirements (must-use-mfa,

0 commit comments

Comments
 (0)