Skip to content

Commit 09c9c88

Browse files
tulshitulshi
committed
Added format field to complex subjects and updated examples
1 parent ae0cf79 commit 09c9c88

File tree

3 files changed

+117
-21
lines changed

3 files changed

+117
-21
lines changed

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

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1516,7 +1516,10 @@ <h2 id="abstract"><a href="#abstract" class="selfRef">Abstract</a></h2>
15161516
<p id="section-toc.1-1.15.1"><a href="#appendix-B" class="auto internal xref">Appendix B</a>.  <a href="#name-notices" class="internal xref">Notices</a></p>
15171517
</li>
15181518
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.16">
1519-
<p id="section-toc.1-1.16.1"><a href="#appendix-C" class="auto internal xref"></a><a href="#name-authors-addresses" class="internal xref">Authors' Addresses</a></p>
1519+
<p id="section-toc.1-1.16.1"><a href="#appendix-C" class="auto internal xref"></a><a href="#name-contributors" class="internal xref">Contributors</a></p>
1520+
</li>
1521+
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.17">
1522+
<p id="section-toc.1-1.17.1"><a href="#appendix-D" class="auto internal xref"></a><a href="#name-authors-addresses" class="internal xref">Authors' Addresses</a></p>
15201523
</li>
15211524
</ul>
15221525
</nav>
@@ -1598,8 +1601,9 @@ <h3 id="name-complex-subject-members">
15981601
<a href="#section-3.2" class="section-number selfRef">3.2. </a><a href="#name-complex-subject-members" class="section-name selfRef">Complex Subject Members</a>
15991602
</h3>
16001603
<p id="section-3.2-1">A Complex Subject Member has a name and a value that is a JSON <span>[<a href="#RFC7159" class="cite xref">RFC7159</a>]</span>
1601-
object that has one or more Simple Subject Members. The name of each Simple
1602-
Subject Member in this value MAY be one of the following:<a href="#section-3.2-1" class="pilcrow"></a></p>
1604+
object that has a format field, and one or more Simple Subject Members. The name
1605+
of the format field is "format", and its value is "complex". The name of each
1606+
Simple Subject Member in this value MAY be one of the following:<a href="#section-3.2-1" class="pilcrow"></a></p>
16031607
<p id="section-3.2-2">user<a href="#section-3.2-2" class="pilcrow"></a></p>
16041608
<ul class="normal ulEmpty">
16051609
<li class="normal ulEmpty" id="section-3.2-3.1">
@@ -1650,6 +1654,7 @@ <h3 id="name-complex-subject-members">
16501654
<div class="lang-json sourcecode" id="section-3.2-18.1">
16511655
<pre>
16521656
"transferee": {
1657+
"format": "complex",
16531658
"user" : {
16541659
"format": "email",
16551660
"email": "bar@example.com"
@@ -1863,6 +1868,7 @@ <h2 id="name-example-sets-that-conform-t">
18631868
"events": {
18641869
"https://schemas.openid.net/secevent/caep/event-type/session-revoked": {
18651870
"subject": {
1871+
"format": "complex",
18661872
"user": {
18671873
"format": "iss_sub",
18681874
"iss": "https://idp.example.com/3957ea72-1b66-44d6-a044-d805712b9288/",
@@ -3228,6 +3234,7 @@ <h5 id="name-reading-a-streams-status">
32283234
{
32293235
"status": "enabled",
32303236
"subject": {
3237+
"format": "complex",
32313238
"tenant" : {
32323239
"format" : "iss_sub",
32333240
"iss" : "http://example.com/idp1",
@@ -3362,6 +3369,7 @@ <h5 id="name-updating-a-streams-status">
33623369
"stream_id": "f67e39a0a4d34d56b3aa1bc4cff0069f",
33633370
"status": "paused",
33643371
"subject": {
3372+
"format": "complex",
33653373
"tenant" : {
33663374
"format" : "iss_sub",
33673375
"iss" : "http://example.com/idp1",
@@ -3890,6 +3898,7 @@ <h4 id="name-stream-updated-event">
38903898
"events": {
38913899
"https://schemas.openid.net/secevent/ssf/event-type/stream-updated": {
38923900
"subject": {
3901+
"format" : "complex",
38933902
"tenant" : {
38943903
"format": "iss_sub",
38953904
"iss" : "http://example.com/idp1",
@@ -4466,8 +4475,24 @@ <h2 id="name-notices">
44664475
<p id="appendix-B-3">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.<a href="#appendix-B-3" class="pilcrow"></a></p>
44674476
</section>
44684477
</div>
4469-
<div id="authors-addresses">
4478+
<div id="contributors">
44704479
<section id="appendix-C">
4480+
<h2 id="name-contributors">
4481+
<a href="#name-contributors" class="section-name selfRef">Contributors</a>
4482+
</h2>
4483+
<address class="vcard">
4484+
<div dir="auto" class="left"><span class="fn nameRole">Steve Venema</span></div>
4485+
<div dir="auto" class="left"><span class="org">ForgeRock</span></div>
4486+
<div class="email">
4487+
<span>Email:</span>
4488+
<a href="mailto:steve.venema@forgerock.com" class="email">steve.venema@forgerock.com</a>
4489+
</div>
4490+
</address>
4491+
<p id="appendix-C-1">Steve defined the format field of Complex Subjects<a href="#appendix-C-1" class="pilcrow"></a></p>
4492+
</section>
4493+
</div>
4494+
<div id="authors-addresses">
4495+
<section id="appendix-D">
44714496
<h2 id="name-authors-addresses">
44724497
<a href="#name-authors-addresses" class="section-name selfRef">Authors' Addresses</a>
44734498
</h2>

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

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,15 @@ author:
5252
org: Cisco
5353
email: smiel@cisco.com
5454

55+
contributor:
56+
-
57+
ins: S. Venema
58+
name: Steve Venema
59+
org: ForgeRock
60+
email: steve.venema@forgerock.com
61+
contribution: |
62+
Steve defined the format field of Complex Subjects
63+
5564
normative:
5665
CLIENTCRED:
5766
author:
@@ -254,8 +263,9 @@ event.
254263
## Complex Subject Members {#complex-subjects}
255264

256265
A Complex Subject Member has a name and a value that is a JSON {{RFC7159}}
257-
object that has one or more Simple Subject Members. The name of each Simple
258-
Subject Member in this value MAY be one of the following:
266+
object that has a format field, and one or more Simple Subject Members. The name
267+
of the format field is "format", and its value is "complex". The name of each
268+
Simple Subject Member in this value MAY be one of the following:
259269

260270
user
261271

@@ -292,6 +302,7 @@ Below is a non-normative example of a Complex Subject claim in a SSF event.
292302

293303
~~~ json
294304
"transferee": {
305+
"format": "complex",
295306
"user" : {
296307
"format": "email",
297308
"email": "bar@example.com"
@@ -439,6 +450,7 @@ The following are hypothetical examples of SETs that conform to the Shared Signa
439450
"events": {
440451
"https://schemas.openid.net/secevent/caep/event-type/session-revoked": {
441452
"subject": {
453+
"format": "complex",
442454
"user": {
443455
"format": "iss_sub",
444456
"iss": "https://idp.example.com/3957ea72-1b66-44d6-a044-d805712b9288/",
@@ -1434,6 +1446,7 @@ Cache-Control: no-store
14341446
{
14351447
"status": "enabled",
14361448
"subject": {
1449+
"format": "complex",
14371450
"tenant" : {
14381451
"format" : "iss_sub",
14391452
"iss" : "http://example.com/idp1",
@@ -1521,6 +1534,7 @@ Authorization: Bearer eyJ0b2tlbiI6ImV4YW1wbGUifQo=
15211534
"stream_id": "f67e39a0a4d34d56b3aa1bc4cff0069f",
15221535
"status": "paused",
15231536
"subject": {
1537+
"format": "complex",
15241538
"tenant" : {
15251539
"format" : "iss_sub",
15261540
"iss" : "http://example.com/idp1",
@@ -1851,6 +1865,7 @@ subject
18511865
"events": {
18521866
"https://schemas.openid.net/secevent/ssf/event-type/stream-updated": {
18531867
"subject": {
1868+
"format" : "complex",
18541869
"tenant" : {
18551870
"format": "iss_sub",
18561871
"iss" : "http://example.com/idp1",

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

Lines changed: 71 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ Tulshibagwale, et al. Standards Track [Page 2]
127127
13.2. Informative References . . . . . . . . . . . . . . . . . 54
128128
Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 54
129129
Appendix B. Notices . . . . . . . . . . . . . . . . . . . . . . 54
130+
Contributors . . . . . . . . . . . . . . . . . . . . . . . . . . 55
130131
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 55
131132

132133
1. Introduction
@@ -164,7 +165,6 @@ Tulshibagwale, et al. Standards Track [Page 2]
164165

165166

166167

167-
168168
Tulshibagwale, et al. Standards Track [Page 3]
169169

170170
SharedSignals March 2023
@@ -189,9 +189,10 @@ Tulshibagwale, et al. Standards Track [Page 3]
189189
3.2. Complex Subject Members
190190

191191
A Complex Subject Member has a name and a value that is a JSON
192-
[RFC7159] object that has one or more Simple Subject Members. The
193-
name of each Simple Subject Member in this value MAY be one of the
194-
following:
192+
[RFC7159] object that has a format field, and one or more Simple
193+
Subject Members. The name of the format field is "format", and its
194+
value is "complex". The name of each Simple Subject Member in this
195+
value MAY be one of the following:
195196

196197
user
197198

@@ -220,7 +221,6 @@ Tulshibagwale, et al. Standards Track [Page 3]
220221

221222

222223

223-
224224
Tulshibagwale, et al. Standards Track [Page 4]
225225

226226
SharedSignals March 2023
@@ -238,6 +238,7 @@ Tulshibagwale, et al. Standards Track [Page 4]
238238
event.
239239

240240
"transferee": {
241+
"format": "complex",
241242
"user" : {
242243
"format": "email",
243244
"email": "bar@example.com"
@@ -276,7 +277,6 @@ Tulshibagwale, et al. Standards Track [Page 4]
276277

277278

278279

279-
280280
Tulshibagwale, et al. Standards Track [Page 5]
281281

282282
SharedSignals March 2023
@@ -420,6 +420,7 @@ Tulshibagwale, et al. Standards Track [Page 7]
420420
"events": {
421421
"https://schemas.openid.net/secevent/caep/event-type/session-revoked": {
422422
"subject": {
423+
"format": "complex",
423424
"user": {
424425
"format": "iss_sub",
425426
"iss": "https://idp.example.com/3957ea72-1b66-44d6-a044-d805712b9288/",
@@ -444,7 +445,6 @@ Tulshibagwale, et al. Standards Track [Page 7]
444445

445446

446447

447-
448448
Tulshibagwale, et al. Standards Track [Page 8]
449449

450450
SharedSignals March 2023
@@ -1831,6 +1831,7 @@ Tulshibagwale, et al. Standards Track [Page 32]
18311831
{
18321832
"status": "enabled",
18331833
"subject": {
1834+
"format": "complex",
18341835
"tenant" : {
18351836
"format" : "iss_sub",
18361837
"iss" : "http://example.com/idp1",
@@ -1841,7 +1842,6 @@ Tulshibagwale, et al. Standards Track [Page 32]
18411842

18421843
Figure 30: Example: Check Stream Status Response
18431844

1844-
Errors are signaled with HTTP status codes as follows:
18451845

18461846

18471847

@@ -1850,6 +1850,8 @@ Tulshibagwale, et al. Standards Track [Page 33]
18501850
SharedSignals March 2023
18511851

18521852

1853+
Errors are signaled with HTTP status codes as follows:
1854+
18531855
+======+========================================================+
18541856
| Code | Description |
18551857
+======+========================================================+
@@ -1896,8 +1898,6 @@ Tulshibagwale, et al. Standards Track [Page 33]
18961898

18971899
REQUIRED. The stream whose status is being updated.
18981900

1899-
status
1900-
19011901

19021902

19031903

@@ -1906,6 +1906,8 @@ Tulshibagwale, et al. Standards Track [Page 34]
19061906
SharedSignals March 2023
19071907

19081908

1909+
status
1910+
19091911
REQUIRED. The new status of the Event Stream.
19101912

19111913
subject
@@ -1955,8 +1957,6 @@ Tulshibagwale, et al. Standards Track [Page 34]
19551957

19561958

19571959

1958-
1959-
19601960
Tulshibagwale, et al. Standards Track [Page 35]
19611961

19621962
SharedSignals March 2023
@@ -1970,6 +1970,7 @@ Tulshibagwale, et al. Standards Track [Page 35]
19701970
"stream_id": "f67e39a0a4d34d56b3aa1bc4cff0069f",
19711971
"status": "paused",
19721972
"subject": {
1973+
"format": "complex",
19731974
"tenant" : {
19741975
"format" : "iss_sub",
19751976
"iss" : "http://example.com/idp1",
@@ -2012,7 +2013,6 @@ Tulshibagwale, et al. Standards Track [Page 35]
20122013

20132014

20142015

2015-
20162016
Tulshibagwale, et al. Standards Track [Page 36]
20172017

20182018
SharedSignals March 2023
@@ -2478,6 +2478,7 @@ Tulshibagwale, et al. Standards Track [Page 44]
24782478
"events": {
24792479
"https://schemas.openid.net/secevent/ssf/event-type/stream-updated": {
24802480
"subject": {
2481+
"format" : "complex",
24812482
"tenant" : {
24822483
"format": "iss_sub",
24832484
"iss" : "http://example.com/idp1",
@@ -2516,7 +2517,6 @@ Tulshibagwale, et al. Standards Track [Page 44]
25162517

25172518

25182519

2519-
25202520
Tulshibagwale, et al. Standards Track [Page 45]
25212521

25222522
SharedSignals March 2023
@@ -3038,6 +3038,15 @@ Tulshibagwale, et al. Standards Track [Page 54]
30383038
patents, patent applications, or other proprietary rights that may
30393039
cover technology that may be required to practice this specification.
30403040

3041+
Contributors
3042+
3043+
Steve Venema
3044+
ForgeRock
3045+
Email: steve.venema@forgerock.com
3046+
3047+
3048+
Steve defined the format field of Complex Subjects
3049+
30413050
Authors' Addresses
30423051

30433052
Atul Tulshibagwale
@@ -3065,6 +3074,14 @@ Authors' Addresses
30653074
Email: secevemt@ve7jtb.com
30663075

30673076

3077+
3078+
3079+
3080+
Tulshibagwale, et al. Standards Track [Page 55]
3081+
3082+
SharedSignals March 2023
3083+
3084+
30683085
Shayne Miel
30693086
Cisco
30703087
Email: smiel@cisco.com
@@ -3077,4 +3094,43 @@ Authors' Addresses
30773094

30783095

30793096

3080-
Tulshibagwale, et al. Standards Track [Page 55]
3097+
3098+
3099+
3100+
3101+
3102+
3103+
3104+
3105+
3106+
3107+
3108+
3109+
3110+
3111+
3112+
3113+
3114+
3115+
3116+
3117+
3118+
3119+
3120+
3121+
3122+
3123+
3124+
3125+
3126+
3127+
3128+
3129+
3130+
3131+
3132+
3133+
3134+
3135+
3136+
Tulshibagwale, et al. Standards Track [Page 56]

0 commit comments

Comments
 (0)