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 .Sh HOOKS
  65 This node type supports up to
  66 .Dv NG_NETFLOW_MAXIFACES
  67 (default 65536) hooks named
  68 .Va iface0 , iface1 ,
  69 etc.,
  70 and the same number of hooks named
  71 .Va out0 , out1 ,
  72 etc.,
  73 plus two export hooks:
  74 .Va export
  75 (for NetFlow version 5) and
  76 .Va export9
  77 (for NetFlow version 9). Export can be done simultaneously for all supported
  78 export hooks. By default (ingress NetFlow enabled) node does NetFlow accounting of data
  79 received on
  80 .Va iface*
  81 hooks.
  82 If corresponding
  83 .Va out
  84 hook is connected, unmodified data is bypassed to it, otherwise data is freed.
  85 If data is received on
  86 .Va out
  87 hook, it is bypassed to corresponding
  88 .Va iface
  89 hook without any processing (egress NetFlow disabled by default).
  90 When full export datagram for an export protocol is built it is sent to the
  91 .Va export
  92 or
  93 .Va export9
  94 hook.
  95 In normal operation, one (or more) export hook is connected to the
  96 .Va inet/dgram/udp
  97 hook of the
  98 .Xr ng_ksocket 4
  99 node.
 100 .Sh CONTROL MESSAGES
 101 This node type supports the generic control messages, plus the following:
 102 .Bl -tag -width indent
 103 .It Dv NGM_NETFLOW_INFO Pq Ic info
 104 Returns some node statistics and the current timeout values in a
 105 .Vt "struct ng_netflow_info" .
 106 .It Dv NGM_NETFLOW_IFINFO Pq Ic ifinfo
 107 Returns information about the
 108 .Va iface Ns Ar N
 109 hook.
 110 The hook number is passed as an argument.
 111 .It Dv NGM_NETFLOW_SETDLT Pq Ic setdlt
 112 Sets data link type on the
 113 .Va iface Ns Ar N
 114 hook.
 115 Currently, supported types are raw IP datagrams and Ethernet.
 116 This message type uses
 117 .Vt "struct ng_netflow_setdlt"
 118 as an argument:
 119 .Bd -literal -offset 4n
 120 struct ng_netflow_setdlt {
 121         uint16_t iface;         /* which iface dlt change */
 122         uint8_t  dlt;           /* DLT_XXX from bpf.h */
 123 };
 124 .Ed
 125 .Pp
 126 The requested
 127 .Va iface Ns Ar N
 128 hook must already be connected, otherwise message send operation will
 129 return an error.
 130 .It Dv NGM_NETFLOW_SETIFINDEX Pq Ic setifindex
 131 In some cases,
 132 .Nm
 133 may be unable to determine the input interface index of a packet.
 134 This can happen if traffic enters the
 135 .Nm
 136 node before it comes to the system interface's input queue.
 137 An example of such a setup is capturing a traffic
 138 .Em between
 139 synchronous data line and
 140 .Xr ng_iface 4 .
 141 In this case, the input index should be associated with a given hook.
 142 The interface's index can be determined via
 143 .Xr if_nametoindex 3
 144 from userland.
 145 This message requires
 146 .Vt "struct ng_netflow_setifindex"
 147 as an argument:
 148 .Bd -literal -offset 4n
 149 struct ng_netflow_setifindex {
 150         uint16_t iface;         /* which iface index change */
 151         uint16_t index;         /* new index */
 152 };
 153 .Ed
 154 .Pp
 155 The requested
 156 .Va iface Ns Ar N
 157 hook must already be connected, otherwise the message
 158 send operation will return an error.
 159 .It Dv NGM_NETFLOW_SETTIMEOUTS Pq Ic settimeouts
 160 Sets values in seconds for NetFlow active/inactive timeouts.
 161 This message requires
 162 .Vt "struct ng_netflow_settimeouts"
 163 as an argument:
 164 .Bd -literal -offset 4n
 165 struct ng_netflow_settimeouts {
 166         uint32_t inactive_timeout;      /* flow inactive timeout */
 167         uint32_t active_timeout;        /* flow active timeout */
 168 };
 169 .Ed
 170 .It Dv NGM_NETFLOW_SETCONFIG Pq Ic setconfig
 171 Sets configuration for the specified interface.
 172 This message requires
 173 .Vt "struct ng_netflow_setconfig"
 174 as an argument:
 175 .Bd -literal -offset 4n
 176 struct ng_netflow_setconfig {
 177         uint16_t iface;         /* which iface config change */
 178         uint32_t conf;          /* new config */
 179 #define NG_NETFLOW_CONF_INGRESS         1
 180 #define NG_NETFLOW_CONF_EGRESS          2
 181 #define NG_NETFLOW_CONF_ONCE            4
 182 #define NG_NETFLOW_CONF_THISONCE        8
 183 };
 184 .Ed
 185 .Pp
 186 Configuration is a bitmask of several options. Option NG_NETFLOW_CONF_INGRESS
 187 enabled by default enables ingress NetFlow generation (for data coming from
 188 ifaceX hook). Option NG_NETFLOW_CONF_EGRESS enables egress NetFlow (for data
 189 coming from outX hook). Option NG_NETFLOW_CONF_ONCE defines that packet should
 190 be accounted only once if it several times passes via netflow node. Option
 191 NG_NETFLOW_CONF_THISONCE defines that packet should be accounted only once
 192 if it several times passes via exactly this netflow node. Last two options are
 193 important to avoid duplicate accounting when both ingress and egress NetFlow
 194 are enabled.
 195 .It Dv NGM_NETFLOW_SETTEMPLATE Pq Ic settemplate
 196 Sets various timeouts to announce data flow templates
 197 (NetFlow v9-specific). This message requires
 198 .Vt "struct ng_netflow_settemplate"
 199 as an argument:
 200 .Bd -literal -offset 4n
 201 struct ng_netflow_settemplate {
 202         uint16_t time;          /* max time between announce */
 203         uint16_t packets;       /* max packets between announce */
 204 };
 205 .Ed
 206 .Pp
 207 Value of time field represents time in seconds to re-announce data templates.
 208 Value of packets field represents maximum packets count between
 209 re-announcing data templates.
 210 .It Dv NGM_NETFLOW_SETMTU Pq Ic setmtu
 211 Sets export interface MTU to build packets of specified size (NetFlow v9-specific).
 212 This message requires
 213 .Vt "struct ng_netflow_setmtu"
 214 as an argument:
 215 .Bd -literal -offset 4n
 216 struct ng_netflow_setemtu {
 217         uint16_t mtu;           /* MTU for packet */
 218 };
 219 .Ed
 220 .Pp
 221 Default is 1500 bytes.
 222 .It Dv NGM_NETFLOW_SHOW
 223 This control message asks a node to dump the entire contents of the flow cache.
 224 It is called from
 225 .Xr flowctl 8 ,
 226 not directly from
 227 .Xr ngctl 8 .
 228 See also
 229 .Sx BUGS
 230 section.
 231 .It Dv NGM_NETFLOW_V9INFO Pq Ic v9info
 232 Returns some NetFlow v9 related values in a
 233 .Bd -literal -offset 4n
 234 struct ng_netflow_v9info {
 235     uint16_t        templ_packets;  /* v9 template packets */
 236     uint16_t        templ_time;     /* v9 template time */
 237     uint16_t        mtu;            /* v9 MTU */
 238 };
 239 .Ed
 240 .El
 241 .Sh SHUTDOWN
 242 This node shuts down upon receipt of a
 243 .Dv NGM_SHUTDOWN
 244 control message, or when all hooks have been disconnected.
 245 .Sh EXAMPLES
 246 The simplest possible configuration is one Ethernet interface, where
 247 flow collecting is enabled.
 248 .Bd -literal -offset indent
 249 /usr/sbin/ngctl -f- <<-SEQ
 250         mkpeer fxp0: netflow lower iface0
 251         name fxp0:lower netflow
 252         connect fxp0: netflow: upper out0
 253         mkpeer netflow: ksocket export inet/dgram/udp
 254         msg netflow:export connect inet/10.0.0.1:4444
 255 SEQ
 256 .Ed
 257 .Pp
 258 This is a more complicated example of a router with 2 NetFlow-enabled
 259 interfaces
 260 .Li fxp0
 261 and
 262 .Li ng0 .
 263 Note that the
 264 .Va ng0:
 265 node in this example is connected to
 266 .Xr ng_tee 4 .
 267 The latter sends us a copy of IP packets, which we analyze and free.
 268 On
 269 .Va fxp0:
 270 we do not use tee, but send packets back to either node.
 271 .Bd -literal -offset indent
 272 /usr/sbin/ngctl -f- <<-SEQ
 273         # connect ng0's tee to iface0 hook
 274         mkpeer ng0:inet netflow right2left iface0
 275         name ng0:inet.right2left netflow
 276         # set DLT to raw mode
 277         msg netflow: setdlt { iface=0 dlt=12 }
 278         # set interface index (5 in this example)
 279         msg netflow: setifindex { iface=0 index=5 }
 280
 281         # Connect fxp0: to iface1 and out1 hook
 282         connect fxp0: netflow: lower iface1
 283         connect fxp0: netflow: upper out1
 284
 285         # Create ksocket node on export hook, and configure it
 286         # to send exports to proper destination
 287         mkpeer netflow: ksocket export inet/dgram/udp
 288         msg netflow:export connect inet/10.0.0.1:4444
 289 SEQ
 290 .Ed
 291 .Sh SEE ALSO
 292 .Xr netgraph 4 ,
 293 .Xr setfib 2 ,
 294 .Xr ng_ether 4 ,
 295 .Xr ng_iface 4 ,
 296 .Xr ng_ksocket 4 ,
 297 .Xr ng_tee 4 ,
 298 .Xr flowctl 8 ,
 299 .Xr ngctl 8
 300 .Rs
 301 .%A B. Claise, Ed
 302 .%T "Cisco Systems NetFlow Services Export Version 9"
 303 .%O RFC 3954
 304 .Re
 305 .Pp
 306 .Pa http://www.cisco.com/en/US/docs/ios/solutions_docs/netflow/nfwhite.html
 307 .Sh AUTHORS
 308 .An -nosplit
 309 The
 310 .Nm
 311 node type was written by
 312 .An Gleb Smirnoff Aq glebius@FreeBSD.org ,
 313 .An Alexander Motin Aq mav@FreeBSD.org ,
 314 .An Alexander Chernikov Aq melifaro@ipfw.ru .
 315 The initial code was based on
 316 .Nm ng_ipacct
 317 written by
 318 .An Roman V. Palagin Aq romanp@unshadow.net .
 319 .Sh BUGS
 320 Cache snapshot obtained via
 321 .Dv NGM_NETFLOW_SHOW
 322 command may lack some percentage of entries under severe load.
 323 IPv6 flows are not shown.
 324 .Pp
 325 The
 326 .Nm
 327 node type does not fill in AS numbers.
 328 This is due to the lack of necessary information in the kernel routing table.
 329 However, this information can be injected into the kernel from a routing daemon
 330 such as GNU Zebra.
 331 This functionality may become available in future releases.