1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry>
<refentryinfo>
<author>
<firstname>Jem</firstname>
<surname>Berkes</surname>
</author>
<address>
<email>jem@berkes.ca</email>
</address>
<copyright>
<year>2013</year>
<holder>Jem Berkes</holder>
</copyright>
<date>Jan 4, 2014</date>
</refentryinfo>
<refmeta>
<refentrytitle>GREPCIDR</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>grepcidr</refname>
<refpurpose>Filter IPv4 and IPv6 addresses matching CIDR patterns</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>grepcidr</command>
<arg><option><replaceable>OPTIONS</replaceable></option></arg>
<arg choice="req">PATTERN</arg>
<arg><option><replaceable>FILE...</replaceable></option></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>grepcidr</command>
<arg><option><replaceable>OPTIONS</replaceable></option></arg>
<arg><option>-e <replaceable>PATTERN</replaceable></option> | <option>-f <replaceable>PATFILE</replaceable></option></arg>
<arg><option><replaceable>FILE...</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
<command>grepcidr</command> can be used to filter a list of IP addresses against one or more
Classless Inter-Domain Routing (CIDR) specifications. As with grep, there
are options to invert matching and load patterns from a file. <command>grepcidr</command> is
capable of efficiently processing large numbers of IPs and networks.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>-V</option></term>
<listitem>
<para>Show software version</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option></term>
<listitem>
<para>Display count of the matching lines, instead of showing the lines</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-i</option></term>
<listitem>
<para>Inverse match, include lines without an IP, implies -v</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option></term>
<listitem>
<para>Enforce strict alignment of CIDR mask; host portion must be all zero</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<listitem>
<para>Invert the sense of matching, output lines with IPs that don't match</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-x</option></term>
<listitem>
<para>Strict matching, only look at start of line</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-e</option></term>
<listitem>
<para>Specify individual IP or CIDR pattern(s) on command-line</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option></term>
<listitem>
<para>Load individual IP or CIDR pattern(s) from file</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>USAGE NOTES</title>
<para>
PATTERN specified on the command line may contain multiple patterns
separated by whitespace or commas. For long lists of network patterns,
use <option>-f</option> to load a file where each line contains one pattern (can be IPv4
or IPv6). Blank lines and comments starting with # are ignored.
</para>
<para>Each IPv4 pattern, whether on command line or loaded from a file, may be:</para>
<programlisting>
a.b.c.d/xy (CIDR format)
a.b.c.d-e.f.g.h (IP range)
a.b.c.d (Single IP)
</programlisting>
<para>And similarly for IPv6:</para>
<programlisting>
a:b:c::/xyz (CIDR format)
a:b:c:: (Single IP)
</programlisting>
<para>
Dotted-decimal IPv4 format, or any legal IPv6 format is supported (see: man inet_pton).
</para>
<para>
IP addresses that appear anywhere on the input line will be compared and
matched against the patterns. To be recognized, an IP (field) must end
with terminating text. An IPv4 field terminates upon anything other than
alphanumeric or dot. An IPv6 field terminates upon anything other than
alphanumeric, dot, or colon. This is to prevent accidental matching of
ambiguous text such as host names containing reverse DNS.
</para>
<para>
Use the <option>-x</option> option to do a strict parse without searching the whole line,
and <command>grepcidr</command> will only look for the single IP at the start of the line.
</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para><emphasis><command>grepcidr</command> -f ournetworks blacklist > abuse.log</emphasis></para>
<para>Find customers (CIDR ranges in file) that appear in blacklist</para>
<para><emphasis><command>grepcidr</command> 2001:db8::/32 log.1 log.2</emphasis></para>
<para>Search for this IPv6 network inside two files</para>
<para><emphasis><command>grepcidr</command> 127.0.0.0/8 iplog</emphasis></para>
<para>Searches for any localnet IP addresses inside the iplog file</para>
<para><emphasis><command>grepcidr</command> "192.168.0.1-192.168.10.13" iplog</emphasis></para>
<para>Searches for IPs matching indicated range in the iplog file</para>
<para><emphasis><command>script</command> | <command>grepcidr</command> -vf whitelist > blacklist</emphasis></para>
<para>Create a blacklist, with whitelisted networks removed (inverse)</para>
<para><emphasis><command>grepcidr</command> -f list1 list2</emphasis></para>
<para>Cross-reference two lists, outputs IPs common to both lists</para>
</refsect1>
<refsect1>
<title>EXIT STATUS</title>
<para>
As with grep: the exit status is 0 if matching IPs are found, and 1
if not found. If an error occurred the exit status is 2.
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This software and manual page was written by Jem Berkes <jem@berkes.ca>
based on the first man page and DocBook format contributed by Ryan Finnie.
Permission is granted to copy, distribute and/or modify this document under
the terms of the GNU General Public License, Version 2 or any later version
published by the Free Software Foundation.
</para>
</refsect1>
<refsect1>
<title>WEB SITE</title>
<para>
http://www.pc-tools.net/unix/grepcidr/
</para>
</refsect1>
<refsect1>
<title>THANKS</title>
<para>
Sponsored in part by the Spamhaus Project, http://www.spamhaus.org/
</para>
<para>
Thanks to John Levine <johnl@taugh.com> for sharing his alternative
implementation. I used a couple ideas from his code, such as portable 128-bit
numbers and support for multiple input files. However, John's version is quite
different and represents a significant fork in the project.
</para>
<para>
Thanks to Ryan Finnie <ryan@finnie.org> for his work on the Debian package.
I've adopted several of his changes including the Makefile, and the DocBook
format which now is the source of the man page. Thanks to Ryan for writing
the first manual in DocBook format.
</para>
<para>
Many thanks to Dick Wesseling <ftu@fi.uu.nl> who suggested an improved data
structure format as well as binary search, to improve grepcidr performance.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|
