Trisul Executable
Thetrisulexecutable is located in/usr/local/bin/
.
Thetrisulexecutable is the actual probe process. One instance of trisul will run for every context. You rarely need to run this command manually, instead
- use the web interface menuAdmin > Start/Stop Tasks > Start Trisul on each probe
- use
trisulctl_probe start context ctxname
command line tool
Full command line
Just typetrisulto have it tell you the command line options.
[root@li76-90 ~]# trisul
Usage: trisul [--version|--machineid|--listdev] | [-demon|-nodemon] /path/to/config/file -mode {runmode} -in ifile -out ofile -args extra_args
{runmode} = select ONE of the following
* online_rxring - Linux RX RING [default]
online_pfring - Use native PF_RING API (requires libs)
online_libpcap - LIBPCAP
online_afpacket - AF_PACKET with FANOUT flow based load balancing
online_napa - Use Napatech API (requires libs)
offline - read pcap files (also need -in option)
idsalert - alerts only processing via unix socket
offlineoverlay - read pcap files overlaying on existing DB
idsalertoverlay - alerts only overlaying on stats db
crashpcap - for debugging, gen a pcap file from prev run
instant - for debugging, gen pkts from /dev/random like device
lua - a lua input filter drives the pipeline
Common operation
Checking Verison
[demo@li76-90 ~]$ trisul --version
6.0.1774
Getting machineid
You need to get the machineid in order to upgrade Trisul from the 3-day window free version to a licensed version.
[root@li76-90 ~]# trisul --machineid
00551AD4-CA00-BE16-3A42-1ACCFD6BF00D
Listing all available interface
[vivek@localhost trisul]$ trisul --listdev
[sudo] password for vivek:
---------------------------------------------------------------------------
Num Name Description
---------------------------------------------------------------------------
1 eth0 not available
2 wlan0 not available
3 usbmon1 USB bus number 1
4 usbmon2 USB bus number 2
5 any Pseudo-device that captures on all interfaces
6 lo not available
---------------------------------------------------------------------------
About run mode
Therun modecontrols what capabilities of Trisul are used while running.
The run mode is a combination of
- Packet Capture : type of capture mechanism
- Analytics Overlay : whether analytics are overlaid on top of existing metrics
Specifying the run mode from the web interface
To specify a run mode, go to Admin Tasks > Start/Stop Tasks then select run mode from drop down list for each probe
Available Feature in run mode
Runmode | Packet acquisition | Parameters |
---|---|---|
online_rxring | use RX RING | |
online_libpcap | use LIBPCAP | |
online_afpacket | use AF_PACKET | |
online_napa | use Napatech API (*requires libs see below ) | |
online_pfring | use native PF_RING API (*requires libs see below ) | |
offline | From capture file/directory | -in capture-file-dir |
idsalert | alerts only processing via unix socket | |
crashpcap | For debugging | |
instant | For debugging | |
offlineoverlay | From capture file/directory Overlay metrics on to existing data | |
idsalertoverlay | IDS alerts from unix socket Overlay metrics on to existing data | |
lua | a lua script drives the pipeline | -in lua-importscript.lua -args passed as T.args to your LUA script |
For PF_RING and other runmodes markedrequires libsyou need to copy the appropriate libXX.so file into/usr/local/lib/trisul-probe
. Trisul only ships with a stub implementation. For example : if you want to use PF_RING. Copy the compiled libpfring.so file into/usr/local/lib/trisul-probe
. This is due to licensing issues.
Examples
Normal run as a daemon
trisul -demon /usr/local/etc/trisul-probe/domain0/probe0/context0/trisulProbeConfig.xml -mode online_rxring
Normal run attached to terminal
trisul -nodemon /usr/local/etc/trisul-probe/domain0/probe0/context0/trisulProbeConfig.xml -mode online_rxring
Run trisul over capture files in a directory
All capture files must be in tcpdump (libpcap) format. Trisul supports both big and little endian pcap files.
- PCAPfiles in directory are automatically processed in order of the timestamp of the first packet in each file.
- capture files can be gzip or bzip2. The prefix must be gz or bzip2 of bz2.
You can process a singlePCAPfile, a directory ofPCAPfiles, or even nested directory trees
trisul -nodemon /usr/local/etc/trisul-probe/domain0/probe0/context0/trisulProbeConfig.xml -mode offline -in /home/vivek/mycaps/capdir
Run trisul for context named “satellitelinks”
Eachtrisul contextis defined by the corresponding trisulConfigcontextname
folder.
trisul -demon /usr/local/etc/trisul-probe/domain0/probe0/context_satellitelinks/trisulProbeConfig.xml -mode online_libpcap
Run trisul only looking at alerts
In this mode Trisul only looks atIDSalerts. The only meters activated are related to alerts, such as top hosts generating alerts, victim hosts, etc.
trisul -demon /usr/local/etc/trisul-probe/domain0/probe0/context0/trisulProbeConfig.xml -mode idsalert
Run trisul only looking at alerts
In this mode Trisul only looks atIDSalerts. The only meters activated are related to alerts, such as top hosts generating alerts, victim hosts, etc.
trisul -demon /usr/local/etc/trisul-probe/domain0/probe0/context0/trisulProbeConfig.xml -mode idsalert
Run trisul using aLUAinput filter script
If you want yourinputfilterscript at/home/kev/read_tcp.lua
to drive the Trisul pipeline use the following
trisul -demon /usr/local/etc/trisul-probe/domain0/probe0/context0/trisulProbeConfig.xml -mode lua -in /home/kev/read_tcp.lua -args argstolua-script