Skip to content

Commit 46962d3

Browse files
committed
review suggestions
1 parent 9a11428 commit 46962d3

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

openid-sharedsignals-framework-1_0.md

+25-25
Original file line numberDiff line numberDiff line change
@@ -165,13 +165,13 @@ and Coordination (RISC) and the Continuous Access Evaluation Profile ({{CAEP}})
165165

166166
This specification defines:
167167

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
175175

176176
This specification also directly profiles several IETF Security Events specifications:
177177

@@ -1769,36 +1769,36 @@ Errors are signaled with HTTP status codes as follows:
17691769
In some cases, the frequency of event transmission on an Event Stream will be
17701770
very low, making it difficult for an Event Receiver to tell the difference
17711771
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
17731773
over the Event Stream, allowing the Receiver to confirm that the stream is
17741774
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
17761776
delivery is working, including signature verification and encryption.
17771777

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
17791779
not requested by the Event Receiver.
17801780

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}}).
17821782

17831783

17841784
#### 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:
17861786

17871787
state
17881788

17891789
> OPTIONAL An opaque value provided by the Event Receiver when the event is
17901790
triggered.
17911791

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:
17931793

17941794
sub_id
17951795

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.
17971797

17981798
> Note that the subject that identifies a stream itself is always implicitly
17991799
added to the stream and MAY NOT be removed from the stream.
18001800

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
18021802
validate its claims. In particular, the Event Receiver SHALL confirm that the
18031803
value for "state" is as expected. If the value of "state" does not match, an
18041804
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
18091809
acknowledgement by the Event Receiver.
18101810

18111811
#### 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
18131813
Receiver makes an HTTP POST request to the Verification Endpoint, with a [JSON]
18141814
[RFC7159] object containing the parameters of the verification request, if any.
18151815
On a successful request, the Event Transmitter responds with an empty
@@ -1819,22 +1819,22 @@ Verification requests have the following properties:
18191819

18201820
stream_id
18211821

1822-
> REQUIRED. The stream that the Verification event is being requested on.
1822+
> REQUIRED. The stream that the Verification Event is being requested on.
18231823

18241824
state
18251825

18261826
> 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
18301830
then this parameter MUST not be set.
18311831

18321832
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
18341834
Transmitter has transmitted the event or will do so at some point in the future.
18351835
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
18381838
particular order relative to the current queue of events.
18391839

18401840
Errors are signaled with HTTP status codes as follows:
@@ -1847,7 +1847,7 @@ Errors are signaled with HTTP status codes as follows:
18471847
| 429 | if the Event Receiver is sending too many requests in a given amount of time; see related "min_verification_interval" in {{stream-config}}
18481848
{: title="Verification Errors" #taberifyerr}
18491849

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:
18511851

18521852
~~~ http
18531853
POST /ssf/verify HTTP/1.1
@@ -1871,7 +1871,7 @@ Cache-Control: no-store
18711871
~~~
18721872
{: title="Example: Trigger Verification Response" #figverifyresp}
18731873

1874-
And the following is a non-normative example of a Verification event sent to the
1874+
And the following is a non-normative example of a Verification Event sent to the
18751875
Event Receiver as a result of the above request:
18761876

18771877
~~~ json

0 commit comments

Comments
 (0)