Skip to content

Commit 64229a3

Browse files
authored
New session presented event (#183)
* New session presented event * removed risk_score from the event description. I will create a new PR for that * added txn claim to example * modified value of "ip" field to being an array * incorporated Apoorva's feedback * added txn to all event examples, and removed risk_score from session presented event example
1 parent e84e908 commit 64229a3

File tree

1 file changed

+61
-3
lines changed

1 file changed

+61
-3
lines changed

openid-caep-specification-1_0.md

+61-3
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,7 @@ NOTE: The event type URI is wrapped, the backslash is the continuation character
255255
"jti": "24c63fb56e5a2d77a6b512616ca9fa24",
256256
"iat": 1615305159,
257257
"aud": "https://sp.example.com/caep",
258+
"txn": 8675309,
258259
"sub_id": {
259260
"format": "opaque",
260261
"id": "dMTlD|1600802906337.16|16008.16"
@@ -274,6 +275,7 @@ NOTE: The event type URI is wrapped, the backslash is the continuation character
274275
"jti": "24c63fb56e5a2d77a6b512616ca9fa24",
275276
"iat": 1615305159,
276277
"aud": "https://sp.example.com/caep",
278+
"txn": 8675309,
277279
"sub_id": {
278280
"format": "complex",
279281
"session": {
@@ -313,6 +315,7 @@ NOTE: The event type URI is wrapped, the backslash is the continuation character
313315
"jti": "24c63fb56e5a2d77a6b512616ca9fa24",
314316
"iat": 1615305159,
315317
"aud": "https://sp.example.com/caep",
318+
"txn": 8675309,
316319
"sub_id": {
317320
"format": "complex",
318321
"user": {
@@ -376,6 +379,7 @@ NOTE: The event type URI is wrapped, the backslash is the continuation character
376379
"jti": "9afce1e4e642b165fcaacdd0e7aa4903",
377380
"iat": 1615305159,
378381
"aud": "https://sp.example2.net/caep",
382+
"txn": 8675309,
379383
"sub_id": {
380384
"format": "jwt_id",
381385
"iss": "https://idp.example.com/987654321/",
@@ -399,6 +403,7 @@ NOTE: The event type URI is wrapped, the backslash is the continuation character
399403
"jti": "9afce1e4e642b165fcaacdd0e7aa4903",
400404
"iat": 1615305159,
401405
"aud": "https://sp.example2.net/caep",
406+
"txn": 8675309,
402407
"sub_id": {
403408
"format": "jwt_id",
404409
"iss": "https://idp.example.com/987654321/",
@@ -431,6 +436,7 @@ NOTE: The event type URI is wrapped, the backslash is the continuation character
431436
"jti": "dae94fed5f459881efa38b65c6772ddc",
432437
"iat": 1615305159,
433438
"aud": "https://sp.example2.net/caep",
439+
"txn": 8675309,
434440
"sub_id": {
435441
"format": "saml_assertion_id",
436442
"issuer": "https://idp.example.com/987654321/",
@@ -514,6 +520,7 @@ NOTE: The event type URI is wrapped, the backslash is the continuation character
514520
"jti": "07efd930f0977e4fcc1149a733ce7f78",
515521
"iat": 1615305159,
516522
"aud": "https://sp.example2.net/caep",
523+
"txn": 8675309,
517524
"sub_id": {
518525
"format": "iss_sub",
519526
"iss": "https://idp.example.com/3456789/",
@@ -596,6 +603,7 @@ the assurance level changed.
596603
"jti": "07efd930f0977e4fcc1149a733ce7f78",
597604
"iat": 1615305159,
598605
"aud": "https://sp.example2.net/caep",
606+
"txn": 8675309,
599607
"sub_id": {
600608
"format": "iss_sub",
601609
"iss": "https://idp.example.com/3456789/",
@@ -621,6 +629,7 @@ the assurance level changed.
621629
"jti": "07efd930f0977e4fcc1149a733ce7f78",
622630
"iat": 1615305159,
623631
"aud": "https://sp.example2.net/caep",
632+
"txn": 8675309,
624633
"sub_id": {
625634
"format": "iss_sub",
626635
"iss": "https://idp.example.com/3456789/",
@@ -678,6 +687,7 @@ NOTE: The event type URI is wrapped, the backslash is the continuation character
678687
"jti": "24c63fb56e5a2d77a6b512616ca9fa24",
679688
"iat": 1615305159,
680689
"aud": "https://sp.example.com/caep",
690+
"txn": 8675309,
681691
"sub_id": {
682692
"format": "complex",
683693
"device": {
@@ -724,7 +734,7 @@ The `event_timestamp` in this event type specifies the time at which the session
724734
### Event Specific Claims {#session-established-event-specific-claims}
725735
The following optional claims MAY be included in the Session Established event:
726736

727-
ip
737+
ips
728738
: The array of IP addresses of the user as observed by the Transmitter. The value MUST be in the format of an array of strings, each one of which represents the RFC 4001 {{RFC4001}} string represetation of an IP address. (**NOTE**, this can be different from the one observed by the Receiver for the same user because of network translation)
729739

730740
fp_ua
@@ -749,21 +759,69 @@ The following is a non-normative example of the `session-established` event type
749759
"jti": "24c63fb56e5a2d77a6b512616ca9fa24",
750760
"iat": 1615305159,
751761
"aud": "https://sp.example.com/caep",
762+
"txn": 8675309,
752763
"sub_id": {
753764
"format": "email",
754765
"email": "[email protected]"
755766
},
756767
"events": {
757768
"https://schemas.openid.net/secevent/caep/event-type/session-established": {
758-
"ip": "192.168.1.12",
769+
"ips": ["192.168.1.12", "10.1.1.1"],
759770
"fp_ua": "abb0b6e7da81a42233f8f2b1a8ddb1b9a4c81611",
760771
"acr": "AAL2",
761-
"amr": "otp"
772+
"amr": "otp",
773+
"event_timestamp": 1615304991643
762774
}
763775
}
764776
}
765777
~~~
766778

779+
## Session Presented {#session-presented}
780+
Event Type URI:
781+
782+
`https://schemas.openid.net/secevent/caep/event-type/session-presented`
783+
784+
The Session Presented event signifies that the Transmitter has observed the session to be present at the Transmitter at the time indicated by the `event_timestamp` field in the Session Presented event. Receivers may use this information for reasons that include:
785+
786+
* Detecting abnormal user activity
787+
* Establishing an inventory of live sessions belonging to a user
788+
789+
### Event Specific Claims {#session-presented-event-specific-claims}
790+
The following optional claims MAY be present in a Session Presented event:
791+
792+
ips
793+
: The array of IP addresses of the user as observed by the Transmitter. The value MUST be in the format of an array of strings, each one of which represents the RFC 4001 {{RFC4001}} string represetation of an IP address. (**NOTE**, this can be different from the one observed by the Receiver for the same user because of network translation)
794+
795+
fp_ua
796+
: Fingerprint of the user agent computed by the Transmitter. (**NOTE**, this is not to identify the session, but to present some qualities of the session)
797+
798+
ext_id
799+
: The external session identifier, which may be used to correlate this session with a broader session (e.g., a federated session established using SAML)
800+
801+
### Examples {#session-presented-examples}
802+
The following is a non-normative example of a Session Presented event:
803+
804+
~~~json
805+
{
806+
"iss": "https://idp.example.com/123456789/",
807+
"jti": "24c63fb56e5a2d77a6b512616ca9fa24",
808+
"iat": 1615305159,
809+
"aud": "https://sp.example.com/caep",
810+
"txn": 8675309,
811+
"sub_id": {
812+
"format": "email",
813+
"email": "[email protected]"
814+
},
815+
"events": {
816+
"https://schemas.openid.net/secevent/caep/event-type/session-presented": {
817+
"ips": ["192.168.1.12","10.1.1.1"],
818+
"fp_ua": "abb0b6e7da81a42233f8f2b1a8ddb1b9a4c81611",
819+
"ext_id": "12345",
820+
"event_timestamp": 1615304991643
821+
}
822+
}}
823+
~~~
824+
767825
--- back
768826

769827
# Acknowledgements

0 commit comments

Comments
 (0)