Internet-Draft | New TCP and IPv6 EH IPFIX IEs | May 2024 |
Boucadair & Claise | Expires 24 November 2024 | [Page] |
This document specifies new IP Flow Information Export (IPFIX) Information Elements (IEs) to solve issues with existing ipv6ExtensionHeaders and tcpOptions IPFIX IEs, especially the ability to export any observed IPv6 extension headers or TCP options.¶
This note is to be removed before publishing as an RFC.¶
Discussion of this document takes place on the Operations and Management Area Working Group Working Group mailing list (opsawg@ietf.org), which is archived at https://mailarchive.ietf.org/arch/browse/opsawg/.¶
Source for this draft and an issue tracker can be found at https://github.com/boucadair/ipfix-tcpoptions-and-v6eh.¶
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 24 November 2024.¶
Copyright (c) 2024 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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
This document specifies new IP Flow Information Export (IPFIX) [RFC7011] Information Elements (IEs) to solve a set of issues encountered with the specifications of ipv6ExtensionHeaders (to export IPv6 extension headers) and tcpOptions (to export TCP options) IEs [IANA-IPFIX]. More details about these issues are provided in the following sub-sections.¶
The specification of the ipv6ExtensionHeaders IPFIX IE (64) does not:¶
Cover the full extension headers' range defined in the IPv6 specification (Section 4 of [RFC8200]).¶
Specify the procedure to follow when all bits are exhausted.¶
Specify a means to export the order and the number of occurrences of a given extension header.¶
Specify how to automatically update the IANA IPFIX registry ([IANA-IPFIX]) when a new value is assigned in the IPv6 Extension Header Types registry [IANA-EH]. Only a frozen set of extension headers can be exported using the ipv6ExtensionHeaders IE. For example, the ipv6ExtensionHeaders IE can't report some IPv6 EHs, specifically EHs for Host Identity Protocol (139), Shim6 Protocol (140) or extension headers for experimentation and testing.¶
Specify whether the exported values match the full enclosed values or only up to a limit imposed by hardware or software (e.g., Section 1.1 of [RFC8883]). Note that some implementations may not be able to export all observed extension headers in a Flow because of a hardware or software limit (see, e.g., [I-D.ietf-6man-eh-limits]). The specification of the ipv6ExtensionHeaders Information Element does not discuss whether it covers all enclosed extension headers or only up to a limit.¶
Specify how to report the length of IPv6 extension headers.¶
Optimize the encoding.¶
Explain the reasoning for reporting values which do not correspond to extension headers (e.g., "Unknown Layer 4 header" or "Payload compression header").¶
Specify how to report extension header chains or aggregate extension headers length.¶
Section 3 addresses these issues.¶
This specification deprecates the ipv6ExtensionHeaders IPFIX IE in favor of the new IEs defined in this document.¶
The specification of the tcpOptions IPFIX IE (209) does not:¶
Describe how some observed TCP options in a Flow can be exported using IPFIX. Only TCP options having a Kind <= 63 can be exported in a tcpOptions IE.¶
Allow reporting the observed Experiment Identifiers (ExIDs) that are carried in shared Experimental TCP options (Kind=253 or 254) [RFC6994].¶
Optimize the encoding.¶
Section 4 addresses these issues.¶
This specification deprecates the tcpOptions IE in favor of the new IEs defined in this document.¶
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.¶
This document uses the IPFIX-specific terminology (Information Element, Template Record, Flow, etc.) defined in Section 2 of [RFC7011]. As in the base IPFIX specification [RFC7011], these IPFIX-specific terms have the first letter of a word capitalized.¶
Also, the document uses the terms defined in IPv6 [RFC8200] and TCP [RFC9293] specifications.¶
In addition, the document makes use of the following term:¶
Refers to the chain of extension headers that are present in an IPv6 packet.¶
This term should not be confused with the IPv6 header chain, which includes the IPv6 header, zero or more IPv6 extension headers, and zero or a single Upper-Layer Header.¶
Refers to a Flow where distinct extension header chains are observed. Concretely, different packets in such a Flow will have a different sequence of extension header type codes.¶
ipv6ExtensionHeaderType¶
TBD1¶
Type of an IPv6 extension header observed in packets of this Flow.¶
unsigned8¶
identifier¶
See Section 4 of [RFC8200] for the general definition of IPv6 extension headers.¶
This-Document¶
ipv6ExtensionHeaderCount¶
TBD2¶
The number of consecutive occurrences of the same extension header type in a Flow.¶
The type of the extension header is provided in the ipv6ExtensionHeaderType Information Element.¶
unsigned8¶
totalCounter¶
See Section 4 of [RFC8200] for the general definition of IPv6 extension headers.¶
This-Document¶
ipv6ExtensionHeadersFull¶
TBD3¶
IPv6 extension headers observed in packets of this Flow. The information is encoded in a set of bit fields. For each IPv6 extension header, there is a bit in this set. The bit is set to 1 if any observed packet of this Flow contains the corresponding IPv6 extension header. Otherwise, if no observed packet of this Flow contains the respective IPv6 extension header, the value of the corresponding bit is 0.¶
The IPv6 extension header associated with each bit is provided in [NEW_IPFIX_IPv6EH_SUBREGISTRY]. Bit 0 corresponds to the least-significant bit in the ipv6ExtensionHeadersFull IE while bit 255 corresponds to the most-significant bit of the IE. In doing so, few octets will be needed to encode common IPv6 extension headers when observed in a Flow.¶
The "No Next Header" (59) value (Section 4.7 of [RFC8200]) is used if there is no upper-layer header in an IPv6 packet. Even if the value is not considered as an extension header as such, the corresponding bit is set in the ipv6ExtensionHeadersFull IE whenever that value is encountered in the Flow.¶
Extension headers observed in a Flow with varying extension header chain MUST NOT be grouped in the ipv6ExtensionHeadersFull Information Element if the ipv6ExtensionHeaderChainLengthList Information Element is also present.¶
If the ipv6ExtensionHeaderChainLengthList Information Element is not present, then extension headers observed in a Flow with varying extension header chain MAY be grouped in one single ipv6ExtensionHeadersFull Information Element or be exported in separate ipv6ExtensionHeadersFull IEs, one for each extension header chain.¶
The ipv6ExtensionHeadersFull Information Element MUST NOT be exported if ipv6ExtensionHeaderTypeCountList Information Element is also present because of the overlapping scopes between these two IEs.¶
The value of ipv6ExtensionHeadersFull IE may be encoded in fewer octets per the guidelines in Section 6.2 of [RFC7011].¶
unsigned256¶
flags¶
See the ipv6ExtensionHeaders Bits registry at [NEW_IPFIX_IPv6EH_SUBREGISTRY].¶
See Section 4 of [RFC8200] for the general definition of IPv6 extension headers.¶
This-Document¶
Note to the RFC Editor: Please replace [NEW_IPFIX_IPv6EH_SUBREGISTRY] with the link to the "ipv6ExtensionHeaders Bits" registry (Section 8.4).¶
ipv6ExtensionHeaderTypeCountList¶
TBD4¶
As per Section 4.1 of [RFC8200], IPv6 nodes must accept and attempt to process extension headers occurring any number of times in the same packet. This Information Element echoes the order of extension headers and number of consecutive occurrences of the same extension header type in a Flow.¶
This Information Element is a subTemplateList of ipv6ExtensionHeaderType and ipv6ExtensionHeaderCount Information Elements.¶
Each header chain in Flow with varying extension header chain MUST be exported in a separate IE.¶
The same extension header type may appear several times in an ipv6ExtensionHeaderTypeCountList Information Element. For example, if an IPv6 packet of a Flow includes a Hop-by-Hop Options header, a Destination Options header, a Fragment header, and Destination Options header, the ipv6ExtensionHeaderTypeCountList Information Element will report:¶
If an implementation determines that an observed packet of a Flow includes an extension header (including an extension header that it does not support), then the exact observed code of that extension header MUST be echoed in the ipv6ExtensionHeaderTypeCountList IE. How an implementation disambiguates between unknown upper-layer protocols vs. extension headers is not IPFIX-specific. Refer, for example, to Section 2.2 of [RFC8883] for a behavior of an intermediate node that encounters an unknown Next Header type.¶
subTemplateList¶
list¶
See [RFC8200] for the general definition of IPv6 extension headers.¶
This-Document¶
ipv6ExtensionHeadersLimit¶
TBD5¶
When set to "false", this Information Element indicates that the exported extension headers information (e.g., ipv6ExtensionHeadersFull or ipv6ExtensionHeaderTypeCountList) does not match the full enclosed extension headers, but only up to a limit that is typically set by hardware or software.¶
When set to "true", this Information Element indicates that the exported extension header information matches the full enclosed extension headers.¶
boolean¶
default¶
See Section 4 of [RFC8200] for the general definition of IPv6 extension headers.¶
See [RFC8883] for an example of IPv6 packet processing due to limits on extension headers.¶
This-Document¶
ipv6ExtensionHeadersChainLength¶
TBD6¶
In theory, there are no limits on the number of IPv6 extension headers that may be present in a packet other than the path MTU. However, it was regularly reported that IPv6 packets with extension headers are often dropped in the Internet.¶
As discussed in Section 1.2 of [RFC8883], some hardware devices implement a parsing buffer of a fixed size to process packets, including all the headers. When the aggregate length of headers of an IPv6 packet exceeds that size, the packet will be discarded or deferred to a slow path.¶
The ipv6ExtensionHeadersChainLength IE is used to report, in octets, the length of an extension header chain observed in a Flow. The length is the sum of the length of all extension headers of the chain. Exporting such information might help identifying root causes of performance degradation, including packet drops.¶
Each header chain length of a Flow with varying extension header chain MUST be exported in a separate ipv6ExtensionHeadersChainLength IE.¶
unsigned32¶
identifier¶
octets¶
See Section 4 of [RFC8200] for the general definition of IPv6 extension headers.¶
See [RFC9098] for an overview of operational implications of IPv6 packets with extension headers.¶
This-Document¶
ipv6ExtensionHeaderChainLengthList¶
TBD7¶
This Information Element is used to report the chains and their length as observed in a Flow with varying extension header chain.¶
This Information Element is a subTemplateList of ipv6ExtensionHeadersFull and ipv6ExtensionHeadersChainLength Information Elements.¶
If several extension header chains are observed in a Flow, each header chain MUST be exported in a separate ipv6ExtensionHeaderChainLengthList IE.¶
subTemplateList¶
list¶
See [RFC8200] for the general definition of IPv6 extension headers.¶
This-Document¶
This section specifies a new IE to cover the full TCP options range.¶
tcpOptionsFull¶
TBD8¶
TCP options in packets of this Flow. The information is encoded in a set of bit fields. For each TCP option, there is a bit in this set. The bit is set to 1 if any observed packet of this Flow contains the corresponding TCP option. Otherwise, if no observed packet of this Flow contains the respective TCP option, the value of the corresponding bit is 0.¶
Options are mapped to bits according to their option numbers. TCP option Kind 0 corresponds to the least-significant bit in the tcpOptionsFull IE while Kind 255 corresponds to the most-significant bit of the IE. This approach allows an observer to export any observed TCP option even if it does support that option and without requiring updating a mapping table.¶
The value of tcpOptionsFull IE may be encoded in fewer octets per the guidelines in Section 6.2 of [RFC7011].¶
The presence of tcpSharedOptionExID16List or tcpSharedOptionExID32List IEs is an indication that a shared TCP option (Kind=253 or 254) is observed in a Flow. The presence of tcpSharedOptionExID16List or tcpSharedOptionExID32List IEs takes precedence over setting the corresponding bits in the tcpOptionsFull IE for the same Flow. In order to optimize the use of the reduced-size encoding in the presence of tcpSharedOptionExID16List or tcpSharedOptionExID32List IEs, the Exporter MUST NOT set to 1 the shared TCP options (Kind=253 or 254) flags of the tcpOptionsFull IE that is reported for the same Flow.¶
unsigned256¶
flags¶
This-Document¶
tcpSharedOptionExID16¶
TBD9¶
Reports an observed 2-byte ExID in a shared TCP option (Kind=253 or 254) in a Flow.¶
unsigned16¶
identifier¶
See the TCP Experimental Option Experiment Identifiers (TCP ExIDs) registry at [IANA-TCP-EXIDs].¶
See [RFC6994] for the shared use of experimental TCP Options.¶
This-Document¶
tcpSharedOptionExID32¶
TBD10¶
Reports an observed 4-byte ExID in a shared TCP option (Kind=253 or 254) in a Flow.¶
unsigned32¶
identifier¶
See the TCP Experimental Option Experiment Identifiers (TCP ExIDs) registry at [IANA-TCP-EXIDs].¶
See [RFC6994] for the shared use of experimental TCP Options.¶
This-Document¶
tcpSharedOptionExID16List¶
TBD11¶
Reports observed 2-byte ExIDs in shared TCP options (Kind=253 or 254) in a Flow.¶
A basicList of tcpSharedOptionExID16 Information Elements in which each tcpSharedOptionExID16 Information Element carries an observed 2-byte ExID in a shared option.¶
basicList¶
list¶
See the TCP Experimental Option Experiment Identifiers (TCP ExIDs) registry at [IANA-TCP-EXIDs].¶
See [RFC6994] for the shared use of experimental TCP Options.¶
This-Document¶
tcpSharedOptionExID32List¶
TBD12¶
Reports observed 4-byte ExIDs in shared TCP options (Kind=253 or 254) in a Flow.¶
A basicList of tcpSharedOptionExID32 Information Elements in which each tcpSharedOptionExID32 Information Element carries an observed 4-byte ExID in a shared option.¶
basicList¶
list¶
See the TCP Experimental Option Experiment Identifiers (TCP ExIDs) registry at [IANA-TCP-EXIDs].¶
See [RFC6994] for the shared use of experimental TCP Options.¶
This-Document¶
Implementations of tcpSharedOptionExID16, tcpSharedOptionExID32, tcpSharedOptionExID16List, and tcpSharedOptionExID32List IEs are assumed to be provided with a list of valid ExIDs [IANA-TCP-EXIDs]. How that list is maintained is implementation-specific. Absent that list, an implementation can't autonomously determine whether an ExID is present and, if so, whether it is 2- or 4-byte length.¶
If a TCP Flow contains packets with a mix of 2-byte and 4-byte ExIDs, the same Template Record is used with both tcpSharedOptionExID16 and tcpSharedOptionExID32 IEs.¶
This section provides a few examples to illustrate the use of some IEs defined in this document.¶
Figure 1 provides an example of EH/bit mappings in an ipv6ExtensionHeadersFull IE for an IPv6 Flow in which only the IPv6 Destination Options (0) header is observed. The bits are set following the table provided in Section 8.4.1.¶
The leading zeros are dropped per the reduced-size encoding guidance. One octet is thus sufficient to send these observed options on the wire. Concretely, the ipv6ExtensionHeadersFull IE will be set to 0x01 (Figure 2).¶
Figure 3 provides another example of reported values in an ipv6ExtensionHeadersFull IE for an IPv6 Flow in which the Destination Options (0), IPv6 Hop-by-Hop Options (1), and Routing (5) headers are observed. One octet is sufficient to report these observed options. Concretely, the ipv6ExtensionHeadersFull IE will be set to 0x23.¶
Given TCP Kind allocation practices and the option mapping defined in Section 4.1, fewer octets are likely to be used for Flows with common TCP options.¶
Figure 4 shows an example of Kind/bit mappings in a tcpOptionsFull IE for a TCP Flow in which End of Option List (0), Maximum Segment Size (2), and Window Scale (3) options are observed.¶
One octet is sufficient to report these observed options. Concretely, the tcpOptionsFull IE will be set to 0x0D (Figure 5).¶
IPFIX security considerations are discussed in Section 11 of [RFC7011].¶
ipv6ExtensionHeadersChainLength and ipv6ExtensionHeadersLimit IEs can be exploited by an unauthorized observer as a means to deduce the processing capabilities of nodes. Section 8 of [RFC7012] discusses the required measures to guarantee the integrity and confidentiality of the exported information.¶
This document does not add new security considerations for exporting IEs other than those already discussed in Section 8 of [RFC7012].¶
This document requests IANA to update the "IPFIX Information Elements" registry under the "IP Flow Information Export (IPFIX) Entities" registry group [IANA-IPFIX] as follows:¶
Update the ipv6ExtensionHeaders IE (64) entry by marking it as deprecated in favor of the ipv6ExtensionHeadersFull IE defined in this document. This note should also be echoed in the "Additional Information" of the ipv6ExtensionHeaders IE.¶
Update the tcpOptions IE (209) entry by marking it as deprecated in favor of the tcpOptionsFull IE defined in this document. This note should also be echoed in the "Additional Information" of the tcpOptions IE.¶
IANA is also requested to update the reference of ipv6ExtensionHeaders IE (64) and tcpOptions IE (209) to point to this document.¶
This document requests IANA to add the following new IPFIX IEs to the "IPFIX Information Elements" registry under the "IP Flow Information Export (IPFIX) Entities" registry group [IANA-IPFIX]:¶
Value | Name | Reference |
---|---|---|
TBD1 | ipv6ExtensionHeader | Section 3.1 of This-Document |
TBD2 | ipv6ExtensionHeaderCount | Section 3.2 of This-Document |
TBD3 | ipv6ExtensionHeadersFull | Section 3.3 of This-Document |
TBD4 | ipv6ExtensionHeaderTypeCountList | Section 3.4 of This-Document |
TBD5 | ipv6ExtensionHeadersLimit | Section 3.5 of This-Document |
TBD6 | ipv6ExtensionHeadersChainLength | Section 3.6 of This-Document |
TBD7 | ipv6ExtensionHeaderChainLengthList | Section 3.7 of This-Document |
TBD8 | tcpOptionsFull | Section 4.1 of This-Document |
TBD9 | tcpSharedOptionExID16 | Section 4.2 of This-Document |
TBD10 | tcpSharedOptionExID32 | Section 4.3 of This-Document |
TBD11 | tcpSharedOptionExID16List | Section 4.4 of This-Document |
TBD12 | tcpSharedOptionExID32List | Section 4.5 of This-Document |
This document requests IANA to add the following new abstract data type to the "IPFIX Information Element Data Types" registry under the "IP Flow Information Export (IPFIX) Entities" registry group [IANA-IPFIX]:¶
Value | Description | Reference |
---|---|---|
TBD10 | unsigned256 | This-Document |
The type "unsigned256" represents a non-negative integer value in the range of '0' to '2^256 - 1'. Similar to Section 6.1.1 of [RFC7011], this type MUST be encoded using the default canonical format in network byte order.¶
Reduced-Size encoding (Section 6.2 of [RFC7011]) applies to this data type. The reduction in size can be to any number of octets smaller than the unsigned256 type if the data value still fits, i.e., so that only leading zeroes are dropped.¶
This document requests IANA to create a new registry entitled "ipv6ExtensionHeaders Bits" under the IANA IPFIX registry group [IANA-IPFIX].¶
When a new code is assigned to an IPv6 EH in [IANA-EH], the next available free bit is selected by IANA for this EH from "ipv6ExtensionHeaders Bits" registry and the registry is updated with the details that mirror the assigned EH. The "Label" mirrors the "keyword" of an EH as indicated in [IANA-Protocols], while the "Protocol Number" mirrors the "Protocol Number" in [IANA-EH]. IANA is requested to add the following note to [IANA-EH]:¶
When a new code is assigned to an IPv6 Extension Header, the next available free bit in [NEW_IPFIX_IPv6EH_SUBREGISTRY] is selected for this new Extension Header. [NEW_IPFIX_IPv6EH_SUBREGISTRY] is updated accordingly. Modifications to existing registrations must be mirrored in [NEW_IPFIX_IPv6EH_SUBREGISTRY].¶
Note to the RFC Editor: Please replace [NEW_IPFIX_IPv6EH_SUBREGISTRY] with the link used by IANA for this new registry.¶
Otherwise, the registration policy for the registry is Expert Review (Section 4.5 of [RFC8126]). See more details in Section 8.4.2.¶
The initial values of this registry are provided in Table 3.¶
Bit | Label | Protocol Number | Description | Reference |
---|---|---|---|---|
0 | DST | 60 | Destination Options for IPv6 | This-Document |
1 | HOP | 0 | IPv6 Hop-by-Hop Options | This-Document |
2 | NoNxt | 59 | No Next Header for IPv6 | This-Document |
3 | UNK | Unknown extension header | This-Document | |
4 | FRA0 | 44 | Fragment header - first fragment | This-Document |
5 | RH | 43 | Routing header | This-Document |
6 | FRA1 | 44 | Fragmentation header - not first fragment | This-Document |
7 | MOB | 135 | Mobility Header | This-Document |
8 | ESP | 50 | Encapsulating Security Payload | This-Document |
9 | AH | 51 | Authentication Header | This-Document |
10 | HIP | 139 | Host Identity Protocol | This-Document |
11 | SHIM6 | 140 | Shim6 Protocol | This-Document |
12 | 253 | Use for experimentation and testing | This-Document | |
13 | 254 | Use for experimentation and testing | This-Document | |
14 to 255 | Unassigned |
It is suggested that multiple designated experts be appointed for registry change requests.¶
Designated experts are solicited only for changes that are not covered by the automatic mirroring described above. For example, a registration may request two bits for a new EH to cover specific behaviors or uses of that EH.¶
Criteria that should be applied by the designated experts include determining whether the proposed registration duplicates existing entries, whether the exception to the automatic mirroring procedure is justified, and whether the registration description is clear and fits the purpose of this registry.¶
Within the review period, the designated experts will either approve or deny the registration request, communicating this decision to the IANA. Denials should include an explanation and, if applicable, suggestions as to how to make the request successful.¶
Thanks to Paul Aitken, Eric Vyncke, and Joe Touch for the reviews and comments. Special thanks to Andrew Feren for sharing data about scans of IPFIX data he collected.¶
Thanks to Wesley Eddy for the tsvart review, Yingzhen Qu for the opsdir review, Dirk Von Hugo for intdir review, Joel Halpern for the genart review, and Tero Kivinen for the secdir review.¶
Thanks to Thomas Graf for the Shepherd review.¶
Thanks to Mahesh Jethanandani for the AD review.¶