git Service of IN-Ulm e.V. Explore Help
Sign In
cbiedl
/
softflowd
1
0
Fork 0
Files
Tree: bb9a8c4e04
Branches Tags
softflowd
/
README

README 2.9 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384 
  1. Welcome to softflowd, a flow-based network monitor.
    2. 

  2. 

  3. Introduction
    4. 

  4. ------------
    5. 

  5. 

  6. softflowd listens promiscuously on a network interface and semi-statefully
    7. 

  7. tracks network flows. These flows can be reported using NetFlow version 1, 5 
    8. 

  8. or 9 datagrams. softflowd is fully IPv6 capable: it can track IPv6 flows and 
    9. 

  9. export to IPv6 hosts.
    10. 

  10. 

  11. More details about softflowd's function and usage may be found in the
    12. 

  12. supplied PDF manpages. They were built with:
    13. 

  13. 

  14. man -t ./softflowd.8 | ps2pdf - softflowd.pdf
    15. 

  15. man -t ./softflowctl.8 | ps2pdf - softflowctl.pdf
    16. 

  16. 

  17. You can view those pages prior to installation using:
    18. 

  18. 

  19. /usr/bin/nroff -c -mandoc softflowd.8 | less
    20. 

  20. /usr/bin/nroff -c -mandoc softflowctl.8 | less
    21. 

  21. 

  22. If you are in need of a NetFlow collector, you may be interested in 
    23. 

  23. softflowd's companion project "flowd" (http://www.mindrot.org/projects/flowd/). 
    24. 

  24. flowd is a NetFlow collector that is maintained in parallel with
    25. 

  25. softflowd and includes a few handy features, such as the ability
    26. 

  26. to filter flows it receives as well as Perl and Python APIs to its
    27. 

  27. storage format. NB. You don't have to use flowd: any NetFlow compatible 
    28. 

  28. collector should work with softflowd. An example Perl collector is included 
    29. 

  29. for testing purposes as collector.pl, but it doesn't yet support NetFlow v.9
    30. 

  30. 

  31. Installing
    32. 

  32. ----------
    33. 

  33. 

  34. Building softflowd should be as simple as typing:
    35. 

  35. 

  36. autoconf
    37. 

  37. autoreconf
    38. 

  38. ./configure
    39. 

  39. make
    40. 

  40. make install
    41. 

  41. 

  42. Unfortunately some systems like to make life complicated. Things work
    43. 

  43. fine on the systems that I develop and test on (OpenBSD and Linux).
    44. 

  44. There is peliminary support for Solaris 9 (i.e. it compiled), but no
    45. 

  45. testing on this platform has been performed.
    46. 

  46. 

  47. Licensing
    48. 

  48. ---------
    49. 

  49. 

  50. Softflowd is licensed under a two-term BSD license (see the source
    51. 

  51. files for details). The code in sys-tree.h is Copyright Niels Provos
    52. 

  52. <provos@citi.umich.edu> and comes straight from OpenBSD CVS, convtime.c
    53. 

  53. comes is Copyright Kevin Steves and comes from OpenSSH (misc.c). Both
    54. 

  54. of these files are licensed under two-term BSD licenses too. strlcpy.c,
    55. 

  55. strlcat.c and closefrom.c also come from OpenBSD CVS and are Copyright
    56. 

  56. Todd C. Miller. Please refer to the LICENSE file for full details.
    57. 

  57. 

  58. Reporting Bugs
    59. 

  59. --------------
    60. 

  60. 

  61. Please report bugs in softflowd (https://github.com/irino/softflowd/)
    62. 

  62. to https://github.com/irino/softflowd/issues
    63. 

  63. 

  64. Following descriptions are historical information:
    65. 

  65. Please report bugs in softflowd to http://bugzilla.mindrot.org/ If you
    66. 

  66. find a security bug, please report it directly by email. If you have any
    67. 

  67. feedback or questions, please email me:
    68. 

  68. 

  69. Contributing
    70. 

  70. ------------
    71. 

  71. 

  72. Softflowd has an extensive TODO list of interesting features, large and
    73. 

  73. small, that are waiting to be implemented. If you are interested in
    74. 

  74. helping, please contact me.
    75. 

  75. 

  76. The latest source code may be obtained from Github:
    77. 

  77. https://github.com/irino/softflowd/
    78. 

  78. (This repository was forked from http://code.google.com/p/softflowd/)
    79. 

  79. 

  80. Original creator:
    81. 

  81. Damien Miller <djm@mindrot.org>
    82. 

  82. 

  83. Current maintainer:
    84. 

  84. Hitoshi Irino <irino@sfc.wide.ad.jp>
    85.