<?xml version="1.0" encoding="UTF-8"?>
  <?xml-stylesheet type="text/xsl" href="rfc2629.xslt" ?>
  <!-- generated by https://github.com/cabo/kramdown-rfc2629 version 1.2.12 -->

<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
]>

<?rfc toc="yes"?>
<?rfc sortrefs="yes"?>
<?rfc symrefs="yes"?>

<rfc ipr="trust200902" docName="draft-wendt-stir-identity-header-errors-handling-02" category="std" updates="RFC3326">

  <front>
    <title abbrev="Identity Errors">Identity Header Error Handling</title>

    <author initials="C." surname="Wendt" fullname="Chris Wendt">
      <organization>Comcast</organization>
      <address>
        <postal>
          <street>Comcast Technology Center</street>
          <city>Philadelphia, PA  19103</city>
          <country>USA</country>
        </postal>
        <email>chris-ietf@chriswendt.net</email>
      </address>
    </author>

    <date year="2021" month="July" day="12"/>

    <area>art</area>
    
    <keyword>Identity</keyword>

    <abstract>


<t>This document extends STIR and the Authenticated Identity Management in the Session Initiation Protocol (SIP) related to error handling for STIR verification services and how they feedback errors to STIR authentication services. Specifically, the use of a Reason header field and addressing scenarios that use multiple identity headers where some may have errors and others may not and the handling of those situations is defined.</t>



    </abstract>


  </front>

  <middle>


<section anchor="introduction" title="Introduction">

<t><xref target="RFC8224"/> in Section 6.2.2 discusses future specifications for enhancement of how errors are communicated and the handling of multiple Identity header fields. This specification provides some additional mechanisms for solutions to address these problems.</t>

<t>In some deployments of STIR and specifically using SIP <xref target="RFC3261"/> as defined by <xref target="RFC8224"/>, one issue with the current error handling, specifically with the use of the defined 4xx error responses, is that when an error occurs with the verification of the Identity header filed or the PASSporT contained in the Identity header field and a 4xx response is returned, the call is then terminated. It may be the case that the policy for handling errors dictates that calls should continue even if there is a verification error, in the case of, for example inadvertent errors, however the authentication service should still be notified of the error so that corrective action can be taken. This specification will discuss the use of the Reason header field in subsequent provisional (1xx) responses in order to accomplish this.</t>

<t>For the handling of multiple Identity header fields and the potential situation that some of the Identity header fields in a call may pass verification but others may have errors, this document provides a mechanism to add an identifier so that the authentication service can identify which Identity header field is being referred to in the case of an error.</t>

</section>
<section anchor="terminology" title="Terminology">

<t>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 <xref target="RFC2119"/> <xref target="RFC8174"/> when, and only when, they appear in all capitals, as shown here.</t>

</section>
<section anchor="use-of-provisional-error-responses-to-signal-errors-without-terminating-the-call" title="Use of provisional error responses to signal errors without terminating the call">

<t>In cases where local policy dictates that a call should continue irregardless when any verification errors, including 4XX errors described in <xref target="RFC8224"/> Section 6.2.2, then the verification service SHOULD not send the 4XX as a response, but rather include the error response code and reason phrase in a Reason header field, defined in <xref target="RFC3326"/>, in the next provisional or final responses sent to the authentication service.</t>

<t>Example Reason header field:</t>

<figure><artwork><![CDATA[
Reason: SIP ;cause=436 ;text="Bad Identity Info"
]]></artwork></figure>

</section>
<section anchor="handling-of-a-verification-error-when-there-is-multiple-identity-header-fields" title="Handling of a verification error when there is multiple Identity header fields">

<t>In cases where a SIP message includes multiple Identity header fields and one of those Identity header fields has an error, the verification service SHOULD include the error response code and reason phrase associated with the error in a Reason header field, defined in <xref target="RFC3326"/>, in the next provisional or final responses sent to the authentication service. The reason cause in the Reason header field SHOULD represent the error that occurred when verifying the contents of the Identity header field.  The association of a Reason header field and error to a specific Identity header field is accomplished by adding a “ppt” parameter containing the PASSporT that generated the error to the Reason header field. The “ppt” parameter for the Reason header field is optional, but RECOMMENDED, in particular for cases that a SIP INVITE contains multiple Identity header fields. The PASSporT can be included in full form, or optionally in compact form, where only the signature of the PASSporT is used to identify the reported Identity header field with an error.</t>

<t>Example Reason header field with full form PASSporT:</t>

