CAEP-Spec | June 2024 | |
Cappalli & Tulshibagwale | Standards Track | [Page] |
This document defines the Continuous Access Evaluation Profile (CAEP) of the Shared Signals Framework [SSF]. It specifies a set of event types conforming to the Shared Signals Framework. These event types are intended to be used between cooperating Transmitters and Receivers such that Transmitters may send continuous updates using which Receivers can attenuate access to shared human or robotic users, devices, sessions and applications.¶
CAEP is the application of the Shared Signals Profile of IETF Security Events 1.0 [SSF] (SSF Profile) to ensure access security in a network of cooperating providers. CAEP specifies a set of event-types that conform to the SSF Profile. This document specifies the event-types required to achieve this goal.¶
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.¶
The following claims are optional unless otherwise specified in the event definition.¶
OPTIONAL, JSON number: the time at which the event described by this SET occurred. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.¶
OPTIONAL, JSON string: describes the entity that invoked the event.¶
This MUST be one of the following strings:¶
OPTIONAL, JSON object: a localizable administrative message intended for logging and auditing. The object MUST contain one or more key/value pairs, with a BCP47 [RFC5646] language tag as the key and the locale-specific administrative message as the value.¶
OPTIONAL, JSON object: a localizable user-friendly message for display to an end-user. The object MUST contain one or more key/value pairs, with a BCP47 [RFC5646] language tag as the key and the locale-specific end-user message as the value.¶
The base URI for CAEP event types is:¶
https://schemas.openid.net/secevent/caep/event-type/
¶
Event Type URI:¶
https://schemas.openid.net/secevent/caep/event-type/session-revoked
¶
Session Revoked signals that the session identified by the subject has been revoked. The explicit session identifier may be directly referenced in the subject or other properties of the session may be included to allow the receiver to identify applicable sessions.¶
When a Complex Claim is used as the subject, the revocation event applies to any session derived from matching those combined claims.¶
The actual reason why the session was revoked might be specified with the
nested reason_admin
and/or reason_user
claims described in Section 2.¶
There are no event-specific claims for this event type.¶
When event_timestamp
is included, its value MUST represent the time at which
the session revocation occurred.¶
Event Type URI:¶
https://schemas.openid.net/secevent/caep/event-type/token-claims-change
¶
Token Claims Change signals that a claim in a token, identified by the subject claim, has changed.¶
The actual reason why the claims change occurred might be specified with the
nested reason_admin
and/or reason_user
claims made in Section 2.¶
REQUIRED, JSON object: one or more claims with their new value(s)¶
When event_timestamp
is included, its value MUST represent the time at which
the claim value(s) changed.¶
Event Type URI:¶
https://schemas.openid.net/secevent/caep/event-type/credential-change
¶
The Credential Change event signals that a credential was created, changed, revoked or deleted. Credential Change scenarios include:¶
password/PIN change/reset¶
certificate enrollment, renewal, revocation and deletion¶
second factor / passwordless credential enrollment or deletion (U2F, FIDO2, OTP, app-based)¶
The actual reason why the credential change occurred might be specified with the
nested reason_admin
and/or reason_user
claims made in Section 2.¶
REQUIRED, JSON string: This MUST be one of the following strings, or any other credential type supported mutually by the Transmitter and the Receiver.¶
REQUIRED, JSON string: This MUST be one of the following strings:¶
OPTIONAL, JSON string: credential friendly name¶
OPTIONAL, JSON string: issuer of the X.509 certificate as defined in [RFC5280]¶
OPTIONAL, JSON string: serial number of the X.509 certificate as defined in [RFC5280]¶
OPTIONAL, JSON string: FIDO2 Authenticator Attestation GUID as defined in [WebAuthn]¶
When event_timestamp
is included, its value MUST represent the time at which
the credential change occurred.¶
Event Type URI:¶
https://schemas.openid.net/secevent/caep/event-type/assurance-level-change
¶
The Assurance Level Change event signals that there has been a change in authentication method since the initial user login. This change can be from a weak authentication method to a strong authentication method, or vice versa.¶
In the first scenario, Assurance Level Change will an increase, while in the second scenario it will be a decrease. For example, a user can start a session with Service Provider A using single factor authentication (such as a password). The user can then open another session with Service Provider B using two-factor authentication (such as OTP). In this scenario an increase Assurance Level Change event will signal to Service Provider A that user has authenticated with a stronger authentication method.¶
The actual reason why the assurance level changed might be specified with the
nested reason_admin
and/or reason_user
claims made in Section 2.¶
REQUIRED, JSON string: the namespace of the values in the current_level
and previous_level
claims.
This string MAY be one of the following strings:¶
RFC8176
: The assurance level values are from the [RFC8176] specification¶
RFC6711
: The assurance level values are from the [RFC6711] specification¶
ISO-IEC-29115
: The assurance level values are from the [ISO-IEC-29115] specification¶
NIST-IAL
: The assurance level values are from the [NIST-IDPROOF] specification¶
NIST-AAL
: The assurance level values are from the [NIST-AUTH] specification¶
NIST-FAL
: The assurance level values are from the [NIST-FED] specification¶
Any other value that is an alias for a custom namespace agreed between the Transmitter and the Receiver¶
REQUIRED, JSON string: The current assurance level, as defined in the specified namespace
¶
OPTIONAL, JSON string: the previous assurance level, as defined in the specified namespace
If the Transmitter omits this value, the Receiver MUST assume that the previous assurance level is unknown to the Transmitter¶
OPTIONAL, JSON string: the assurance level increased or decreased
If the Transmitter has specified the previous_level
, then the Transmitter SHOULD provide a value for this claim.
If present, this MUST be one of the following strings:¶
When event_timestamp
is included, its value MUST represent the time at which
the assurance level changed.¶
Event Type URI:¶
https://schemas.openid.net/secevent/caep/event-type/device-compliance-change
¶
Device Compliance Change signals that a device's compliance status has changed.¶
The actual reason why the status change occurred might be specified with the
nested reason_admin
and/or reason_user
claims made in Section 2.¶
REQUIRED, JSON string: the compliance status prior to the change that triggered the event¶
This MUST be one of the following strings:¶
REQUIRED, JSON string: the current status that triggered the event¶
This MUST be one of the following strings:¶
When event_timestamp
is included, its value MUST represent the time at which
the device compliance status changed.¶
Event Type URI:¶
https://schemas.openid.net/secevent/caep/event-type/session-established
¶
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:¶
A service acting as a Transmitter can close the loop with the IdP after a user has been federated from the IdP¶
An IdP can detect unintended logins¶
A Receiver can establish an inventory of user sessions¶
The event_timestamp
in this event type specifies the time at which the session was established.¶
The following optional claims MAY be included in the Session Established event:¶
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)¶
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)¶
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]¶
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]¶
The external session identifier, which may be used to correlate this session with a broader session (e.g., a federated session established using SAML)¶
The following is a non-normative example of the session-established
event type:¶
{ "iss": "https://idp.example.com/123456789/", "jti": "24c63fb56e5a2d77a6b512616ca9fa24", "iat": 1615305159, "aud": "https://sp.example.com/caep", "txn": 8675309, "sub_id": { "format": "email", "email": "someuser@somedomain.com" }, "events": { "https://schemas.openid.net/secevent/caep/event-type/session-established": { "ips": ["192.168.1.12", "10.1.1.1"], "fp_ua": "abb0b6e7da81a42233f8f2b1a8ddb1b9a4c81611", "acr": "AAL2", "amr": "otp", "event_timestamp": 1615304991643 } } }¶
Event Type URI:¶
https://schemas.openid.net/secevent/caep/event-type/session-presented
¶
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:¶
The following optional claims MAY be present in a Session Presented event:¶
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)¶
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)¶
The external session identifier, which may be used to correlate this session with a broader session (e.g., a federated session established using SAML)¶
The following is a non-normative example of a Session Presented event:¶
{ "iss": "https://idp.example.com/123456789/", "jti": "24c63fb56e5a2d77a6b512616ca9fa24", "iat": 1615305159, "aud": "https://sp.example.com/caep", "txn": 8675309, "sub_id": { "format": "email", "email": "someuser@somedomain.com" }, "events": { "https://schemas.openid.net/secevent/caep/event-type/session-presented": { "ips": ["192.168.1.12","10.1.1.1"], "fp_ua": "abb0b6e7da81a42233f8f2b1a8ddb1b9a4c81611", "ext_id": "12345", "event_timestamp": 1615304991643 } }}¶
Any implementations of events described in this document SHOULD comply with the Shared Signals Framework [SSF]. Exchanging events described herein without complying with the Shared Signals Framework [SSF] may result in security issues.¶
The authors wish to thank all members of the OpenID Foundation Shared Signals Working Group who contributed to the development of this specification.¶
Copyright (c) 2024 The OpenID Foundation.¶
The OpenID Foundation (OIDF) grants to any Contributor, developer, implementer, or other interested party a non-exclusive, royalty free, worldwide copyright license to reproduce, prepare derivative works from, distribute, perform and display, this Implementers Draft or Final Specification solely for the purposes of (i) developing specifications, and (ii) implementing Implementers Drafts and Final Specifications based on such documents, provided that attribution be made to the OIDF as the source of the material, but that such attribution does not indicate an endorsement by the OIDF.¶
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.¶
[[ To be removed from the final specification ]]¶
-03¶