Skip to content

Commit 8ebe7d3

Browse files
authored
Add reference section (#252)
I have added Normative References and Informational References Normative References are also hyperlinked in the text to the respective RFC:s whereas Informational References are not.
1 parent f2d5cc1 commit 8ebe7d3

1 file changed

Lines changed: 30 additions & 9 deletions

File tree

IETF-RFC.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ transfers.
5353
Open Cloud Mesh handles interactions only up to the point where the
5454
Receiving Party is informed of their access to the Resource. Actual
5555
Resource access is subsequently managed by other protocols, such as
56-
WebDAV.
56+
[WebDAV](https://datatracker.ietf.org/doc/rfc4918/).
5757

5858
--- middle
5959
# Introduction
@@ -118,7 +118,9 @@ that a Share has been created.
118118
* actively or passively notifies the receiving user or group of any
119119
incoming Share Creation Notification,
120120
* acts as an API client, allowing the receiving user to access the
121-
Resource through an API (e.g., WebDAV) of the sending server.
121+
Resource through an API (e.g.,
122+
[WebDAV](https://datatracker.ietf.org/doc/rfc4918/)) of the sending
123+
server.
122124
* __Sending Gesture__ - A user interface interaction from the Sending
123125
Party to the Sending Server, conveying the intention to create a Share.
124126
* __Share Creation__ - The addition of a Share to the database state of
@@ -519,10 +521,11 @@ itself be an object containing the following fields:
519521
}
520522
```
521523
Fields:
522-
* webdav (string) - The top-level WebDAV path at this endpoint. In
523-
order to access a Remote Resource,
524-
implementations MAY use this path as a prefix, or
525-
as the full path (see sharing examples).
524+
* webdav (string) - The top-level
525+
[WebDAV](https://datatracker.ietf.org/doc/rfc4918/)
526+
path at this endpoint. In order to access a Remote
527+
Resource, implementations MAY use this path as a
528+
prefix, or as the full path (see sharing examples).
526529
* webapp (string) - The top-level path for web apps at this
527530
endpoint. This value is provided for documentation
528531
purposes, and it SHOULD NOT be intended as a prefix
@@ -531,7 +534,9 @@ itself be an object containing the following fields:
531534
This value is provided for documentation purposes,
532535
and it SHOULD NOT be intended as a prefix. In
533536
addition, implementations are expected to execute
534-
the transfer using WebDAV as the wire protocol.
537+
the transfer using
538+
[WebDAV](https://datatracker.ietf.org/doc/rfc4918/)
539+
as the wire protocol.
535540
* Any additional protocol supported for this Resource type MAY be
536541
advertised here, where the value MAY correspond to
537542
a top-level URI to be used for that protocol.
@@ -546,8 +551,9 @@ supported by this OCM Server.
546551
* `"enforce-mfa"` - to indicate that this OCM Server can apply a
547552
Sending Server's MFA requirements for a Share on their behalf.
548553
* `"webdav-uri"` - to indicate that this OCM Server can append a
549-
relative URI to the path listed for WebDAV in the appropriate
550-
`resourceTypes` entry
554+
relative URI to the path listed for
555+
[WebDAV](https://datatracker.ietf.org/doc/rfc4918/) in the
556+
appropriate `resourceTypes` entry
551557
* `"protocol-object"` - to indicate that this OCM Server can
552558
receive a Share Creation Notification whose `protocol` object
553559
contains one property per supported protocol instead of containing
@@ -959,6 +965,21 @@ The legacy format of an OCM Share Notification with shared secrets is
959965
only provided for backwards compatibility with existing implementations.
960966
Implementers SHOULD NOT use it and prefer short-lived tokens instead.
961967

968+
# References
969+
970+
## Normative References
971+
972+
[1] Backman, A., Richer, J. and Sporny, M. "HTTP Message Signatures",
973+
[RFC 9421](https://tools.ietf.org/html/rfc9421), February 2024.
974+
[2] Dusseault, L. M. "HTTP Extensions for Web Distributed Authoring
975+
and Versioning",
976+
[RFC 4918](https://datatracker.ietf.org/html/rfc4918/), June 2007.
977+
978+
## Informative References
979+
980+
[1] Hardt, D. (ed), "The OAuth 2.0 Authorization Framework",
981+
[RFC 6749](https://datatracker.ietf.org/html/rfc6749), October 2012.
982+
962983

963984
# Appendix A: Multi-factor Authentication
964985
If a Receiving Server exposes the capability `enforce-mfa`, it

0 commit comments

Comments
 (0)