Skip to content

Commit 86eb59c

Browse files
authored
New Session Established Event Type (#154)
* New Session Established Event Type * incorporated feedback from Apoorva and Tim * moved to new format of subject in events
1 parent 93b7567 commit 86eb59c

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

openid-caep-specification-1_0.md

+73
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ author:
2828
2929

3030
normative:
31+
RFC4001: # Textual Conventions for Internet Network Addresses
32+
3133
ISO-IEC-29115:
3234
target: http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=45138
3335
title: "ISO/IEC 29115:2013 -- Information technology - Security techniques - Entity authentication assurance framework"
@@ -79,6 +81,21 @@ normative:
7981
ins: J. L. Fenton
8082
name: James L. Fenton
8183
date: 2017-06
84+
OpenID.Core:
85+
author:
86+
- ins: N. Sakimura
87+
name: Nat Sakimura
88+
- ins: J. Bradley
89+
name: John Bradley
90+
- ins: M.B. Jones
91+
name: Michael B. Jones
92+
- ins: B. de Medeiros
93+
name: Breno de Medeiros
94+
- ins: C. Mortimore
95+
name: Chuck Mortimore
96+
date: November 2014
97+
target: http://openid.net/specs/openid-connect-core-1_0.html#IDToken
98+
title: OpenID Connect Core 1.0 - ID Token
8299
RFC2119:
83100
RFC8174:
84101
RFC5280:
@@ -691,6 +708,62 @@ NOTE: The event type URI is wrapped, the backslash is the continuation character
691708
~~~
692709
{: #device-compliance-change-examples-out-of-compliance title="Example: Device No Longer Compliant - Complex Subject + optional claims"}
693710

711+
## Session Established {#session-established}
712+
Event Type URI:
713+
714+
`https://schemas.openid.net/secevent/caep/event-type/session-established`
715+
716+
The Session Established event signifies that the Transmitter has established a new session for the subject. Receivers may use this information for a number of reasons, including:
717+
718+
* A service acting as a Transmitter can close the loop with the IdP after a user has been federated from the IdP
719+
* An IdP can detect unintended logins
720+
* A Receiver can establish an inventory of user sessions
721+
722+
The `event_timestamp` in this event type specifies the time at which the session was established.
723+
724+
### Event Specific Claims {#session-established-event-specific-claims}
725+
The following optional claims MAY be included in the Session Established event:
726+
727+
ip
728+
: 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)
729+
730+
fp_ua
731+
: 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)
732+
733+
acr
734+
: The authentication context class reference of the session, as established by the Transmitter. The value of this field MUST be interpreted in the same way as the corresponding field in an OpenID Connect ID Token {{OpenID.Core}}
735+
736+
amr
737+
: The authentication methods reference of the session, as established by the Transmitter. The value of this field MUST be an array of strings, each of which MUST be interpreted in the same way as the corresponding field in an OpenID Connect ID Token {{OpenID.Core}}
738+
739+
ext_id
740+
: The external session identifier, which may be used to correlate this session with a broader session (e.g., a federated session established using SAML)
741+
742+
743+
### Examples {#session-established-examples}
744+
The following is a non-normative example of the `session-established` event type:
745+
746+
~~~json
747+
{
748+
"iss": "https://idp.example.com/123456789/",
749+
"jti": "24c63fb56e5a2d77a6b512616ca9fa24",
750+
"iat": 1615305159,
751+
"aud": "https://sp.example.com/caep",
752+
"sub_id": {
753+
"format": "email",
754+
"email": "[email protected]"
755+
},
756+
"events": {
757+
"https://schemas.openid.net/secevent/caep/event-type/session-established": {
758+
"ip": "192.168.1.12",
759+
"fp_ua": "abb0b6e7da81a42233f8f2b1a8ddb1b9a4c81611",
760+
"acr": "AAL2",
761+
"amr": "otp"
762+
}
763+
}
764+
}
765+
~~~
766+
694767
--- back
695768

696769
# Acknowledgements

0 commit comments

Comments
 (0)