<figure><artwork><![CDATA[
Reason: SIP ;cause=436 ;text="Bad Identity Info" ;ppt= \
"eyJhbGciOiJFUzI1NiIsInR5cCI6InBhc3Nwb3J0IiwieDV1I \
joiaHR0cHM6Ly9jZXJ0LmV4YW1wbGUub3JnL3Bhc3Nwb3J0LmNlciJ9.eyJ \
kZXN0Ijp7InVyaSI6WyJzaXA6YWxpY2VAZXhhbXBsZS5jb20iXX0sImlhdC \
I6IjE0NDMyMDgzNDUiLCJvcmlnIjp7InRuIjoiMTIxNTU1NTEyMTIifX0.r \
q3pjT1hoRwakEGjHCnWSwUnshd0-zJ6F1VOgFWSjHBr8Qjpjlk-cpFYpFYs \
ojNCpTzO3QfPOlckGaS6hEck7w"
]]></artwork></figure>

<t>Example Reason header field with compact form PASSporT:
~~~~~~~~~~~
Reason: SIP ;cause=436 ;text=”Bad Identity Info” ;ppt= \
“..rq3pjT1akEGjHCnWSwUnshd0-zJ6F1VOgFWSjHBr8Qjpjlk-cpFYpFYs \
ojNCpTzO3QfPOlckGaS6hEck7w”
~~~~~~~~~~~</t>

</section>
<section anchor="handling-multiple-verification-errors" title="Handling multiple verification errors">

<t>This specification updates <xref target="RFC3326"/> in that for STIR applications the use of multiple Reason header fields with the same “SIP” protocol string is allowed.  So, if there is multiple Identity header field verification errors being reported the verification service SHOULD include corresponding Reason header fields with “ppt” parameters including full or compact form of the PASSporT with cause and text parameters identifying each error.</t>

<t>Example Reason header fields for two identity info errors:</t>

<figure><artwork><![CDATA[
Reason: SIP ;cause=436 ;text="Bad Identity Info" ;ppt= \
"eyJhbGciOiJFUzI1NiIsInR5cCI6InBhc3Nwb3J0IiwieDV1I \
joiaHR0cHM6Ly9jZXJ0LmV4YW1wbGUub3JnL3Bhc3Nwb3J0LmNlciJ9.eyJ \
kZXN0Ijp7InVyaSI6WyJzaXA6YWxpY2VAZXhhbXBsZS5jb20iXX0sImlhdC \
I6IjE0NDMyMDgzNDUiLCJvcmlnIjp7InRuIjoiMTIxNTU1NTEyMTIifX0.r \
q3pjT1hoRwakEGjHCnWSwUnshd0-zJ6F1VOgFWSjHBr8Qjpjlk-cpFYpFYs \
ojNCpTzO3QfPOlckGaS6hEck7w"

Reason: SIP ;cause=436 ; text="Bad Identity Info" ;ppt= \
"eyJhbGciOiJFUzI1NiIsInR5cCI6InBhc3Nwb3J0IiwieDV1I \
joiaHR0cHM6Ly9jZXJ0LmV4YW1wbGUub3JnL3Bhc3Nwb3J0LmNlciJ9.eyJ \
xpY2VAZXhhbXBsZS5jb20iXX0sImlhdCkZXN0Ijp7InVyaSI6WyJzaXA6YW \
p7InRuIjoiMTIxNTU1NTEyMTIifX0I6IjE0NDMyMDgzNDUiLCJvcmlnIj.r \
J6F1VOgFWSjHBr8Qjpjlk-cpFYpFYsq3pjT1hoRwakEGjHCnWSwUnshd0-z \
ckGaS6hEck7wojNCpTzO3QfPOl"

]]></artwork></figure>

</section>
<section anchor="removal-of-the-reason-header-field-by-authentication-service" title="Removal of the Reason header field by Authentication Service">

<t>When an Authentication Service <xref target="RFC8224"/> receives the Reason header field with a PASSporT it generated as part of an Identity header field and the authentication of a call, it should first follow local policy to recognize and acknowledge the error (e.g. perform operational actions like logging or alarming), but then MUST remove the identified Reason header field to avoid the PASSporT information going upstream to UAC or UAS that may not be authorized to see claim information contained in the PASSporT for privacy or other reasons.</t>

</section>
<section anchor="acknowledgements" title="Acknowledgements">

<t>Would like to thank David Hancock for help to identify these error scenarios and Jon Peterson, Roman Shpount, and STIR working group for helpful feedback and discussion.</t>

</section>
<section anchor="Security" title="Security Considerations">

<t>TBD</t>

</section>


  </middle>

  <back>

    <references title='Normative References'>





