GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  RADTOOL (1)

NAME

radtool - Realtime Anomaly Detector (RAD) tool

CONTENTS

Synopsis
Description
     Options
     Commands
Files
Environment Variables
See Also

SYNOPSIS

[-VdN] [-F fields] [-E ciphers] [-S certs] [-c cfile] [commands]

DESCRIPTION

Radtool connects and sends Advanced Exchange Access (AXA) protocol messages to Realtime Anomaly Detector (RAD) servers and displays the responses. It can also tunnel SIE data like radtunnel(1).

Radtool is a programming example for the Advanced Exchange Access (AXA) applications programming interface to RAD servers, the AXA protocol. It also demonstrates the use of the AXA helper library, libaxa.a.

Start using radtool with the connect command described below. Use one or more anomaly commands to specify interesting patterns of SIE messages or IP packets. Limit the number of packets or messages transmitted from the SRA server or displayed with the rate limit and count commands.

Unless more output is enabled with the verbose command, most messages or packets are displayed in two lines. The first line includes the channel number on which it was received, the SIE message vendor of the message, the name of the field that caused the message to be selected, and the contents of the field. The second line is a summary of the message or packet.

When more verbose output is enabled or when radtool does not understand the message, IP packets are printed in ASCII and SIE messages are printed in the standard nmsg presentation format also seen from nmsgtool(1).

    OPTIONS

The following arguments are available:
-V displays the version of radtool and its preferred version of the AXA protocol.
-d turns on tracing and debugging reports. Additional -d turn on more messages.
-F fields
  overrides the default location of the fields file that defines relationships among and semantics among SIE message fields. The default is $AXACONF/fields, ~/.axa/fields, or /usr/local/etc/axa/fields.
-E ciphers
  specifies the TLS encryption ciphers to use with TLS connections.
-S certs
  specifies the directory containing SSL certificates and keys. If -S is not used, radtool uses the first directory among $AXACONF/certs, ~/.axa/certs, and /usr/local/etc/axa/certs.
-c cfile
  reads commands from cfile as if the first command string on the command line were "source cfile".
commands
  are optional commands strings that are executed before radtool starts accepting commands from the use. There can be more than one string of commands Multiple commands within a string are separated by semicolons.

    COMMANDS

radtool executes commands read from the standard input. Command history is available if the standard input is a terminal. Multiple commands can be specified at once by separating them with semicolons. The following commands are available:
help [command]
  lists all commands or describes a single command.
exit ends radtool.
error mode [disconnect | off]
  disconnects from the RAD server and exits when the server reports an error or the connection breaks. In the default mode error mode off, errors are only reported.
debug [on | off | quiet | N]
  increases, decreases or shows the level of debugging and tracing messages that is also controlled by -d . Debug quiet turns off reports of successful AXA commands.
verbose [on | off | N]
  controls the length of SIE message and IP packet descriptions. The default, verbose off, generally displays one line summaries.
version
  displays the version of radtool and its version of the AXA protocol.
mode [SRA | RAD]
  Show the current command mode or expect to connect to an SRA or RAD server. The default command mode is set by the name of the program.
source filename
  reads and executes commands from a file.
connect [
.Sm off Ar tcp: Oo Ar user@ Oc Ar host,port Sm on |
.Sm off Ar unix: Oo Ar user@ Oc Ar /ud/socket Sm on |
.Sm off Ar ssh: Oo Ar user@ Oc Ar host Sm on |
.Sm off Ar tls:cert,key@host,port Sm on ]
  By itself connect shows the current connection. Otherwise connect to the specified RAD server.

Ssh: connections use ssh(1) configuration files including ssh_config(5) to specify the required public keys and optionally the fully qualified host names and user names associated with the public key. Use the "debug 4" command to diagnose ssh connection problems.

Tls: connections use the SSL certificate in the cert file and the private key in the key file. If not absolute, the files are in the -S certs directory.

disconnect
  disconnects from the RAD server.
count [N | off]
  sets terminal output to stop displaying packets after a number of packets (including immediately with a number of 0), show the currently remaining count, or turn off the packet count limit.
ciphers [cipher-list]
  set the list of ciphers for the next TLS connection or show the current contents of the list.
