Skip to content

Commit 095bc73

Browse files
committed
renamed file back to using openid standard. Incorporated feedback from Apoorva and Shayne
1 parent f75d858 commit 095bc73

File tree

2 files changed

+29
-19
lines changed

2 files changed

+29
-19
lines changed

.github/workflows/build-everything.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ jobs:
4141
- name: Render caep text
4242
run: xml2rfc openid-caep-specification-1_0.xml --text -o openid-caep-specification-1_0.txt
4343
- name: Convert caep-interop md to xml
44-
run: kramdown-rfc2629 caep-interoperability-profile-1_0.md > caep-interoperability-profile-1_0.xml
44+
run: kramdown-rfc2629 openid-caep-interoperability-profile-1_0.md > openid-caep-interoperability-profile-1_0.xml
4545
- name: Render caep-interop html
46-
run: xml2rfc caep-interoperability-profile-1_0.xml --html -o caep-interoperability-profile-1_0.html
46+
run: xml2rfc openid-caep-interoperability-profile-1_0.xml --html -o openid-caep-interoperability-profile-1_0.html
4747
- name: Render caep-interop text
48-
run: xml2rfc caep-interoperability-profile-1_0.xml --text -o caep-interoperability-profile-1_0.txt
48+
run: xml2rfc openid-caep-interoperability-profile-1_0.xml --text -o openid-caep-interoperability-profile-1_0.txt
4949
- name: Upload artifact
5050
uses: actions/upload-artifact@v2
5151
with:
@@ -57,8 +57,8 @@ jobs:
5757
openid-risc-profile-specification-1_0.txt
5858
openid-caep-specification-1_0.html
5959
openid-caep-specification-1_0.txt
60-
caep-interoperability-profile-1_0.html
61-
caep-interoperability-profile-1_0.txt
60+
openid-caep-interoperability-profile-1_0.html
61+
openid-caep-interoperability-profile-1_0.txt
6262
publish-to-pages:
6363
if: github.ref == 'refs/heads/main'
6464
needs: [build-sharedsignals]

caep-interoperability-profile-1_0.md renamed to openid-caep-interoperability-profile-1_0.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ contributor:
3232
normative:
3333
RFC9493: # Subject Identifier Formats for SETs
3434
SSF:
35-
target: http://openid.net/specs/openid-sse-framework-1_0.html
36-
title: OpenID Shared Signals and Events Framework Specification 1.0
35+
target: https://openid.net/specs/openid-sharedsignals-framework-1_0.html
36+
title: OpenID Shared Signals and Events Framework Specification 1.0 - draft 02
3737
author:
3838
-
3939
ins: A. Tulshibagwale
@@ -52,9 +52,14 @@ normative:
5252
name: Annabelle Backman
5353
org: Amazon
5454
-
55-
ins: John Bradley
55+
ins: J. Bradley
5656
name: John Bradley
5757
org: Yubico
58+
-
59+
ins: S. Miel
60+
name: Shayne Miel
61+
org: Cisco
62+
5863
CAEP:
5964
target: https://openid.net/specs/openid-caep-specification-1_0.html
6065
title: OpenID Continuous Access Evaluation Profile 1.0
@@ -76,7 +81,7 @@ This document defines an interoperability profile for implementations of the Sha
7681
--- middle
7782

7883
# Introduction {#introduction}
79-
SSF and CAEP together enable improved session security outcomes. This specification defines the minimum required features from SSF and CAEP that an implementation MUST offer in order to be considered as an interoperable implementation. This document defines specific use cases. An implementation may support only a subset of the use cases defined herein, and SHALL be considered an interoperable implementation for the specific use-cases it supports. The following use-cases are considered as a part of this specification:
84+
SSF and CAEP together enable improved session security outcomes. This specification defines the minimum required features from SSF and CAEP that an implementation MUST offer in order to be considered as an interoperable implementation. This document defines specific use cases. An implementation MAY support only a subset of the use cases defined herein, and SHALL be considered an interoperable implementation for the specific use-cases it supports. The following use-cases are considered as a part of this specification:
8085