<reference  anchor="RFC3261" target='https://www.rfc-editor.org/info/rfc3261'>
<front>
<title>SIP: Session Initiation Protocol</title>
<author initials='J.' surname='Rosenberg' fullname='J. Rosenberg'><organization /></author>
<author initials='H.' surname='Schulzrinne' fullname='H. Schulzrinne'><organization /></author>
<author initials='G.' surname='Camarillo' fullname='G. Camarillo'><organization /></author>
<author initials='A.' surname='Johnston' fullname='A. Johnston'><organization /></author>
<author initials='J.' surname='Peterson' fullname='J. Peterson'><organization /></author>
<author initials='R.' surname='Sparks' fullname='R. Sparks'><organization /></author>
<author initials='M.' surname='Handley' fullname='M. Handley'><organization /></author>
<author initials='E.' surname='Schooler' fullname='E. Schooler'><organization /></author>
<date year='2002' month='June' />
<abstract><t>This document describes Session Initiation Protocol (SIP), an application-layer control (signaling) protocol for creating, modifying, and terminating sessions with one or more participants.  These sessions include Internet telephone calls, multimedia distribution, and multimedia conferences.  [STANDARDS-TRACK]</t></abstract>
</front>
<seriesInfo name='RFC' value='3261'/>
<seriesInfo name='DOI' value='10.17487/RFC3261'/>
</reference>



<reference  anchor="RFC3326" target='https://www.rfc-editor.org/info/rfc3326'>
<front>
<title>The Reason Header Field for the Session Initiation Protocol (SIP)</title>
<author initials='H.' surname='Schulzrinne' fullname='H. Schulzrinne'><organization /></author>
<author initials='D.' surname='Oran' fullname='D. Oran'><organization /></author>
<author initials='G.' surname='Camarillo' fullname='G. Camarillo'><organization /></author>
<date year='2002' month='December' />
<abstract><t>The REGISTER function is used in a Session Initiation Protocol (SIP) system primarily to associate a temporary contact address with an address-of-record.  This contact is generally in the form of a Uniform Resource Identifier (URI), such as Contact: &lt;sip:alice@pc33.atlanta.com&gt; and is generally dynamic and associated with the IP address or hostname of the SIP User Agent (UA).  The problem is that network topology may have one or more SIP proxies between the UA and the registrar, such that any request traveling from the user's home network to the registered UA must traverse these proxies.  The REGISTER method does not give us a mechanism to discover and record this sequence of proxies in the registrar for future use.  This document defines an extension header field, &quot;Path&quot; which provides such a mechanism.  [STANDARDS-TRACK]</t></abstract>
</front>
<seriesInfo name='RFC' value='3326'/>
<seriesInfo name='DOI' value='10.17487/RFC3326'/>
</reference>



<reference  anchor="RFC8174" target='https://www.rfc-editor.org/info/rfc8174'>
<front>
<title>Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words</title>
<author initials='B.' surname='Leiba' fullname='B. Leiba'><organization /></author>
<date year='2017' month='May' />
<abstract><t>RFC 2119 specifies common key words that may be used in protocol  specifications.  This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the  defined special meanings.</t></abstract>
</front>
<seriesInfo name='BCP' value='14'/>
<seriesInfo name='RFC' value='8174'/>
<seriesInfo name='DOI' value='10.17487/RFC8174'/>
</reference>



<reference  anchor="RFC8224" target='https://www.rfc-editor.org/info/rfc8224'>
<front>
<title>Authenticated Identity Management in the Session Initiation Protocol (SIP)</title>
<author initials='J.' surname='Peterson' fullname='J. Peterson'><organization /></author>
<author initials='C.' surname='Jennings' fullname='C. Jennings'><organization /></author>
<author initials='E.' surname='Rescorla' fullname='E. Rescorla'><organization /></author>
<author initials='C.' surname='Wendt' fullname='C. Wendt'><organization /></author>
<date year='2018' month='February' />
<abstract><t>The baseline security mechanisms in the Session Initiation Protocol (SIP) are inadequate for cryptographically assuring the identity of the end users that originate SIP requests, especially in an interdomain context.  This document defines a mechanism for securely identifying originators of SIP requests.  It does so by defining a SIP header field for conveying a signature used for validating the identity and for conveying a reference to the credentials of the signer.</t><t>This document obsoletes RFC 4474.</t></abstract>
</front>
<seriesInfo name='RFC' value='8224'/>
<seriesInfo name='DOI' value='10.17487/RFC8224'/>
</reference>




    </references>

    <references title='Informative References'>