output
  Start, stop or show the state of forwarding packets received from the server. Received msg messages and IP packets can be forwarded as nmsg messages to a TCP or UDP port. Received IP packets can be forwarded as a pcap stream to a file, to a fifo created with separately ‘mkfio‘, or in Ethernet frames on a named network interface to a 48-bit address.

.Sm off nmsg: [tcp:|udp:] host,port
.Sm on Op Ar count
  sends nmsg messages to the tcp or udp host name and port number host,port. UDP is the default. IP packets are converted to nmsg messages.

.Sm off nmsg:file: path
.Sm on Op Ar count
  sends nmsg messages to the file. IP packets are converted to nmsg messages.

.Sm off pcap [-fifo]: file
.Sm on Op Ar count
  sends IP packets to a file or FIFO for examination with tcpdump(1) or another packet tracing tool. An ordinary file is the default. Only IP packets but not nmsg messages are sent.

.Sm off pcap-if: [dst /] ifname
.Sm on Op Ar count
  transmits IP packets on the network interface named ifname for examination with tcpdump(1) or another packet tracing tool. dst optionally specifies a destination 48-bit Ethernet address other than all 0:0:0:0:0:0 default. This output usually requires that radtool be run by root. Only IP packets but not nmsg messages are sent.

If count is present, forwarding stops after that many packets.
nop sends a command to the server that does nothing but test the connection.
user name
  sends a AXA_P_OP_USER command to the server.
rate limit[
  [-|MAX|per-sec op] [-|NEVER|report-secs] ] Tell the RAD server to report its rate limits or set rate limits and the interval between rate limit reports. Hits in excess of the rate limit are discarded by the server.
sample [X%]
  Get and optionally set the percentage of hits that the RAD servers sends.
window [bufsize]
  Get and optionally set the TCP output buffer size or maximum send window used by the server.
pause Tell the RAD server to stop sending data.
go Tell the RAD server to resume sending data.
sleep x.y
  Do nothing for x.y seconds.
accounting
  Tell the server to report counts of packets seen, missed, sent, and lost.
status
  Show information about the current connection state including time connected.
tag watch Brq ip=IP[/N][(shared) | dns=[*.]dom[(shared)]
  Specify IP addresses or domain names relevant to the anomaly detection modules specified by subsequent anomaly commands with the same tag. The optional [(shared)] suffix marks IP addresses or domains that are not exclusively used by the RAD client.

.Sm off ip= IP [/ n]
.Sm on
  The IPv4 or IPv6 address IP specifies a host address unless a prefix length is specified.

.Sm off dns= [*.] dom
.Sm on
  watches for the domain anywhere in the IP packets or SIE messages on the channels selected with -c . A wild card watches for occurrences of the domain and all sub-domains.

tag anomaly name [parameters]
  Start the named anomaly detector module. The relevant domains and IP addresses are specified by preceding watch commands with the same tag. The parameters for each module are described it its man page. Tag is a number that labels the module and the relevant watches as well as other modules using the same watches.
[taglist anomaly]
  If a tag is present, list the set of watches and anomaly detection modules with that tag. Without a tag, list all active as well as available anomaly detection modules
runits Ask the server to report user’s current RAD balance.

FILES

fields
  defines relationships among and meanings of SIE message fields. Its contents should rarely if ever need to be changed.
certs is the directory set with -S that contains TLS certificate and key files.
config
  is the ssh_config(5) configuration file used with connect ssh:... connections. If it is not specified explicitly by
.Sm off Fl z Fl F Sm on with the connect command, the usual ssh(1) sequence is used, starting with ~/.ssh/config. "Host" stanzas in the file can simplify connections to RAD servers.
~/.sratool_history
  contains the command history from previous radtool and/or sratool invocations

ENVIRONMENT VARIABLES

If set, AXACONF specifies the AXA configuration directory instead of, ~/.axa or /usr/local/etc/axa.

SEE ALSO

ip_probe(1), dns_binding(1), spam_watch(1), sratool(1), sratunnel(1), radtunnel(1), mkfifo(1), and nmsgtool(1).
Search for    or go to Top of page |  Section 1 |  Main Index


Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.