Skip to content

Commit 7c83df4

Browse files
tulshitulshi
committed
updated text to reflect sub_id as a top-level field in verification and stream updated events
1 parent 927afaa commit 7c83df4

File tree

3 files changed

+82
-91
lines changed

3 files changed

+82
-91
lines changed

‎openid-sharedsignals-framework-1_0.html‎

Lines changed: 27 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3790,40 +3790,35 @@ <h4 id="name-verification">
37903790
<h5 id="name-verification-event">
37913791
<a href="#section-7.1.4.1" class="section-number selfRef">7.1.4.1. </a><a href="#name-verification-event" class="section-name selfRef">Verification Event</a>
37923792
</h5>
3793-
<p id="section-7.1.4.1-1">The Verification Event is a standard SET with the following attributes:<a href="#section-7.1.4.1-1" class="pilcrow"></a></p>
3794-
<p id="section-7.1.4.1-2">event type<a href="#section-7.1.4.1-2" class="pilcrow"></a></p>
3793+
<p id="section-7.1.4.1-1">The Verification Event is a SSF Event with the event type: "https://schemas.openid.net/secevent/ssf/event-type/verification". The event contains the following attribute:<a href="#section-7.1.4.1-1" class="pilcrow"></a></p>
3794+
<p id="section-7.1.4.1-2">state<a href="#section-7.1.4.1-2" class="pilcrow"></a></p>
37953795
<ul class="normal ulEmpty">
37963796
<li class="normal ulEmpty" id="section-7.1.4.1-3.1">
3797-
<p id="section-7.1.4.1-3.1.1">The Event Type URI is: "https://schemas.openid.net/secevent/ssf/event-type/verification".<a href="#section-7.1.4.1-3.1.1" class="pilcrow"></a></p>
3797+
<p id="section-7.1.4.1-3.1.1">OPTIONAL An opaque value provided by the Event Receiver when the event is
3798+
triggered.<a href="#section-7.1.4.1-3.1.1" class="pilcrow"></a></p>
37983799
</li>
37993800
</ul>
3800-
<p id="section-7.1.4.1-4">state<a href="#section-7.1.4.1-4" class="pilcrow"></a></p>
3801+
<p id="section-7.1.4.1-4">As with any SSF event, the Verification Event has a top-level <code>sub_id</code> claim:<a href="#section-7.1.4.1-4" class="pilcrow"></a></p>
3802+
<p id="section-7.1.4.1-5">sub_id<a href="#section-7.1.4.1-5" class="pilcrow"></a></p>
38013803
<ul class="normal ulEmpty">
3802-
<li class="normal ulEmpty" id="section-7.1.4.1-5.1">
3803-
<p id="section-7.1.4.1-5.1.1">OPTIONAL An opaque value provided by the Event Receiver when the event is
3804-
triggered. This is a nested attribute in the event payload.<a href="#section-7.1.4.1-5.1.1" class="pilcrow"></a></p>
3804+
<li class="normal ulEmpty" id="section-7.1.4.1-6.1">
3805+
<p id="section-7.1.4.1-6.1.1">REQUIRED. The value of the top-level <code>sub_id</code> claim in a Verification Event MUST always be set to have a simple value of type <code>opaque</code>. The <code>id</code> of the value MUST be the <code>stream_id</code> of the stream being verified.<a href="#section-7.1.4.1-6.1.1" class="pilcrow"></a></p>
38053806
</li>
38063807
</ul>
3807-
<p id="section-7.1.4.1-6">sub_id<a href="#section-7.1.4.1-6" class="pilcrow"></a></p>
38083808
<ul class="normal ulEmpty">
38093809
<li class="normal ulEmpty" id="section-7.1.4.1-7.1">
3810-
<p id="section-7.1.4.1-7.1.1">REQUIRED. The value of the top-level <code>sub_id</code> claim in a Verification Event MUST always be set to have a simple value of type <code>opaque</code>. The <code>id</code> of the value MUST be the <code>stream_id</code> of the stream being verified.<a href="#section-7.1.4.1-7.1.1" class="pilcrow"></a></p>
3810+
<p id="section-7.1.4.1-7.1.1">Note that the subject that identifies a stream itself is always implicitly
3811+
added to the stream and MAY NOT be removed from the stream.<a href="#section-7.1.4.1-7.1.1" class="pilcrow"></a></p>
38113812
</li>
38123813
</ul>
3813-
<ul class="normal ulEmpty">
3814-
<li class="normal ulEmpty" id="section-7.1.4.1-8.1">
3815-
<p id="section-7.1.4.1-8.1.1">Note that the subject that identifies a stream itself is always implicitly
3816-
added to the stream and MAY NOT be removed from the stream.<a href="#section-7.1.4.1-8.1.1" class="pilcrow"></a></p>
3817-
</li>
3818-
</ul>
3819-
<p id="section-7.1.4.1-9">Upon receiving a Verification Event, the Event Receiver SHALL parse the SET and
3814+
<p id="section-7.1.4.1-8">Upon receiving a Verification Event, the Event Receiver SHALL parse the SET and
38203815
validate its claims. In particular, the Event Receiver SHALL confirm that the
38213816
value for "state" is as expected. If the value of "state" does not match, an
38223817
error response of "setData" SHOULD be returned (see Section 2.3 of
3823-
<span>[<a href="#DELIVERYPUSH" class="cite xref">DELIVERYPUSH</a>]</span> or <span>[<a href="#DELIVERYPOLL" class="cite xref">DELIVERYPOLL</a>]</span>).<a href="#section-7.1.4.1-9" class="pilcrow"></a></p>
3824-
<p id="section-7.1.4.1-10">In many cases, Event Transmitters MAY disable or suspend an Event Stream that
3818+
<span>[<a href="#DELIVERYPUSH" class="cite xref">DELIVERYPUSH</a>]</span> or <span>[<a href="#DELIVERYPOLL" class="cite xref">DELIVERYPOLL</a>]</span>).<a href="#section-7.1.4.1-8" class="pilcrow"></a></p>
3819+
<p id="section-7.1.4.1-9">In many cases, Event Transmitters MAY disable or suspend an Event Stream that
38253820
fails to successfully verify based on the acknowledgement or lack of
3826-
acknowledgement by the Event Receiver.<a href="#section-7.1.4.1-10" class="pilcrow"></a></p>
3821+
acknowledgement by the Event Receiver.<a href="#section-7.1.4.1-9" class="pilcrow"></a></p>
38273822
</section>
38283823
</div>
38293824
<div id="triggering-a-verification-event">
@@ -3989,30 +3984,26 @@ <h4 id="name-stream-updated-event">
39893984
status.<a href="#section-7.1.5-8.1.1" class="pilcrow"></a></p>
39903985
</li>
39913986
</ul>
3992-
<p id="section-7.1.5-9">sub_id<a href="#section-7.1.5-9" class="pilcrow"></a></p>
3987+
<p id="section-7.1.5-9">As with any SSF Event, this event has a top-level <code>sub_id</code> claim:<a href="#section-7.1.5-9" class="pilcrow"></a></p>
3988+
<p id="section-7.1.5-10">sub_id<a href="#section-7.1.5-10" class="pilcrow"></a></p>
39933989
<ul class="normal ulEmpty">
3994-
<li class="normal ulEmpty" id="section-7.1.5-10.1">
3995-
<p id="section-7.1.5-10.1.1">REQUIRED. The top-level <code>sub_id</code> claim specifies the Subject Principal for whom the status has been updated.
3990+
<li class="normal ulEmpty" id="section-7.1.5-11.1">
3991+
<p id="section-7.1.5-11.1.1">REQUIRED. The top-level <code>sub_id</code> claim specifies the Subject Principal for whom the status has been updated.
39963992
If the event applies to the entire stream, the value of the <code>sub_id</code> field
39973993
MUST be of format <code>opaque</code>, and its <code>id</code> value MUST be the unique ID of the
3998-
stream.<a href="#section-7.1.5-10.1.1" class="pilcrow"></a></p>
3999-
</li>
4000-
</ul>
4001-
<ul class="normal ulEmpty">
4002-
<li class="normal ulEmpty" id="section-7.1.5-11.1">
4003-
<p id="section-7.1.5-11.1.1">Note that the subject that identifies a stream itself is always implicitly
4004-
added to the stream and MAY NOT be removed from the stream.<a href="#section-7.1.5-11.1.1" class="pilcrow"></a></p>
3994+
stream.<a href="#section-7.1.5-11.1.1" class="pilcrow"></a></p>
40053995
</li>
40063996
</ul>
40073997
<ul class="normal ulEmpty">
40083998
<li class="normal ulEmpty" id="section-7.1.5-12.1">
4009-
<p id="section-7.1.5-12.1.1">Below is a non-normative example of a <code>stream-updated</code> event with a specific
4010-
subject.<a href="#section-7.1.5-12.1.1" class="pilcrow"></a></p>
3999+
<p id="section-7.1.5-12.1.1">Note that the subject that identifies a stream itself is always implicitly
4000+
added to the stream and MAY NOT be removed from the stream.<a href="#section-7.1.5-12.1.1" class="pilcrow"></a></p>
40114001
</li>
40124002
</ul>
4003+
<p id="section-7.1.5-13">Below is a non-normative example of a <code>stream-updated</code> event with a specific subject.<a href="#section-7.1.5-13" class="pilcrow"></a></p>
40134004
<span id="name-example-stream-updated-set-"></span><div id="figstreamupdatedset">
40144005
<figure id="figure-41">
4015-
<div class="lang-json sourcecode" id="section-7.1.5-13.1">
4006+
<div class="lang-json sourcecode" id="section-7.1.5-14.1">
40164007
<pre>
40174008
{
40184009
"jti": "123456",
@@ -4041,14 +4032,14 @@ <h4 id="name-stream-updated-event">
40414032
</figcaption></figure>
40424033
</div>
40434034
<ul class="normal ulEmpty">
4044-
<li class="normal ulEmpty" id="section-7.1.5-14.1">
4045-
<p id="section-7.1.5-14.1.1">Below is a non-normative example of a <code>stream-updated</code> event with a stream
4046-
subject.<a href="#section-7.1.5-14.1.1" class="pilcrow"></a></p>
4035+
<li class="normal ulEmpty" id="section-7.1.5-15.1">
4036+
<p id="section-7.1.5-15.1.1">Below is a non-normative example of a <code>stream-updated</code> event with a stream
4037+
subject.<a href="#section-7.1.5-15.1.1" class="pilcrow"></a></p>
40474038
</li>
40484039
</ul>
40494040
<span id="name-example-stream-updated-set-w"></span><div id="figstreamupdatedstreamset">
40504041
<figure id="figure-42">
4051-
<div class="lang-json sourcecode" id="section-7.1.5-15.1">
4042+
<div class="lang-json sourcecode" id="section-7.1.5-16.1">
40524043
<pre>
40534044
{
40544045
"jti": "123456",

‎openid-sharedsignals-framework-1_0.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1797,16 +1797,14 @@ An Event Transmitter MAY send a Verification Event at any time, even if one was
17971797
not requested by the Event Receiver.
17981798

17991799
#### Verification Event {#verification-event}
1800-
The Verification Event is a standard SET with the following attributes:
1801-
1802-
event type
1803-
1804-
> The Event Type URI is: "https://schemas.openid.net/secevent/ssf/event-type/verification".
1800+
The Verification Event is a SSF Event with the event type: "https://schemas.openid.net/secevent/ssf/event-type/verification". The event contains the following attribute:
18051801

18061802
state
18071803

18081804
> OPTIONAL An opaque value provided by the Event Receiver when the event is
1809-
triggered. This is a nested attribute in the event payload.
1805+
triggered.
1806+
1807+
As with any SSF event, the Verification Event has a top-level `sub_id` claim:
18101808

18111809
sub_id
18121810

@@ -1936,6 +1934,8 @@ reason
19361934

19371935
> OPTIONAL. Provides a short description of why the Transmitter has updated the
19381936
status.
1937+
1938+
As with any SSF Event, this event has a top-level `sub_id` claim:
19391939

19401940
sub_id
19411941

@@ -1947,8 +1947,7 @@ sub_id
19471947
> Note that the subject that identifies a stream itself is always implicitly
19481948
added to the stream and MAY NOT be removed from the stream.
19491949

1950-
> Below is a non-normative example of a `stream-updated` event with a specific
1951-
subject.
1950+
Below is a non-normative example of a `stream-updated` event with a specific subject.
19521951

19531952
~~~ json
19541953
{
@@ -2297,3 +2296,4 @@ The OpenID Foundation (OIDF) grants to any Contributor, developer, implementer,
22972296

22982297
The technology described in this specification was made available from contributions from various sources, including members of the OpenID Foundation and others. Although the OpenID Foundation has taken steps to help ensure that the technology is available for distribution, it takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this specification or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any independent effort to identify any such rights. The OpenID Foundation and the contributors to this specification make no (and hereby expressly disclaim any) warranties (express, implied, or otherwise), including implied warranties of merchantability, non-infringement, fitness for a particular purpose, or title, related to this specification, and the entire risk as to implementing this specification is assumed by the implementer. The OpenID Intellectual Property Rights policy requires contributors to offer a patent promise not to assert certain patent claims against other contributors and against implementers. The OpenID Foundation invites any interested party to bring to its attention any copyrights, patents, patent applications, or other proprietary rights that may cover technology that may be required to practice this specification.
22992298

2299+

‎openid-sharedsignals-framework-1_0.txt‎

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Table of Contents
9494
7.1.2. Stream Status . . . . . . . . . . . . . . . . . . . . 33
9595
7.1.3. Subjects . . . . . . . . . . . . . . . . . . . . . . 39
9696
7.1.4. Verification . . . . . . . . . . . . . . . . . . . . 43
97-
7.1.5. Stream Updated Event . . . . . . . . . . . . . . . . 47
97+
7.1.5. Stream Updated Event . . . . . . . . . . . . . . . . 46
9898
8. Authorization . . . . . . . . . . . . . . . . . . . . . . . . 49
9999
9. Security Considerations . . . . . . . . . . . . . . . . . . . 49
100100
9.1. Subject Probing . . . . . . . . . . . . . . . . . . . . . 49
@@ -2396,11 +2396,11 @@ Tulshibagwale, et al. Standards Track [Page 42]
23962396

23972397
7.1.4.1. Verification Event
23982398

2399-
The Verification Event is a standard SET with the following
2400-
attributes:
2401-
2402-
event type
2399+
The Verification Event is a SSF Event with the event type:
2400+
"https://schemas.openid.net/secevent/ssf/event-type/verification".
2401+
The event contains the following attribute:
24032402

2403+
state
24042404

24052405

24062406

@@ -2410,14 +2410,11 @@ Tulshibagwale, et al. Standards Track [Page 43]
24102410
SharedSignals June 2023
24112411

24122412

2413-
The Event Type URI is: "https://schemas.openid.net/secevent/ssf/
2414-
event-type/verification".
2415-
2416-
state
2417-
24182413
OPTIONAL An opaque value provided by the Event Receiver when the
2419-
event is triggered. This is a nested attribute in the event
2420-
payload.
2414+
event is triggered.
2415+
2416+
As with any SSF event, the Verification Event has a top-level sub_id
2417+
claim:
24212418

24222419
sub_id
24232420

@@ -2458,6 +2455,9 @@ Tulshibagwale, et al. Standards Track [Page 43]
24582455

24592456
state
24602457

2458+
OPTIONAL. An arbitrary string that the Event Transmitter MUST
2459+
echo back to the Event Receiver in the verification event's
2460+
payload. Event Receivers MAY use the value of this parameter to
24612461

24622462

24632463

@@ -2466,9 +2466,6 @@ Tulshibagwale, et al. Standards Track [Page 44]
24662466
SharedSignals June 2023
24672467

24682468

2469-
OPTIONAL. An arbitrary string that the Event Transmitter MUST
2470-
echo back to the Event Receiver in the verification event's
2471-
payload. Event Receivers MAY use the value of this parameter to
24722469
correlate a verification event with a verification request. If
24732470
the verification event is initiated by the transmitter then this
24742471
parameter MUST not be set.
@@ -2506,22 +2503,6 @@ Tulshibagwale, et al. Standards Track [Page 44]
25062503
The following is a non-normative example request to trigger a
25072504
verification event:
25082505

2509-
2510-
2511-
2512-
2513-
2514-
2515-
2516-
2517-
2518-
2519-
2520-
Tulshibagwale, et al. Standards Track [Page 45]
2521-
2522-
SharedSignals June 2023
2523-
2524-
25252506
POST /ssf/verify HTTP/1.1
25262507
Host: transmitter.example.com
25272508
Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
@@ -2534,6 +2515,13 @@ Tulshibagwale, et al. Standards Track [Page 45]
25342515

25352516
Figure 38: Example: Trigger Verification Request
25362517

2518+
2519+
2520+
Tulshibagwale, et al. Standards Track [Page 45]
2521+
2522+
SharedSignals June 2023
2523+
2524+
25372525
The following is a non-normative example response to a successful
25382526
request:
25392527

@@ -2564,20 +2552,6 @@ Tulshibagwale, et al. Standards Track [Page 45]
25642552

25652553
Figure 40: Example: Verification SET
25662554

2567-
2568-
2569-
2570-
2571-
2572-
2573-
2574-
2575-
2576-
Tulshibagwale, et al. Standards Track [Page 46]
2577-
2578-
SharedSignals June 2023
2579-
2580-
25812555
7.1.5. Stream Updated Event
25822556

25832557
A Transmitter MAY change the stream status in reference to one or
@@ -2596,6 +2570,14 @@ Tulshibagwale, et al. Standards Track [Page 46]
25962570
this event to any Receiver that has previously been enabled to
25972571
receive events for the specified Subject.
25982572

2573+
2574+
2575+
2576+
Tulshibagwale, et al. Standards Track [Page 46]
2577+
2578+
SharedSignals June 2023
2579+
2580+
25992581
The "stream-updated" event MAY contain the following claims:
26002582

26012583
status
@@ -2608,6 +2590,8 @@ Tulshibagwale, et al. Standards Track [Page 46]
26082590
OPTIONAL. Provides a short description of why the Transmitter has
26092591
updated the status.
26102592

2593+
As with any SSF Event, this event has a top-level sub_id claim:
2594+
26112595
sub_id
26122596

26132597
REQUIRED. The top-level sub_id claim specifies the Subject
@@ -2620,8 +2604,24 @@ Tulshibagwale, et al. Standards Track [Page 46]
26202604
implicitly added to the stream and MAY NOT be removed from the
26212605
stream.
26222606

2623-
Below is a non-normative example of a stream-updated event with a
2624-
specific subject.
2607+
Below is a non-normative example of a stream-updated event with a
2608+
specific subject.
2609+
2610+
2611+
2612+
2613+
2614+
2615+
2616+
2617+
2618+
2619+
2620+
2621+
2622+
2623+
2624+
26252625

26262626

26272627

0 commit comments

Comments
 (0)