Skip to content

Commit cff7480

Browse files
committed
Decouple SSF from OAuth protocol
Decouple SSF from OAuth protocol - Revert #83 - Removed type from authorization scheme - More OAuth agnostic changes - Removed OPRM references - spec_urn verbiage changes - Removed OAuth2 references from the aud claim
1 parent 02306ef commit cff7480

File tree

1 file changed

+29
-42
lines changed

1 file changed

+29
-42
lines changed

openid-sharedsignals-framework-1_0.md

Lines changed: 29 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ normative:
146146
date: May 2021
147147
target: https://datatracker.ietf.org/doc/html/draft-ietf-secevent-subject-identifiers
148148
title: Subject Identifiers for Security Event Tokens
149+
149150
CAEP:
150151
author:
151152
-
@@ -604,42 +605,39 @@ critical_subject_members
604605

605606
> OPTIONAL. An array of member names in a Complex Subject which, if present in
606607
a Subject Member in an event, MUST be interpreted by a Receiver.
607-
608-
supported_scopes
609608

610-
> OPTIONAL. A list of OAuth {{RFC6749}} scope names that the Transmitter supports for specific endpoints. The value of this field is a JSON object that has the endpoint names as keys, and arrays of scope name strings they support as their values. OAuth tokens obtained using any of the scopes defined here MUST be accepted by the specified endpoint. Any key that is not defined as an endpoint in the Transmitter Configuration Metadata MUST be ignored. If the supported_scopes member is present in the metadata and an endpoint is not listed as a key, then that endpoint MUST not require OAuth for authorization.
609+
authorization_schemes
611610

612-
authorization_servers
611+
> OPTIONAL. An array of JSON objects that specify the supported
612+
authorization scheme properties defined in {{authorization-scheme}}. To enable seamless discovery of
613+
configurations, the service provider SHOULD, with the appropriate
614+
security considerations, make the authorization_schemes attribute
615+
publicly accessible without prior authentication.
613616

614-
> OPTIONAL. An array of supported authorization servers and the scopes they support. Each element of the array is a Authorization Server Descriptor JSON object defined in the section {{authz-server-descriptor}} below. If the `supported_scopes` member is present in the metadata, then the `authorization_servers` MUST also be present, and it MUST provide a server location for every supported scope.
615617

616618
TODO: consider adding a IANA Registry for metadata, similar to Section 7.1.1 of
617619
{{RFC8414}}. This would allow other specs to add to the metadata.
618620

619-
### Authorization Server Descriptor {#authz-server-descriptor}
620-
An Authorization Server Descriptor is a JSON object that has two keys:
621+
### Authorization scheme {#authorization-scheme}
622+
SSF is an HTTP based signals sharing framework and is agnostic to the authentication and authorization schemes 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. The authorization scheme section of the metadata provides discovery information related to the transmitter's stream management APIs.
621623

622-
scopes
624+
spec_urn
623625

624-
> REQUIRED. An array of scope names supported by the authorization server
626+
> REQUIRED. A URN that describes the specification of the protocol being used.
625627

626-
servers
628+
The receiver will call the transmitter APIs by providing appropriate credentials as per the `spec_urn`.
627629

628-
> REQUIRED. An array of authorization server URLs. This is the URL from which the Authorization Server Metadata MAY be obtained by following the process described in Section 3 of RFC8414 {{RFC8414}}
629-
630-
The following is a non-normative example of an Authorization Server Descriptor
630+
The following is a non-normative example of the `spec_urn`
631631

632632
~~~ json
633-
{
634-
"scopes" : ["scope1", "scope2"],
635-
"servers": [
636-
"https://server1.example/base/url",
637-
"https://server2.example/base/url",
638-
"https://server3.example/base/url"
639-
]
640-
}
633+
{
634+
"spec_urn": "urn:ietf:rfc:6749"
635+
}
641636
~~~
642-
{: #authz-descriptor-example title="Example Authorization Server Descriptor"}
637+
638+
In this case, the receiver may obtain an access token using the Client
639+
Credential Grant {{CLIENTCRED}}, or any other method suitable for the Receiver and the
640+
Transmitter.
643641

644642
## Obtaining Transmitter Configuration Information
645643

@@ -738,17 +736,14 @@ Content-Type: application/json
738736
"verification_endpoint":
739737
"https://tr.example.com/ssf/mgmt/verification",
740738
"critical_subject_members": [ "tenant", "user" ],
741-
"supported_scopes":
739+
"authorization_schemes":[
742740
{
743-
"status_endpoint": ["status_scope"],
744-
"configuration_endpoint": ["admin_scope", "status_scope"]
741+
"spec_urn": "urn:ietf:rfc:6749"
745742
},
746-
"authorization_servers": [
747743
{
748-
"scopes": ["admin_scope", "status_scope"],
749-
"servers": ["https://myauthzserver.example"]
744+
"spec_urn": "urn:ietf:rfc:8705"
750745
}
751-
]
746+
]
752747
}
753748
~~~
754749
{: #figdiscoveryresponse title="Example: Transmitter Configuration Response"}
@@ -1547,9 +1542,9 @@ Errors are signaled with HTTP status codes as follows:
15471542

15481543
Examples:
15491544

1550-
1. If a Receiver makes a request with an invalid OAuth token, then the
1545+
1. If a Receiver makes an unauthorized request, then the
15511546
Transmitter MUST respond with a 401 error status.
1552-
2. If the Receiver presents a valid OAuth token, but the Transmitter policy
1547+
2. If a Receiver makes an authorized request, but the Transmitter policy
15531548
does not permit the Receiver from obtaining the status, then the Transmitter
15541549
MAY respond with a 403 error status.
15551550
3. If the Receiver requests the status for a stream that does not exist then the
@@ -1963,14 +1958,6 @@ sub_id
19631958
~~~
19641959
{: title="Example: Stream Updated SET" #figstreamupdatedset}
19651960

1966-
# Authorization {#management-api-auth}
1967-
HTTP API calls from a Receiver to a Transmitter SHOULD be authorized by
1968-
providing an OAuth 2.0 Access Token as defined by {{RFC6750}}.
1969-
1970-
The receiver may obtain an access token using the Client
1971-
Credential Grant {{CLIENTCRED}}, or any other method suitable for the Receiver and the
1972-
Transmitter.
1973-
19741961
# Security Considerations {#management-sec}
19751962

19761963
## Subject Probing {#management-sec-subject-probing}
@@ -2155,9 +2142,9 @@ The purpose is defense in depth against confusion with other JWTs, as described
21552142
in Sections 4.5 and 4.6 of {{RFC8417}}.
21562143

21572144
### The "aud" Claim {#aud-claim}
2158-
The "aud" claim can be a single value or an array. Each value SHOULD be the
2159-
OAuth 2.0 client ID. Other values that uniquely identifies the Receiver to the
2160-
Transmitter MAY be used, if the two parties have agreement on the format.
2145+
The "aud" claim can be a single string or an array of strings. Values that
2146+
uniquely identify the Receiver to the Transmitter MAY be used, if the two parties
2147+
have agreement on the format.
21612148

21622149
More than one value can be present if the corresponding Receivers are known to
21632150
the Transmitter to be the same entity, for example a web client and a mobile

0 commit comments

Comments
 (0)