forked from independentid/Identity-Events
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-hunt-secevent-sstp.txt
1288 lines (829 loc) · 44.8 KB
/
draft-hunt-secevent-sstp.txt
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
Network Working Group P. Hunt, Ed.
Internet-Draft Oracle
Intended status: Standards Track A. Nadalin
Expires: September 23, 2018 Microsoft
March 22, 2018
Symmetric SET Transfer Protocol
draft-hunt-secevent-sstp-00
Abstract
This specification defines how security event tokens (SETs) may be
exchanged between a client and service provider using HTTP POST over
TLS using a symmetric format. The specification supports three modes
of operation: "push", "pull", and "push-pull" bi-directional SET
exchange. The specification also defines a simple acknowledge
mechanism allowing parties to confirm delivery.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on September 23, 2018.
Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
Hunt & Nadalin Expires September 23, 2018 [Page 1]
Internet-Draft draft-hunt-secevent-sstp March 2018
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Notational Conventions . . . . . . . . . . . . . . . . . 4
1.2. Definitions . . . . . . . . . . . . . . . . . . . . . . . 4
2. Simple SET Transfer Protocol . . . . . . . . . . . . . . . . 5
2.1. SSTP Message Format (Content-Type: application/sstp+json) 5
2.2. Examples . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2.1. Example Push Transfer . . . . . . . . . . . . . . . . 8
2.2.2. Example Pull Transfer . . . . . . . . . . . . . . . . 9
2.2.3. Example Push-Pull Bi-directional Transfer . . . . . . 13
2.3. Error Response Handling . . . . . . . . . . . . . . . . . 15
3. Authentication and Authorization . . . . . . . . . . . . . . 16
3.1. Use of Tokens as Authorizations . . . . . . . . . . . . . 17
4. Security Considerations . . . . . . . . . . . . . . . . . . . 18
4.1. Authentication Using Signed SETs . . . . . . . . . . . . 18
4.2. HTTP Considerations . . . . . . . . . . . . . . . . . . . 18
4.3. TLS Support Considerations . . . . . . . . . . . . . . . 18
4.4. Authorization Token Considerations . . . . . . . . . . . 19
4.4.1. Bearer Token Considerations . . . . . . . . . . . . . 19
5. Privacy Considerations . . . . . . . . . . . . . . . . . . . 19
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 20
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 20
7.1. Normative References . . . . . . . . . . . . . . . . . . 20
7.2. Informative References . . . . . . . . . . . . . . . . . 21
Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . 22
Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 23
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 23
1. Introduction
[EDITORS NOTE: This specification is based upon draft-ietf-secevent-
delivery and attempts to provide a unified single MTI protocol
solution satisfying all use cases for SECEVENTS.]
This specification defines how SETs (see [I-D.ietf-secevent-token])
can be exchanged using HTTP [RFC7231] over TLS using a symmetric
request/response format. The specification supports three modes of
operation: "push", "pull", and "push-pull" bi-directional SET
exchange. The specification also defines a simple acknowledge
mechanism allowing parties to confirm delivery or attempt re-
delivery.
This specification makes several simplifying assumptions:
Hunt & Nadalin Expires September 23, 2018 [Page 2]
Internet-Draft draft-hunt-secevent-sstp March 2018
o SSTP is a symmetric protocol meaning it uses the same HTTP
content-type and JSON structure to send requests and process
responses
o Recovery is provided for unacknowledged SETs for short term or
missed deliveries. Issuers are able to re-transmit SETs in
situations where a SET has been unacknowledged (e.g. over more
than one request/response cycles).
o The protocol can be used for unidirectional, or bi-directional
communication avoiding the need to implement multiple delivery
methods.
o The use of HTTP Long Polling MAY be used in cases where pull or
bi-directional communication is needed in real time.
o Only one party in an exchange needs to have an addressable fixed
URI endpoint and can act as an SSTP protocol service provider to a
mobile or otherwise unrechable client.
o SET message exchanges are secured through the use of TLS and some
form of HTTP authorization (e.g. RFC6750, RFC7519), and MAY in
turn be signed and encrypted.
This specification supports the following use-cases:
Broadcaster
Where a large entity (e.g. an Identity Provider) needs to issue
SETs to a large number of relying parties.
Protected Client
Where a client party is behind a firewall or otherwise network
restricted location and cannot act as a SSTP service provider.
Examples include Enterprise on-premise security systems, IoT
devices which may be shielded in restricted network environments.
Mobile
Where a client is mobile and thus would be unable to maintain a
permanent HTTP endpoint.
This specification does not define how endpoints are configured, nor
does it define the specifics of which SET event types are exchanged
over any particular delivery relationship.
Hunt & Nadalin Expires September 23, 2018 [Page 3]
Internet-Draft draft-hunt-secevent-sstp March 2018
1.1. Notational Conventions
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 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
For purposes of readability examples are not URL encoded.
Implementers MUST percent encode URLs as described in Section 2.1 of
[RFC3986] .
Throughout this documents all figures MAY contain spaces and extra
line-wrapping for readability and space limitations. Similarly, some
URI's contained within examples, have been shortened for space and
readability reasons. All examples are non-normative.
1.2. Definitions
This specification assumes terminology defined in the Security Event
Token specification[I-D.ietf-secevent-token] .
This specification defines the following terms:
Client An entity which acts as an HTTP client as defined by
[RFC7231] which is communicating with an SSTP server.
Server An entity which has a permanent endpoint reachable by a
client which acts as an HTTP server as defined by [RFC7231] and
supports this specification.
Event
An Event is defined to be an event as represented by a security
event token (SET). See [I-D.ietf-secevent-token].
NumericDate
A JSON numeric value representing the number of seconds from
1970-01-01T00:00:00Z UTC until the specified UTC date/time,
ignoring leap seconds. This is equivalent to the IEEE Std 1003.1,
2013 Edition [POSIX.1] definition "Seconds Since the Epoch", in
which each day is accounted for by exactly 86400 seconds, other
than that non-integer values can be represented. See [RFC3339]
for details regarding date/times in general and UTC in particular.
Hunt & Nadalin Expires September 23, 2018 [Page 4]
Internet-Draft draft-hunt-secevent-sstp March 2018
2. Simple SET Transfer Protocol
SSTP is a symmetric protocol. As such an SSTP client uses HTTP POST
(Section 4.3.3 [RFC7231]) with a body with "Content-Type" of
"application/sstp+json" to deliver 0 or more SETs and/or to
acknowledge previously received SETs from an SSTP server. In
response, the SSTP server returns an HTTP body with the same
document-type which may also return 0 or more SETs, acknowledgments,
and errors.
Requests MAY be spontaneous (in the case of push mode), scheduled
over a a periodic interval (in the case of pull), or requests to pull
MAY await new SETS using HTTP long polling (see Section 2 [RFC6202]).
An SSTP server choosing NOT to support HTTP long polling MAY do so by
returning HTTP Status of 403 "Forbidden" (see Section 6.5.3
[RFC7231]) if a particular client is not authorized, or HTTP status
501 "Not implemented" (see Section 6.6.2 [RFC7231]) if the server
does not support long polling.
SSTP provides an acknowledgement capability for the purpose of
informing communications partners about which SETs have been
successfully delivered. Upon receipt of a SET and before
acknowledgement, receivers SHOULD ensure received SETs are valid and
have been retained in a manner appropriate to the receiver's
retention needs. The level and method of retention of SETs by
receivers is out-of-scope of this specification.
If after a period of time, negotiated between the client and server,
unacknowledged SETs MAY be re-transmitted. The receiver SHOULD
accept repeat SETs and acknowledge the SETs regardless of whether the
receiver believes it has already acknowledged the SETs previously. A
SET issuer MAY limit the number of attempts to deliver a SET.
A receiving party (client or server) of SETs SHOULD parse and
validate each SET to meet its own requirements and SHOULD acknowledge
receipt in a timely (e.g. minutes) fashion so that the issuer may
mark the SETs as received. Receivers SHOULD acknowledge receipt
before taking any local actions based on the SETs to avoid
unnecessary delay in acknowledgement to avoid unnecessary re-
transmission.
2.1. SSTP Message Format (Content-Type: application/sstp+json)
The body (or message) of an SSTP request or response is a "Content-
Type" of "application/sstp+json" which is a JSON document consisting
of the following optional JSON attributes:
Request Handling:
Hunt & Nadalin Expires September 23, 2018 [Page 5]
Internet-Draft draft-hunt-secevent-sstp March 2018
returnEvents
A JSON boolean parameter which indicates whether the receiver
SHOULD return SETs in its upcoming response. When part of an HTTP
Request, it indicates the SSTP server SHOULD return with SETs in
its response (and optionally wait). When asserted as "false" by
an SSTP server in its response, it indicates that the SSTP server
is not requesting SETs in the next client request. If omitted,
this attribute SHALL have a default value of "true".
returnImmediately
An OPTIONAL JSON boolean value which when "true" has the effect of
declining HTTP long polling. A value of "false" indicates the
request is to be treated as an HTTP Long Poll (see Section 2
[RFC6202]). When asserted in an HTTP response, the value
indicates the SSTP has more information and the client SHOULD NOT
wait before initiating its next request. When omitted, the
default value of "false" SHALL be assumed.
Delivery:
sets
A JSON object that contains one or more nested JSON attributes.
Each nested attribute corresponds to the "jti" of a SET to be
delivered and whose value is a JSON String containing the value of
the encoded corresponding SET. If there are no SETs to be
transmitted, the attribute MAY be omitted.
Acknowledgment:
ack
An array of Strings that each correspond to the "jti" of a
successfully received SET by the client. If there are no
outstanding SETs to acknowledge, the attribute MAY be omitted.
When acknowledging a SET, the issuer is released from any
obligation to retain the SET (e.g. for a future re-try).
setErrs
A JSON Object that contains one or more nested JSON attributes
that correspond to the "jti" of each invalid SET received. The
value of each is a JSON object whose contents is an "err"
attribute and "description" attribute whose value correspond to
the errors described in Section 2.3. If there are no errors to
acknowledge, the attribute MAY be omitted.
Hunt & Nadalin Expires September 23, 2018 [Page 6]
Internet-Draft draft-hunt-secevent-sstp March 2018
The following is an example SSTP message that could be exchanged
either in a HTPP POST request or response between a client and an
SSTP server.
{
"returnImmediately":true,
"returnEvents":true,
"sets":{
"4d3559ec67504aaba65d40b0363faad8":
"eyJhbGciOiJub25lIn0.
eyJqdGkiOiI0ZDM1NTllYzY3NTA0YWFiYTY1ZDQwYjAzNjNmYWFkOCIsImlhdCI6MTQ
1ODQ5NjQwNCwiaXNzIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tIiwiYXVkIjpbIm
h0dHBzOi8vc2NpbS5leGFtcGxlLmNvbS9GZWVkcy85OGQ1MjQ2MWZhNWJiYzg3OTU5M
2I3NzU0IiwiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tL0ZlZWRzLzVkNzYwNDUxNmIx
ZDA4NjQxZDc2NzZlZTciXSwiZXZlbnRzIjp7InVybjppZXRmOnBhcmFtczpzY2ltOmV
2ZW50OmNyZWF0ZSI6eyJyZWYiOiJodHRwczovL3NjaW0uZXhhbXBsZS5jb20vVXNlcn
MvNDRmNjE0MmRmOTZiZDZhYjYxZTc1MjFkOSIsImF0dHJpYnV0ZXMiOlsiaWQiLCJuY
W1lIiwidXNlck5hbWUiLCJwYXNzd29yZCIsImVtYWlscyJdfX19.",
"3d0c3cf797584bd193bd0fb1bd4e7d30":
"eyJhbGciOiJub25lIn0.
eyJqdGkiOiIzZDBjM2NmNzk3NTg0YmQxOTNiZDBmYjFiZDRlN2QzMCIsImlhdCI6MTQ
1ODQ5NjAyNSwiaXNzIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tIiwiYXVkIjpbIm
h0dHBzOi8vamh1Yi5leGFtcGxlLmNvbS9GZWVkcy85OGQ1MjQ2MWZhNWJiYzg3OTU5M
2I3NzU0IiwiaHR0cHM6Ly9qaHViLmV4YW1wbGUuY29tL0ZlZWRzLzVkNzYwNDUxNmIx
ZDA4NjQxZDc2NzZlZTciXSwic3ViIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tL1V
zZXJzLzQ0ZjYxNDJkZjk2YmQ2YWI2MWU3NTIxZDkiLCJldmVudHMiOnsidXJuOmlldG
Y6cGFyYW1zOnNjaW06ZXZlbnQ6cGFzc3dvcmRSZXNldCI6eyJpZCI6IjQ0ZjYxNDJkZ
jk2YmQ2YWI2MWU3NTIxZDkifSwiaHR0cHM6Ly9leGFtcGxlLmNvbS9zY2ltL2V2ZW50
L3Bhc3N3b3JkUmVzZXRFeHQiOnsicmVzZXRBdHRlbXB0cyI6NX19fQ."
}
}
Figure 1: Example Request or Response Document
2.2. Examples
Three examples are provided where:
o A client pushes SETs to a server using the "sets" JSON attribute
in its request and receives "ack" values in response from the SSTP
server.
o A polling client that requests SETs from a a server and uses the
"ack" parameter in its request to acknowledge SETs from a previous
HTTP request, and receives new SETs in the response.
Hunt & Nadalin Expires September 23, 2018 [Page 7]
Internet-Draft draft-hunt-secevent-sstp March 2018
o A client and SSTP server bi-directionally exchange SETs using both
the "sets" and "ack" JSON attributes in both the request and
response messages.
2.2.1. Example Push Transfer
In this example, a client posts SETs to an SSTP server which in turn
acknowledges the transferred SETs in its response.
In the figure, two SETs are transferred to the SSTP server. The
parameter "returnEvents" indicates the client is not interested in
receiving SETs.
POST /Events HTTP/1.1
Host: notify.exampleidp.com
Authorization: Bearer h480djs93hd8
Content-Type: application/sstp+json
Accept: application/sstp+json
{
"returnImmediately":true,
"returnEvents":false,
"sets":{
"4d3559ec67504aaba65d40b0363faad8":
"eyJhbGciOiJub25lIn0.
eyJqdGkiOiI0ZDM1NTllYzY3NTA0YWFiYTY1ZDQwYjAzNjNmYWFkOCIsImlhdCI6MTQ
1ODQ5NjQwNCwiaXNzIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tIiwiYXVkIjpbIm
h0dHBzOi8vc2NpbS5leGFtcGxlLmNvbS9GZWVkcy85OGQ1MjQ2MWZhNWJiYzg3OTU5M
2I3NzU0IiwiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tL0ZlZWRzLzVkNzYwNDUxNmIx
ZDA4NjQxZDc2NzZlZTciXSwiZXZlbnRzIjp7InVybjppZXRmOnBhcmFtczpzY2ltOmV
2ZW50OmNyZWF0ZSI6eyJyZWYiOiJodHRwczovL3NjaW0uZXhhbXBsZS5jb20vVXNlcn
MvNDRmNjE0MmRmOTZiZDZhYjYxZTc1MjFkOSIsImF0dHJpYnV0ZXMiOlsiaWQiLCJuY
W1lIiwidXNlck5hbWUiLCJwYXNzd29yZCIsImVtYWlscyJdfX19.",
"3d0c3cf797584bd193bd0fb1bd4e7d30":
"eyJhbGciOiJub25lIn0.
eyJqdGkiOiIzZDBjM2NmNzk3NTg0YmQxOTNiZDBmYjFiZDRlN2QzMCIsImlhdCI6MTQ
1ODQ5NjAyNSwiaXNzIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tIiwiYXVkIjpbIm
h0dHBzOi8vamh1Yi5leGFtcGxlLmNvbS9GZWVkcy85OGQ1MjQ2MWZhNWJiYzg3OTU5M
2I3NzU0IiwiaHR0cHM6Ly9qaHViLmV4YW1wbGUuY29tL0ZlZWRzLzVkNzYwNDUxNmIx
ZDA4NjQxZDc2NzZlZTciXSwic3ViIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tL1V
zZXJzLzQ0ZjYxNDJkZjk2YmQ2YWI2MWU3NTIxZDkiLCJldmVudHMiOnsidXJuOmlldG
Y6cGFyYW1zOnNjaW06ZXZlbnQ6cGFzc3dvcmRSZXNldCI6eyJpZCI6IjQ0ZjYxNDJkZ
jk2YmQ2YWI2MWU3NTIxZDkifSwiaHR0cHM6Ly9leGFtcGxlLmNvbS9zY2ltL2V2ZW50
L3Bhc3N3b3JkUmVzZXRFeHQiOnsicmVzZXRBdHRlbXB0cyI6NX19fQ."
}
}
Figure 2: Example Push Request
Hunt & Nadalin Expires September 23, 2018 [Page 8]
Internet-Draft draft-hunt-secevent-sstp March 2018
The figure below shows the response returned from the SSTP server in
response to the request in Figure 2
HTTP/1.1 200 OK
Content-Type: application/sstp+json
Location: https://notify.exampleidp.com/Events
{
"ack":[
"4d3559ec67504aaba65d40b0363faad8",
"3d0c3cf797584bd193bd0fb1bd4e7d30"
]
}
Figure 3: Example Push Response
2.2.2. Example Pull Transfer
The figure below is an example pull request to the SSTP server whose
location is: "https://nofity.exampleidp.com/Events". In this
example, the client is requesting an immediate response whether or
not new SETs are available.
POST /Events HTTP/1.1
Host: notify.exampleidp.com
Authorization: Bearer h480djs93hd8
Content-Type: application/sstp+json
Accept: application/sstp+json
{
"returnImmediately":true
}
Figure 4: Example Initial Pull Request
The following is an example default pull request to the SSTP server
whose location is: "https://nofity.exampleidp.com/Events". The
default mode to return events and to wait if necessary is assumed.
POST /Events HTTP/1.1
Host: notify.exampleidp.com
Authorization: Bearer h480djs93hd8
Accept: application/sstp+json
{}
Figure 5: Example Default Pull Request
Hunt & Nadalin Expires September 23, 2018 [Page 9]
Internet-Draft draft-hunt-secevent-sstp March 2018
In response to the above two requests, the SSTP server responds
immediately if "respondImmediately" is true or SETs are available.
If no SETs are available at the time of the request and
"respondImmediately" is false, the SSTP server delays response until
a SET is available.
As described in Section 2.1 a JSON document is returned containing
the JSON attribute "sets".
The following is an example response to the requests shown Figure 4
and Figure 5. This example shows two SETs are returned.
HTTP/1.1 200 OK
Content-Type: application/sstp+json
Location: https://notify.exampleidp/Events
{
"sets":{
"4d3559ec67504aaba65d40b0363faad8":
"eyJhbGciOiJub25lIn0.
eyJqdGkiOiI0ZDM1NTllYzY3NTA0YWFiYTY1ZDQwYjAzNjNmYWFkOCIsImlhdCI6MTQ
1ODQ5NjQwNCwiaXNzIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tIiwiYXVkIjpbIm
h0dHBzOi8vc2NpbS5leGFtcGxlLmNvbS9GZWVkcy85OGQ1MjQ2MWZhNWJiYzg3OTU5M
2I3NzU0IiwiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tL0ZlZWRzLzVkNzYwNDUxNmIx
ZDA4NjQxZDc2NzZlZTciXSwiZXZlbnRzIjp7InVybjppZXRmOnBhcmFtczpzY2ltOmV
2ZW50OmNyZWF0ZSI6eyJyZWYiOiJodHRwczovL3NjaW0uZXhhbXBsZS5jb20vVXNlcn
MvNDRmNjE0MmRmOTZiZDZhYjYxZTc1MjFkOSIsImF0dHJpYnV0ZXMiOlsiaWQiLCJuY
W1lIiwidXNlck5hbWUiLCJwYXNzd29yZCIsImVtYWlscyJdfX19.",
"3d0c3cf797584bd193bd0fb1bd4e7d30":
"eyJhbGciOiJub25lIn0.
eyJqdGkiOiIzZDBjM2NmNzk3NTg0YmQxOTNiZDBmYjFiZDRlN2QzMCIsImlhdCI6MTQ
1ODQ5NjAyNSwiaXNzIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tIiwiYXVkIjpbIm
h0dHBzOi8vamh1Yi5leGFtcGxlLmNvbS9GZWVkcy85OGQ1MjQ2MWZhNWJiYzg3OTU5M
2I3NzU0IiwiaHR0cHM6Ly9qaHViLmV4YW1wbGUuY29tL0ZlZWRzLzVkNzYwNDUxNmIx
ZDA4NjQxZDc2NzZlZTciXSwic3ViIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tL1V
zZXJzLzQ0ZjYxNDJkZjk2YmQ2YWI2MWU3NTIxZDkiLCJldmVudHMiOnsidXJuOmlldG
Y6cGFyYW1zOnNjaW06ZXZlbnQ6cGFzc3dvcmRSZXNldCI6eyJpZCI6IjQ0ZjYxNDJkZ
jk2YmQ2YWI2MWU3NTIxZDkifSwiaHR0cHM6Ly9leGFtcGxlLmNvbS9zY2ltL2V2ZW50
L3Bhc3N3b3JkUmVzZXRFeHQiOnsicmVzZXRBdHRlbXB0cyI6NX19fQ."
}
}
Figure 6: Example Pull Response
In the above example, two SETs whose "jti" are
"4d3559ec67504aaba65d40b0363faad8" and
"3d0c3cf797584bd193bd0fb1bd4e7d30" are delivered.
Hunt & Nadalin Expires September 23, 2018 [Page 10]
Internet-Draft draft-hunt-secevent-sstp March 2018
The following is an example response to the request shown Figure 4
where "returnImmediately" was set showing no new SETs are available.
HTTP/1.1 200 OK
Content-Type: application/sstp+json
Location: https://notify.exampleidp/Events
{
"sets":{ }
}
Figure 7: Example No SETs Pull Response
2.2.2.1. Acknowledge Only Request
This variation is typically used when a client needs to acknowledge
received SETs on a separate thread from one receiving SETs.
An SSTP client acknowledges previously received SETs but indicates it
does not want to receive SETs in the current request/response by
setting the "returnEvents" attribute to "false".
The following example is an acknowledgement of SETs previously
received (e.g. from the response shown in Figure 6).
POST /Events HTTP/1.1
Host: notify.exampleidp.com
Authorization: Bearer h480djs93hd8
Content-Type: application/sstp+json
Authorization: Bearer h480djs93hd8
{
"ack":[
"4d3559ec67504aaba65d40b0363faad8",
"3d0c3cf797584bd193bd0fb1bd4e7d30"
],
"returnEvents":false
}
Figure 8: Example Acknowledge Only Request
2.2.2.2. Poll with Acknowledgement
This variation allows a client to simultaneously acknowledge
previously received SETs and wait for the next group of SETs in a
single HTTP request.
Hunt & Nadalin Expires September 23, 2018 [Page 11]
Internet-Draft draft-hunt-secevent-sstp March 2018
The following SSTP request contains an acknowledgement of SETs
received from Figure 6.
POST /Events HTTP/1.1
Host: notify.exampleidp.com
Authorization: Bearer h480djs93hd8
Content-Type: application/sstp+json
Accept: application/sstp+json
Authorization: Bearer h480djs93hd8
{
"ack":[
"4d3559ec67504aaba65d40b0363faad8",
"3d0c3cf797584bd193bd0fb1bd4e7d30"
],
"returnImmediately":false
}
Figure 9: Example Pull With Acknowledgement and No Errors
2.2.2.3. Pull with Acknowledgement and Errors
In the case where errors are detected in previously received SETs,
the client (or server) uses the "setErrs" attribute to indicate
errors in its request.
Hunt & Nadalin Expires September 23, 2018 [Page 12]
Internet-Draft draft-hunt-secevent-sstp March 2018
The following is an example of an SSTP response acknowledges 1 error
and 1 receipt of two SETs received in Figure 6.
POST /Events HTTP/1.1
Host: notify.exampleidp.com
Authorization: Bearer h480djs93hd8
Content-Type: application/sstp+json
Accept: application/sstp+json
Authorization: Bearer h480djs93hd8
{
"ack":["3d0c3cf797584bd193bd0fb1bd4e7d30"],
"setErrs":{
"4d3559ec67504aaba65d40b0363faad8":{
"err":"jwtAud",
"description":"The audience value was incorrect."
}
}
}
Figure 10: Example Pull Acknowledgement With Error
2.2.3. Example Push-Pull Bi-directional Transfer
In push-pull mode, JSON attributes "sets", "ack" and "setErrs" are
used in both HTTP request and response messages between client and
SSTP server.
Hunt & Nadalin Expires September 23, 2018 [Page 13]
Internet-Draft draft-hunt-secevent-sstp March 2018
In the following example, two SETs are transferred to the SSTP server
and events are requested in return.
POST /Events HTTP/1.1
Host: notify.exampleidp.com
Authorization: Bearer h480djs93hd8
Content-Type: application/sstp+json
Accept: application/sstp+json
{
"returnEvents":true,
"ack":["b453bf9972b84e0492d5c7f55f68fb6a"],
"sets":{
"4d3559ec67504aaba65d40b0363faad8":
"eyJhbGciOiJub25lIn0.
eyJqdGkiOiI0ZDM1NTllYzY3NTA0YWFiYTY1ZDQwYjAzNjNmYWFkOCIsImlhdCI6MTQ
1ODQ5NjQwNCwiaXNzIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tIiwiYXVkIjpbIm
h0dHBzOi8vc2NpbS5leGFtcGxlLmNvbS9GZWVkcy85OGQ1MjQ2MWZhNWJiYzg3OTU5M
2I3NzU0IiwiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tL0ZlZWRzLzVkNzYwNDUxNmIx
ZDA4NjQxZDc2NzZlZTciXSwiZXZlbnRzIjp7InVybjppZXRmOnBhcmFtczpzY2ltOmV
2ZW50OmNyZWF0ZSI6eyJyZWYiOiJodHRwczovL3NjaW0uZXhhbXBsZS5jb20vVXNlcn
MvNDRmNjE0MmRmOTZiZDZhYjYxZTc1MjFkOSIsImF0dHJpYnV0ZXMiOlsiaWQiLCJuY
W1lIiwidXNlck5hbWUiLCJwYXNzd29yZCIsImVtYWlscyJdfX19.",
"3d0c3cf797584bd193bd0fb1bd4e7d30":
"eyJhbGciOiJub25lIn0.
eyJqdGkiOiIzZDBjM2NmNzk3NTg0YmQxOTNiZDBmYjFiZDRlN2QzMCIsImlhdCI6MTQ
1ODQ5NjAyNSwiaXNzIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tIiwiYXVkIjpbIm
h0dHBzOi8vamh1Yi5leGFtcGxlLmNvbS9GZWVkcy85OGQ1MjQ2MWZhNWJiYzg3OTU5M
2I3NzU0IiwiaHR0cHM6Ly9qaHViLmV4YW1wbGUuY29tL0ZlZWRzLzVkNzYwNDUxNmIx
ZDA4NjQxZDc2NzZlZTciXSwic3ViIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tL1V
zZXJzLzQ0ZjYxNDJkZjk2YmQ2YWI2MWU3NTIxZDkiLCJldmVudHMiOnsidXJuOmlldG
Y6cGFyYW1zOnNjaW06ZXZlbnQ6cGFzc3dvcmRSZXNldCI6eyJpZCI6IjQ0ZjYxNDJkZ
jk2YmQ2YWI2MWU3NTIxZDkifSwiaHR0cHM6Ly9leGFtcGxlLmNvbS9zY2ltL2V2ZW50
L3Bhc3N3b3JkUmVzZXRFeHQiOnsicmVzZXRBdHRlbXB0cyI6NX19fQ."
}
}
Figure 11: Example Push-Pull Request
Hunt & Nadalin Expires September 23, 2018 [Page 14]
Internet-Draft draft-hunt-secevent-sstp March 2018
The following is an example response to the request shown Figure 11.
HTTP/1.1 200 OK
Content-Type: application/sstp+json
Location: https://notify.exampleidp/Events
{
"ack":[
"4d3559ec67504aaba65d40b0363faad8",
"3d0c3cf797584bd193bd0fb1bd4e7d30"
],
"sets":{
"6f332aefc730400a9f645d36a12ba4ab":
"eyJhbGciOiJub25lIn0.
eyJqdGkiOiI0ZDM1NTllYzY3NTA0YWFiYTY1ZDQwYjAzNjNmYWFkOCIsImlhdCI6MTQ
1ODQ5NjQwNCwiaXNzIjoiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tIiwiYXVkIjpbIm
h0dHBzOi8vc2NpbS5leGFtcGxlLmNvbS9GZWVkcy85OGQ1MjQ2MWZhNWJiYzg3OTU5M
2I3NzU0IiwiaHR0cHM6Ly9zY2ltLmV4YW1wbGUuY29tL0ZlZWRzLzVkNzYwNDUxNmIx
ZDA4NjQxZDc2NzZlZTciXSwiZXZlbnRzIjp7InVybjppZXRmOnBhcmFtczpzY2ltOmV
2ZW50OmNyZWF0ZSI6eyJyZWYiOiJodHRwczovL3NjaW0uZXhhbXBsZS5jb20vVXNlcn
MvNDRmNjE0MmRmOTZiZDZhYjYxZTc1MjFkOSIsImF0dHJpYnV0ZXMiOlsiaWQiLCJuY
W1lIiwidXNlck5hbWUiLCJwYXNzd29yZCIsImVtYWlscyJdfX19."
}
}
Figure 12: Example Push-Pull Response
Following the response from the SSTP server, the client would
subsequently repeats the request-response cycle by acknowledging the
SET identified by a "jti" value of
"6f332aefc730400a9f645d36a12ba4ab".
2.3. Error Response Handling
If a SET is invalid, the following error codes are defined:
Hunt & Nadalin Expires September 23, 2018 [Page 15]
Internet-Draft draft-hunt-secevent-sstp March 2018
+-------------+-----------------------------------------------------+
| Err Value | Description |
+-------------+-----------------------------------------------------+
| json | Invalid JSON object. |
| jwtParse | Invalid or unparsable JWT or JSON structure. |
| jwtHdr | In invalid JWT header was detected. |
| jwtCrypto | Unable to parse due to unsupported algorithm. |
| jws | Signature was not validated. |
| jwe | Unable to decrypt JWE encoded data. |
| jwtAud | Invalid audience value. |
| jwtIss | Issuer not recognized. |
| setType | An unexpected Event type was received. |
| setParse | Invalid structure was encountered such as an |
| | inability to parse or an incomplete set of event |
| | claims. |
| setData | SET event claims incomplete or invalid. |
| directional | The SSTP does not support transfer of SETs in the |
| | requested direction. |
+-------------+-----------------------------------------------------+
Table 1: SET Errors
An error response has a "Content-Type" of "application/sstp+json"
which is a JSON document that provides details about the error. The
JSON document includes the JSON attributes:
err
A value which is a keyword that describes the error (see Table 1).
description
A human-readable text that provides additional diagnostic
information.
When included as part of an HTTP Status 400 response, the above JSON
is the HTTP response body in the JSON attribute "setErrs" (see
Section 2.1).
3. Authentication and Authorization
The SET delivery methods described in this specification are based
upon HTTP and depend on the use of TLS and/or standard HTTP
authentication and authorization schemes as per [RFC7235]. For
example, the following methodologies could be used among others:
TLS Client Authentication
SSTP server MAY negotiate TLS mutual client authentication. See
Section 7.3 [RFC5246].
Hunt & Nadalin Expires September 23, 2018 [Page 16]
Internet-Draft draft-hunt-secevent-sstp March 2018
Bearer Tokens
Bearer tokens [RFC6750] MAY be used when combined with TLS and a
token framework such as OAuth 2.0 [RFC6749]. For security
considerations regarding the use of bearer tokens in SET delivery
see Section 4.4.1.
Basic Authentication
Usage of basic authentication should be avoided due to its use of
a single factor that is based upon a relatively static, symmetric
secret. Implementers SHOULD combine the use of basic
authentication with other factors. The security considerations of
HTTP BASIC, are well documented in [RFC7617] and SHOULD be
considered along with using signed SETs (see SET Payload
Authentication below).
SET Payload Authentication
In scenarios where SETs are signed and the delivery method is HTTP
POST, SSTP clients MAY elect to use Basic Authentication or not to
use HTTP or TLS based authentication at all. See Section 4.1 for
considerations.
As per Section 4.1 of [RFC7235], a SET delivery endpoint SHALL
indicate supported HTTP authentication schemes via the "WWW-
Authenticate" header.
Because SET Delivery describes a simple function, authorization for
the ability to pick-up or deliver SETs can be derived by considering
the identity of the SET issuer, or via an authentication method
above. This specification considers authentication as a feature to
prevent denial-of-service attacks. Because SETs are not commands
(see ), event receivers are free to ignore SETs that are not of
interest.
For illustrative purposes only, SET delivery examples show an OAuth2
bearer token value [RFC6750] in the authorization header. This is
not intended to imply that bearer tokens are preferred. However, the
use of bearer tokens in the specification does reflect common
practice.
3.1. Use of Tokens as Authorizations
When using bearer tokens or proof-of-possession tokens that represent
an authorization grant such as issued by OAuth (see [RFC6749]),
implementers SHOULD consider the type of authorization granted, any
authorized scopes (see Section 3.3 of [RFC6749]), and the security
subject(s) that SHOULD be mapped from the authorization when
considering local access control rules. Section 6 of the OAuth
Hunt & Nadalin Expires September 23, 2018 [Page 17]
Internet-Draft draft-hunt-secevent-sstp March 2018
Assertions draft [RFC7521], documents common scenarios for
authorization including:
o Clients using an assertion to authenticate and/or act on behalf of
itself;
o Clients acting on behalf of a user; and,
o A Client acting on behalf of an anonymous user (e.g., see next
section).
When using OAuth authorization tokens, implementers MUST take into
account the threats and countermeasures documented in the security
considerations for the use of client authorizations (see Section 8 of
[RFC7521]). When using other token formats or frameworks,
implementers MUST take into account similar threats and
countermeasures, especially those documented by the relevant
specifications.
4. Security Considerations
4.1. Authentication Using Signed SETs
In scenarios where HTTP authorization or TLS mutual authentication
are not used or are considered weak, JWS signed SETs SHOULD be used
(see [RFC7515] and Security Considerations
[I-D.ietf-secevent-token]). This enables event receivers to validate
that the SET issuer is authorized to deliver SETs.
4.2. HTTP Considerations
SET delivery depends on the use of Hypertext Transfer Protocol and
thus subject to the security considerations of HTTP Section 9
[RFC7230] and its related specifications.
As stated in Section 2.7.1 [RFC7230], an HTTP requestor MUST NOT
generate the "userinfo" (i.e., username and password) component (and
its "@" delimiter) when an "http" URI reference is generated with a
message as they are now disallowed in HTTP.
4.3. TLS Support Considerations
SETs contain sensitive information that is considered PII (e.g.
subject claims). Therefore, event issuers and receivers MUST require