<reference  anchor="RFC2119" target='https://www.rfc-editor.org/info/rfc2119'>
<front>
<title>Key words for use in RFCs to Indicate Requirement Levels</title>
<author initials='S.' surname='Bradner' fullname='S. Bradner'><organization /></author>
<date year='1997' month='March' />
<abstract><t>In many standards track documents several words are used to signify the requirements in the specification.  These words are often capitalized. This document defines these words as they should be interpreted in IETF documents.  This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t></abstract>
</front>
<seriesInfo name='BCP' value='14'/>
<seriesInfo name='RFC' value='2119'/>
<seriesInfo name='DOI' value='10.17487/RFC2119'/>
</reference>




    </references>



  </back>

<!-- ##markdown-source:
H4sIABaz7GAAA+1ZW2/bOBZ+168g3JcWsA3byaRTFwXWcZJGQeKkviRpdxcL
WqIt2pKoISU7TtH97XsOSV3s2skMdhc7D1sUCC2RPLfvfOeQajQaTsrTkHWJ
67MYhhtyyajPJDmXUkhySWM/5PHcodOpZKvKNP1eOb7wYhrBel/SWdpYs9hP
GyrlssHtzEagN2wwvaAR2B0brY7j0xRWdlqddqP1vtHuOB48mAu56RKV+o7D
E9klqcxU2mm1PsACKhntEipTZ8k2ayH9LhmN3WHll3tX/sh1dRyVgtR/0FDE
IG/DlJPwLvlrKrw6UUKmks0UjDYRDv7uOFmCmqkuGV70j446J45DszQQsusQ
wmN43m+SB7QUfhvr+4Hkqngm5BweicijCn+yiPKwSzyc0+Asnf1FD7WvmjHD
KQp0YGmxiIyZF8QiFPMN6YMRTMIcD0zpkruAh+DPMAk4rZO7HiHtD+3WEb4X
WZyi7yajnuPEQkY05SuGSqMdnZN2PoSxHf7afn+cDzsdGPJ4trOw025/6DpO
o9EgdAp6Ui91nHEA5kLsswi0I+wpBVuUjgUBT5M0YKQHLkP/Y0z9Ejc3NKZz
ppfxWE8cMaW4iIkb85SDZBjeSQHBESF5CwF9RyQL9SapIBpFJAcRAWWN1BWT
fIaycLlicsU9prQugVijmA2ZMeZPqbc0eyjczShcKlpd3CSjhHl60zDc1LWq
mWJEzAglQ0YVzDXQJjPOQl8Lo74v0RxQTXksppILEBTQVC+NsjDlSchInht2
A0XWAZMMsBjBJAqP6YrlauK2AoTDEF/FIi1cXLgBdAJ8ggTF00yboQgGiM14
zPymiV7EfT9kjvMGPJ1K4WceTnSc799t9H/8wJCMmH5OTpqdZof4XHmZUuDL
WZZmqGPuFCMFA8BiUMQzMQVN0OG57rDAE1GUxRYG+zQvvOJue8W4FeKgwbYl
lyRSrMCJyrgMvM7xMQ1JBIlDY64io5oSYWYUhWjb4KAC4CrYYhqySIF33Njs
47MkFBu0Q6FiBZxVBQgQSNQbcEm04zCvwHG08DaZbkjFpXUCpAPBUBkja54G
2nwvk1Inzhaa69uCitkWdTjMZRw/PdnFYFEC9jEgMG6hBmCKQW87QXggTZW7
bWWK3fZnz4cgBBbjy7veaJQIOYZIxinV4m3m7g2YyQOtYa4baiYZwAfWmkRC
C42+oCrQW8RjxEeTuKlG+ZTZaYoZm/BXIkLubXRcC/xYoPncS5GyzWTcHaAR
iAzUQa15DN5nK5DFtcFSq0S3faG3que2adFiVjcIf6KRztuY+rAmLWIHXge4
w87GVfupJNcEyiJYDaZBDoNY9LBxvwmUElZ7AeDwkIEJNanoQTDRI3TJ4r3p
sMaNbaruQmYfVYGNKpsq9luGluhkUiZ/3rafnt6VoMKZUEvRPMgfD3I5CblC
IHFMnAsLkT+QzgUFJALdyEFmQVrGfp2KB4Gp9wCtqMEQgiWhYPVWKKdZWuXM
Cp3Wtepl6SqIhJbUYbkCU8gQNUgtw/NCnL1yBaRvwL3gQIqABlOG/oKGA/Qy
pW0beEUCN5GxxzpFTEPw/U1a/vqBtZgR6HkINj2K1G4mo3Gtbv6Swa0eD8+/
TNzh+RmOR5e96+tikM8YXd5Ors/KUbmyf3tzcz44M4vhKdl5dNP7Cn8wqrXb
u7F7O+hd14wtVT9jJQAbp5hDoH4CdIDlAFlTeZJPDamc9u9I+9jQJ/YdQKyG
SqFNgTESmxElYiRI/VPXdpokjEqNCwCFRxOe0hCCTTUNrBH+kmlPTox3q5jf
IVLUU/F58cZwpwBI5USFkctZTFcPjFlexEMBj3Ou2uYli9ldYuKAgDmVUJyV
ysl7s4ebkOJjL8x8lH/8+FiQX9WF1Wq+Vcrrlmx3S0AOXht37C8UszmKQijm
Ru6cuk4tSTG3rDKsQmEF4XsCnmOgpGGfJJAIa523ewipXhS23ALsUbF42qSI
ocXcipnAlTgow6YQZ6l4IUEBAOeWyfcoAU3uP8t/jpmhjxTko0eBUT8dH52Q
jymo8ql2Sis9rQtNc21rMQDtssKJ+yqNiXRRjF6hzZ9gRrViEUAG2uk8FK9u
Y5OHlR3jgXkBhr2oia+B5o8jAShbeFz3hEVnYlb+rzFCkE+tsjrs+f77Cqm1
XzIgNLN3YYfOeN18Ib/rYGsXbgr2gPzPW82Dta5JtD65u2zPdvgAYmVDASta
hMM1qCzopm3FPhqUo6SWJGkN6qqEwy2QXt755ZoXHaG2cc5iJs35rDReHHKZ
8e+ugJltJPY2K+ChxLT3hn4qBUgHH7aBKGYhNfuYLLGEi0niDu7d8XluxKs5
YjQsu17TfFmIa/TNMmBxPCfXEWO5clCR4B16FNo2+9rkqq5WaJ4uK/oYZWNe
SAEjAWqmD8g7iFQDEV5vHaC3fKNzp9IpvEBvZm6heiH636Q98hFC+Yn8zamx
zVUw/ezxW351MXl22wPuKjce/uL13RM3Pg28o8F6enTVcvmas7P7tguLFoLT
y2HLu7w5ud58WHx7vGpdR/fHXx/a6+nnSQbT4+ujcul1NAg9fvWhCbJg9fLb
46DlLpL3bny/oSP35GFz9UwfeydfH56Sr5373rfHIJg+nqpvo18W006LPz62
lBuFgd+H1aDV4rw1OLvZ3JzNnwdnE37dv1p5URibLYeZC+rdjN2nwXjSHozP
NzDms8dWU8Lq346SxbgdiOGaLs8/Ly778cNoPYlV4Lcaz1cnF+372/nFw2hx
eSp//bJIFuGy4SUXX+G/gtViMegn4+fboy+zu9vQW36mo5Pg3Fu+X+/UkVcD
WsVbJab/mZA2m9LY+V+1sVIri9Tc0/3YW6ftk4+9qqsWBMPXNC0vh6A7DIsb
i8rxqJC2x7uVE7MCkoK+2L2rYXkxF1MqlagvkmgYwgkQiXok6lvny5d5Zp+J
xanAJv3vrbv6yIg1TvP3YWt2aFdV+klNDMieVTztspRBnC6K+hinK25lN8tc
+mBO4fTzO2jJ3NOka1FeiuEdpHXI/8npT0ZOB0NA/owxeM3RL8QIVr/o55cC
pGPwsptfjBCsrnp9Ox41Z5c9hywSK+x3D1/4QHPX2253R4ZJHOfB3hbuf791
npTMY3zF1EExph2pdDXV7hBOFNip2buNw3eHe3pz3fLi2bmOW9rz84xLhTyF
/Lt96oYmClQV85g/G6Ki3jIW65D58+oZ5S1rzpskYdJwXYJ6mpODuXdTJORL
PNDP5/ocJ4HrKd4AzN+ZRlQfqPU9i8QQmL2LKyN/r4uwNV8J7u+0f/lnF5g+
FygtS/CbENWXUZNeH6VPeiNT2PLvAFPjKCHBTr2zYlALQsqjrQ1/urctxCL1
JpKvKDgNO1l9rDdnH6VvS3ql4/S1OMBF+147Rjf5NF6SM7oCg6CIe8JbmvtZ
Fia7vawqLjqLLyMYmyv83qPrh4jrZCgiAMcoSPBjlrnr0SV8LeQS3TKXIksK
EVC0ys86ONfegYLVWv0Rg+MXgqwPBoEu0vYA39/kb/D+7PTMfCDBXZx/ARTb
ScoTHQAA

-->

</rfc>

