draft-hunt-idevent-token-07.txt   draft-hunt-idevent-token-08.txt 
Security Events Working Group P. Hunt, Ed. Security Events Working Group P. Hunt, Ed.
Internet-Draft Oracle Internet-Draft Oracle
Intended status: Standards Track W. Denniss Intended status: Standards Track W. Denniss
Expires: May 27, 2017 Google Expires: July 10, 2017 Google
M. Ansari M. Ansari
Cisco Cisco
M. Jones M. Jones
Microsoft Microsoft
November 23, 2016 January 6, 2017
Security Event Token (SET) Security Event Token (SET)
draft-hunt-idevent-token-07 draft-hunt-idevent-token-08
Abstract Abstract
This specification defines the Security Event Token, which may be This specification defines the Security Event Token, which may be
distributed via a protocol such as HTTP. The Security Event Token distributed via a protocol such as HTTP. The Security Event Token
(SET) specification profiles the JSON Web Token (JWT) and may be (SET) specification profiles the JSON Web Token (JWT) and may be
optionally signed and/or encrypted. A SET describes a statement of optionally signed and/or encrypted. A SET describes a statement of
fact that may be shared by an event publisher with event subscribers. fact that may be shared by an event publisher with event subscribers.
Status of This Memo Status of This Memo
skipping to change at page 1, line 39 skipping to change at page 1, line 39
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on May 27, 2017. This Internet-Draft will expire on July 10, 2017.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction and Overview . . . . . . . . . . . . . . . . . . 2 1. Introduction and Overview . . . . . . . . . . . . . . . . . . 2
1.1. Notational Conventions . . . . . . . . . . . . . . . . . 4 1.1. Notational Conventions . . . . . . . . . . . . . . . . . 4
1.2. Definitions . . . . . . . . . . . . . . . . . . . . . . . 4 1.2. Definitions . . . . . . . . . . . . . . . . . . . . . . . 4
2. The Security Event Token (SET) . . . . . . . . . . . . . . . 5 2. The Security Event Token (SET) . . . . . . . . . . . . . . . 5
2.1. Core SET Claims . . . . . . . . . . . . . . . . . . . . . 8 2.1. Core SET Claims . . . . . . . . . . . . . . . . . . . . . 8
2.2. Security Event Token Construction . . . . . . . . . . . . 10 2.2. Security Event Token Construction . . . . . . . . . . . . 10
3. Security Considerations . . . . . . . . . . . . . . . . . . . 13 3. Security Considerations . . . . . . . . . . . . . . . . . . . 12
3.1. Confidentiality and Integrity . . . . . . . . . . . . . . 13 3.1. Confidentiality and Integrity . . . . . . . . . . . . . . 12
3.2. Delivery . . . . . . . . . . . . . . . . . . . . . . . . 13 3.2. Delivery . . . . . . . . . . . . . . . . . . . . . . . . 13
3.3. Sequencing . . . . . . . . . . . . . . . . . . . . . . . 13 3.3. Sequencing . . . . . . . . . . . . . . . . . . . . . . . 13
3.4. Timing Issues . . . . . . . . . . . . . . . . . . . . . . 14 3.4. Timing Issues . . . . . . . . . . . . . . . . . . . . . . 13
3.5. Distinguishing SETs from Access Tokens . . . . . . . . . 14 3.5. Distinguishing SETs from Access Tokens . . . . . . . . . 14
4. Privacy Considerations . . . . . . . . . . . . . . . . . . . 15 4. Privacy Considerations . . . . . . . . . . . . . . . . . . . 14
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 15 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 15
5.1. JSON Web Token Claims Registration . . . . . . . . . . . 15 5.1. JSON Web Token Claims Registration . . . . . . . . . . . 15
5.1.1. Registry Contents . . . . . . . . . . . . . . . . . . 15 5.1.1. Registry Contents . . . . . . . . . . . . . . . . . . 15
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 15 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.1. Normative References . . . . . . . . . . . . . . . . . . 16 6.1. Normative References . . . . . . . . . . . . . . . . . . 15
6.2. Informative References . . . . . . . . . . . . . . . . . 17 6.2. Informative References . . . . . . . . . . . . . . . . . 16
Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . 17 Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . 17
Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 17 Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 17
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 18 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 18
1. Introduction and Overview 1. Introduction and Overview
This specification defines an extensible Security Event Token (SET) This specification defines an extensible Security Event Token (SET)
format which may be exchanged using protocols such as HTTP. The format which may be exchanged using protocols such as HTTP. The
specification builds on the JSON Web Token (JWT) format [RFC7519] in specification builds on the JSON Web Token (JWT) format [RFC7519] in
order to provide a self-contained token that can be optionally signed order to provide a self-contained token that can be optionally signed
using JSON Web Signature (JWS) [RFC7515] and/or encrypted using JSON using JSON Web Signature (JWS) [RFC7515] and/or encrypted using JSON
Web Encryption (JWE) [RFC7516]. Web Encryption (JWE) [RFC7516].
For the purpose of this specification, an event is a statement of For the purpose of this specification, an event is a statement of
fact by a publisher (also known as the event issuer) that the state fact by a publisher (also known as the event issuer) that the state
of a security subject (e.g., a web resource, token, IP address) it of a security subject (e.g., a web resource, token, IP address) it
controls or is aware of, has changed in some way (explicitly or controls or is aware of, has changed in some way (explicitly or
implicitly). A security subject may be permanent (e.g., a user implicitly). A security subject may be permanent (e.g., a user
account) or temporary (e.g., a login session) in nature. A state account) or temporary (e.g., an HTTP session) in nature. A state
change may include direct changes of entity state, implicit changes change may include direct changes of entity state, implicit changes
to state or other higher-level security statements such as: to state or other higher-level security statements such as:
o The creation, modification, removal of a resource. o The creation, modification, removal of a resource.
o The resetting or suspension of an account. o The resetting or suspension of an account.
o The revocation of a security token prior to its expiry. o The revocation of a security token prior to its expiry.
o The logout of a user session. Or, o The logout of a user session. Or,
o A cumulative conclusion such as to indicate that a user has taken o A cumulative conclusion such as to indicate that a user has taken
over an email identifier that may have been used in the past by over an email identifier that may have been used in the past by
another user. another user.
Based on some agreed upon criteria for an event feed, the publisher Based on some externally agreed criteria for an event feed, the
distributes events to the appropriate subscribers. While an event publisher distributes events to the appropriate subscribers of a
may be delivered via synchronous means (e.g., HTTP POST), the feed. While an event may be delivered via synchronous means (e.g.,
distribution of the event often happens asynchronously to the change HTTP POST), the distribution of the event often happens
of state which generated the security event. As an example, an asynchronously to the change of state which generated the security
OAuth2 Authorization Server [RFC6749], having received a token event. As an example, an OAuth2 Authorization Server [RFC6749],
revocation request [RFC7009], may issue a token revocation event to having received a token revocation request [RFC7009], may issue a
downstream web resource providers. Having been informed of a token token revocation event to downstream web resource providers. Having
revocation, the OAuth2 web resource service provider may add the been informed of a token revocation, the OAuth2 web resource service
token identifier to its local revocation list assuming the token has provider may add the token identifier to its local revocation list
not already expired. assuming the token has not already expired.
A subscriber having received an event, validates and interprets the A subscriber having received an event, validates and interprets the
event and takes its own independent action, if any. For example, event and takes its own independent action, if any. For example,
having been informed of a personal identifier now being associated having been informed of a personal identifier now being associated
with a different security subject (i.e., is being used by someone with a different security subject (i.e., is being used by someone
else), the subscriber may choose to ensure that the new user is not else), the subscriber may choose to ensure that the new user is not
granted access to resources associated with the previous user. Or it granted access to resources associated with the previous user. Or it
may not have any relationship with the subject, and no action is may not have any relationship with the subject, and no action is
taken. taken.
skipping to change at page 3, line 49 skipping to change at page 3, line 49
events, events MUST NOT be assumed to be commands or requests. To do events, events MUST NOT be assumed to be commands or requests. To do
so requires complex bi-directional signals and error recovery so requires complex bi-directional signals and error recovery
mechanisms that fall outside the scope of this specification. The mechanisms that fall outside the scope of this specification. The
intent of this specification is to define a way of exchanging intent of this specification is to define a way of exchanging
statements of fact that subscribers may interpret for their own statements of fact that subscribers may interpret for their own
purposes. Since events are typically historical statements by a purposes. Since events are typically historical statements by a
publisher and are not commands, idempotency or lack thereof, does not publisher and are not commands, idempotency or lack thereof, does not
apply. apply.
Unless otherwise specified, this specification uses example events Unless otherwise specified, this specification uses example events
intended as non-normative examples showing how an event may be used. intended to serve as non-normative examples showing how an event may
It is expected that other specifications will use this specification be constructed. It is expected that other "profiling" specifications
to define normative events. will use this specification to define normative events within some
specified context or protocol.
This specification is scoped to security and identity related events. This specification is scoped to security and identity related events.
While security event tokens may be used for other purposes, the While security event tokens may be used for other purposes, the
specification only considers security and privacy concerns relevant specification only considers security and privacy concerns relevant
to identity and personal information. to identity and personal information.
1.1. Notational Conventions 1.1. Notational Conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
skipping to change at page 5, line 34 skipping to change at page 5, line 34
o An outer JSON structure that acts as the SET envelope. The o An outer JSON structure that acts as the SET envelope. The
envelope contains a set of name/value pairs called the JWT Claims envelope contains a set of name/value pairs called the JWT Claims
Set, typically common to every SET or common to a number of Set, typically common to every SET or common to a number of
different Security Events within a single profiling specification different Security Events within a single profiling specification
or a related series of specifications. Claims in the envelope or a related series of specifications. Claims in the envelope
SHOULD be registered in the JWT Token Claims Registry Section 10.1 SHOULD be registered in the JWT Token Claims Registry Section 10.1
[RFC7519] or be Public Claims or Private Claims as also defined in [RFC7519] or be Public Claims or Private Claims as also defined in
[RFC7519]. [RFC7519].
o Envelope claims that are profiled and defined in this o Envelope claims that are profiled and defined in this
specification are used to validate the SET and determine the event specification are used to validate a SET and declare the event
data included. The claim "events" identifies the type of security data included in the SET. The claim "events" identifies the
event and MAY also include event-specific data. While a SET security event types being expressed related to the Security
contains a single event, it MAY have multiple extensions providing Subject and MAY also include event-specific data.
additional data about the same event. The primary event is
typically the first value in the "events" object, while event
extensions are the 2nd, 3rd, etc.
o Each JSON member of the "events" object is a name/value pair, o Each JSON member of the "events" object is a name/value pair. The
whose value is a JSON object known as the event "payload". The JSON attribute name is a URI String value that expresses an event
payload object contains claims typically unique to the event's URI type. The corresponding value is a JSON object known as the event
value and are not registered as JWT claims. These claims are "payload". The payload JSON object contains claims typically
defined by their associated event specification. An event with no unique to the event's URI type value and are not registered as JWT
payload claims SHALL be represented as the empty JSON object claims. These claims are defined by their associated event
("{}"). Event extensions can be used for many purposes. Some specification. An event with no payload claims SHALL be
examples include but are not limited to: represented as the empty JSON object ("{}"). In many cases, one
event URI expresses the primary event URI, while other events
might be considered extensions that MAY be used to do things such
as:
* A categorization extension applied to multiple event types to * A categorization event type to provide classification
provide classification information (e.g., threat type or information (e.g., threat type or level).
level).
* Enhancement of an existing specifications the arise over time. * An enhancement of an existing specifications the arise over
time.
* Correlation extensions needed to link a potential series of * An extensions needed to link a potential series of events.
events.
* Localized contextual extensions needed between a publisher and * Localized specific purpose extensions needed between a
subscriber. particular publisher and subscriber.
The following is a non-normative example showing the JWT Claims Set The following is a non-normative example showing the JWT Claims Set
for a hypothetical SCIM password reset SET. This example is also one for a hypothetical SCIM password reset SET. This example shows an
in which the issuer has provided an extension extension ("https://example.com/scim/event/passwordResetExt") that is
("https://example.com/scim/event/passwordResetExt") that is used to used to convey additional information -- in this case, the current
convey additional information -- in this case, the current count of count of reset attempts:
reset attempts:
{ {
"jti": "3d0c3cf797584bd193bd0fb1bd4e7d30", "jti": "3d0c3cf797584bd193bd0fb1bd4e7d30",
"iat": 1458496025, "iat": 1458496025,
"iss": "https://scim.example.com", "iss": "https://scim.example.com",
"aud": [ "aud": [
"https://jhub.example.com/Feeds/98d52461fa5bbc879593b7754", "https://jhub.example.com/Feeds/98d52461fa5bbc879593b7754",
"https://jhub.example.com/Feeds/5d7604516b1d08641d7676ee7" "https://jhub.example.com/Feeds/5d7604516b1d08641d7676ee7"
], ],
"sub": "https://scim.example.com/Users/44f6142df96bd6ab61e7521d9", "sub": "https://scim.example.com/Users/44f6142df96bd6ab61e7521d9",
skipping to change at page 7, line 11 skipping to change at page 7, line 9
information such as the current count of resets. information such as the current count of resets.
o An "iss" claim, denoting the event publisher. o An "iss" claim, denoting the event publisher.
o The "sub" claim specifies the SCIM resource URI that was affected. o The "sub" claim specifies the SCIM resource URI that was affected.
o The "aud" claim specifies the intended audiences for the event. o The "aud" claim specifies the intended audiences for the event.
In practical terms, an audience MAY be the URI for an event feed In practical terms, an audience MAY be the URI for an event feed
that a client has subscribed to. that a client has subscribed to.
Additional extensions to an event may be added by adding more values In this example, the SCIM event indicates that a password has been
to the "events" claims. For each event URI value specified, there is updated and the current password reset count is 5. Notice that the
a corresponding JSON object that contains the claims associated with value for "resetAttempts" is actually part of its own JSON object
that event, if any. In this example, the SCIM event indicates that a associated with its own event URI attribute.
password has been updated and the current password reset count is 5.
Notice that the value for "resetAttempts" is actually part of its own
JSON object associated with the extension URI.
Here is another example JWT Claims Set for a security event token, Here is another example JWT Claims Set for a security event token,
this one for a Logout Token: this one for a Logout Token:
{ {
"iss": "https://server.example.com", "iss": "https://server.example.com",
"sub": "248289761001", "sub": "248289761001",
"aud": "s6BhdRkqt3", "aud": "s6BhdRkqt3",
"iat": 1471566154, "iat": 1471566154,
"jti": "bWJq", "jti": "bWJq",
skipping to change at page 8, line 21 skipping to change at page 8, line 21
{ {
"jti": "fb4e75b5411e4e19b6c0fe87950f7749", "jti": "fb4e75b5411e4e19b6c0fe87950f7749",
"sub": "248289761001", "sub": "248289761001",
"iat": 1458496025, "iat": 1458496025,
"iss": "https://my.examplemed.com", "iss": "https://my.examplemed.com",
"aud": [ "aud": [
"https://rp.example.com" "https://rp.example.com"
], ],
"events": { "events": {
"https://openid.net/heart/consent.html":{ "https://openid.net/heart/specs/consent.html":{
"iss":"https://connect.example.com",
"consentUri":[ "consentUri":[
"https://terms.examplemed.com/labdisclosure.html#Agree" "https://terms.examplemed.com/labdisclosure.html#Agree"
] ]
} }
} }
} }
Figure 3: Example Consent Event Figure 3: Example Consent Event
In the above example "iss" and "sub" contained within the claim In the above example, the attribute "iss" contained within the
"https://openid.net/heart/consent", refer to the subject and issuer payload for the event "https://openid.net/heart/specs/consent.html",
of the original OpendID Provider. They are distinct from the top refers to the issuer of the Security Subject ("sub") rather than the
level value of "iss" which always refers to the issuer of the event - event issuer "https://my.examplemed.com". They are distinct from the
a medical consent service that is a relying party to the OpenID top level value of "iss" which always refers to the issuer of the
Provider. event - a medical consent service that is a relying party to the
OpenID Provider.
2.1. Core SET Claims 2.1. Core SET Claims
The following are claims that are based on [RFC7519] claim The following are claims that are based on [RFC7519] claim
definitions and are profiled for use in an event token: definitions and are profiled for use in an event token:
jti jti
As defined by Section 4.1.7 [RFC7519] contains a unique identifier As defined by Section 4.1.7 [RFC7519] contains a unique identifier
for an event. The identifier SHOULD be unique within a particular for an event. The identifier SHOULD be unique within a particular
event feed and MAY be used by clients to track whether a event feed and MAY be used by clients to track whether a
particular event has already been received. This claim is particular event has already been received. This claim is
REQUIRED. REQUIRED.
iss iss
A single valued String containing the URI of the service provider A single valued String containing the URI of the service provider
publishing the SET (the issuer). This claim is REQUIRED. publishing the SET (the issuer). This claim is REQUIRED. Note
that when a SET is expressing an event about a Security Subject
for which the SET issuer is not the issuer of the Security
Subject, the conflict SHALL be resolved by including the Security
Subject "iss" value within the event "payload" (see "events"
claim).
aud aud
A multi-valued String containing the URIs representing the As defined in Section 4.1.3 [RFC7519], an array containing the
audience of the event. Values are typically URLs of the feeds the StringOrURI values representing the audience of the event. Values
event is associated with. When an event has multiple audiences are typically URLs of the feeds the event is associated with.
that go to the same subscriber, the publisher is not obligated to This claim is RECOMMENDED.
deliver repeated events to the same subscriber. This claim is
RECOMMENDED.
iat iat
As defined by Section 4.1.6 [RFC7519], a value containing a As defined by Section 4.1.6 [RFC7519], a value containing a
NumericDate, which represents when the event was issued. Unless NumericDate, which represents when the event was issued. Unless
otherwise specified, the value SHOULD be interpreted by the otherwise specified, the value SHOULD be interpreted by the
subscriber as equivalent to the actual time of the event. This subscriber as equivalent to the actual time of the event. This
claim is REQUIRED. claim is REQUIRED.
nbf nbf
As defined by Section 4.1.5 [RFC7519], a value containing a Defined by Section 4.1.5 [RFC7519], a number whose value is a
NumericDate, which represents a future date when the event will NumericDate. In the context of the SET token it SHALL be
occur. This claim is OPTIONAL. interpreted to mean a date in which the event is believed to have
occurred (in the past) or will occur in the future. Note: there
MAY be some cases where "nbf" is still smaller than "iat" such as
when it took an extended time for a SET to be issued (for example
after some analysis). This claim is OPTIONAL.
sub As defined by Section 4.1.2 [RFC7519], a String or URI value sub As defined by Section 4.1.2 [RFC7519], a String or URI value
representing the principal or the subject of the SET. This is representing the principal or the subject of the SET. This is
usually the entity whose "state" was changed. For example, an IP usually the entity whose "state" was changed. For example, an IP
Address was added to a black list. A URI representing a user Address was added to a black list. A URI representing a user
resource that was modified. A token identifier for a revoked resource that was modified. A token identifier for a revoked
token. If used, the profile specification SHOULD define the token. If used, the profile specification SHOULD define the
content and format semantics for the value. This claim is content and format semantics for the value. This claim is
OPTIONAL, as the principal for any given profile may already be OPTIONAL, as the principal for any given profile may already be
identified without the inclusion of a subject claim. identified without the inclusion of a subject claim.
skipping to change at page 9, line 45 skipping to change at page 10, line 6
exp As defined by [RFC7519], this claim is time on which the JWT exp As defined by [RFC7519], this claim is time on which the JWT
MUST NOT be accepted for processing. In the context of a SET MUST NOT be accepted for processing. In the context of a SET
however, this notion does not apply since a SET reflects something however, this notion does not apply since a SET reflects something
that has already been processed and is historical in nature. that has already been processed and is historical in nature.
While some specifications MAY have a need for this claim, its use While some specifications MAY have a need for this claim, its use
in general cases is NOT RECOMMENDED. in general cases is NOT RECOMMENDED.
The following are new claims defined by this specification: The following are new claims defined by this specification:
events events
A JSON object whose members are a set of JSON name/value pairs The semantics of this claim is to define a set of event statements
whose names are URIs representing the primary event (typically the that each MAY add additional claims to fully describe a single
first member) and event extensions being expressed. For each name logical event that has occurred (e.g. a state change to a
present, the corresponding value SHALL be a JSON object. The JSON subject). Multiple event statements of the same type SHALL NOT be
object MAY be an empty object ("{}"), or it MAY be a JSON object accepted. The "events" claim SHOULD NOT be used to express
containing data as described by the profiling event specification. multiple logical events.
The value of "events" is a JSON object whose members are a set of
JSON name/value pairs whose names are URIs representing the event
statements being expressed. Event URI values SHOULD be stable
values (e.g. a permanent URL for an event specification). For
each name present, the corresponding value SHALL be a JSON object.
The JSON object MAY be an empty object ("{}"), or it MAY be a JSON
object containing data as described by the profiling event
specification.
txn txn
An OPTIONAL single-valued String value that represents a unique An OPTIONAL String value that represents a unique transaction
transaction identifier. In cases where multiple SETs are issued identifier. In cases where multiple SETs are issued based on
based on different event URIs, the transaction identifier MAY be different event URIs, the transaction identifier MAY be used to
used to correlate SETs to the same originating event or stateful correlate SETs to the same originating event or stateful change.
change.
2.2. Security Event Token Construction 2.2. Security Event Token Construction
A SET is a JWT [RFC7519] that is constructed by building a JSON A SET is a JWT [RFC7519] that is constructed by building a JSON
structure that constitutes an event object and which is then used as structure that constitutes an event object and which is then used as
the body of a JWT. the body of a JWT.
While this specification uses JWT to convey a SET, implementers SHALL While this specification uses JWT to convey a SET, implementers SHALL
NOT use SETs to convey authentication or authorization assertions. NOT use SETs to convey authentication or authorization assertions.
skipping to change at page 11, line 21 skipping to change at page 11, line 21
"iss": "https://scim.example.com", "iss": "https://scim.example.com",
"aud": [ "aud": [
"https://scim.example.com/Feeds/98d52461fa5bbc879593b7754", "https://scim.example.com/Feeds/98d52461fa5bbc879593b7754",
"https://scim.example.com/Feeds/5d7604516b1d08641d7676ee7" "https://scim.example.com/Feeds/5d7604516b1d08641d7676ee7"
], ],
"events": { "events": {
"urn:ietf:params:scim:event:create": { "urn:ietf:params:scim:event:create": {
"ref": "ref":
"https://scim.example.com/Users/44f6142df96bd6ab61e7521d9", "https://scim.example.com/Users/44f6142df96bd6ab61e7521d9",
"attributes":["id", "name", "userName", "password", "emails"], "attributes":["id", "name", "userName", "password", "emails"]
"values": {
"emails": [
{"type": "work", "value": "jdoe@example.com"}
],
"password": "not4u2no",
"userName": "jdoe",
"id": "44f6142df96bd6ab61e7521d9",
"name": {
"givenName": "John",
"familyName": "Doe"
}
}
} }
} }
} }
Figure 4: Example Event Claims Figure 4: Example Event Claims
When transmitted, the above JSON body must be converted into a JWT as When transmitted, the above JSON body must be converted into a JWT as
per [RFC7519]. In this example, because the event contains attribute per [RFC7519].
values, the token MUST be encrypted per JWE (see [RFC7516]) before
transmission.
The following is an example of a SCIM Event expressed as an unsecured The following is an example of a SCIM Event expressed as an unsecured
JWT. The JWT header of: JWT. The JWT header of:
{"alg":"none"} {"alg":"none"}
Base64url encoding of the octets of the UTF-8 representation of the Base64url encoding of the octets of the UTF-8 representation of the
header yields: header yields:
eyJhbGciOiJub25lIn0 eyJhbGciOiJub25lIn0
The example JSON Event Data is encoded as follows: The example JSON Event Data is encoded as follows:
eyAgCiAgImp0aSI6ICI0ZDM1NTllYzY3NTA0YWFiYTY1ZDQwYjAzNjNmYWFkOCIsCiAg e3sgIAogICJqdGkiOiAiNGQzNTU5ZWM2NzUwNGFhYmE2NWQ0MGIwMzYzZmFhZDgiLAog
ImlhdCI6IDE0NTg0OTY0MDQsCiAgImlzcyI6ICJodHRwczovL3NjaW0uZXhhbXBsZS5j ICJpYXQiOiAxNDU4NDk2NDA0LAogICJpc3MiOiAiaHR0cHM6Ly9zY2ltLmV4YW1wbGUu
b20iLCAgCiAgImF1ZCI6IFsKICAgImh0dHBzOi8vc2NpbS5leGFtcGxlLmNvbS9GZWVk Y29tIiwgIAogICJhdWQiOiBbCiAgICJodHRwczovL3NjaW0uZXhhbXBsZS5jb20vRmVl
cy85OGQ1MjQ2MWZhNWJiYzg3OTU5M2I3NzU0IiwKICAgImh0dHBzOi8vc2NpbS5leGFt ZHMvOThkNTI0NjFmYTViYmM4Nzk1OTNiNzc1NCIsCiAgICJodHRwczovL3NjaW0uZXhh
cGxlLmNvbS9GZWVkcy81ZDc2MDQ1MTZiMWQwODY0MWQ3Njc2ZWU3IgogIF0sICAKICAK bXBsZS5jb20vRmVlZHMvNWQ3NjA0NTE2YjFkMDg2NDFkNzY3NmVlNyIKICBdLCAgCiAg
ICAiZXZlbnRzIjogewogICAgInVybjppZXRmOnBhcmFtczpzY2ltOmV2ZW50OmNyZWF0 CiAgImV2ZW50cyI6IHsKICAgICJ1cm46aWV0ZjpwYXJhbXM6c2NpbTpldmVudDpjcmVh
ZSI6IHsKICAgICAgInJlZiI6CiAgICAgICAgImh0dHBzOi8vc2NpbS5leGFtcGxlLmNv dGUiOiB7CiAgICAgICJyZWYiOgogICAgICAgICJodHRwczovL3NjaW0uZXhhbXBsZS5j
bS9Vc2Vycy80NGY2MTQyZGY5NmJkNmFiNjFlNzUyMWQ5IiwKICAgICAgImF0dHJpYnV0 b20vVXNlcnMvNDRmNjE0MmRmOTZiZDZhYjYxZTc1MjFkOSIsCiAgICAgICJhdHRyaWJ1
ZXMiOlsiaWQiLCAibmFtZSIsICJ1c2VyTmFtZSIsICJwYXNzd29yZCIsICJlbWFpbHMi dGVzIjpbImlkIiwgIm5hbWUiLCAidXNlck5hbWUiLCAicGFzc3dvcmQiLCAiZW1haWxz
XSwKICAgICAgInZhbHVlcyI6IHsKICAgICAgICAiZW1haWxzIjogWwogICAgICAgICB7 Il0KICAgIH0KICB9Cn0
InR5cGUiOiAid29yayIsICJ2YWx1ZSI6ICJqZG9lQGV4YW1wbGUuY29tIn0KICAgICAg
ICBdLAogICAgICAgICJwYXNzd29yZCI6ICJub3Q0dTJubyIsCiAgICAgICAgInVzZXJO
YW1lIjogImpkb2UiLAogICAgICAgICJpZCI6ICI0NGY2MTQyZGY5NmJkNmFiNjFlNzUy
MWQ5IiwKICAgICAgICAibmFtZSI6IHsKICAgICAgICAgICJnaXZlbk5hbWUiOiAiSm9o
biIsCiAgICAgICAgICAiZmFtaWx5TmFtZSI6ICJEb2UiCiAgICAgICAgfQogICAgICB9
CiAgICB9CiAgfQp9
The encoded JWS signature is the empty string. Concatenating the The encoded JWS signature is the empty string. Concatenating the
parts yields: parts yields:
eyJhbGciOiJub25lIn0 eyJhbGciOiJub25lIn0
. .
eyAgCiAgImp0aSI6ICI0ZDM1NTllYzY3NTA0YWFiYTY1ZDQwYjAzNjNmYWFkOCIsCiAg e3sgIAogICJqdGkiOiAiNGQzNTU5ZWM2NzUwNGFhYmE2NWQ0MGIwMzYzZmFhZDgiLAog
ImlhdCI6IDE0NTg0OTY0MDQsCiAgImlzcyI6ICJodHRwczovL3NjaW0uZXhhbXBsZS5j ICJpYXQiOiAxNDU4NDk2NDA0LAogICJpc3MiOiAiaHR0cHM6Ly9zY2ltLmV4YW1wbGUu
b20iLCAgCiAgImF1ZCI6IFsKICAgImh0dHBzOi8vc2NpbS5leGFtcGxlLmNvbS9GZWVk Y29tIiwgIAogICJhdWQiOiBbCiAgICJodHRwczovL3NjaW0uZXhhbXBsZS5jb20vRmVl
cy85OGQ1MjQ2MWZhNWJiYzg3OTU5M2I3NzU0IiwKICAgImh0dHBzOi8vc2NpbS5leGFt ZHMvOThkNTI0NjFmYTViYmM4Nzk1OTNiNzc1NCIsCiAgICJodHRwczovL3NjaW0uZXhh
cGxlLmNvbS9GZWVkcy81ZDc2MDQ1MTZiMWQwODY0MWQ3Njc2ZWU3IgogIF0sICAKICAK bXBsZS5jb20vRmVlZHMvNWQ3NjA0NTE2YjFkMDg2NDFkNzY3NmVlNyIKICBdLCAgCiAg
ICAiZXZlbnRzIjogewogICAgInVybjppZXRmOnBhcmFtczpzY2ltOmV2ZW50OmNyZWF0 CiAgImV2ZW50cyI6IHsKICAgICJ1cm46aWV0ZjpwYXJhbXM6c2NpbTpldmVudDpjcmVh
ZSI6IHsKICAgICAgInJlZiI6CiAgICAgICAgImh0dHBzOi8vc2NpbS5leGFtcGxlLmNv dGUiOiB7CiAgICAgICJyZWYiOgogICAgICAgICJodHRwczovL3NjaW0uZXhhbXBsZS5j
bS9Vc2Vycy80NGY2MTQyZGY5NmJkNmFiNjFlNzUyMWQ5IiwKICAgICAgImF0dHJpYnV0 b20vVXNlcnMvNDRmNjE0MmRmOTZiZDZhYjYxZTc1MjFkOSIsCiAgICAgICJhdHRyaWJ1
ZXMiOlsiaWQiLCAibmFtZSIsICJ1c2VyTmFtZSIsICJwYXNzd29yZCIsICJlbWFpbHMi dGVzIjpbImlkIiwgIm5hbWUiLCAidXNlck5hbWUiLCAicGFzc3dvcmQiLCAiZW1haWxz
XSwKICAgICAgInZhbHVlcyI6IHsKICAgICAgICAiZW1haWxzIjogWwogICAgICAgICB7 Il0KICAgIH0KICB9Cn0
InR5cGUiOiAid29yayIsICJ2YWx1ZSI6ICJqZG9lQGV4YW1wbGUuY29tIn0KICAgICAg
ICBdLAogICAgICAgICJwYXNzd29yZCI6ICJub3Q0dTJubyIsCiAgICAgICAgInVzZXJO
YW1lIjogImpkb2UiLAogICAgICAgICJpZCI6ICI0NGY2MTQyZGY5NmJkNmFiNjFlNzUy
MWQ5IiwKICAgICAgICAibmFtZSI6IHsKICAgICAgICAgICJnaXZlbk5hbWUiOiAiSm9o
biIsCiAgICAgICAgICAiZmFtaWx5TmFtZSI6ICJEb2UiCiAgICAgICAgfQogICAgICB9
CiAgICB9CiAgfQp9
. .
Figure 5: Example Unsecured Security Event Token Figure 5: Example Unsecured Security Event Token
To create and or validate a signed or encrypted SET, follow the For the purpose of a simpler example in Figure 5 an unencrypted token
instructions in section 7 of [RFC7519]. was shown. When SETs are not signed or encrypted, the subscriber
MUST depend upon TLS and HTTP to authenticate the sender and the
security of the channel to authenticate the SET and its sender.
When validation (i.e. auditing), or additional transmission security
is required, JWS Signing and JWS Encryption MAY be used. To create
and or validate a signed or encrypted SET, follow the instructions in
section 7 of [RFC7519].
3. Security Considerations 3. Security Considerations
3.1. Confidentiality and Integrity 3.1. Confidentiality and Integrity
SETs may often contain sensitive information. Therefore, methods for SETs may often contain sensitive information. Therefore, methods for
distribution of events SHOULD require the use of a transport-layer distribution of events SHOULD require the use of a transport-layer
security mechanism when distributing events. Parties MUST support security mechanism when distributing events. Parties MUST support
TLS 1.2 [RFC5246] and MAY support additional transport-layer TLS 1.2 [RFC5246] and MAY support additional transport-layer
mechanisms meeting its security requirements. When using TLS, the mechanisms meeting its security requirements. When using TLS, the
skipping to change at page 13, line 38 skipping to change at page 13, line 15
so that individual events MAY be authenticated and validated by the so that individual events MAY be authenticated and validated by the
subscriber. subscriber.
3.2. Delivery 3.2. Delivery
This specification does not define a delivery mechanism by itself. This specification does not define a delivery mechanism by itself.
In addition to confidentiality and integrity (discussed above), In addition to confidentiality and integrity (discussed above),
implementers and profile specifications MUST consider the implementers and profile specifications MUST consider the
consequences of delivery mechanisms that are not secure and/or not consequences of delivery mechanisms that are not secure and/or not
assured. For example, while a SET may be end-to-end secured using assured. For example, while a SET may be end-to-end secured using
JWE, that alone will not guarantee that the correct subscribing party JWE encrypted SETs, without TLS there is no assurance that the
knows they should have received a particular SET. correct endpoint received the SET and that it could be successfully
processed.
3.3. Sequencing 3.3. Sequencing
As defined in this specification, there is no defined way to order As defined in this specification, there is no defined way to order
multiple SETs in a sequence. Depending on the type and nature of SET multiple SETs in a sequence. Depending on the type and nature of SET
event, order may or may not matter. For example, in provisioning, event, order may or may not matter. For example, in provisioning,
event order is critical -- an object could not be modified before it event order is critical -- an object could not be modified before it
was created. In other SET types, such as a token revocation, the was created. In other SET types, such as a token revocation, the
order of SETs for revoked tokens does not matter. If however, the order of SETs for revoked tokens does not matter. If however, the
event was described as a log-in or logged-out status for a user event was described as a log-in or logged-out status for a user
skipping to change at page 18, line 39 skipping to change at page 18, line 14
o Corrected typos o Corrected typos
o New txn claim o New txn claim
o New security considerations Sequencing and Timing Issues o New security considerations Sequencing and Timing Issues
Draft 07 - Draft 07 -
o PH - Moved payload objects to be values of event URI attributes, o PH - Moved payload objects to be values of event URI attributes,
per discussion. per discussion.
o mbj - Applied terminology consistency and grammar cleanups. o mbj - Applied terminology consistency and grammar cleanups.
Draft 08 - PH -
o Added clarification to status of examples
o Changed from primary vs. extension to state that multiple events
may be expressed, some of which may or may not be considered
extensions of others (which is for the subscriber or profiling
specifications to determine).
o Other editorial changes suggested by Yaron
Authors' Addresses Authors' Addresses
Phil Hunt (editor) Phil Hunt (editor)
Oracle Corporation Oracle Corporation
Email: phil.hunt@yahoo.com Email: phil.hunt@yahoo.com
William Denniss William Denniss
Google Google
 End of changes. 35 change blocks. 
142 lines changed or deleted 146 lines changed or added

This html diff was produced by rfcdiff 1.45. The latest version is available from http://tools.ietf.org/tools/rfcdiff/