8186
Session Revocation
8287
: A SSF Transmitter or Receiver is able to respectively generate or respond to the CAEP session-revoked event
@@ -100,10 +105,16 @@ The Transmitter Configuration Metadata MUST include the `delivery_methods_suppor
100105
The Transmitter Configuration Metadata MUST include the `jwks_uri` field, and its value MUST provide the current signing key of the Transmitter.
101106

102107
### Configuration Endpoint {#configuration-endpoint}
103-
The Transmitter Configuration Metadata MUST include the `configuration_endpoint` field. The specified endpoint MUST provide a way to Create a Stream.
108+
The Transmitter Configuration Metadata MUST include the `configuration_endpoint` field. The specified endpoint MUST support the `POST` method in order to be able to create a stream.
104109

105110
### Status Endpoint {#status-endpoint}
106-
The Transmitter Configuration Metadata MUST include the `status_endpoint` field. The specified endpoint MUST provide a way to Get and Update the Stream Status. The Transmitter MUST be able to pause and restart streams. For streams that are paused, the Transmitter MUST specify (offline) the resource constraints on how many events it can keep, or for how long. The way a Transmitter specifies this information is outside the scope of the SSF spec.
111+
The Transmitter Configuration Metadata MUST include the `status_endpoint` field. The specified endpoint MUST support the `GET` and `POST` methods in order to get and update the stream status respectively. The Transmitter MUST support the following values in an Update Stream Status request:
112+
113+
* `enabled`
114+
* `paused`
115+
* `disabled`
116+
117+
For streams that are `paused`, the Transmitter MUST specify (offline) the resource constraints on how many events it can keep, or for how long. The way a Transmitter specifies this information is outside the scope of the SSF spec.
107118

108119
### Verification Endpoint {#verification-endpoint}
109120
The Transmitter Configuration Metadata MUST include the `verification_endpoint` field. The specified endpoint MUST provide a way to request verification events to be sent.
@@ -121,13 +132,12 @@ The Transmitter Configuration Metadata MUST include the `authorization_schemes`
121132
In all streams created by the Transmitter, the following MUST be true:
122133

123134
#### Delivery {#common-delivery}
124-
The `delivery` field MUST be present in the Configuration of any Stream generated by the Transmitter, and its value MUST include the following:
135+
A Transmitter MUST be able to accept a Create Stream request that includes either of the following delivery methods:
125136

126-
~~~ json
127-
{
128-
"method" : "urn:ietf:rfc:8935"
129-
}
130-
~~~
137+
* urn:ietf:rfc:8935 (Push)
138+
* urn:ietf:rfc:8936 (Poll)
139+
140+
The `delivery` field MUST be present in the Configuration of any Stream generated by the Transmitter, and its value MUST include one of the two delivery methods listed above.
131141

132142
#### Stream Control
133143
The following Stream Configuration API Methods MUST be supported:
@@ -147,8 +157,8 @@ The following Stream Configuration API Methods MUST be supported:
147157
## Receivers {#common-receivers}
148158
Receivers MUST implement the following features:
149159

150-
### Push Delivery {#common-receiver-push}
151-
Receivers MUST be able to accept events using the Push-Based Security Event Token (SET) Delivery Using HTTP {{RFC8935}} specification.
160+
### Delivery Methods {#common-receiver-delivery}
161+
Receivers MUST be able to accept events using the Push-Based Security Event Token (SET) Delivery Using HTTP {{RFC8935}} specification and the Poll-Based Security Event Token (SET) Delivery Using HTTP {{RFC8936}} specification.
152162

153163
### Implicitly Added Subjects {#common-receiver-subjects}
154164
Receivers MUST assume that all subjects are implicitly included in a Stream, without any `AddSubject` method invocations.

0 commit comments

Comments
 (0)