Print this page
12743 man page spelling mistakes
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man4/ippool.4
+++ new/usr/src/man/man4/ippool.4
1 1 '\" te
2 2 .\" To view license terms, attribution, and copyright for IP Filter, the
3 -.\" default path is /usr/lib/ipf/IPFILTER.LICENCE. If the Illumos operating
3 +.\" default path is /usr/lib/ipf/IPFILTER.LICENCE. If the illumos operating
4 4 .\" environment has been installed anywhere other than the default, modify the
5 5 .\" given path to access the file at the installed location.
6 6 .\" Portions Copyright (c) 2015, Joyent, Inc.
7 -.TH IPPOOL 4 "April 9, 2016"
7 +.TH IPPOOL 4 "May 16, 2020"
8 8 .SH NAME
9 9 ippool, ippool.conf \- IP Pool file format
10 10 .SH DESCRIPTION
11 11 The format for files accepted by ippool is described by the following grammar:
12 12 .LP
13 13 .nf
14 14 line ::= table | groupmap .
15 15 table ::= "table" role tabletype .
16 16 groupmap ::= "group-map" inout role number ipfgroup
17 17 tabletype ::= ipftree | ipfhash .
18 18
19 19 role ::= "role" "=" "ipf" .
20 20 inout ::= "in" | "out" .
21 21
22 22 ipftree ::= "type" "=" "tree" number "{" addrlist "}" .
23 23 ipfhash ::= "type" "=" "hash" number hashopts "{" hashlist "}" .
24 24
25 25 ipfgroup ::= setgroup hashopts "{" grouplist "}" |
26 26 hashopts "{" setgrouplist "}" .
27 27 setgroup ::= "group" "=" groupname .
28 28
29 29 hashopts ::= size [ seed ] | seed .
30 30
31 31 size ::= "size" number .
32 32 seed ::= "seed" number .
33 33
34 34 addrlist ::= [ "!" ] addrmask ";" [ addrlist ] .
35 35 grouplist ::= groupentry ";" [ grouplist ] | addrmask ";" [ grouplist ] .
36 36
37 37 setgrouplist ::= groupentry ";" [ setgrouplist ] .
38 38
39 39 groupentry ::= addrmask "," setgroup .
40 40
41 41 hashlist ::= hashentry ";" [ hashlist ] .
42 42 hashentry ::= addrmask .
43 43
44 44 addrmask ::= ipaddr | ipaddr "/" mask .
45 45
46 46 mask ::= number | ipaddr .
47 47
48 48 groupname ::= number | name .
49 49
50 50 number ::= digit { digit } .
51 51
52 52 ipaddr = host-num "." host-num "." host-num "." host-num .
53 53 host-num = digit [ digit [ digit ] ] .
54 54
|
↓ open down ↓ |
37 lines elided |
↑ open up ↑ |
55 55 digit ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" .
56 56 name ::= letter { letter | digit } .
57 57 .fi
58 58 .PP
59 59 The IP pool configuration file is used for defining a single object that
60 60 contains a reference to multiple IP address/netmask pairs. A pool may consist
61 61 of a mixture of netmask sizes, from 0 to 32.
62 62 .PP
63 63 At this point in time, only IPv4 addressing is supported.
64 64 .SH OVERVIEW
65 -.PP
66 65 The IP pool configuration file provides for defining two different mechanisms
67 66 for improving speed in matching IP addresses with rules.
68 67 The first,
69 68 .B table
70 69 , defines a lookup
71 70 .I table
72 71 to provide a single reference in a
73 72 filter rule to multiple targets and the second,
74 73 .B group-map
75 74 , provides a mechanism to target multiple groups from a single filter line.
76 75 .PP
77 76 The
78 77 .B group-map
|
↓ open down ↓ |
3 lines elided |
↑ open up ↑ |
79 78 command can only be used with filter rules that use the
80 79 .B call
81 80 command to invoke either
82 81 .B fr_srcgrpmap
83 82 or
84 83 .B fr_dstgrpmap
85 84 , to use the source or destination address,
86 85 respectively, for determining which filter group to jump to next for
87 86 continuation of filter packet processing.
88 87 .SH POOL TYPES
89 -.PP
90 88 Two storage formats are provided: hash tables and tree structure. The hash
91 89 table is intended for use with objects all containing the same netmask or a
92 90 few different sized netmasks of non-overlapping address space and the tree
93 91 is designed for being able to support exceptions to a covering mask, in
94 92 addition to normal searching as you would do with a table. It is not possible
95 93 to use the tree data storage type with
96 94 .B group-map
97 95 configuration entries.
98 96 .SH POOL ROLES
99 -.PP
100 -When a pool is defined in the configruation file, it must have an associated
97 +When a pool is defined in the configuration file, it must have an associated
101 98 role. At present the only supported role is
102 99 .B ipf.
103 100 Future development will see further expansion of their use by other sections
104 101 of IPFilter code.
105 102 .SH EXAMPLES
106 103 The following examples show how the pool configuration file is used with
107 104 the ipf configuration file to enhance the ability for the ipf configuration
108 105 file to be succinct in meaning.
109 106 .TP
110 107 1
111 108 The first example shows how a filter rule makes reference to a specific
112 109 pool for matching of the source address.
113 110 .nf
114 111 pass in from pool/100 to any
115 112 .fi
116 113 .PP
117 114 The pool configuration, which matches IP addresses 1.1.1.1 and any
118 115 in 2.2.0.0/16, except for those in 2.2.2.0/24.
119 116 .PP
120 117 .nf
121 118 table role = ipf type = tree number = 100
122 119 { 1.1.1.1/32; 2.2.0.0/16; !2.2.2.0/24 };
123 120 .fi
124 121 .TP
125 122 2
126 123 The following ipf.conf extract uses the
127 124 fr_srcgrpmap/fr_dstgrpmap lookups to use the
128 125 .B group-map
129 126 facility to lookup the next group to use for filter processing, providing
130 127 the
131 128 .B call
132 129 filter rule is matched.
133 130 .nf
134 131 call now fr_srcgrpmap/1010 in all
135 132 call now fr_dstgrpmap/2010 out all
136 133 pass in all group 1020
137 134 block in all group 1030
138 135 pass out all group 2020
139 136 block out all group 2040
140 137 .fi
141 138 .PP
142 139 A ippool configuration to work with the above ipf.conf file might
143 140 look like this:
144 141 .PP
145 142 .nf
146 143 group-map in role = ipf number = 1010
147 144 { 1.1.1.1/32, group = 1020; 3.3.0.0/16, group = 1030; };
148 145 group-map out role = ipf number = 2010 group = 2020
149 146 { 2.2.2.2/32; 4.4.0.0/16; 5.0.0.0/8, group = 2040; };
150 147 .fi
151 148 .SH FILES
152 149 /dev/iplookup
153 150 .br
154 151 /etc/ippool.conf
155 152 .br
156 153 /etc/hosts
157 154 .SH SEE ALSO
158 155 \fBippool\fR(1M), \fBhosts\fR(4), \fBipf\fR(4), \fBipf\fR(1M), \fBipnat\fR(1M),
159 156 \fBipfilter\fR(5)
|
↓ open down ↓ |
49 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX