Skip to content

Commit ca66a1c

Browse files
committed
Metadata attribute details
Added more details around the metadata attributes
1 parent 5fcce7e commit ca66a1c

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

openid-sharedsignals-framework-1_0.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ normative:
140140
date: May 2021
141141
target: https://datatracker.ietf.org/doc/html/draft-ietf-secevent-subject-identifiers
142142
title: Subject Identifiers for Security Event Tokens
143-
PROTECTEDSERVERMETADATA:
143+
OPRM:
144144
author:
145145
- ins: M.B. Jones
146146
name: Michael B. Jones
@@ -562,18 +562,29 @@ TODO: consider adding a IANA Registry for metadata, similar to Section 7.1.1 of
562562
{{RFC8414}}. This would allow other specs to add to the metadata.
563563

564564
### Authorization scheme {#authorization-scheme}
565-
Authorization scheme used by the receiver to authorize with the Transmitter's management API for SET event stream.
565+
SSF is an HTTP based signals sharing framework. It is agnostic to the authentication and authorization schems used to secure stream configuration APIs. It does not provide any SSF specific authentication and authorization schemes but relies on the cooperating parties mutual security considerations. Authorization scheme section of the metadata, providers disovery informaton related to the transmitter's stream management APIs.
566566

567567
type
568568

569-
> The authorization scheme. This specification defines the values "oauth", "oauth2", "oauthbearertoken" REQUIRED.
569+
> The authorization scheme. This specification defines the values "oauth",
570+
"oauth2", "oauthbearertoken" REQUIRED.
571+
572+
spec_uri
573+
574+
> An HTTP-addressable URL pointing to the authentication scheme's
575+
specification. OPTIONAL.
576+
577+
documentation_uri
578+
579+
> An HTTP-addressable URL pointing to the authentication scheme's usage
580+
documentation. OPTIONAL.
570581

571582
The receiver will call the transmitter APIs by providing appropriate credentials as mentioned in the type.
572583

573584

574585
If the Authorization scheme is OAuth2
575-
- The Transmitter SHOULD publish Protected Server Metadata {{PROTECTEDSERVERMETADATA}} to aid the discovery of metadata needed to interact with an OAuth 2.0 protected resource.
576-
- Discovery of the Protected Server Metadata {{PROTECTEDSERVERMETADATA}} is outside the scope of this specification.
586+
- The Transmitter SHOULD publish Protected Server Metadata {{OPRM}} to aid the discovery of metadata needed to interact with an OAuth 2.0 protected resource.
587+
- Discovery of the Protected Server Metadata {{OPRM}} is outside the scope of this specification.
577588
- The receiver may obtain an access token using the Client
578589
Credential Grant {{CLIENTCRED}}, or any other method suitable for the Receiver and the
579590
Transmitter.
@@ -678,7 +689,9 @@ Content-Type: application/json
678689
"authorization_schemes": {
679690
[
680691
{
681-
"type": "oauth2"
692+
"type": "oauth2",
693+
"spec_uri": "https://datatracker.ietf.org/doc/html/rfc6749",
694+
"documentations_uri": "https://tr.example.com/oauth2-how-to"
682695
}
683696
]
684697
}

0 commit comments

Comments
 (0)