You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: openid-sharedsignals-framework-1_0.md
+25-25
Original file line number
Diff line number
Diff line change
@@ -165,13 +165,13 @@ and Coordination (RISC) and the Continuous Access Evaluation Profile ({{CAEP}})
165
165
166
166
This specification defines:
167
167
168
-
* A Profile for Security Events Tokens {{RFC8417}}
169
-
* Subject Principals
170
-
* Subject Claims in SSF Events
171
-
* Event Types
172
-
* Event Properties
173
-
* Configuration Metadata and Discovery Method for Transmitters
174
-
* A Management API for Event Streams
168
+
* A profile for Security Events Tokens {{RFC8417}}
169
+
* Subject principals
170
+
* Subject claims in SSF events
171
+
* Event types
172
+
* Event properties
173
+
* Transmitter Configuration Metadata and its discovery method for Receivers
174
+
* A management API for Event Streams
175
175
176
176
This specification also directly profiles several IETF Security Events specifications:
177
177
@@ -1769,36 +1769,36 @@ Errors are signaled with HTTP status codes as follows:
1769
1769
In some cases, the frequency of event transmission on an Event Stream will be
1770
1770
very low, making it difficult for an Event Receiver to tell the difference
1771
1771
between expected behavior and event transmission failure due to a misconfigured
1772
-
stream. Event Receivers can request that a Verification event be transmitted
1772
+
stream. Event Receivers can request that a Verification Event be transmitted
1773
1773
over the Event Stream, allowing the Receiver to confirm that the stream is
1774
1774
configured correctly upon successful receipt of the event. The acknowledgment of
1775
-
a Verification event also confirms to the Event Transmitter that end-to-end
1775
+
a Verification Event also confirms to the Event Transmitter that end-to-end
1776
1776
delivery is working, including signature verification and encryption.
1777
1777
1778
-
A Transmitter MAY send a Verification event at any time, even if one was
1778
+
A Transmitter MAY send a Verification Event at any time, even if one was
1779
1779
not requested by the Event Receiver.
1780
1780
1781
-
A Transmitter MAY respond to Verification event requests even if the event is not present in the `events_supported`, `events_requested` and / or `events_delivered` fields in the Stream Configuration ({{stream-config}}).
1781
+
A Transmitter MAY respond to Verification Event requests even if the event is not present in the `events_supported`, `events_requested` and / or `events_delivered` fields in the Stream Configuration ({{stream-config}}).
1782
1782
1783
1783
1784
1784
#### Verification Event {#verification-event}
1785
-
The Verification event is an SSF event with the event type: "https://schemas.openid.net/secevent/ssf/event-type/verification". The event contains the following attribute:
1785
+
The Verification Event is an SSF event with the event type: "https://schemas.openid.net/secevent/ssf/event-type/verification". The event contains the following attribute:
1786
1786
1787
1787
state
1788
1788
1789
1789
> OPTIONAL An opaque value provided by the Event Receiver when the event is
1790
1790
triggered.
1791
1791
1792
-
As with any SSF event, the Verification event has a top-level `sub_id` claim:
1792
+
As with any SSF event, the Verification Event has a top-level `sub_id` claim:
1793
1793
1794
1794
sub_id
1795
1795
1796
-
> REQUIRED. The value of the top-level `sub_id` claim in a Verification event MUST always be set to have a simple value of type `opaque`. The `id` of the value MUST be the `stream_id` of the stream being verified.
1796
+
> REQUIRED. The value of the top-level `sub_id` claim in a Verification Event MUST always be set to have a simple value of type `opaque`. The `id` of the value MUST be the `stream_id` of the stream being verified.
1797
1797
1798
1798
> Note that the subject that identifies a stream itself is always implicitly
1799
1799
added to the stream and MAY NOT be removed from the stream.
1800
1800
1801
-
Upon receiving a Verification event, the Event Receiver SHALL parse the SET and
1801
+
Upon receiving a Verification Event, the Event Receiver SHALL parse the SET and
1802
1802
validate its claims. In particular, the Event Receiver SHALL confirm that the
1803
1803
value for "state" is as expected. If the value of "state" does not match, an
1804
1804
error response of "setData" SHOULD be returned (see Section 2.3 of
@@ -1809,7 +1809,7 @@ fails to successfully verify based on the acknowledgement or lack of
1809
1809
acknowledgement by the Event Receiver.
1810
1810
1811
1811
#### Triggering a Verification Event. {#triggering-a-verification-event}
1812
-
To request that a Verification event be sent over an Event Stream, the Event
1812
+
To request that a Verification Event be sent over an Event Stream, the Event
1813
1813
Receiver makes an HTTP POST request to the Verification Endpoint, with a [JSON]
1814
1814
[RFC7159] object containing the parameters of the verification request, if any.
1815
1815
On a successful request, the Event Transmitter responds with an empty
@@ -1819,22 +1819,22 @@ Verification requests have the following properties:
1819
1819
1820
1820
stream_id
1821
1821
1822
-
> REQUIRED. The stream that the Verification event is being requested on.
1822
+
> REQUIRED. The stream that the Verification Event is being requested on.
1823
1823
1824
1824
state
1825
1825
1826
1826
> OPTIONAL. An arbitrary string that the Event Transmitter MUST echo back to the
1827
-
Event Receiver in the Verification event’s payload. Event Receivers MAY use
1828
-
the value of this parameter to correlate a Verification event with a
1829
-
verification request. If the Verification event is initiated by the Transmitter
1827
+
Event Receiver in the Verification Event’s payload. Event Receivers MAY use
1828
+
the value of this parameter to correlate a Verification Event with a
1829
+
verification request. If the Verification Event is initiated by the Transmitter
1830
1830
then this parameter MUST not be set.
1831
1831
1832
1832
A successful response from a POST to the Verification Endpoint does not indicate
1833
-
that the Verification event was transmitted successfully, only that the Event
1833
+
that the Verification Event was transmitted successfully, only that the Event
1834
1834
Transmitter has transmitted the event or will do so at some point in the future.
1835
1835
Event Transmitters MAY transmit the event via an asynchronous process, and SHOULD
1836
-
publish an SLA for Verification event transmission times. Event Receivers MUST NOT
1837
-
depend on the Verification event being transmitted synchronously or in any
1836
+
publish an SLA for Verification Event transmission times. Event Receivers MUST NOT
1837
+
depend on the Verification Event being transmitted synchronously or in any
1838
1838
particular order relative to the current queue of events.
1839
1839
1840
1840
Errors are signaled with HTTP status codes as follows:
@@ -1847,7 +1847,7 @@ Errors are signaled with HTTP status codes as follows:
1847
1847
| 429 | if the Event Receiver is sending too many requests in a given amount of time; see related "min_verification_interval" in {{stream-config}}
1848
1848
{: title="Verification Errors" #taberifyerr}
1849
1849
1850
-
The following is a non-normative example request to trigger a Verification event:
1850
+
The following is a non-normative example request to trigger a Verification Event:
0 commit comments