idnits 2.17.1 draft-wendt-stir-identity-header-errors-handling-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (November 16, 2020) is 1256 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Unused Reference: 'RFC6919' is defined on line 178, but no explicit reference was found in the text == Unused Reference: 'RFC7340' is defined on line 183, but no explicit reference was found in the text == Unused Reference: 'RFC7519' is defined on line 188, but no explicit reference was found in the text == Unused Reference: 'RFC8225' is defined on line 202, but no explicit reference was found in the text ** Downref: Normative reference to an Experimental RFC: RFC 6919 ** Downref: Normative reference to an Informational RFC: RFC 7340 Summary: 3 errors (**), 0 flaws (~~), 5 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group C. Wendt 3 Internet-Draft Comcast 4 Intended status: Standards Track November 16, 2020 5 Expires: May 20, 2021 7 Identity Header Error Handling 8 draft-wendt-stir-identity-header-errors-handling-00 10 Abstract 12 This document extends STIR and the Authenticated Identity Management 13 in the Session Initiation Protocol (SIP) related to error handling 14 for STIR verification services and how they feedback errors to STIR 15 authentication services. 17 Status of This Memo 19 This Internet-Draft is submitted in full conformance with the 20 provisions of BCP 78 and BCP 79. 22 Internet-Drafts are working documents of the Internet Engineering 23 Task Force (IETF). Note that other groups may also distribute 24 working documents as Internet-Drafts. The list of current Internet- 25 Drafts is at https://datatracker.ietf.org/drafts/current/. 27 Internet-Drafts are draft documents valid for a maximum of six months 28 and may be updated, replaced, or obsoleted by other documents at any 29 time. It is inappropriate to use Internet-Drafts as reference 30 material or to cite them other than as "work in progress." 32 This Internet-Draft will expire on May 20, 2021. 34 Copyright Notice 36 Copyright (c) 2020 IETF Trust and the persons identified as the 37 document authors. All rights reserved. 39 This document is subject to BCP 78 and the IETF Trust's Legal 40 Provisions Relating to IETF Documents 41 (https://trustee.ietf.org/license-info) in effect on the date of 42 publication of this document. Please review these documents 43 carefully, as they describe your rights and restrictions with respect 44 to this document. Code Components extracted from this document must 45 include Simplified BSD License text as described in Section 4.e of 46 the Trust Legal Provisions and are provided without warranty as 47 described in the Simplified BSD License. 49 Table of Contents 51 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 52 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 2 53 3. Use of provisional error responses to signal errors without 54 terminating the call . . . . . . . . . . . . . . . . . . . . 3 55 4. Handling of errors when there is multiple identity headers . 3 56 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 4 57 6. Security Considerations . . . . . . . . . . . . . . . . . . . 4 58 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 4 59 7.1. Normative References . . . . . . . . . . . . . . . . . . 4 60 7.2. Informative References . . . . . . . . . . . . . . . . . 5 61 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 5 63 1. Introduction 65 [RFC8224] in Section 6.2.2 discusses future specifications for 66 enhancement of how errors are communicated and the handling of 67 multiple identity headers. This specification provides some 68 additional mechanisms for solutions to address these problems. 70 In some deployments of STIR and specifically using SIP [RFC3261] as 71 defined by [RFC8224], one issue with the current error handling, 72 specifically with the use of the defined 4xx error responses, is that 73 when an error occurs with the verification of the identity header or 74 the PASSporT contained in the identity header and a 4xx response is 75 returned, the call is then terminated. It may be the case that the 76 policy for handling errors might be that calls should continue even 77 if there is a verification error, in the case of, for example 78 inadvertent errors, however the authentication service should still 79 be notified of the error so that corrective action can be taken. 80 This specification will discuss the use of reason header in 81 subsequent provisional (1xx) responses in order to accomplish this. 83 For the handling of multiple identity headers and the potential 84 situation that some of the identity headers in a call may pass 85 verification but others may have errors, this document provides a 86 mechanism to add an identifier so that the authentication service can 87 identify which identity header is being referred to in the case of an 88 error. 90 2. Terminology 92 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 93 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 94 "OPTIONAL" in this document are to be interpreted as described in BCP 95 14 [RFC2119] [RFC8174] when, and only when, they appear in all 96 capitals, as shown here. 98 3. Use of provisional error responses to signal errors without 99 terminating the call 101 In cases where local policy dictates that a call should not terminate 102 when any verification errors, including errors described in [RFC8224] 103 Section 6.2.2, then the verification service SHOULD include the error 104 response code and reason phrase in a Reason header field, defined in 105 [RFC3326], in the next provisional or final response sent to the 106 authentication service. 108 Example Reason header field: 110 Reason: SIP ;cause=436 ;text="Bad Identity Info" 112 4. Handling of errors when there is multiple identity headers 114 In cases where a SIP message includes multiple identity headers and 115 one or more of those identity headers has errors the verification 116 service SHOULD include the error response code and reason phrase in a 117 Reason header field, defined in [RFC3326], in the next provisional or 118 final response sent to the authentication service. The reason cause 119 SHOULD represent at least one of the errors that occurred with one of 120 the identity headers, but in order to identify each of the associated 121 identity headers that had errors the body of the response should 122 include a multipart MIME with each section including the PASSporT of 123 the corresponding identity header. 125 Example Reason header field with multipart MIME body: 127 Reason: SIP ;cause=436 ;text="Bad Identity Info" 129 Content-Type: multipart/mixed; boundary=boundary1 130 Content-Length: ... 132 --boundary1 134 Content-Type: application/passport 136 eyJhbGciOiJFUzI1NiIsInR5cCI6InBhc3Nwb3J0IiwieDV1I \ 137 joiaHR0cHM6Ly9jZXJ0LmV4YW1wbGUub3JnL3Bhc3Nwb3J0LmNlciJ9.eyJ \ 138 kZXN0Ijp7InVyaSI6WyJzaXA6YWxpY2VAZXhhbXBsZS5jb20iXX0sImlhdC \ 139 I6IjE0NDMyMDgzNDUiLCJvcmlnIjp7InRuIjoiMTIxNTU1NTEyMTIifX0.r \ 140 q3pjT1hoRwakEGjHCnWSwUnshd0-zJ6F1VOgFWSjHBr8Qjpjlk-cpFYpFYs \ 141 ojNCpTzO3QfPOlckGaS6hEck7w 143 --boundary1 145 Content-Type: application/passport 147 eyJhbGciOiJFUzI1NiIsInR5cCI6InBhc3Nwb3J0IiwieDV1I \ 148 joiaHR0cHM6Ly9jZXJ0LmV4YW1wbGUub3JnL3Bhc3Nwb3J0LmNlciJ9.eyJ \ 149 kZXN0Ijp7InVyaSI6WyJzaXA6YWxpY2VAZXhhbXBsZS5jb20iXX0sImlhdC \ 150 I6IjE0NDMyMDgzNDUiLCJvcmlnIjp7InRuIjoiMTIxNTU1NTEyMTIifX0.r \ 151 q3pjT1hoRwakEGjHCnWSwUnshd0-zJ6F1VOgFWSjHBr8Qjpjlk-cpFYpFYs \ 152 ojNCpTzO3QfPOlckGaS6hEck7w 154 5. Acknowledgements 156 Would like to thank David Hancock for help to identify these error 157 scenarios and Jon Peterson for helpful feedback. 159 6. Security Considerations 161 TBD 163 7. References 165 7.1. Normative References 167 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, 168 A., Peterson, J., Sparks, R., Handley, M., and E. 169 Schooler, "SIP: Session Initiation Protocol", RFC 3261, 170 DOI 10.17487/RFC3261, June 2002, 171 . 173 [RFC3326] Schulzrinne, H., Oran, D., and G. Camarillo, "The Reason 174 Header Field for the Session Initiation Protocol (SIP)", 175 RFC 3326, DOI 10.17487/RFC3326, December 2002, 176 . 178 [RFC6919] Barnes, R., Kent, S., and E. Rescorla, "Further Key Words 179 for Use in RFCs to Indicate Requirement Levels", RFC 6919, 180 DOI 10.17487/RFC6919, April 2013, 181 . 183 [RFC7340] Peterson, J., Schulzrinne, H., and H. Tschofenig, "Secure 184 Telephone Identity Problem Statement and Requirements", 185 RFC 7340, DOI 10.17487/RFC7340, September 2014, 186 . 188 [RFC7519] Jones, M., Bradley, J., and N. Sakimura, "JSON Web Token 189 (JWT)", RFC 7519, DOI 10.17487/RFC7519, May 2015, 190 . 192 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 193 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 194 May 2017, . 196 [RFC8224] Peterson, J., Jennings, C., Rescorla, E., and C. Wendt, 197 "Authenticated Identity Management in the Session 198 Initiation Protocol (SIP)", RFC 8224, 199 DOI 10.17487/RFC8224, February 2018, 200 . 202 [RFC8225] Wendt, C. and J. Peterson, "PASSporT: Personal Assertion 203 Token", RFC 8225, DOI 10.17487/RFC8225, February 2018, 204 . 206 7.2. Informative References 208 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 209 Requirement Levels", BCP 14, RFC 2119, 210 DOI 10.17487/RFC2119, March 1997, 211 . 213 Author's Address 214 Chris Wendt 215 Comcast 216 Comcast Technology Center 217 Philadelphia, PA 19103 218 USA 220 Email: chris-ietf@chriswendt.net