| Network Working Group | A. Backman, Ed. |
| Internet-Draft | Amazon |
| Intended status: Standards Track | M. Jones, Ed. |
| Expires: April 25, 2019 | Microsoft |
| M. Scurtescu | |
| Coinbase | |
| M. Ansari | |
| Cisco | |
| A. Nadalin | |
| Microsoft | |
| October 22, 2018 |
Poll-Based Security Event Token (SET) Delivery Using HTTP
draft-ietf-secevent-http-poll-01
This specification defines how a series of Security Event Tokens (SETs) may be delivered to an intended recipient using HTTP POST over TLS initiated as a poll by the recipient. The specification also defines how delivery can be assured, subject to the SET Recipient's need for assurance.
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 April 25, 2019.
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 the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
This specification defines how a stream of Security Event Tokens (SETs) [RFC8417] can be transmitted to an intended SET Recipient using HTTP [RFC7231] over TLS. The specification defines a method to poll for SETs using HTTP POST.
This specification defines a method of SET delivery in what is known as Event Streams.
This specification does not define the method by which Event Streams are defined, provisioned, managed, monitored, and configured and is out of scope of this specification.
[[This work is TBD by the SECEVENTS WG]]
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 document, all figures MAY contain spaces and extra line wrapping for readability and due to space limitations. Similarly, some URIs contained within examples have been shortened for space and readability reasons.
This specification utilizes terminology defined in [RFC8417], as well as the terms defined below:
When an event occurs, the SET Transmitter constructs a SET [RFC8417] that describes the event. The SET Transmitter determines the SET Recipients that the SET should be distributed to.
How SETs are defined and the process by which events are identified for SET Recipients is out of scope of this specification.
When a SET is available for an SET Recipient, the SET Transmitter attempts to deliver the SET based on the SET Recipient's registered delivery mechanism:
In Poll-Based SET Delivery Using HTTP, multiple SETs are delivered in a JSON document [RFC7159] to an SET Recipient in response to an HTTP POST request to the SET Transmitter. Then in a following request, the SET Recipient acknowledges received SETs and MAY poll for more. All requests and responses are JSON documents and use a Content-Type of application/json as described in Section 2.1.
After successful (acknowledged) SET delivery, Event Transmitters SHOULD NOT be required to maintain or record SETs for recovery. Once a SET is acknowledged, the SET Recipient SHALL be responsible for retention and recovery.
Transmitted SETs SHOULD be self-validating (e.g., signed) if there is a requirement to verify they were issued by the Event Transmitter at a later date when de-coupled from the original delivery where authenticity could be checked via the HTTP or TLS mutual authentication.
Upon receiving a SET, the SET Recipient reads the SET and validates it. The SET Recipient MUST acknowledge receipt to the SET Transmitter, using the defined acknowledgement or error method depending on the method of transfer.
The SET Recipient SHALL NOT use the Event acknowledgement mechanism to report Event errors other than relating to the parsing and validation of the SET.
This method allows an SET Recipient to use HTTP POST (Section 4.3.3 of [RFC7231]) to acknowledge SETs and to check for and receive zero or more SETs. Requests MAY be made at a periodic interval (short polling) or requests MAY wait, pending availability of new SETs using long polling (see Section 2 of [RFC6202]).
The delivery of SETs in this method is facilitated by HTTP POST requests initiated by the SET Recipient in which:
The purpose of the "acknowledgement" is to inform the SET Transmitter that has successfully been delivered and attempts to re-deliver are no longer required. Before acknowledgement, Event Recipients SHOULD ensure received SETs have been validated and retained in a manner appropriate to the recipient's retention requirements. The level and method of retention of SETs by SET Recipients is out of scope of this specification.
When initiating a poll request, the SET Recipient constructs a JSON document that consists of polling request parameters and SET acknowledgement parameters in the form of JSON attributes.
The request payloads are delivered in one of two forms as described in Section 2.4 and Section 2.5
When making a request, the HTTP header Content-Type is set to application/json.
The following JSON Attributes are used in a polling request:
In response to a poll request, the SET Transmitter checks for available SETs and responds with a JSON document containing the following JSON attributes:
When making a response, the HTTP header Content-Type is set to application/json.
The SET Recipient performs an HTTP POST (see Section 4.3.4 of [RFC7231]) to a pre-arranged polling endpoint URI to check for SETs that are available. Because the SET Recipient has no prior SETs to acknowledge, the ack and errs request parameters are omitted.
If after a period of time, negotiated between the Event Transmitter and Recipient, an SET Transmitter MAY reissue SETs it has previously delivered. The SET Recipient SHOULD accept repeat SETs and acknowledge the SETs regardless of whether the Recipient believes it has already acknowledged the SETs previously. An SET Transmitter MAY limit the number of times it attempts to deliver a SET.
If the SET Recipient has received SETs from the SET Transmitter, the SET Recipient SHOULD parse and validate received SETs to meet its own requirements and SHOULD acknowledge receipt in a timely (e.g., minutes) fashion so that the Event Transmitter may mark the SETs as received. SET Recipients SHOULD acknowledge receipt before taking any local actions based on the SETs to avoid unnecessary delay in acknowledgement, where possible.
Poll requests have three variations:
In the case where no SETs were received in a previous poll (see Figure 7), the SET Recipient simply polls without acknowledgement parameters (sets and setErrs).
The following is an example request made by an SET Recipient that has no outstanding SETs to acknowledge and is polling for available SETs.
The following is a non-normative example poll request to the endpoint: https://nofity.exampleidp.com/Events.
POST /Events HTTP/1.1
Host: notify.exampleidp.com
Authorization: Bearer h480djs93hd8
Accept: application/json
{
"returnImmediately":true
}
Figure 1: Example Initial Poll Request
An SET Recipient MAY poll with no parameters at all by passing an empty JSON object.
The following is a non-normative example default poll request to the endpoint: https://nofity.exampleidp.com/Events.
POST /Events HTTP/1.1
Host: notify.exampleidp.com
Authorization: Bearer h480djs93hd8
Accept: application/json
{}
Figure 2: Example Default Poll Request
In this variation, the SET Recipient acknowledges previously received SETs and indicates it does not want to receive SETs in response by setting the maxEvents attribute to 0.
This variation is typically used when an SET Recipient needs to acknowledge received SETs independently (e.g., on separate threads) from the process of receiving SETs.
The following is a non-normative example poll with acknowledgement of SETs received (for example as shown in Figure 6).
POST /Events HTTP/1.1
Host: notify.exampleidp.com
Authorization: Bearer h480djs93hd8
Content-Type: application/json
Authorization: Bearer h480djs93hd8
{
"ack":[
"4d3559ec67504aaba65d40b0363faad8",
"3d0c3cf797584bd193bd0fb1bd4e7d30"
],
"maxEvents":0
}
Figure 3: Example Acknowledge Only equest
This variation allows a recipient thread to simultaneously acknowledge previously received SETs and wait for the next group of SETs in a single request.
The following is a non-normative example poll with acknowledgement of SETs received in Figure 6.
POST /Events HTTP/1.1
Host: notify.exampleidp.com
Authorization: Bearer h480djs93hd8
Content-Type: application/json
Authorization: Bearer h480djs93hd8
{
"ack":[
"4d3559ec67504aaba65d40b0363faad8",
"3d0c3cf797584bd193bd0fb1bd4e7d30"
],
"returnImmediately":false
}
Figure 4: Example Poll With Acknowledgement and No Errors
In the above acknowledgement, the SET Recipient has acknowledged receipt of two SETs and has indicated it wants to wait until the next SET is available.
In the case where errors were detected in previously delivered SETs, the SET Recipient MAY use the setErrs attribute to indicate errors in the following poll request.
The following is a non-normative example of a response acknowledging 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/json
Authorization: Bearer h480djs93hd8
{
"ack":["3d0c3cf797584bd193bd0fb1bd4e7d30"],
"setErrs":{
"4d3559ec67504aaba65d40b0363faad8":{
"err":"jwtAud",
"description":"The audience value was incorrect."
}
},
"returnImmediately":true
}
Figure 5: Example Poll Acknowledgement With Error
In response to a poll request, the service provider MAY respond immediately if SETs are available to be delivered. If no SETs are available at the time of the request, the SET Transmitter SHALL delay responding until a SET is available unless the poll request parameter returnImmediately is true.
As described in Section 2.3 a JSON document is returned containing a number of attributes including sets which SHALL contain zero or more SETs.
The following is a non-normative example response to the request shown Section 2.4. This example shows two SETs are returned.
HTTP/1.1 200 OK
Content-Type: application/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 Poll Response
In the above example, a two SETs whose jti are 4d3559ec67504aaba65d40b0363faad8 and 3d0c3cf797584bd193bd0fb1bd4e7d30 are delivered.
The following is a non-normative example response to the request shown Section 2.4 showing no new SETs or unacknowledged SETs are available.
HTTP/1.1 200 OK
Content-Type: application/json
Location: https://notify.exampleidp/Events
{
"sets":{ }
}
Figure 7: Example No SETs Poll Response
Upon receiving the JSON document (e.g., as shown in Figure 6), the SET Recipient parses and verifies the received SETs and notifies the SET Transmitter via the next poll request to the SET Transmitter as described in Section 2.4.3 or Section 2.4.4.
If a SET is invalid, error codes from the IANA "Security Event Token Delivery Error Codes" registry established by [I-D.ietf-secevent-http-push] are used in error responses. An error response SHALL include a JSON object which provides details about the error. The JSON object includes the JSON attributes:
When included as part of a batch of SETs, the above JSON is included as part of the setErrs attribute, as defined in Section 2.3 and Section 2.4.4.
The SET delivery method described in this specification is based upon HTTP and depends 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:
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, SET Recipients 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.
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 Assertions draft [RFC7521], documents common scenarios for authorization including:[RFC7521]). When using other token formats or frameworks, implementers MUST take into account similar threats and countermeasures, especially those documented by the relevant specifications.
When using OAuth access 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
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). This enables the SET Recipient to validate that the SET issuer is authorized to deliver the SET.
SET delivery depends on the use of Hypertext Transfer Protocol and thus subject to the security considerations of HTTP Section 9 of [RFC7230] and its related specifications.
As stated in Section 2.7.1 of [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.
SETs may contain sensitive information that is considered PII (e.g., subject claims). In such cases, SET Transmitters and SET Recipients MUST require the use of a transport-layer security mechanism. Event delivery endpoints MUST support TLS 1.2 [RFC5246] and MAY support additional transport-layer mechanisms meeting its security requirements. When using TLS, the client MUST perform a TLS/SSL server certificate check, per [RFC6125]. Implementation security considerations for TLS can be found in "Recommendations for Secure Use of TLS and DTLS" [RFC7525].
When using access tokens such as those issued by OAuth 2.0 [RFC6749], implementers MUST take into account threats and countermeasures documented in Section 8 of [RFC7521].
Due to the possibility of interception, Bearer tokens MUST be exchanged using TLS.
Bearer tokens MUST have a limited lifetime that can be determined directly or indirectly (e.g., by checking with a validation service) by the service provider. By expiring tokens, clients are forced to obtain a new token (which usually involves re-authentication) for continued authorized access. For example, in OAuth2, a client MAY use OAuth token refresh to obtain a new bearer token after authenticating to an authorization server. See Section 6 of [RFC6749].
Implementations supporting OAuth bearer tokens need to factor in security considerations of this authorization method [RFC7521]. Since security is only as good as the weakest link, implementers also need to consider authentication choices coupled with OAuth bearer tokens. The security considerations of the default authentication method for OAuth bearer tokens, HTTP BASIC, are well documented in [RFC7617], therefore implementers are encouraged to prefer stronger authentication methods. Designating the specific methods of authentication and authorization are out of scope for the delivery of SETs, however this information is provided as a resource to implementers.
If a SET needs to be retained for audit purposes, a JWS signature MAY be used to provide verification of its authenticity.
SET Transmitters SHOULD attempt to specialize Event Streams so that the content is targeted to the specific business and protocol needs of subscribers.
When sharing personally identifiable information or information that is otherwise considered confidential to affected users, Event Transmitters and Recipients MUST have the appropriate legal agreements and user consent or terms of service in place.
The propagation of subject identifiers can be perceived as personally identifiable information. Where possible, SET Transmitters and Recipients SHOULD devise approaches that prevent propagation -- for example, the passing of a hash value that requires the subscriber to already know the subject.
There are no IANA considerations.
The editors would like to thank the members of the SCIM working group, which began discussions of provisioning events starting with: draft-hunt-scim-notify-00 in 2015.
The editors would like to thank Phil Hunt and the other the authors of draft-ietf-secevent-delivery-02, on which this draft is based.
The editors would like to thank the participants in the the SECEVENTS working group for their contributions to this specification.
[[ to be removed by the RFC Editor before publication as an RFC ]]
Draft 00 - AB - Based on draft-ietf-secevent-delivery-02 with the following additions:
Draft 01 - mbj: