forked from openid/sharedsignals
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openid-sse-framework-1_0.html
2306 lines (2213 loc) · 111 KB
/
openid-sse-framework-1_0.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head profile="http://www.w3.org/2006/03/hcard http://dublincore.org/documents/2008/08/04/dc-html/">
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<title>OpenID Shared Signals and Events Framework Specification 1.0 - draft 01</title>
<style type="text/css" title="Xml2Rfc (sans serif)">
/*<![CDATA[*/
a {
text-decoration: none;
}
/* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
a.info {
/* This is the key. */
position: relative;
z-index: 24;
text-decoration: none;
}
a.info:hover {
z-index: 25;
color: #FFF; background-color: #900;
}
a.info span { display: none; }
a.info:hover span.info {
/* The span will display just on :hover state. */
display: block;
position: absolute;
font-size: smaller;
top: 2em; left: -5em; width: 15em;
padding: 2px; border: 1px solid #333;
color: #900; background-color: #EEE;
text-align: left;
}
a.smpl {
color: black;
}
a:hover {
text-decoration: underline;
}
a:active {
text-decoration: underline;
}
address {
margin-top: 1em;
margin-left: 2em;
font-style: normal;
}
body {
color: black;
font-family: verdana, helvetica, arial, sans-serif;
font-size: 10pt;
max-width: 55em;
}
cite {
font-style: normal;
}
dd {
margin-right: 2em;
}
dl {
margin-left: 2em;
}
ul.empty {
list-style-type: none;
}
ul.empty li {
margin-top: .5em;
}
dl p {
margin-left: 0em;
}
dt {
margin-top: .5em;
}
h1 {
font-size: 14pt;
line-height: 21pt;
page-break-after: avoid;
}
h1.np {
page-break-before: always;
}
h1 a {
color: #333333;
}
h2 {
font-size: 12pt;
line-height: 15pt;
page-break-after: avoid;
}
h3, h4, h5, h6 {
font-size: 10pt;
page-break-after: avoid;
}
h2 a, h3 a, h4 a, h5 a, h6 a {
color: black;
}
img {
margin-left: 3em;
}
li {
margin-left: 2em;
margin-right: 2em;
}
ol {
margin-left: 2em;
margin-right: 2em;
}
ol p {
margin-left: 0em;
}
p {
margin-left: 2em;
margin-right: 2em;
}
pre {
margin-left: 3em;
background-color: lightyellow;
padding: .25em;
}
pre.text2 {
border-style: dotted;
border-width: 1px;
background-color: #f0f0f0;
width: 69em;
}
pre.inline {
background-color: white;
padding: 0em;
}
pre.text {
border-style: dotted;
border-width: 1px;
background-color: #f8f8f8;
width: 69em;
}
pre.drawing {
border-style: solid;
border-width: 1px;
background-color: #f8f8f8;
padding: 2em;
}
table {
margin-left: 2em;
}
table.tt {
vertical-align: top;
}
table.full {
border-style: outset;
border-width: 1px;
}
table.headers {
border-style: outset;
border-width: 1px;
}
table.tt td {
vertical-align: top;
}
table.full td {
border-style: inset;
border-width: 1px;
}
table.tt th {
vertical-align: top;
}
table.full th {
border-style: inset;
border-width: 1px;
}
table.headers th {
border-style: none none inset none;
border-width: 1px;
}
table.left {
margin-right: auto;
}
table.right {
margin-left: auto;
}
table.center {
margin-left: auto;
margin-right: auto;
}
caption {
caption-side: bottom;
font-weight: bold;
font-size: 9pt;
margin-top: .5em;
}
table.header {
border-spacing: 1px;
width: 95%;
font-size: 10pt;
color: white;
}
td.top {
vertical-align: top;
}
td.topnowrap {
vertical-align: top;
white-space: nowrap;
}
table.header td {
background-color: gray;
width: 50%;
}
table.header a {
color: white;
}
td.reference {
vertical-align: top;
white-space: nowrap;
padding-right: 1em;
}
thead {
display:table-header-group;
}
ul.toc, ul.toc ul {
list-style: none;
margin-left: 1.5em;
margin-right: 0em;
padding-left: 0em;
}
ul.toc li {
line-height: 150%;
font-weight: bold;
font-size: 10pt;
margin-left: 0em;
margin-right: 0em;
}
ul.toc li li {
line-height: normal;
font-weight: normal;
font-size: 9pt;
margin-left: 0em;
margin-right: 0em;
}
li.excluded {
font-size: 0pt;
}
ul p {
margin-left: 0em;
}
.comment {
background-color: yellow;
}
.center {
text-align: center;
}
.error {
color: red;
font-style: italic;
font-weight: bold;
}
.figure {
font-weight: bold;
text-align: center;
font-size: 9pt;
}
.filename {
color: #333333;
font-weight: bold;
font-size: 12pt;
line-height: 21pt;
text-align: center;
}
.fn {
font-weight: bold;
}
.hidden {
display: none;
}
.left {
text-align: left;
}
.right {
text-align: right;
}
.title {
color: #990000;
font-size: 18pt;
line-height: 18pt;
font-weight: bold;
text-align: center;
margin-top: 36pt;
}
.vcardline {
display: block;
}
.warning {
font-size: 14pt;
background-color: yellow;
}
@media print {
.noprint {
display: none;
}
a {
color: black;
text-decoration: none;
}
table.header {
width: 90%;
}
td.header {
width: 50%;
color: black;
background-color: white;
vertical-align: top;
font-size: 12pt;
}
ul.toc a::after {
content: leader('.') target-counter(attr(href), page);
}
ul.ind li li a {
content: target-counter(attr(href), page);
}
.print2col {
column-count: 2;
-moz-column-count: 2;
column-fill: auto;
}
}
@page {
@top-left {
content: "Internet-Draft";
}
@top-right {
content: "December 2010";
}
@top-center {
content: "Abbreviated Title";
}
@bottom-left {
content: "Doe";
}
@bottom-center {
content: "Expires June 2011";
}
@bottom-right {
content: "[Page " counter(page) "]";
}
}
@page:first {
@top-left {
content: normal;
}
@top-right {
content: normal;
}
@top-center {
content: normal;
}
}
/*]]>*/
</style>
<link href="#rfc.toc" rel="Contents">
<link href="#rfc.section.1" rel="Chapter" title="1 Introduction">
<link href="#rfc.section.1.1" rel="Chapter" title="1.1 Notational Conventions">
<link href="#rfc.section.2" rel="Chapter" title="2 Subject Principals">
<link href="#rfc.section.3" rel="Chapter" title="3 Subject Members in SSE Events">
<link href="#rfc.section.3.1" rel="Chapter" title="3.1 Simple Subject Members">
<link href="#rfc.section.3.2" rel="Chapter" title="3.2 Complex Subject Members">
<link href="#rfc.section.3.2.1" rel="Chapter" title="3.2.1 Complex Subject Interpretation">
<link href="#rfc.section.3.3" rel="Chapter" title="3.3 Subject Identifiers in SSE Events">
<link href="#rfc.section.3.4" rel="Chapter" title="3.4 Additional Subject Identifier Formats">
<link href="#rfc.section.3.4.1" rel="Chapter" title="3.4.1 JWT ID Subject Identifier Format">
<link href="#rfc.section.3.4.2" rel="Chapter" title="3.4.2 SAML Assertion ID Subject Identifier Format">
<link href="#rfc.section.3.5" rel="Chapter" title="3.5 Receiver Subject Processing">
<link href="#rfc.section.4" rel="Chapter" title="4 Event Properties">
<link href="#rfc.section.5" rel="Chapter" title="5 Example SETs that conform to the SSE framework">
<link href="#rfc.section.6" rel="Chapter" title="6 Transmitter Configuration Discovery">
<link href="#rfc.section.6.1" rel="Chapter" title="6.1 Transmitter Configuration Metadata">
<link href="#rfc.section.6.2" rel="Chapter" title="6.2 Obtaining Transmitter Configuration Information">
<link href="#rfc.section.6.2.1" rel="Chapter" title="6.2.1 Transmitter Configuration Request">
<link href="#rfc.section.6.2.2" rel="Chapter" title="6.2.2 Backward Compatibility for RISC Transmitters">
<link href="#rfc.section.6.2.3" rel="Chapter" title="6.2.3 Transmitter Configuration Response">
<link href="#rfc.section.6.2.4" rel="Chapter" title="6.2.4 Transmitter Configuration Validation">
<link href="#rfc.section.7" rel="Chapter" title="7 Management API for SET Event Streams">
<link href="#rfc.section.7.1" rel="Chapter" title="7.1 Event Stream Management">
<link href="#rfc.section.7.1.1" rel="Chapter" title="7.1.1 Stream Status">
<link href="#rfc.section.7.1.1.1" rel="Chapter" title="7.1.1.1 Reading a Stream’s Status">
<link href="#rfc.section.7.1.1.2" rel="Chapter" title="7.1.1.2 Updating a Stream's Status">
<link href="#rfc.section.7.1.2" rel="Chapter" title="7.1.2 Stream Configuration">
<link href="#rfc.section.7.1.2.1" rel="Chapter" title="7.1.2.1 Reading a Stream’s Configuration">
<link href="#rfc.section.7.1.2.2" rel="Chapter" title="7.1.2.2 Updating a Stream’s Configuration">
<link href="#rfc.section.7.1.2.3" rel="Chapter" title="7.1.2.3 Removing a Stream Configuration">
<link href="#rfc.section.7.1.3" rel="Chapter" title="7.1.3 Subjects">
<link href="#rfc.section.7.1.3.1" rel="Chapter" title="7.1.3.1 Adding a Subject to a Stream">
<link href="#rfc.section.7.1.3.2" rel="Chapter" title="7.1.3.2 Removing a Subject">
<link href="#rfc.section.7.1.4" rel="Chapter" title="7.1.4 Verification">
<link href="#rfc.section.7.1.4.1" rel="Chapter" title="7.1.4.1 Verification Event">
<link href="#rfc.section.7.1.4.2" rel="Chapter" title="7.1.4.2 Triggering a Verification Event.">
<link href="#rfc.section.7.1.5" rel="Chapter" title="7.1.5 Stream Updated Event">
<link href="#rfc.section.8" rel="Chapter" title="8 Authorization">
<link href="#rfc.section.9" rel="Chapter" title="9 Security Considerations">
<link href="#rfc.section.9.1" rel="Chapter" title="9.1 Subject Probing">
<link href="#rfc.section.9.2" rel="Chapter" title="9.2 Information Harvesting">
<link href="#rfc.section.9.3" rel="Chapter" title="9.3 Malicious Subject Removal">
<link href="#rfc.section.10" rel="Chapter" title="10 Privacy Considerations">
<link href="#rfc.section.10.1" rel="Chapter" title="10.1 Subject Information Leakage">
<link href="#rfc.section.10.2" rel="Chapter" title="10.2 Previously Consented Data">
<link href="#rfc.section.10.3" rel="Chapter" title="10.3 New Data">
<link href="#rfc.section.10.3.1" rel="Chapter" title="10.3.1 Organizational Data">
<link href="#rfc.section.10.3.2" rel="Chapter" title="10.3.2 Consentable Data">
<link href="#rfc.section.11" rel="Chapter" title="11 Profiles">
<link href="#rfc.section.11.1" rel="Chapter" title="11.1 Security Event Token Profile">
<link href="#rfc.section.11.1.1" rel="Chapter" title="11.1.1 Signature Key Resolution">
<link href="#rfc.section.11.1.2" rel="Chapter" title="11.1.2 SSE Event Subject">
<link href="#rfc.section.11.1.3" rel="Chapter" title="11.1.3 SSE Event Properties">
<link href="#rfc.section.11.1.4" rel="Chapter" title="11.1.4 Explicit Typing of SETs">
<link href="#rfc.section.11.1.5" rel="Chapter" title='11.1.5 The "exp" Claim'>
<link href="#rfc.section.11.1.6" rel="Chapter" title='11.1.6 The "aud" Claim'>
<link href="#rfc.section.11.1.7" rel="Chapter" title='11.1.7 The "events" claim'>
<link href="#rfc.section.11.1.8" rel="Chapter" title="11.1.8 Security Considerations">
<link href="#rfc.section.11.1.8.1" rel="Chapter" title="11.1.8.1 Distinguishing SETs from other Kinds of JWTs">
<link href="#rfc.section.11.2" rel="Chapter" title="11.2 SET Token Delivery Using HTTP Profile">
<link href="#rfc.section.11.2.1" rel="Chapter" title="11.2.1 Stream Configuration Metadata">
<link href="#rfc.section.11.2.1.1" rel="Chapter" title="11.2.1.1 Push Delivery using HTTP">
<link href="#rfc.section.11.2.1.2" rel="Chapter" title="11.2.1.2 Polling Delivery using HTTP">
<link href="#rfc.section.12" rel="Chapter" title="12 IANA Considerations">
<link href="#rfc.references" rel="Chapter" title="13 References">
<link href="#rfc.references.1" rel="Chapter" title="13.1 Normative References">
<link href="#rfc.references.2" rel="Chapter" title="13.2 Non-Normative References">
<link href="#rfc.appendix.A" rel="Chapter" title="A Acknowledgements">
<link href="#rfc.appendix.B" rel="Chapter" title="B Notices">
<link href="#rfc.authors" rel="Chapter">
<meta name="generator" content="xml2rfc version 3.10.0 - https://tools.ietf.org/tools/xml2rfc" />
<link rel="schema.dct" href="http://purl.org/dc/terms/" />
<meta name="dct.creator" content="Tulshibagwale, A., Cappalli, T., Scurtescu, M., Backman, A., and J. Bradley" />
<meta name="dct.identifier" content="urn:ietf:id:openid-sse-framework-1_0" />
<meta name="dct.issued" scheme="ISO8601" content="2021-06-08" />
<meta name="dct.abstract" content="This Shared Signals and Events (SSE) Framework enables sharing of signals and events between cooperating peers. It enables multiple applications such as Risk Incident Sharing and Coordination (RISC) and the Continuous Access Evaluation Profile () This specification defines: A profile for IETF Security Events Subject Principals Subject Claims in SSE Events Event Types Event Properties Configuration information and discovery method for Transmitters A Management API for Event Streams This spec also directly profiles several IETF Security Events drafts:Security Event Token (SET) Subject Identifiers for Security Event Tokens Push-Based SET Token Delivery Using HTTP Poll-Based SET Token Delivery Using HTTP " />
<meta name="description" content="This Shared Signals and Events (SSE) Framework enables sharing of signals and events between cooperating peers. It enables multiple applications such as Risk Incident Sharing and Coordination (RISC) and the Continuous Access Evaluation Profile () This specification defines: A profile for IETF Security Events Subject Principals Subject Claims in SSE Events Event Types Event Properties Configuration information and discovery method for Transmitters A Management API for Event Streams This spec also directly profiles several IETF Security Events drafts:Security Event Token (SET) Subject Identifiers for Security Event Tokens Push-Based SET Token Delivery Using HTTP Poll-Based SET Token Delivery Using HTTP " />
</head>
<body>
<table class="header">
<tbody>
<tr>
<td class="left"></td>
<td class="right">A. Tulshibagwale</td>
</tr>
<tr>
<td class="left"></td>
<td class="right">Google</td>
</tr>
<tr>
<td class="left"></td>
<td class="right">T. Cappalli</td>
</tr>
<tr>
<td class="left"></td>
<td class="right">Microsoft</td>
</tr>
<tr>
<td class="left"></td>
<td class="right">M. Scurtescu</td>
</tr>
<tr>
<td class="left"></td>
<td class="right">Coinbase</td>
</tr>
<tr>
<td class="left"></td>
<td class="right">A. Backman</td>
</tr>
<tr>
<td class="left"></td>
<td class="right">Amazon</td>
</tr>
<tr>
<td class="left"></td>
<td class="right">J. Bradley</td>
</tr>
<tr>
<td class="left"></td>
<td class="right">Yubico</td>
</tr>
<tr>
<td class="left"></td>
<td class="right">June 8, 2021</td>
</tr>
</tbody>
</table>
<p class="title">OpenID Shared Signals and Events Framework Specification 1.0 - draft 01<br />
<span class="filename">openid-sse-framework-1_0</span></p>
<h1 id="rfc.abstract"><a href="#rfc.abstract">Abstract</a></h1>
<p>This Shared Signals and Events (SSE) Framework enables sharing of signals and events between cooperating peers. It enables multiple applications such as Risk Incident Sharing and Coordination (RISC) and the Continuous Access Evaluation Profile (<a href="#CAEP" class="xref">[CAEP]</a>) </p>
<p>This specification defines: </p>
<ul>
<li>A profile for <a href="https://datatracker.ietf.org/wg/secevent/about/">IETF Security Events</a>
</li>
<li>Subject Principals</li>
<li>Subject Claims in SSE Events</li>
<li>Event Types</li>
<li>Event Properties</li>
<li>Configuration information and discovery method for Transmitters</li>
<li>A Management API for Event Streams</li>
</ul>
<p>This spec also directly profiles several IETF Security Events drafts:</p>
<ul>
<li><a href="#SET" class="xref">Security Event Token (SET)</a></li>
<li><a href="#SUBIDS" class="xref">Subject Identifiers for Security Event Tokens</a></li>
<li><a href="#DELIVERYPUSH" class="xref">Push-Based SET Token Delivery Using HTTP</a></li>
<li><a href="#DELIVERYPOLL" class="xref">Poll-Based SET Token Delivery Using HTTP</a></li>
</ul>
<hr class="noprint" />
<h1 class="np" id="rfc.toc"><a href="#rfc.toc">Table of Contents</a></h1>
<ul class="toc">
<li>1. <a href="#rfc.section.1">Introduction</a>
</li>
<ul><li>1.1. <a href="#rfc.section.1.1">Notational Conventions</a>
</li>
</ul><li>2. <a href="#rfc.section.2">Subject Principals</a>
</li>
<li>3. <a href="#rfc.section.3">Subject Members in SSE Events</a>
</li>
<ul><li>3.1. <a href="#rfc.section.3.1">Simple Subject Members</a>
</li>
<li>3.2. <a href="#rfc.section.3.2">Complex Subject Members</a>
</li>
<ul><li>3.2.1. <a href="#rfc.section.3.2.1">Complex Subject Interpretation</a>
</li>
</ul><li>3.3. <a href="#rfc.section.3.3">Subject Identifiers in SSE Events</a>
</li>
<li>3.4. <a href="#rfc.section.3.4">Additional Subject Identifier Formats</a>
</li>
<ul><li>3.4.1. <a href="#rfc.section.3.4.1">JWT ID Subject Identifier Format</a>
</li>
<li>3.4.2. <a href="#rfc.section.3.4.2">SAML Assertion ID Subject Identifier Format</a>
</li>
</ul><li>3.5. <a href="#rfc.section.3.5">Receiver Subject Processing</a>
</li>
</ul><li>4. <a href="#rfc.section.4">Event Properties</a>
</li>
<li>5. <a href="#rfc.section.5">Example SETs that conform to the SSE framework</a>
</li>
<li>6. <a href="#rfc.section.6">Transmitter Configuration Discovery</a>
</li>
<ul><li>6.1. <a href="#rfc.section.6.1">Transmitter Configuration Metadata</a>
</li>
<li>6.2. <a href="#rfc.section.6.2">Obtaining Transmitter Configuration Information</a>
</li>
<ul><li>6.2.1. <a href="#rfc.section.6.2.1">Transmitter Configuration Request</a>
</li>
<li>6.2.2. <a href="#rfc.section.6.2.2">Backward Compatibility for RISC Transmitters</a>
</li>
<li>6.2.3. <a href="#rfc.section.6.2.3">Transmitter Configuration Response</a>
</li>
<li>6.2.4. <a href="#rfc.section.6.2.4">Transmitter Configuration Validation</a>
</li>
</ul></ul><li>7. <a href="#rfc.section.7">Management API for SET Event Streams</a>
</li>
<ul><li>7.1. <a href="#rfc.section.7.1">Event Stream Management</a>
</li>
<ul><li>7.1.1. <a href="#rfc.section.7.1.1">Stream Status</a>
</li>
<ul><li>7.1.1.1. <a href="#rfc.section.7.1.1.1">Reading a Stream’s Status</a>
</li>
<li>7.1.1.2. <a href="#rfc.section.7.1.1.2">Updating a Stream's Status</a>
</li>
</ul><li>7.1.2. <a href="#rfc.section.7.1.2">Stream Configuration</a>
</li>
<ul><li>7.1.2.1. <a href="#rfc.section.7.1.2.1">Reading a Stream’s Configuration</a>
</li>
<li>7.1.2.2. <a href="#rfc.section.7.1.2.2">Updating a Stream’s Configuration</a>
</li>
<li>7.1.2.3. <a href="#rfc.section.7.1.2.3">Removing a Stream Configuration</a>
</li>
</ul><li>7.1.3. <a href="#rfc.section.7.1.3">Subjects</a>
</li>
<ul><li>7.1.3.1. <a href="#rfc.section.7.1.3.1">Adding a Subject to a Stream</a>
</li>
<li>7.1.3.2. <a href="#rfc.section.7.1.3.2">Removing a Subject</a>
</li>
</ul><li>7.1.4. <a href="#rfc.section.7.1.4">Verification</a>
</li>
<ul><li>7.1.4.1. <a href="#rfc.section.7.1.4.1">Verification Event</a>
</li>
<li>7.1.4.2. <a href="#rfc.section.7.1.4.2">Triggering a Verification Event.</a>
</li>
</ul><li>7.1.5. <a href="#rfc.section.7.1.5">Stream Updated Event</a>
</li>
</ul></ul><li>8. <a href="#rfc.section.8">Authorization</a>
</li>
<li>9. <a href="#rfc.section.9">Security Considerations</a>
</li>
<ul><li>9.1. <a href="#rfc.section.9.1">Subject Probing</a>
</li>
<li>9.2. <a href="#rfc.section.9.2">Information Harvesting</a>
</li>
<li>9.3. <a href="#rfc.section.9.3">Malicious Subject Removal</a>
</li>
</ul><li>10. <a href="#rfc.section.10">Privacy Considerations</a>
</li>
<ul><li>10.1. <a href="#rfc.section.10.1">Subject Information Leakage</a>
</li>
<li>10.2. <a href="#rfc.section.10.2">Previously Consented Data</a>
</li>
<li>10.3. <a href="#rfc.section.10.3">New Data</a>
</li>
<ul><li>10.3.1. <a href="#rfc.section.10.3.1">Organizational Data</a>
</li>
<li>10.3.2. <a href="#rfc.section.10.3.2">Consentable Data</a>
</li>
</ul></ul><li>11. <a href="#rfc.section.11">Profiles</a>
</li>
<ul><li>11.1. <a href="#rfc.section.11.1">Security Event Token Profile</a>
</li>
<ul><li>11.1.1. <a href="#rfc.section.11.1.1">Signature Key Resolution</a>
</li>
<li>11.1.2. <a href="#rfc.section.11.1.2">SSE Event Subject</a>
</li>
<li>11.1.3. <a href="#rfc.section.11.1.3">SSE Event Properties</a>
</li>
<li>11.1.4. <a href="#rfc.section.11.1.4">Explicit Typing of SETs</a>
</li>
<li>11.1.5. <a href="#rfc.section.11.1.5">The "exp" Claim</a>
</li>
<li>11.1.6. <a href="#rfc.section.11.1.6">The "aud" Claim</a>
</li>
<li>11.1.7. <a href="#rfc.section.11.1.7">The "events" claim</a>
</li>
<li>11.1.8. <a href="#rfc.section.11.1.8">Security Considerations</a>
</li>
<ul><li>11.1.8.1. <a href="#rfc.section.11.1.8.1">Distinguishing SETs from other Kinds of JWTs</a>
</li>
</ul></ul><li>11.2. <a href="#rfc.section.11.2">SET Token Delivery Using HTTP Profile</a>
</li>
<ul><li>11.2.1. <a href="#rfc.section.11.2.1">Stream Configuration Metadata</a>
</li>
<ul><li>11.2.1.1. <a href="#rfc.section.11.2.1.1">Push Delivery using HTTP</a>
</li>
<li>11.2.1.2. <a href="#rfc.section.11.2.1.2">Polling Delivery using HTTP</a>
</li>
</ul></ul></ul><li>12. <a href="#rfc.section.12">IANA Considerations</a>
</li>
<li>13. <a href="#rfc.references">References</a>
</li>
<ul><li>13.1. <a href="#rfc.references.1">Normative References</a>
</li>
<li>13.2. <a href="#rfc.references.2">Non-Normative References</a>
</li>
</ul><li>Appendix A. <a href="#rfc.appendix.A">Acknowledgements</a>
</li>
<li>Appendix B. <a href="#rfc.appendix.B">Notices</a>
</li>
<li><a href="#rfc.authors">Authors' Addresses</a>
</li>
</ul>
<h1 id="rfc.section.1">
<a href="#rfc.section.1">1.</a> <a href="#intro" id="intro">Introduction</a>
</h1>
<h1 id="rfc.section.1.1">
<a href="#rfc.section.1.1">1.1.</a> <a href="#conv" id="conv">Notational Conventions</a>
</h1>
<p id="rfc.section.1.1.p.1">The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 <a href="#RFC2119" class="xref">[RFC2119]</a> <a href="#RFC8174" class="xref">[RFC8174]</a> when, and only when, they appear in all capitals, as shown here.</p>
<h1 id="rfc.section.2">
<a href="#rfc.section.2">2.</a> <a href="#subject-principals" id="subject-principals">Subject Principals</a>
</h1>
<p id="rfc.section.2.p.1">This SSE Framework specification defines a Subject Principal to be the entities about which an event can be sent by Transmitters and received by Receivers using the SSE Framework.</p>
<p id="rfc.section.2.p.2">Subject Principals are the managed entities in a SSE Transmitter or Receiver. These include human or robotic principals, devices, customer tenants in a multi-tenanted service, organizational units within a tenant, groups of subject principals or other entities that are managed by Transmitters and Receivers. There may be other actors or resources that can be treated as Subject Principals, and event-type definitions SHOULD specify the range of principals addressed by the event.</p>
<p id="rfc.section.2.p.3">Subject Principals are identified by Subject Members defined below.</p>
<h1 id="rfc.section.3">
<a href="#rfc.section.3">3.</a> <a href="#subject-ids" id="subject-ids">Subject Members in SSE Events</a>
</h1>
<p id="rfc.section.3.p.1">A member of type Subject in an SSE event MAY have any claim name. Each Subject Member MUST refer to exactly one Subject Principal.</p>
<p id="rfc.section.3.p.2">A Subject may be a <samp>simple subject</samp> or a <samp>complex subject.</samp></p>
<h1 id="rfc.section.3.1">
<a href="#rfc.section.3.1">3.1.</a> <a href="#simple-subjects" id="simple-subjects">Simple Subject Members</a>
</h1>
<p id="rfc.section.3.1.p.1">A Simple Subject Member has a claim name and a value that is a <samp>Subject Identifier</samp> as defined in the <a href="#SUBIDS" class="xref">Subject Identifiers for Security Event Tokens</a>. Below is a non-normative example of a Simple Subject Member in a SSE event.</p>
<div id="rfc.figure.1"></div>
<div id="simple-subject-ex"></div>
<pre>
"transferer": {
"format": "email",
"email": "[email protected]"
}
</pre>
<p class="figure">Figure 1: Example: Simple Subject</p>
<h1 id="rfc.section.3.2">
<a href="#rfc.section.3.2">3.2.</a> <a href="#complex-subjects" id="complex-subjects">Complex Subject Members</a>
</h1>
<p id="rfc.section.3.2.p.1">A Complex Subject Member has a name and a value that is a <a href="#RFC7159" class="xref">JSON</a> object that has one or more Simple Subject Members. The name of each Simple Subject Member in this value MAY be one of the following: </p>
<dl>
<dt>user</dt>
<dd style="margin-left: 8">
<br>OPTIONAL. A Subject Identifier that identifies a user.</dd>
<dt>device</dt>
<dd style="margin-left: 8">
<br>OPTIONAL. A Subject Identifier that identifies a device.</dd>
<dt>session</dt>
<dd style="margin-left: 8">
<br>OPTIONAL. A Subject Identifier that identifies a session.</dd>
<dt>application</dt>
<dd style="margin-left: 8">
<br>OPTIONAL. A Subject Identifier that identifies an application.</dd>
<dt>tenant</dt>
<dd style="margin-left: 8">
<br>OPTIONAL. A Subject Identifier that identifies a tenant.</dd>
<dt>org_unit</dt>
<dd style="margin-left: 8">
<br>OPTIONAL. A Subject Identifier that identifies an organizational unit.</dd>
<dt>group</dt>
<dd style="margin-left: 8">
<br>OPTIONAL. A Subject Identifier that identifies a group.</dd>
</dl>
<p id="rfc.section.3.2.p.2">Additional Subject Member names MAY be used in Complex Subjects. Each member name MAY appear at most once in the Complex Subject value.</p>
<p id="rfc.section.3.2.p.3">Below is a non-normative example of a Complex Subject claim in a SSE event.</p>
<div id="rfc.figure.2"></div>
<div id="complex-subject-ex"></div>
<pre>
"transferee": {
"user" : {
"format": "email",
"email": "[email protected]"
},
"tenant" : {
"format": "iss_sub",
"iss" : "http://example.com/idp1",
"sub" : "1234"
}
}
</pre>
<p class="figure">Figure 2: Example: Complex Subject</p>
<h1 id="rfc.section.3.2.1">
<a href="#rfc.section.3.2.1">3.2.1.</a> <a href="#complex-subject-interpretation" id="complex-subject-interpretation">Complex Subject Interpretation</a>
</h1>
<p id="rfc.section.3.2.1.p.1">All members within a Complex Subject MUST represent attributes of the same Subject Principal. As a whole, the Complex Subject MUST refer to exactly one Subject Principal.</p>
<h1 id="rfc.section.3.3">
<a href="#rfc.section.3.3">3.3.</a> <a href="#subject-ids-in-sse" id="subject-ids-in-sse">Subject Identifiers in SSE Events</a>
</h1>
<p id="rfc.section.3.3.p.1">A Subject Identifier in a SSE event MUST have an identifier format that is any one of: </p>
<ul>
<li>Defined in the IANA Registry defined in <a href="#SUBIDS" class="xref">Subject Identifiers for Security Event Tokens</a>, located at <samp>"https://www.iana.org/assignments/secevent/".</samp>
</li>
<li>An identifier format defined in the <a href="#additional-subject-id-formats" class="xref">Additional Subject Identifier Formats</a> section below, OR</li>
<li>A proprietary subject identifier format that is agreed to between parties. Members within a subject identifier that has a proprietary subject identifier format are agreed to between the parties and such agreement is outside the scope of this specification.</li>
</ul>
<h1 id="rfc.section.3.4">
<a href="#rfc.section.3.4">3.4.</a> <a href="#additional-subject-id-formats" id="additional-subject-id-formats">Additional Subject Identifier Formats</a>
</h1>
<p id="rfc.section.3.4.p.1">The following new subject identifier formats are defined:</p>
<h1 id="rfc.section.3.4.1">
<a href="#rfc.section.3.4.1">3.4.1.</a> <a href="#sub-id-jwt-id" id="sub-id-jwt-id">JWT ID Subject Identifier Format</a>
</h1>
<p id="rfc.section.3.4.1.p.1">The "JWT ID" Subject Identifier Format specifies a JSON Web Token (JWT) identifier, defined in <a href="#RFC7519" class="xref">[RFC7519]</a>. Subject Identifiers of this type MUST contain the following members: </p>
<dl>
<dt>iss</dt>
<dd style="margin-left: 8">
<br>REQUIRED. The "iss" (issuer) claim of the JWT being identified, defined in <a href="#RFC7519" class="xref">[RFC7519]</a>
</dd>
<dt>jti</dt>
<dd style="margin-left: 8">
<br>REQUIRED. The "jti" (JWT token ID) claim of the JWT being identified, defined in <a href="#RFC7519" class="xref">[RFC7519]</a>
</dd>
</dl>
<p id="rfc.section.3.4.1.p.2">The "JWT ID" Subject Identifier Format is identified by the name <samp>jwt-id</samp>.</p>
<p id="rfc.section.3.4.1.p.3">Below is a non-normative example of Subject Identifier for the <samp>jwt-id</samp> Subject Identifier Format.</p>
<div id="rfc.figure.3"></div>
<div id="sub-id-jwtid"></div>
<pre>
{
"format": "jwt-id",
"iss": "https://idp.example.com/123456789/",
"jti": "B70BA622-9515-4353-A866-823539EECBC8"
}
</pre>
<p class="figure">Figure 3: Example: 'jwt-id' Subject Identifier</p>
<h1 id="rfc.section.3.4.2">
<a href="#rfc.section.3.4.2">3.4.2.</a> <a href="#sub-id-saml-assertion-id" id="sub-id-saml-assertion-id">SAML Assertion ID Subject Identifier Format</a>
</h1>
<p id="rfc.section.3.4.2.p.1">The "SAML Assertion ID" Subject Identifier Format specifies a SAML 2.0 <a href="#OASIS.saml-core-2.0-os" class="xref">[OASIS.saml-core-2.0-os]</a> assertion identifier. Subject Identifiers of this format MUST contain the following members: </p>
<dl>
<dt>issuer</dt>
<dd style="margin-left: 8">
<br>REQUIRED. The "Issuer" value of the SAML assertion being identified, defined in <a href="#OASIS.saml-core-2.0-os" class="xref">[OASIS.saml-core-2.0-os]</a>
</dd>
<dt>assertion_id</dt>
<dd style="margin-left: 8">
<br>REQUIRED. The "ID" value of the SAML assertion being identified, defined in <a href="#OASIS.saml-core-2.0-os" class="xref">[OASIS.saml-core-2.0-os]</a> </dd>
</dl>
<p id="rfc.section.3.4.2.p.2">The "SAML Assertion ID" Subject Identifier Format is identified by the name <samp>saml_assertion_id</samp>.</p>
<p id="rfc.section.3.4.2.p.3">Below is a non-normative example Subject Identifier for the <samp>saml_assertion_id</samp> Subject Identifier Format.</p>
<div id="rfc.figure.4"></div>
<div id="sub-id-samlassertionid"></div>
<pre>
{
"format": "saml_assertion_id",
"issuer": "https://idp.example.com/123456789/",
"assertion_id": "_8e8dc5f69a98cc4c1ff3427e5ce34606fd672f91e6"
}
</pre>
<p class="figure">Figure 4: Example: 'saml_assertion_id' Subject Identifier</p>
<h1 id="rfc.section.3.5">
<a href="#rfc.section.3.5">3.5.</a> <a href="#receiver-subject-processing" id="receiver-subject-processing">Receiver Subject Processing</a>
</h1>
<p id="rfc.section.3.5.p.1">A SSE Receiver MUST make a best effort process all members from a Subject in an SSE event. The <a href="#discovery-meta" class="xref">Transmitter Configuration Metadata</a> defined below MAY define certain members within a Complex Subject to be Critical. A SSE Receiver MUST discard any event that contains a Subject with a Critical member that it is unable to process.</p>
<h1 id="rfc.section.4">
<a href="#rfc.section.4">4.</a> <a href="#properties" id="properties">Event Properties</a>
</h1>
<p id="rfc.section.4.p.1">Additional members about an event may be included in the <samp>events</samp> claim. Some of these members are required and specified as such in the respective event types specs. If a Transmitter determines that it needs to include additional members that are not specified in the event types spec, then the name of such members MUST be a URI. The discoverability of all additional members is specified in the <a href="#discovery" class="xref">Discovery</a> section. </p>
<h1 id="rfc.section.5">
<a href="#rfc.section.5">5.</a> <a href="#events-examples" id="events-examples">Example SETs that conform to the SSE framework</a>
</h1>
<p id="rfc.section.5.p.1">The following are hypothetical examples of SETs that conform to the SSE framework.</p>
<div id="rfc.figure.5"></div>
<div id="subject-ids-ex-simple"></div>
<pre>
{
"iss": "https://idp.example.com/",
"jti": "756E69717565206964656E746966696572",
"iat": 1520364019,
"aud": "636C69656E745F6964",
"events": {
"https://schemas.openid.net/secevent/risc/event-type/account-enabled": {
"subject": {
"format": "email",
"email": "[email protected]"
}
}
}
}
</pre>
<p class="figure">Figure 5: Example: SET Containing a SSE Event with a Simple Subject Member</p>
<div id="rfc.figure.6"></div>
<div id="subject-ids-ex-complex"></div>
<pre>
{
"iss": "https://idp.example.com/",
"jti": "756E69717565206964656E746966696572",
"iat": 1520364019,
"aud": "636C69656E745F6964",
"events": {
"https://schemas.openid.net/secevent/caep/event-type/session-revoked": {
"subject": {
"user": {
"format": "iss_sub",
"iss": "https://idp.example.com/3957ea72-1b66-44d6-a044-d805712b9288/",
"sub": "[email protected]"
},
"device": {
"format": "iss_sub",
"iss": "https://idp.example.com/3957ea72-1b66-44d6-a044-d805712b9288/",
"sub": "e9297990-14d2-42ec-a4a9-4036db86509a"
}
}
"initiating_entity": "policy",
"reason_admin": "Policy Violation: C076E82F",
"reason_user": "Landspeed violation.",
"event_timestamp": 1600975810
}
}
}
</pre>
<p class="figure">Figure 6: Example: SET Containing a SSE Event with a Complex Subject Member</p>
<div id="rfc.figure.7"></div>
<div id="subject-properties-ex"></div>
<pre>
{
"iss": "https://sp.example2.com/",
"jti": "756E69717565206964656E746966696572",
"iat": 1520364019,
"aud": "636C69656E745F6964",
"events": {
"https://schemas.openid.net/secevent/caep/event-type/token-claims-change": {
"subject": {
"format": "email",
"email": "[email protected]"
},
"event_timestamp": 1600975810,
"claims": {
"role": "ro-admin"
}
}
}
}
</pre>
<p class="figure">Figure 7: Example: SET Containing a SSE Event with a Simple Subject and a Property Member</p>
<div id="rfc.figure.8"></div>
<div id="subject-custom-type-ex"></div>
<pre>
{
"iss": "https://myservice.example3.com/",
"jti": "756E69717565206964656E746966696534",
"iat": 15203800012,
"aud": "636C69656E745F6324",
"events": {
"https://schemas.openid.net/secevent/caep/event-type/token-claims-change": {
"subject": {
"format": "catalog_item",
"catalog_id": "c0384/winter/2354122"
},
"event_timestamp": 1600975810,
"claims": {
"role": "ro-admin"
}
}
}
}
</pre>
<p class="figure">Figure 8: Example: SET Containing a SSE Event with a Proprietary Subject Identifier Format</p>
<h1 id="rfc.section.6">
<a href="#rfc.section.6">6.</a> <a href="#discovery" id="discovery">Transmitter Configuration Discovery</a>
</h1>
<p id="rfc.section.6.p.1">This section defines a mechanism for Receivers to obtain Transmitter configuration information.</p>
<h1 id="rfc.section.6.1">
<a href="#rfc.section.6.1">6.1.</a> <a href="#discovery-meta" id="discovery-meta">Transmitter Configuration Metadata</a>
</h1>
<p id="rfc.section.6.1.p.1">Transmitters have metadata describing their configuration:</p>
<dl>
<dt>issuer</dt>
<dd style="margin-left: 8">REQUIRED. URL using the https scheme with no query or fragment component that the Transmitter asserts as its Issuer Identifier. This MUST be identical to the iss claim value in Security Event Tokens issued from this Transmitter.</dd>
<dt>jwks_uri</dt>
<dd style="margin-left: 8">REQUIRED. URL of the Transmitter's <a href="#RFC7517" class="xref">JSON Web Key Set</a> document. This contains the signing key(s) the Receiver uses to validate signatures from the Transmitter.</dd>
<dt>delivery_methods_supported</dt>
<dd style="margin-left: 8">RECOMMENDED. List of supported delivery method URIs.</dd>
<dt>configuration_endpoint</dt>
<dd style="margin-left: 8">OPTIONAL. The URL of the Configuration Endpoint.</dd>
<dt>status_endpoint</dt>
<dd style="margin-left: 8">OPTIONAL. The URL of the Status Endpoint.</dd>
<dt>add_subject_endpoint</dt>
<dd style="margin-left: 8">OPTIONAL. The URL of the Add Subject Endpoint.</dd>
<dt>remove_subject_endpoint</dt>
<dd style="margin-left: 8">OPTIONAL. The URL of the Remove Subject Endpoint.</dd>
<dt>verification_endpoint</dt>
<dd style="margin-left: 8">OPTIONAL. The URL of the Verification Endpoint.</dd>
<dt>critical_subject_members</dt>
<dd style="margin-left: 8">OPTIONAL. List of member names in a Complex Subject which, if present in a Subject Member in an event, MUST be interpreted by a Receiver.</dd>
</dl>
<p id="rfc.section.6.1.p.2">TODO: consider adding a IANA Registry for metadata, similar to Section 7.1.1 of <a href="#OAUTH-DISCOVERY" class="xref">[OAUTH-DISCOVERY]</a>. This would allow other specs to add to the metadata.</p>
<h1 id="rfc.section.6.2">
<a href="#rfc.section.6.2">6.2.</a> Obtaining Transmitter Configuration Information</h1>
<p id="rfc.section.6.2.p.1">Using the Issuer as documented by the Transmitter, the Transmitter Configuration Information can be retrieved.</p>
<p id="rfc.section.6.2.p.2">Transmitters supporting Discovery MUST make a JSON document available at the path formed by inserting the string <samp>/.well-known/sse-configuration</samp> into the Issuer between the host component and the path component, if any. The syntax and semantics of <samp>.well-known</samp> are defined in <a href="#RFC5785" class="xref">[RFC5785]</a>. <samp>sse-configuration</samp> MUST point to a JSON document compliant with this specification and MUST be returned using the <samp>application/json</samp> content type.</p>
<h1 id="rfc.section.6.2.1">
<a href="#rfc.section.6.2.1">6.2.1.</a> Transmitter Configuration Request</h1>
<p id="rfc.section.6.2.1.p.1">A Transmitter Configuration Document MUST be queried using an HTTP <samp>GET</samp> request at the previously specified path.</p>
<div id="rfc.figure.9"></div>
<div id="figdiscoveryrequest"></div>
<pre>
GET /.well-known/sse-configuration HTTP/1.1
Host: tr.example.com
</pre>
<p class="figure">Figure 9: Example: Transmitter Configuration Request (without path)</p>
<p id="rfc.section.6.2.1.p.2">The Receiver would make the following request to the Issuer <samp>https://tr.example.com</samp> to obtain its Configuration information, since the Issuer contains no path component: </p>
<div id="rfc.figure.10"></div>
<div id="figdiscoveryrequestpath"></div>
<pre>
GET /.well-known/sse-configuration/issuer1 HTTP/1.1
Host: tr.example.com
</pre>
<p class="figure">Figure 10: Example: Transmitter Configuration Request (with path)</p>
<p id="rfc.section.6.2.1.p.3">If the Issuer value contains a path component, any terminating <samp>/</samp> MUST be removed before inserting <samp>/.well-known/sse-configuration</samp> between the host component and the path component. The Receiver would make the following request to the Issuer <samp>https://tr.example.com/issuer1</samp> to obtain its Configuration information, since the Issuer contains a path component: </p>