sys/netgraph/netflow/netflow.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2010-2011 Alexander V. Chernikov <melifaro@ipfw.ru>
   5  * Copyright (c) 2004 Gleb Smirnoff <glebius@FreeBSD.org>
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *       $SourceForge: netflow.h,v 1.8 2004/09/16 17:05:11 glebius Exp $
  30  *       $FreeBSD$
  31  */
  32
  33 /* netflow timeouts in seconds */
  34
  35 #define ACTIVE_TIMEOUT          (30*60) /* maximum flow lifetime is 30 min */
  36 #define INACTIVE_TIMEOUT        15
  37
  38 /*
  39  * More info can be found in these Cisco documents:
  40  *
  41  * Cisco IOS NetFlow, White Papers.
  42  * http://www.cisco.com/en/US/products/ps6601/prod_white_papers_list.html
  43  *
  44  * Cisco CNS NetFlow Collection Engine User Guide, 5.0.2, NetFlow Export
  45  * Datagram Formats.
  46  * http://www.cisco.com/en/US/products/sw/netmgtsw/ps1964/products_user_guide_chapter09186a00803f3147.html#wp26453
  47  *
  48  * Cisco Systems NetFlow Services Export Version 9
  49  * http://www.ietf.org/rfc/rfc3954.txt
  50  *
  51  */
  52
  53 #define NETFLOW_V1 1
  54 #define NETFLOW_V5 5
  55 #define NETFLOW_V9 9
  56
  57 struct netflow_v1_header
  58 {
  59   uint16_t version;     /* NetFlow version */
  60   uint16_t count;       /* Number of records in flow */
  61   uint32_t sys_uptime;  /* System uptime */
  62   uint32_t unix_secs;   /* Current seconds since 0000 UTC 1970 */
  63   uint32_t unix_nsecs;  /* Remaining nanoseconds since 0000 UTC 1970 */
  64 } __attribute__((__packed__));
  65
  66 struct netflow_v5_header
  67 {
  68   uint16_t version;     /* NetFlow version */
  69   uint16_t count;       /* Number of records in flow */
  70   uint32_t sys_uptime;  /* System uptime */
  71   uint32_t unix_secs;   /* Current seconds since 0000 UTC 1970 */
  72   uint32_t unix_nsecs;  /* Remaining nanoseconds since 0000 UTC 1970 */
  73   uint32_t flow_seq;    /* Sequence number of the first record */
  74   uint8_t engine_type;  /* Type of flow switching engine (RP,VIP,etc.) */
  75   uint8_t engine_id;    /* Slot number of the flow switching engine */
  76   uint16_t pad;         /* Pad to word boundary */
  77 } __attribute__((__packed__));
  78
  79 struct netflow_v9_header
  80 {
  81   uint16_t version;     /* NetFlow version */
  82   uint16_t count;       /* Total number of records in packet */
  83   uint32_t sys_uptime;  /* System uptime */
  84   uint32_t unix_secs;   /* Current seconds since 0000 UTC 1970 */
  85   uint32_t seq_num;     /* Sequence number */
  86   uint32_t source_id;   /* Observation Domain id */
  87 } __attribute__((__packed__));
  88
  89 struct netflow_v1_record
  90 {
  91   uint32_t src_addr;    /* Source IP address */
  92   uint32_t dst_addr;    /* Destination IP address */
  93   uint32_t next_hop;    /* Next hop IP address */
  94   uint16_t in_ifx;      /* Source interface index */
  95   uint16_t out_ifx;     /* Destination interface index */
  96   uint32_t packets;     /* Number of packets in a flow */
  97   uint32_t octets;      /* Number of octets in a flow */
  98   uint32_t first;       /* System uptime at start of a flow */
  99   uint32_t last;        /* System uptime at end of a flow */
 100   uint16_t s_port;      /* Source port */
 101   uint16_t d_port;      /* Destination port */
 102   uint16_t pad1;        /* Pad to word boundary */
 103   uint8_t prot;         /* IP protocol */
 104   uint8_t tos;          /* IP type of service */
 105   uint8_t flags;        /* Cumulative OR of tcp flags */
 106   uint8_t pad2;         /* Pad to word boundary */
 107   uint16_t pad3;        /* Pad to word boundary */
 108   uint8_t reserved[5];  /* Reserved for future use */
 109 } __attribute__((__packed__));
 110
 111 struct netflow_v5_record
 112 {
 113   uint32_t src_addr;    /* Source IP address */
 114   uint32_t dst_addr;    /* Destination IP address */
 115   uint32_t next_hop;    /* Next hop IP address */
 116   uint16_t i_ifx;       /* Source interface index */
 117   uint16_t o_ifx;       /* Destination interface index */
 118   uint32_t packets;     /* Number of packets in a flow */
 119   uint32_t octets;      /* Number of octets in a flow */
 120   uint32_t first;       /* System uptime at start of a flow */
 121   uint32_t last;        /* System uptime at end of a flow */
 122   uint16_t s_port;      /* Source port */
 123   uint16_t d_port;      /* Destination port */
 124   uint8_t pad1;         /* Pad to word boundary */
 125   uint8_t flags;        /* Cumulative OR of tcp flags */
 126   uint8_t prot;         /* IP protocol */
 127   uint8_t tos;          /* IP type of service */
 128   uint16_t src_as;      /* Src peer/origin Autonomous System */
 129   uint16_t dst_as;      /* Dst peer/origin Autonomous System */
 130   uint8_t src_mask;     /* Source route's mask bits */
 131   uint8_t dst_mask;     /* Destination route's mask bits */
 132   uint16_t pad2;        /* Pad to word boundary */
 133 } __attribute__((__packed__));
 134
 135 #define NETFLOW_V1_MAX_RECORDS 24
 136 #define NETFLOW_V5_MAX_RECORDS 30
 137
 138 #define NETFLOW_V1_MAX_SIZE (sizeof(netflow_v1_header)+ \
 139                              sizeof(netflow_v1_record)*NETFLOW_V1_MAX_RECORDS)
 140 #define NETFLOW_V5_MAX_SIZE (sizeof(netflow_v5_header)+ \
 141                              sizeof(netflow_v5_record)*NETFLOW_V5_MAX_RECORDS)
 142
 143 struct netflow_v5_export_dgram {
 144         struct netflow_v5_header        header;
 145         struct netflow_v5_record        r[NETFLOW_V5_MAX_RECORDS];
 146 } __attribute__((__packed__));
 147
 148 /* RFC3954 field definitions */
 149 #define NETFLOW_V9_FIELD_IN_BYTES               1       /* Input bytes count for a flow. Default 4, can be 8 */
 150 #define NETFLOW_V9_FIELD_IN_PKTS                2       /* Incoming counter with number of packets associated with an IP Flow. Default 4 */
 151 #define NETFLOW_V9_FIELD_FLOWS                  3       /* Number of Flows that were aggregated. Default 4 */
 152 #define NETFLOW_V9_FIELD_PROTOCOL               4       /* IP protocol byte. 1 */
 153 #define NETFLOW_V9_FIELD_TOS                    5       /* Type of service byte setting when entering the incoming interface. 1 */
 154 #define NETFLOW_V9_FIELD_TCP_FLAGS              6       /* TCP flags; cumulative of all the TCP flags seen in this Flow. 1 */
 155 #define NETFLOW_V9_FIELD_L4_SRC_PORT            7       /* TCP/UDP source port number. 2 */
 156 #define NETFLOW_V9_FIELD_IPV4_SRC_ADDR          8       /* IPv4 source address. 4 */
 157 #define NETFLOW_V9_FIELD_SRC_MASK               9       /* The number of contiguous bits in the source subnet mask (i.e., the mask in slash notation). 1 */
 158 #define NETFLOW_V9_FIELD_INPUT_SNMP             10      /* Input interface index. Default 2 */
 159 #define NETFLOW_V9_FIELD_L4_DST_PORT            11      /* TCP/UDP destination port number. 2 */
 160 #define NETFLOW_V9_FIELD_IPV4_DST_ADDR          12      /* IPv4 destination address. 4 */
 161 #define NETFLOW_V9_FIELD_DST_MASK               13      /* The number of contiguous bits in the destination subnet mask (i.e., the mask in slash notation). 1 */
 162 #define NETFLOW_V9_FIELD_OUTPUT_SNMP            14      /* Output interface index. Default 2 */
 163 #define NETFLOW_V9_FIELD_IPV4_NEXT_HOP          15      /* IPv4 address of the next-hop router. 4 */
 164 #define NETFLOW_V9_FIELD_SRC_AS                 16      /* Source BGP autonomous system number. Default 2, can be 4 */
 165 #define NETFLOW_V9_FIELD_DST_AS                 17      /* Destination BGP autonomous system number. Default 2, can be 4 */
 166 #define NETFLOW_V9_FIELD_BGP_IPV4_NEXT_HOP      18      /* Next-hop router's IP address in the BGP domain. 4 */
 167 #define NETFLOW_V9_FIELD_MUL_DST_PKTS           19      /* IP multicast outgoing packet counter for packets associated with IP flow. Default 4 */
 168 #define NETFLOW_V9_FIELD_MUL_DST_BYTES          20      /* IP multicast outgoing Octet (byte) counter for the number of bytes associated with IP flow. Default 4 */
 169 #define NETFLOW_V9_FIELD_LAST_SWITCHED          21      /* sysUptime in msec at which the last packet of this Flow was switched. 4 */
 170 #define NETFLOW_V9_FIELD_FIRST_SWITCHED         22      /* sysUptime in msec at which the first packet of this Flow was switched. 4 */
 171 #define NETFLOW_V9_FIELD_OUT_BYTES              23      /* Outgoing counter for the number of bytes associated with an IP Flow. Default 4 */
 172 #define NETFLOW_V9_FIELD_OUT_PKTS               24      /* Outgoing counter for the number of packets associated with an IP Flow. Default 4 */
 173 #define NETFLOW_V9_FIELD_IPV6_SRC_ADDR          27      /* IPv6 source address. 16 */
 174 #define NETFLOW_V9_FIELD_IPV6_DST_ADDR          28      /* IPv6 destination address. 16 */
 175 #define NETFLOW_V9_FIELD_IPV6_SRC_MASK          29      /* Length of the IPv6 source mask in contiguous bits. 1 */
 176 #define NETFLOW_V9_FIELD_IPV6_DST_MASK          30      /* Length of the IPv6 destination mask in contiguous bits. 1 */
 177 #define NETFLOW_V9_FIELD_IPV6_FLOW_LABEL        31      /* IPv6 flow label as per RFC 2460 definition. 3 */
 178 #define NETFLOW_V9_FIELD_ICMP_TYPE              32      /* Internet Control Message Protocol (ICMP) packet type; reported as ICMP Type * 256 + ICMP code. 2 */
 179 #define NETFLOW_V9_FIELD_MUL_IGMP_TYPE          33      /* Internet Group Management Protocol (IGMP) packet type. 1 */
 180 #define NETFLOW_V9_FIELD_SAMPLING_INTERVAL      34      /* When using sampled NetFlow, the rate at which packets are sampled; for example, a value of 100 indicates that one of every hundred packets is sampled. 4 */
 181 #define NETFLOW_V9_FIELD_SAMPLING_ALGORITHM     35      /* For sampled NetFlow platform-wide: 0x01 deterministic sampling 0x02 random sampling. 1 */
 182 #define NETFLOW_V9_FIELD_FLOW_ACTIVE_TIMEOUT    36      /* Timeout value (in seconds) for active flow entries in the NetFlow cache. 2 */
 183 #define NETFLOW_V9_FIELD_FLOW_INACTIVE_TIMEOUT  37      /* Timeout value (in seconds) for inactive Flow entries in the NetFlow cache. 2 */
 184 #define NETFLOW_V9_FIELD_ENGINE_TYPE            38      /* Type of Flow switching engine (route processor, linecard, etc...). 1 */
 185 #define NETFLOW_V9_FIELD_ENGINE_ID              39      /* ID number of the Flow switching engine. 1 */
 186 #define NETFLOW_V9_FIELD_TOTAL_BYTES_EXP        40      /* Counter with for the number of bytes exported by the Observation Domain. Default 4 */
 187 #define NETFLOW_V9_FIELD_TOTAL_PKTS_EXP         41      /* Counter with for the number of packets exported by the Observation Domain. Default 4 */
 188 #define NETFLOW_V9_FIELD_TOTAL_FLOWS_EXP        42      /* Counter with for the number of flows exported by the Observation Domain. Default 4 */
 189 #define NETFLOW_V9_FIELD_MPLS_TOP_LABEL_TYPE    46      /* MPLS Top Label Type. 1 */
 190 #define NETFLOW_V9_FIELD_MPLS_TOP_LABEL_IP_ADDR 47      /* Forwarding Equivalent Class corresponding to the MPLS Top Label. 4 */
 191 #define NETFLOW_V9_FIELD_FLOW_SAMPLER_ID        48      /* Identifier shown in "show flow-sampler". 1 */
 192 #define NETFLOW_V9_FIELD_FLOW_SAMPLER_MODE      49      /* The type of algorithm used for sampling data. 2 */
 193 #define NETFLOW_V9_FIELD_FLOW_SAMPLER_RANDOM_INTERVAL           50      /* Packet interval at which to sample. 4. */
 194 #define NETFLOW_V9_FIELD_DST_TOS                55      /* Type of Service byte setting when exiting outgoing interface. 1. */
 195 #define NETFLOW_V9_FIELD_SRC_MAC                56      /* Source MAC Address. 6 */
 196 #define NETFLOW_V9_FIELD_DST_MAC                57      /* Destination MAC Address. 6 */
 197 #define NETFLOW_V9_FIELD_SRC_VLAN               58      /* Virtual LAN identifier associated with ingress interface. 2 */
 198 #define NETFLOW_V9_FIELD_DST_VLAN               59      /* Virtual LAN identifier associated with egress interface. 2 */
 199 #define NETFLOW_V9_FIELD_IP_PROTOCOL_VERSION    60      /* Internet Protocol Version. Set to 4 for IPv4, set to 6 for IPv6. If not present in the template, then version 4 is assumed. 1. */
 200 #define NETFLOW_V9_FIELD_DIRECTION              61      /* Flow direction: 0 - ingress flow 1 - egress flow. 1 */
 201 #define NETFLOW_V9_FIELD_IPV6_NEXT_HOP          62      /* IPv6 address of the next-hop router. 16 */
 202 #define NETFLOW_V9_FIELD_BGP_IPV6_NEXT_HOP      63      /* Next-hop router in the BGP domain. 16 */
 203 #define NETFLOW_V9_FIELD_IPV6_OPTION_HEADERS    64      /* Bit-encoded field identifying IPv6 option headers found in the flow */
 204 #define NETFLOW_V9_FIELD_MPLS_LABEL_1           70      /* MPLS label at position 1 in the stack. 3 */
 205 #define NETFLOW_V9_FIELD_MPLS_LABEL_2           71      /* MPLS label at position 2 in the stack. 3 */
 206 #define NETFLOW_V9_FIELD_MPLS_LABEL_3           72      /* MPLS label at position 3 in the stack. 3 */
 207 #define NETFLOW_V9_FIELD_MPLS_LABEL_4           73      /* MPLS label at position 4 in the stack. 3 */
 208 #define NETFLOW_V9_FIELD_MPLS_LABEL_5           74      /* MPLS label at position 5 in the stack. 3 */
 209 #define NETFLOW_V9_FIELD_MPLS_LABEL_6           75      /* MPLS label at position 6 in the stack. 3 */
 210 #define NETFLOW_V9_FIELD_MPLS_LABEL_7           76      /* MPLS label at position 7 in the stack. 3 */
 211 #define NETFLOW_V9_FIELD_MPLS_LABEL_8           77      /* MPLS label at position 8 in the stack. 3 */
 212 #define NETFLOW_V9_FIELD_MPLS_LABEL_9           78      /* MPLS label at position 9 in the stack. 3 */
 213 #define NETFLOW_V9_FIELD_MPLS_LABEL_10          79      /* MPLS label at position 10 in the stack. 3 */
 214
 215 #define NETFLOW_V9_MAX_RESERVED_FLOWSET         0xFF    /* Clause 5.2 */