DragonFly On-Line Manual Pages
rwsetbuild(1) SiLK Tool Suite rwsetbuild(1)
NAME
rwsetbuild - Create a binary IPset file from list of IPs
SYNOPSIS
rwsetbuild [{--ip-ranges | --ip-ranges=DELIM}]
[--record-version=VERSION] [--invocation-strip]
[--note-add=TEXT] [--note-file-add=FILENAME]
[--compression-method=COMP_METHOD]
[{INPUT_TEXT_FILE | -} [{OUTPUT_SET_FILE | -}]]
rwsetbuild --help
rwsetbuild --version
DESCRIPTION
rwsetbuild creates a binary IPset file from textual input. The IPset
is written to the second command line argument if it has been
specified; otherwise the IPset is written to the standard output if the
standard output is not a terminal. rwsetbuild will not overwrite an
existing file unless the SILK_CLOBBER environment variable is set. The
textual input is read from the first command line argument if it has
been specified; otherwise the text is read from the standard input if
the standard input is not a terminal. A input file name of "stdin" or
"-" means the standard input; an output file name of "stdout" or "-"
means the standard output. rwsetbuild will read textual IPs from the
terminal if the standard input is explicitly given as the input.
rwsetbuild exits with an error if the input file cannot be read or the
output file cannot be written.
Comments are ignored in the input file; they begin with the '"#"'
symbol and continue to the end of the line. Whitespace and blank lines
are also ignored. Otherwise, a line should contain a single IP
addresses unless the --ip-ranges switch is specified, in which case a
line may contain two IP addresses separated by the user-specified
delimiter, which defaults to hyphen ("-").
rwsetbuild supports IPv4 addresses and, when SiLK has been built with
IPv6 support, IPv6 addresses. When the input contains a mixture of
IPv4 and IPv6 addresses, the IPv4 addresses are mapped into the
::ffff:0:0/96 block of IPv6. When writing the IPset, rwsetbuild
converts the output to IPv4 if all IPv6 addresses are in the
::ffff:0:0/96 block. rwsetbuild does not allow the input to contain
both integer values and IPv6 addresses.
Each IP address must be expressed in one of these formats:
o Canonical IPv4 address (i.e., dotted decimal---all 4 octets are
required):
10.1.2.4
o An unsigned 32-bit integer:
167838212
o Canonical IPv6 address:
2001:db8::f00
o Any of the above with a CIDR designation:
10.1.2.4/31
167838212/31
192.168.0.0/16
2001:db8::/48
o SiLK IP Wildcard: An IP Wildcard can represent multiple IPv4 or
IPv6 addresses. An IP Wildcard contains an IP in its canonical
form, except each part of the IP (where part is an octet for IPv4
or a hexadectet for IPv6) may be a single value, a range, a comma
separated list of values and ranges, or the letter "x" to signify
all values for that part of the IP (that is, "0-255" for IPv4).
You may not specify a CIDR suffix when using IP Wildcard notation.
IP Wildcard notation is not supported when the --ip-ranges switch
is specified.
10.x.1-2.4,5
2001:db8::aaab-ffff,aaaa,0-aaa9
o IP Range: An IPv4 address, an unsigned 32-bit integer, or an IPv6
address to use as the start of the range, a delimiter, and an IPv4
address, an unsigned 32-bit integer, or an IPv6 address to use as
the end of the range. The default delimiter is the hyphen ("-"),
but a different delimiter may be specified as a parameter to the
--ip-ranges switch. Whitespace around the IP addresses is ignored.
Only valid when --ip-ranges is specified.
10.1.2.4-10.1.2.5
167838212-167838213
192.168.0.0-192.168.255.255
2001:db8::f00-2001:db8::fff
If an IP address cannot be parsed, rwsetbuild exits with an error.
OPTIONS
Option names may be abbreviated if the abbreviation is unique or is an
exact match for an option. A parameter to an option may be specified
as --arg=param or --arg param, though the first form is required for
options that take optional parameters.
--ip-ranges
--ip-ranges=DELIM
Allow lines of the the input file to contain a pair of IP
addresses, separated by DELIM, that create an IP address range, and
do not allow the IP Wildcard syntax. A line may also contain a
single IP address or a 32-bit integer; these lines may have a CIDR
designation. CIDR designations are not supported on lines that
contain a pair of IP addresses. If DELIM is not specified, hyphen
('"-"') is used as the delimiter. When DELIM is a whitespace
character, any amount of whitespace may surround and separate the
two IP addresses. Since '"#"' is used to denote comments and
newline is used to denote records, neither is a valid delimiter
character.
--record-version=VERSION
Specify the format of the IPset records that are written to the
output. Valid values are 0, 2, 3, and 4. When the switch is not
provided, the SILK_IPSET_RECORD_VERSION environment variable is
checked for a version. A VERSION of 2 creates a file compatible
with SiLK 2.x, and it can only be used for IPsets containing IPv4
addresses. A VERSION of 3 creates a file that can only be read by
SiLK 3.0 or later. A VERSION of 4 creates a file that can only be
read by SiLK 3.7 or later. Version 4 files are smaller than
version 3 files. The default VERSION is 0, which uses version 2
for IPv4 IPsets and version 3 for IPv6 IPsets.
--invocation-strip
Do not record any command line history; that is, do not record the
current command line invocation in the output file.
--note-add=TEXT
Add the specified TEXT to the header of the output file as an
annotation. This switch may be repeated to add multiple
annotations to a file. To view the annotations, use the
rrwwffiilleeiinnffoo(1) tool.
--note-file-add=FILENAME
Open FILENAME and add the contents of that file to the header of
the output file as an annotation. This switch may be repeated to
add multiple annotations. Currently the application makes no
effort to ensure that FILENAME contains text; be careful that you
do not attempt to add a SiLK data file as an annotation.
--compression-method=COMP_METHOD
Specify how to compress the output. When this switch is not given,
output to the standard output or to named pipes is not compressed,
and output to files is compressed using the default chosen when
SiLK was compiled. The valid values for COMP_METHOD are determined
by which external libraries were found when SiLK was compiled. To
see the available compression methods and the default method, use
the --help or --version switch. SiLK can support the following
COMP_METHOD values when the required libraries are available.
none
Do not compress the output using an external library.
zlib
Use the zzlliibb(3) library for compressing the output, and always
compress the output regardless of the destination. Using zlib
produces the smallest output files at the cost of speed.
lzo1x
Use the lzo1x algorithm from the LZO real time compression
library for compression, and always compress the output
regardless of the destination. This compression provides good
compression with less memory and CPU overhead.
best
Use lzo1x if available, otherwise use zlib. Only compress the
output when writing to a file.
--help
Print the available options and exit.
--version
Print the version number and information about how SiLK was
configured, then exit the application.
EXAMPLE
In the following examples, the dollar sign ("$") represents the shell
prompt. The text after the dollar sign represents the command line.
Reading from a file:
$ echo 10.x.x.x > ten.txt
$ rwsetbuild ten.txt ten.set
$ echo 10.0.0.0/8 > ten.txt
$ rwsetbuild ten.txt ten.set
$ echo 10.0.0.0-10.255.255.255 > ten.txt
$ rwsetbuild --ip-ranges ten.txt ten.set
$ echo '167772160,184549375' > ten.txt
$ rwsetbuild --ip-ranges=, ten.txt ten.set
Reading from the standard input:
$ echo 192.168.x.x | rwsetbuild stdin private.set
Example input to rwsetbuild:
# A single address
10.1.2.4
# Two addresses in the same subnet
10.1.2.4,5
# The same two addresses
10.1.2.4/31
# The same two addresses
167838212/31
# A whole subnet
10.1.2.0-255
# The same whole subnet
10.1.2.x
# The same whole subnet yet again
10.1.2.0/24
# All RFC1918 space
10.0.0.0/8
172.16.0.0/12
192.168.0.0/16
# All RFC1918 space
10.x.x.x
172.16-20,21,22-31.x.x
192.168.x.x
# All RFC1918 space
167772160/8
2886729728/12
3232235520/16
# Everything ending in 255
x.x.x.255
# All addresses that end in 1-10
x.x.x.1-10
ENVIRONMENT
SILK_IPSET_RECORD_VERSION
This environment variable is used as the value for the
--record-version when that switch is not provided.
SILK_CLOBBER
The SiLK tools normally refuse to overwrite existing files.
Setting SILK_CLOBBER to a non-empty value removes this restriction.
SEE ALSO
rrwwsseett(1), rrwwsseettccaatt(1), rrwwsseettmmeemmbbeerr(1), rrwwsseettttooooll(1), rrwwffiilleeiinnffoo(1),
ssiillkk(7), zzlliibb(3)
NOTES
The --record-version switch was added in SiLK 3.0. Prior to SiLK 3.6,
the only supported arguments for the switch were 2 and 3, with the
default being 3. As of SiLK 3.6, the default is 0. Version 4 was
added in SiLK 3.7.
SiLK 3.11.0.1 2016-02-19 rwsetbuild(1)