share/man/man4/ng_netflow.4

   1 .\" Copyright (c) 2004-2005 Gleb Smirnoff <glebius@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd Nov 2, 2012
  28 .Dt NG_NETFLOW 4
  29 .Os
  30 .Sh NAME
  31 .Nm ng_netflow
  32 .Nd Cisco's NetFlow implementation
  33 .Sh SYNOPSIS
  34 .In sys/types.h
  35 .In netinet/in.h
  36 .In netgraph/netflow/ng_netflow.h
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 node implements Cisco's NetFlow export protocol on a router running
  41 .Fx .
  42 The
  43 .Nm
  44 node listens for incoming traffic and identifies unique flows in it.
  45 Flows are distinguished by endpoint IP addresses, TCP/UDP port numbers,
  46 ToS and input interface.
  47 Expired flows are exported out of the node in NetFlow version 5/9 UDP datagrams.
  48 Expiration reason can be one of the following:
  49 .Bl -dash
  50 .It
  51 RST or FIN TCP segment.
  52 .It
  53 Active timeout.
  54 Flows cannot live more than the specified period of time.
  55 The default is 1800 seconds (30 minutes).
  56 .It
  57 Inactive timeout.
  58 A flow was inactive for the specified period of time.
  59 The default is 15 seconds.
  60 .El
  61 .Pp
  62 Node supports IPv6 accounting (NetFlow v9 only) and is aware of multiple fibs.
  63 Different fibs are mapped to different domain_id in NetFlow V9 and different engine_id in NetFlow V5.
  64 .Pp
  65 .Sh HOOKS
  66 This node type supports up to
  67 .Dv NG_NETFLOW_MAXIFACES
  68 (default 65536) hooks named
  69 .Va iface0 , iface1 ,
  70 etc.,
  71 and the same number of hooks named
  72 .Va out0 , out1 ,
  73 etc.,
  74 plus two export hooks:
  75 .Va export
  76 (for NetFlow version 5) and
  77 .Va export9
  78 (for NetFlow version 9). Export can be done simultaneously for all supported
  79 export hooks. By default (ingress NetFlow enabled) node does NetFlow accounting of data
  80 received on
  81 .Va iface*
  82 hooks.
  83 If corresponding
  84 .Va out
  85 hook is connected, unmodified data is bypassed to it, otherwise data is freed.
  86 If data is received on
  87 .Va out
  88 hook, it is bypassed to corresponding
  89 .Va iface
  90 hook without any processing (egress NetFlow disabled by default).
  91 When full export datagram for an export protocol is built it is sent to the
  92 .Va export
  93 or
  94 .Va export9
  95 hook.
  96 In normal operation, one (or more) export hook is connected to the
  97 .Va inet/dgram/udp
  98 hook of the
  99 .Xr ng_ksocket 4
 100 node.
 101 .Sh CONTROL MESSAGES
 102 This node type supports the generic control messages, plus the following:
 103 .Bl -tag -width indent
 104 .It Dv NGM_NETFLOW_INFO Pq Ic info
 105 Returns some node statistics and the current timeout values in a
 106 .Vt "struct ng_netflow_info" .
 107 .It Dv NGM_NETFLOW_IFINFO Pq Ic ifinfo
 108 Returns information about the
 109 .Va iface Ns Ar N
 110 hook.
 111 The hook number is passed as an argument.
 112 .It Dv NGM_NETFLOW_SETDLT Pq Ic setdlt
 113 Sets data link type on the
 114 .Va iface Ns Ar N
 115 hook.
 116 Currently, supported types are raw IP datagrams and Ethernet.
 117 This message type uses
 118 .Vt "struct ng_netflow_setdlt"
 119 as an argument:
 120 .Bd -literal -offset 4n
 121 struct ng_netflow_setdlt {
 122         uint16_t iface;         /* which iface dlt change */
 123         uint8_t  dlt;           /* DLT_XXX from bpf.h */
 124 };
 125 .Ed
 126 .Pp
 127 The requested
 128 .Va iface Ns Ar N
 129 hook must already be connected, otherwise message send operation will
 130 return an error.
 131 .It Dv NGM_NETFLOW_SETIFINDEX Pq Ic setifindex
 132 In some cases,
 133 .Nm
 134 may be unable to determine the input interface index of a packet.
 135 This can happen if traffic enters the
 136 .Nm
 137 node before it comes to the system interface's input queue.
 138 An example of such a setup is capturing a traffic
 139 .Em between
 140 synchronous data line and
 141 .Xr ng_iface 4 .
 142 In this case, the input index should be associated with a given hook.
 143 The interface's index can be determined via
 144 .Xr if_nametoindex 3
 145 from userland.
 146 This message requires
 147 .Vt "struct ng_netflow_setifindex"
 148 as an argument:
 149 .Bd -literal -offset 4n
 150 struct ng_netflow_setifindex {
 151         uint16_t iface;         /* which iface index change */
 152         uint16_t index;         /* new index */
 153 };
 154 .Ed
 155 .Pp
 156 The requested
 157 .Va iface Ns Ar N
 158 hook must already be connected, otherwise the message
 159 send operation will return an error.
 160 .It Dv NGM_NETFLOW_SETTIMEOUTS Pq Ic settimeouts
 161 Sets values in seconds for NetFlow active/inactive timeouts.
 162 This message requires
 163 .Vt "struct ng_netflow_settimeouts"
 164 as an argument:
 165 .Bd -literal -offset 4n
 166 struct ng_netflow_settimeouts {
 167         uint32_t inactive_timeout;      /* flow inactive timeout */
 168         uint32_t active_timeout;        /* flow active timeout */
 169 };
 170 .Ed
 171 .It Dv NGM_NETFLOW_SETCONFIG Pq Ic setconfig
 172 Sets configuration for the specified interface.
 173 This message requires
 174 .Vt "struct ng_netflow_setconfig"
 175 as an argument:
 176 .Bd -literal -offset 4n
 177 struct ng_netflow_setconfig {
 178         uint16_t iface;         /* which iface config change */
 179         uint32_t conf;          /* new config */
 180 #define NG_NETFLOW_CONF_INGRESS         1
 181 #define NG_NETFLOW_CONF_EGRESS          2
 182 #define NG_NETFLOW_CONF_ONCE            4
 183 #define NG_NETFLOW_CONF_THISONCE        8
 184 };
 185 .Ed
 186 .Pp
 187 Configuration is a bitmask of several options. Option NG_NETFLOW_CONF_INGRESS
 188 enabled by default enables ingress NetFlow generation (for data coming from
 189 ifaceX hook). Option NG_NETFLOW_CONF_EGRESS enables egress NetFlow (for data
 190 coming from outX hook). Option NG_NETFLOW_CONF_ONCE defines that packet should
 191 be accounted only once if it several times passes via netflow node. Option
 192 NG_NETFLOW_CONF_THISONCE defines that packet should be accounted only once
 193 if it several times passes via exactly this netflow node. Last two options are
 194 important to avoid duplicate accounting when both ingress and egress NetFlow
 195 are enabled.
 196 .It Dv NGM_NETFLOW_SETTEMPLATE Pq Ic settemplate
 197 Sets various timeouts to announce data flow templates
 198 (NetFlow v9-specific). This message requires
 199 .Vt "struct ng_netflow_settemplate"
 200 as an argument:
 201 .Bd -literal -offset 4n
 202 struct ng_netflow_settemplate {
 203         uint16_t time;          /* max time between announce */
 204         uint16_t packets;       /* max packets between announce */
 205 };
 206 .Ed
 207 .Pp
 208 Value of time field represents time in seconds to re-announce data templates.
 209 Value of packets field represents maximum packets count between
 210 re-announcing data templates.
 211 .It Dv NGM_NETFLOW_SETMTU Pq Ic setmtu
 212 Sets export interface MTU to build packets of specified size (NetFlow v9-specific).
 213 This message requires
 214 .Vt "struct ng_netflow_setmtu"
 215 as an argument:
 216 .Bd -literal -offset 4n
 217 struct ng_netflow_setemtu {
 218         uint16_t mtu;           /* MTU for packet */
 219 };
 220 .Ed
 221 .Pp
 222 Default is 1500 bytes.
 223 .It Dv NGM_NETFLOW_SHOW
 224 This control message asks a node to dump the entire contents of the flow cache.
 225 It is called from
 226 .Xr flowctl 8 ,
 227 not directly from
 228 .Xr ngctl 8 .
 229 See also
 230 .Sx BUGS
 231 section.
 232 .It Dv NGM_NETFLOW_V9INFO Pq Ic v9info
 233 Returns some NetFlow v9 related values in a
 234 .Bd -literal -offset 4n
 235 struct ng_netflow_v9info {
 236     uint16_t        templ_packets;  /* v9 template packets */
 237     uint16_t        templ_time;     /* v9 template time */
 238     uint16_t        mtu;            /* v9 MTU */
 239 };
 240 .Ed
 241 .El
 242 .Sh SHUTDOWN
 243 This node shuts down upon receipt of a
 244 .Dv NGM_SHUTDOWN
 245 control message, or when all hooks have been disconnected.
 246 .Sh EXAMPLES
 247 The simplest possible configuration is one Ethernet interface, where
 248 flow collecting is enabled.
 249 .Bd -literal -offset indent
 250 /usr/sbin/ngctl -f- <<-SEQ
 251         mkpeer fxp0: netflow lower iface0
 252         name fxp0:lower netflow
 253         connect fxp0: netflow: upper out0
 254         mkpeer netflow: ksocket export inet/dgram/udp
 255         msg netflow:export connect inet/10.0.0.1:4444
 256 SEQ
 257 .Ed
 258 .Pp
 259 This is a more complicated example of a router with 2 NetFlow-enabled
 260 interfaces
 261 .Li fxp0
 262 and
 263 .Li ng0 .
 264 Note that the
 265 .Va ng0:
 266 node in this example is connected to
 267 .Xr ng_tee 4 .
 268 The latter sends us a copy of IP packets, which we analyze and free.
 269 On
 270 .Va fxp0:
 271 we do not use tee, but send packets back to either node.
 272 .Bd -literal -offset indent
 273 /usr/sbin/ngctl -f- <<-SEQ
 274         # connect ng0's tee to iface0 hook
 275         mkpeer ng0:inet netflow right2left iface0
 276         name ng0:inet.right2left netflow
 277         # set DLT to raw mode
 278         msg netflow: setdlt { iface=0 dlt=12 }
 279         # set interface index (5 in this example)
 280         msg netflow: setifindex { iface=0 index=5 }
 281
 282         # Connect fxp0: to iface1 and out1 hook
 283         connect fxp0: netflow: lower iface1
 284         connect fxp0: netflow: upper out1
 285
 286         # Create ksocket node on export hook, and configure it
 287         # to send exports to proper destination
 288         mkpeer netflow: ksocket export inet/dgram/udp
 289         msg netflow:export connect inet/10.0.0.1:4444
 290 SEQ
 291 .Ed
 292 .Sh SEE ALSO
 293 .Xr netgraph 4 ,
 294 .Xr setfib 2 ,
 295 .Xr ng_ether 4 ,
 296 .Xr ng_iface 4 ,
 297 .Xr ng_ksocket 4 ,
 298 .Xr ng_tee 4 ,
 299 .Xr flowctl 8 ,
 300 .Xr ngctl 8
 301 .Rs
 302 .%A B. Claise, Ed
 303 .%T "Cisco Systems NetFlow Services Export Version 9"
 304 .%O RFC 3954
 305 .Re
 306 .Pp
 307 .Pa http://www.cisco.com/en/US/docs/ios/solutions_docs/netflow/nfwhite.html
 308 .Sh AUTHORS
 309 .An -nosplit
 310 The
 311 .Nm
 312 node type was written by
 313 .An Gleb Smirnoff Aq glebius@FreeBSD.org ,
 314 .An Alexander Motin Aq mav@FreeBSD.org ,
 315 .An Alexander Chernikov Aq melifaro@ipfw.ru .
 316 The initial code was based on
 317 .Nm ng_ipacct
 318 written by
 319 .An Roman V. Palagin Aq romanp@unshadow.net .
 320 .Sh BUGS
 321 Cache snapshot obtained via
 322 .Dv NGM_NETFLOW_SHOW
 323 command may lack some percentage of entries under severe load.
 324 IPv6 flows are not shown.
 325 .Pp
 326 The
 327 .Nm
 328 node type does not fill in AS numbers.
 329 This is due to the lack of necessary information in the kernel routing table.
 330 However, this information can be injected into the kernel from a routing daemon
 331 such as GNU Zebra.
 332 This functionality may become available in future releases.