<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE rfc [
  <!ENTITY nbsp    "&#160;">
  <!ENTITY zwsp   "&#8203;">
  <!ENTITY nbhy   "&#8209;">
  <!ENTITY wj     "&#8288;">
]>
<?rfc sortrefs="yes"?>
<?rfc subcompact="no"?>
<?rfc symrefs="yes"?>
<?rfc toc="yes"?>
<?rfc tocdepth="3"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<rfc category="std" docName="draft-ietf-idr-bgp-sendholdtimer-15" updates="4271" ipr="trust200902" submissionType="IETF" consensus="true" sortRefs="true" symRefs="true" tocInclude="true" tocDepth="3" version="3">
  <!-- xml2rfc v2v3 conversion 3.23.0 -->
  <front>
    <title abbrev="BGP SendHoldTimer">Border Gateway Protocol 4 (BGP-4) Send Hold Timer</title>
    <seriesInfo name="Internet-Draft" value="draft-ietf-idr-bgp-sendholdtimer-15"/>
    <author fullname="Job Snijders" initials="J." surname="Snijders">
      <organization>Fastly</organization>
      <address>
        <postal>
          <street/>
          <city>Amsterdam</city>
          <code/>
          <country>Netherlands</country>
        </postal>
        <email>job@fastly.com</email>
      </address>
    </author>
    <author fullname="Ben Cartwright-Cox" initials="B." surname="Cartwright-Cox">
      <organization abbrev="Port 179">Port 179 Ltd</organization>
      <address>
        <postal>
          <street/>
          <city>London</city>
          <code/>
          <country>United Kingdom</country>
        </postal>
        <email>ben@benjojo.co.uk</email>
      </address>
    </author>
    <author fullname="Yingzhen Qu" initials="Y" surname="Qu">
      <organization abbrev="Futurewei">Futurewei Technologies</organization>
      <address>
        <postal>
          <street/>
          <city>Santa Clara</city>
          <code/>
          <country>United States</country>
        </postal>
        <email>yingzhen.ietf@gmail.com</email>
      </address>
    </author>
    <date/>
    <area>Routing</area>
    <workgroup>IDR</workgroup>
    <keyword>BGP</keyword>
    <keyword>TCP</keyword>
    <abstract>
      <t>
      This document defines the SendHoldtimer, along with the SendHoldTimer_Expires event, for the Border Gateway Protocol (BGP) Finite State Machine (FSM).
      Implementation of the SendHoldTimer helps overcome situations where a BGP connection is not terminated after the local system detects that the remote system is not processing BGP messages.
      This document specifies that the local system should close the BGP connection and not solely rely on the remote system for connection closure when the SendHoldTimer expires.
      This document updates RFC4271.
      </t>
    </abstract>
    <note>
      <name>Requirements Language</name>
      <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>
    </note>
  </front>
  <middle>
    <section>
      <name>Introduction</name>
      <t>
      This document defines the <tt>SendHoldtimer</tt>, along with the <tt>SendHoldTimer_Expires</tt> event, for the Border Gateway Protocol (BGP) <xref target="RFC4271"/> Finite State Machine (FSM) defined in section 8.
      </t>
      <t>
      Failure to terminate a blocked BGP connection can result in network reachability issues, and the subsequent failure to generate and deliver BGP UPDATE messages to another BGP speaker of the local system is detrimental to all participants of the inter-domain routing system.
      This phenomena is thought to have contributed to IP traffic blackholing events in the global Internet routing system <xref target="bgpzombies"/>.
      </t>
      <t>
      This specification intends to improve this situation by requiring that BGP connections be terminated if the local system has detected that the remote system cannot possibly have processed any BGP messages for the duration of the <tt>SendHoldTime</tt>.
      Through standardization of the aforementioned requirement, operators will benefit from consistent behavior across different BGP implementations.
      </t>
      <t>
      BGP speakers following this specification do not rely exclusively on remote systems closing blocked connections, but will also locally close blocked connections.
      </t>
    </section>
    <section>
      <name>Example of a problematic scenario</name>
      <t>
      In implementations lacking the concept of a <tt>SendHoldTimer</tt>, a malfunctioning or overwhelmed remote speaker may cause data on the BGP socket in the local system to accumulate ad infinitum.
      This could result in forwarding failure and traffic loss, as the overwhelmed speaker continues to utilize stale routes.
      </t>
      <t>
      An example fault state: as BGP runs over TCP <xref target="RFC9293"/>, it is possible for a BGP speaker in the Established state to encounter a BGP speaker that is advertising a TCP Receive Window (RCV.WND) of size zero.
      This 0 window prevents the local system from sending KEEPALIVE, UPDATE, or any other critical BGP messages across the network socket to the remote speaker.
      </t>
      <t>
      Generally BGP implementations have no visibility into lower-layer subsystems such as TCP or the speaker's current Receive Window size, and there is no existing BGP mechanism for such a blocked connection to be recognized.
      Hence BGP implementations are not able to handle this situation in a consistent fashion.
      </t>
      <t>
      The major issue arising from a BGP speaker being unable to send a BGP message to a given remote speaker is that as a result that speaker subsequently is operating based on stale routing information.
      Failure of the BGP speaker to send (and thus the remote speaker to receive) BGP messages on a single BGP session can negatively impact the ability of an entire autonomous system (or even a group of autonomous systems) to converge.
      </t>
    </section>
    <section>
      <name>Changes to RFC 4271 - SendHoldTimer</name>
      <t>
    BGP speakers are implemented following a conceptual model "BGP Finite State Machine" (FSM), which is outlined in section 8 of <xref target="RFC4271"/>.
    This specification adds a BGP timer, <tt>SendHoldTimer</tt>, and updates the BGP FSM as follows:
      </t>
      <section>
        <name>Session Attributes</name>
        <t>
      The following optional session attributes for each connection are added to Section 8, before "The optional session attributes support different features of the BGP functionality that have implications for the BGP FSM state transitions":
        </t>
        <t>NEW</t>
        <blockquote>
          <ul empty="true" spacing="normal">
            <li>
              <t>
          14) SendHoldTimer
              </t>
            </li>
            <li>
              <t>
          15) SendHoldTime
              </t>
            </li>
          </ul>
        </blockquote>
        <t>
      The <tt>SendHoldTime</tt> determines how long a BGP speaker will stay in Established state before the TCP connection is dropped because no BGP messages can be transmitted to its peer.
      A BGP speaker can configure the value of the <tt>SendHoldTime</tt> for each peer independently.
        </t>
      </section>
      <section>
        <name>Timer Event: SendHoldTimer_Expires</name>
        <t>
    Another timer event is added to Section 8.1.3 of <xref target="RFC4271"/> as following:
        </t>
        <t>NEW</t>
        <blockquote>
          <dl newline="true">
            <dt>
        Event 29: SendHoldTimer_Expires
            </dt>
            <dd>
              <dl>
                <dt>Definition:</dt>
                <dd>An event generated when the SendHoldTimer expires.</dd>
                <dt>Status:</dt>
                <dd>Optional</dd>
              </dl>
            </dd>
          </dl>
        </blockquote>
      </section>
      <section>
        <name>Changes to the FSM</name>
        <t>The following changes are made to section 8.2.2 in <xref target="RFC4271"/>.</t>
        <t>In "OpenConfirm State", the handling of Event 26 is revised as follows:</t>
        <t>OLD</t>
        <blockquote>
          <t>
        If the local system receives a KEEPALIVE message (KeepAliveMsg (Event 26)), the local system:
          </t>
          <dl newline="false" spacing="normal">
            <dt>-</dt>
            <dd>restarts the HoldTimer and</dd>
            <dt>-</dt>
            <dd>changes its state to Established.</dd>
          </dl>
        </blockquote>
        <t>NEW</t>
        <blockquote>
          <t>
        If the local system receives a KEEPALIVE message (KeepAliveMsg (Event 26)), the local system:
          </t>
          <dl newline="false" spacing="normal">
            <dt>-</dt>
            <dd>restarts the HoldTimer,</dd>
            <dt>-</dt>
            <dd>starts the SendHoldTimer if the SendHoldTime is non-zero, and</dd>
            <dt>-</dt>
            <dd>changes its state to Established.</dd>
          </dl>
        </blockquote>
        <t>
      The following paragraph is added to section 8.2.2 in "Established State", after the paragraph which ends "unless the negotiated HoldTime value is zero.":
        </t>
        <t>NEW</t>
        <blockquote>
          <ul empty="true" spacing="normal">
            <li>
              <t>If the SendHoldTimer_Expires (Event 29) occurs, the local system:
              </t>
              <dl newline="false" spacing="normal">
                <dt>-</dt>
                <dd>(optionally) sends a NOTIFICATION message with the BGP Error Code "Send Hold Timer Expired" if the local system can determine that doing so will not delay the following actions in this paragraph,</dd>
                <dt>-</dt>
                <dd>logs an error message in the local system with the BGP Error Code "Send Hold Timer Expired",</dd>
                <dt>-</dt>
                <dd>releases all BGP resources,</dd>
                <dt>-</dt>
                <dd>sets the ConnectRetryTimer to zero,</dd>
                <dt>-</dt>
                <dd>drops the TCP connection,</dd>
                <dt>-</dt>
                <dd>increments the ConnectRetryCounter by 1,</dd>
                <dt>-</dt>
                <dd>(optionally) performs peer oscillation damping if the DampPeerOscillations attribute is set to TRUE, and</dd>
                <dt>-</dt>
                <dd>changes its state to Idle.</dd>
              </dl>
            </li>
            <li>
              <t>
          Each time the local system sends a BGP message, it restarts the SendHoldTimer unless the SendHoldTime value is zero or the negotiated HoldTime value is zero, in which cases the SendHoldTimer is stopped.
              </t>
            </li>
            <li>
              <t>
          The SendHoldTimer is stopped following any transition out of the Established state as part of the "release all BGP resources" action.
              </t>
            </li>
          </ul>
        </blockquote>
      </section>
      <section anchor="timers">
        <name>Changes to BGP Timers</name>
        <t>
      <xref target="RFC4271" section="10"/> summarizes BGP Timers.
      This document adds another optional BGP timer: <tt>SendHoldTimer</tt>.
        </t>
        <t>NEW</t>
        <blockquote>
          <t>
        SendHoldTime is an FSM attribute that stores the initial value for the SendHoldTimer.
        If SendHoldTime is non-zero then it MUST be greater than the value of HoldTime, see <xref section="5" target="I-D.ietf-idr-bgp-sendholdtimer"/> for suggested default values.
          </t>
        </blockquote>
      </section>
    </section>
    <section>
      <name>Send Hold Timer Expired Error Handling</name>
      <t>
      If the local system does not send any BGP messages within the period specified in <tt>SendHoldTime</tt>, then a NOTIFICATION message with the "Send Hold Timer Expired" Error Code MAY be sent and the BGP connection MUST be closed.
      Additionally, an error MUST be logged in the local system, indicating the Send Hold Timer Expired Error Code.
      </t>
    </section>
    <section anchor="implcons">
      <name>Implementation Considerations</name>
      <t>
      Due to the relative rarity of the failure mode that this specification is designed to address, and also the fact that network operators may be unfamiliar with the formal specification of BGP fault detection mechanisms such as <tt>HoldTimer</tt>, it is likely that a large number of operators are unaware of the necessity of an additional mechanism such as <tt>SendHoldtimer</tt>.
      </t>
      <t>
      Accordingly, it is RECOMMENDED that implementations of this specification enable <tt>SendHoldtimer</tt> by default, without requiring additional configuration of the BGP speaking device.
      </t>
      <t>
      The default value of <tt>SendHoldTime</tt> for a BGP connection SHOULD be the greater of:
      </t>
      <ul>
        <li>8 minutes; or</li>
        <li>2 times the negotiated HoldTime</li>
      </ul>
      <t>
      Implementations MAY make the value of <tt>SendHoldTime</tt> configurable, either globally or on a per-peer basis, within the constraints set out in <xref target="timers"/> above.
      </t>
      <t>
      The subcode for NOTIFICATION message "Send Hold Timer Expired" is set to 0 and is not used, no additional data is to be appended to the end of a "Send Hold Timer Expired" NOTIFICATION message.
      </t>
    </section>
    <section>
      <name>Operational Considerations</name>
      <t>
      When the local system recognizes a remote speaker is not processing any BGP messages for the duration of the <tt>SendHoldTime</tt>, it is likely that the local system will not be able to inform the remote peer through a NOTIFICATION message as to why the connection is being closed.
      This documents suggests that an attempt to send a NOTIFICATION message with the "Send Hold Timer Expired" error code is still made, if doing so will not delay closing the BGP connection.
      Meanwhile an error message is logged into the local system.
      </t>
      <t>
      Other mechanisms can be used as well, for example BGP speakers SHOULD provide this reason as part of their operational state; e.g. bgpPeerLastError in the <xref target="RFC4273">BGP MIB</xref>.
      </t>
    </section>
    <section>
      <name>Security Considerations</name>
      <t>
      This specification does not change BGP's security characteristics. Implementing the BGP <tt>SendHoldTimer</tt> as specified in this document will enhance network resilience by terminating connections with malfunctioning or overwhelmed remote peers.
      </t>
    </section>
    <section>
      <name>IANA Considerations</name>
      <t>
      IANA has registered code 8 for "Send Hold Timer Expired" in the "BGP Error (Notification) Codes" registry in the "Border Gateway Protocol (BGP) Parameters" registry group.
      </t>
    </section>
    <section>
      <name>Acknowledgements</name>
      <t>
      The authors would like to thank
      William McCall,
      Theo de Raadt,
      John Heasley,
      Nick Hilliard,
      Jeffrey Haas,
      Tom Petch,
      Susan Hares,
      Keyur Patel,
      Ben Maddison,
      Claudio Jeker,
      and
      John Scudder
      for their helpful review of this document.
      </t>
    </section>
  </middle>
  <back>
    <references>
      <name>References</name>
      <references>
        <name>Normative References</name>
        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml"/>
        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.4271.xml"/>
        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.8174.xml"/>
        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.9293.xml"/>
        <!-- NOTE TO RFC-EDITOR:
       The below reference is intended as a 'self-reference', but unsure how to do that properly in xml2rfc
       See https://mailarchive.ietf.org/arch/msg/idr/sY-om-d3kZC1ypoBXAS17NCXtXk/
       and https://mailarchive.ietf.org/arch/msg/idr/L6MinGVjHn94gRhCi2lGAQ9GoHw/
       for discussion on the concern of carrying over a literal non-reference into the patched target document content
  -->
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="https://datatracker.ietf.org/doc/bibxml3/draft-ietf-idr-bgp-sendholdtimer.xml"/>
      </references>
      <references>
        <name>Informative References</name>
        <reference anchor="openbgpd" target="https://marc.info/?l=openbsd-tech&amp;m=160820754925261&amp;w=2">
          <front>
            <title>bgpd send side hold timer</title>
            <author fullname="Claudio Jeker">
              <organization>OpenBSD</organization>
            </author>
            <date month="December" year="2020"/>
          </front>
        </reference>
        <reference anchor="frr" target="https://github.com/FRRouting/frr/pull/11225">
          <front>
            <title>bgpd: implement SendHoldTimer</title>
            <author fullname="David Lamparter">
              <organization>NetDEF</organization>
            </author>
            <date month="May" year="2022"/>
          </front>
        </reference>
        <reference anchor="neo-bgp" target="https://bgp.tools/kb/bgp-support">
          <front>
            <title>What does bgp.tools support</title>
            <author fullname="Ben Cartwright-Cox">
              <organization>Port 179 Ltd</organization>
            </author>
            <date month="Aug" year="2022"/>
          </front>
        </reference>
        <reference anchor="BIRD" target="https://gitlab.nic.cz/labs/bird/-/commit/bcf2327425d4dd96f381b87501cccf943bed606e">
          <front>
            <title>BIRD Internet Routing Daemon</title>
            <author fullname=" Katerina Kubecova">
              <organization>CZ.NIC</organization>
            </author>
            <date month="Oct" year="2023"/>
          </front>
        </reference>
        <reference anchor="bgpzombies" target="https://labs.ripe.net/author/romain_fontugne/bgp-zombies/">
          <front>
            <title>BGP Zombies</title>
            <author fullname="Romain Fontugne">
              <organization>IIJ Research Lab</organization>
            </author>
            <date month="april" year="2019"/>
          </front>
        </reference>
        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.4273.xml"/>
      </references>
    </references>
    <section>
      <name>Implementation status - RFC EDITOR: REMOVE BEFORE PUBLICATION</name>
      <t>
      This section records the status of known implementations of the protocol defined by this specification at the time of posting of this Internet-Draft, and is based on a proposal described in RFC 7942.
      The description of implementations in this section is intended to assist the IETF in its decision processes in progressing drafts to RFCs.
      Please note that the listing of any individual implementation here does not imply endorsement by the IETF.
      Furthermore, no effort has been spent to verify the information presented here that was supplied by IETF contributors.
      This is not intended as, and must not be construed to be, a catalog of available implementations or their features.
      Readers are advised to note that other implementations may exist.
      </t>
      <t>
      According to RFC 7942, "this will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature.
      It is up to the individual working groups to use this information as they see fit".
      </t>
      <ul spacing="normal">
        <li>
          <t>
          OpenBGPD <xref target="openbgpd"/>
          </t>
        </li>
      </ul>
      <ul spacing="normal">
        <li>
          <t>
          FRRouting <xref target="frr"/>
          </t>
        </li>
      </ul>
      <ul spacing="normal">
        <li>
          <t>
          neo-bgp (bgp.tools) <xref target="neo-bgp"/>
          </t>
        </li>
      </ul>
      <ul spacing="normal">
        <li>
          <t>
          BIRD <xref target="BIRD"/>
          </t>
        </li>
      </ul>
      <t>
      Patches to recognize error code 8 were merged into OpenBSD's and the-tcpdump-group's tcpdump implementations.
      </t>
    </section>
  </back>
</rfc>
