Debian Codegraph @

examples/README

raw
1 /*
2 * Argus-5.0 Client Software. Tools to read, analyze and manage Argus data.
3 * Copyright (c) 2000-2024 QoSient, LLC
4 * All rights reserved.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3, or (at your option)
9 * any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 *
20 */
21
22 Argus-5.0 Clients
23 QoSient, LLC
24 [email protected]
25 http:/qosient.com
26
27 This directory contains source code for example programs that
28 demonstrate additional reading, parsing and processing of Argus
29 data. The types of functions that these examples provide include:
30
31 argus data environment
32 ratop - realtime argus data processing environment (curses based)
33 provides vi() like functionality for streaming and file based flow data,
34 supporting printing, searching, editing, sorting, writing argus data.
35
36 argus data processing
37 raconvert - ascii to binary data record conversion
38 raevent - non flow data printing
39 rafilteraddr - high performance filtering
40 ralabel - semantic enhancement / metadata tagging
41 rastream - stream block processing
42 rastrip - data compression
43
44 analytics
45 rahisto - frequency distribution analysis for argus data metrics
46
47 graphing
48 ragraph - time series graphing (rrd-tool based)
49 raplot - general plotting (gnuplot based)
50
51 storage management
52 ramysql - mysql based utilities
53 rasql - read native argus data from mysql database tables.
54 rasqlcheckconf - insert and read argus configurations from/to mysql data tables.
55 rasqlinsert - insert and read argus data from/to mysql data tables.
56 rasqltimeindex - generate argus data file time indexes for searching.
57
58 forensics
59 radump - decode captured user data
60 ragrep - regular expression matching from captured user data
61 raservices - user data analysis to determine used protocol
62 radecode - use tshark to decode captured user data
63
64 reporting
65 radark - scanner detection and reporting
66 rascan - scanner detection and reporting
67 rahosts - IP address inventory reporting
68 raips - IP address inventory reporting
69 rapath - print topology information derived from argus data
70 rapolicy - continuous access control policy verification
71 raports - application port usage
72 rarpwatch - arpwatch driven using argus data
73 ratimerange - argus data file time span
74
75 development
76 ratemplate - ra client development template when using the argus clients library.
77
78 Problems, bugs, questions, desirable enhancements, source code
79 contributions, etc., should be sent to the Argus mailing list
80 email address, "[email protected]".
81
82 ************************************************************
83
84 IMPORTANT:
85
86 Send bug (error) reports, questions and comments to the mailing
87 list at [email protected].
88
89 Please use the './bin/argusclientbug' script when posting bug reports
90 about Argus clients. Argusclientbug will gather some information about your
91 system and start your editor with a form in which you can describe
92 your problem. Delete information that you consider non-relevant
93 to your problem. Bug reports not generated by Argusbug might
94 be silently ignored by the Argus maintainers, so please use the
95 tool. A report that says 'Argus does not work. Why?' will
96 not be considered a valid bug report.
97
98 ************************************************************
99
100
101 Carter Bullard
102 [email protected]
103