358ba7469b255ba29b708dc0be8104a043df7b42
[dragonfly.git] / share / man / man4 / pfsync.4
1 \"      $OpenBSD: pfsync.4,v 1.24 2006/10/23 07:05:49 jmc Exp $
2 .\"
3 .\" Copyright (c) 2002 Michael Shalayeff
4 .\" Copyright (c) 2003-2004 Ryan McBride
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF MIND,
22 .\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .Dd August 5, 2010
28 .Dt PFSYNC 4
29 .Os
30 .Sh NAME
31 .Nm pfsync
32 .Nd packet filter state table logging interface
33 .Sh SYNOPSIS
34 .Cd "device pfsync"
35 .Sh DESCRIPTION
36 The
37 .Nm
38 interface is a pseudo-device which exposes certain changes to the state
39 table used by
40 .Xr pf 4 .
41 State changes can be viewed by invoking
42 .Xr tcpdump 1
43 on the
44 .Nm
45 interface.
46 If configured with a physical synchronisation interface,
47 .Nm
48 will also send state changes out on that interface using IP multicast,
49 and insert state changes received on that interface from other systems
50 into the state table.
51 .Pp
52 By default, all local changes to the state table are exposed via
53 .Nm .
54 However, state changes from packets received by
55 .Nm
56 over the network are not rebroadcast.
57 States created by a rule marked with the
58 .Ar no-sync
59 keyword are omitted from the
60 .Nm
61 interface (see
62 .Xr pf.conf 5
63 for details).
64 .Pp
65 The
66 .Nm
67 interface will attempt to collapse multiple updates of the same
68 state into one message where possible.
69 The maximum number of times this can be done before the update is sent out
70 is controlled by the
71 .Ar maxupd
72 parameter to ifconfig
73 (see
74 .Xr ifconfig 8
75 and the example below for more details).
76 .Pp
77 Each packet retrieved on this interface has a header associated
78 with it of length
79 .Dv PFSYNC_HDRLEN .
80 The header indicates the version of the protocol, address family,
81 action taken on the following states, and the number of state
82 table entries attached in this packet.
83 This structure is defined in
84 .Aq Pa net/pf/if_pfsync.h
85 as:
86 .Bd -literal -offset indent
87 struct pfsync_header {
88         u_int8_t version;
89         u_int8_t af;
90         u_int8_t action;
91         u_int8_t count;
92 };
93 .Ed
94 .Sh NETWORK SYNCHRONISATION
95 States can be synchronised between two or more firewalls using this
96 interface, by specifying a synchronisation interface using
97 .Xr ifconfig 8 .
98 For example, the following command sets fxp0 as the synchronisation
99 interface:
100 .Bd -literal -offset indent
101 # ifconfig pfsync0 syncdev fxp0
102 .Ed
103 .Pp
104 By default, state change messages are sent out on the synchronisation
105 interface using IP multicast packets.
106 The protocol is IP protocol 240, PFSYNC, and the multicast group
107 used is 224.0.0.240.
108 When a peer address is specified using the
109 .Ic syncpeer
110 keyword, the peer address is used as a destination for the pfsync traffic,
111 and the traffic can then be protected using
112 .Xr ipsec 4 .
113 In such a configuration, the syncdev should be set to the
114 .Xr enc 4
115 interface, as this is where the traffic arrives when it is decapsulated,
116 e.g.:
117 .Bd -literal -offset indent
118 # ifconfig pfsync0 syncpeer 10.0.0.2 syncdev enc0
119 .Ed
120 .Pp
121 It is important that the pfsync traffic be well secured
122 as there is no authentication on the protocol and it would
123 be trivial to spoof packets which create states, bypassing the pf ruleset.
124 Either run the pfsync protocol on a trusted network \- ideally  a network
125 dedicated to pfsync messages such as a crossover cable between two firewalls,
126 or specify a peer address and protect the traffic with
127 .Xr ipsec 4 .
128 .Pp
129 There is a one-to-one correspondence between packets seen by
130 .Xr bpf 4
131 on the
132 .Nm
133 interface, and packets sent out on the synchronisation interface, i.e.\&
134 a packet with 4 state deletion messages on
135 .Nm
136 means that the same 4 deletions were sent out on the synchronisation
137 interface.
138 However, the actual packet contents may differ as the messages
139 sent over the network are "compressed" where possible, containing
140 only the necessary information.
141 .Sh EXAMPLES
142 .Bd -literal -offset indent
143 # ifconfig pfsync0 up syncif fxp0 maxupd 64
144 # tcpdump -s1500 -evtni pfsync0
145 .Ed
146 .Sh USING PFSYNC WITH CARP
147 .Nm
148 and
149 .Xr carp 4
150 can be used together to provide automatic failover of a pair of firewalls
151 configured in parallel.
152 One firewall handles all traffic \- if it dies or
153 is shut down, the second firewall takes over automatically.
154 .Pp
155 Both firewalls in this example have three
156 .Xr sis 4
157 interfaces.
158 sis0 is the external interface, on the 10.0.0.0/24 subnet; sis1 is the
159 internal interface, on the 192.168.0.0/24 subnet; and sis2 is the
160 .Nm
161 interface, using the 192.168.254.0/24 subnet.
162 A crossover cable connects the two firewalls via their sis2 interfaces.
163 On all three interfaces, firewall A uses the .254 address, while firewall B
164 uses .253.
165 The interfaces are configured as follows (firewall A unless otherwise
166 indicated):
167 .Pp
168 Interfaces configuration in
169 .Pa /etc/rc.conf :
170 .Bd -literal -offset indent
171 network_interfaces="lo0 sis0 sis1 sis2"
172 cloned_interfaces="carp0 carp1"
173 ifconfig_sis0="10.0.0.254/24"
174 ifconfig_sis1="192.168.0.254/24"
175 ifconfig_sis2="192.168.254.254/24"
176 ifconfig_carp0="vhid 1 pass foo 10.0.0.1/24"
177 ifconfig_carp1="vhid 2 pass bar 192.168.0.1/24"
178 pfsync_enable="YES"
179 pfsync_syncdev="sis2"
180 .Ed
181 .Pp
182 .Xr pf 4
183 must also be configured to allow
184 .Nm
185 and
186 .Xr carp 4
187 traffic through.
188 The following should be added to the top of
189 .Pa /etc/pf.conf :
190 .Bd -literal -offset indent
191 pass quick on { sis2 } proto pfsync
192 pass on { sis0 sis1 } proto carp
193 .Ed
194 .Pp
195 If it is preferable that one firewall handle the traffic,
196 the
197 .Ar advskew
198 on the backup firewall's
199 .Xr carp 4
200 interfaces should be set to something higher than
201 the primary's.
202 For example, if firewall B is the backup, its
203 carp1 configuration would look like this:
204 .Bd -literal -offset indent
205 ifconfig_carp1="vhid 2 pass bar advskew 100 192.168.0.1/24"
206 .Ed
207 .Pp
208 The following must also be added to
209 .Pa /etc/sysctl.conf :
210 .Bd -literal -offset indent
211 net.inet.carp.preempt=1
212 .Ed
213 .Sh SEE ALSO
214 .Xr bpf 4 ,
215 .Xr carp 4 ,
216 .Xr inet 4 ,
217 .Xr inet6 4 ,
218 .Xr ipsec 4 ,
219 .Xr netintro 4 ,
220 .Xr pf 4 ,
221 .Xr pf.conf 5 ,
222 .Xr protocols 5 ,
223 .Xr ifconfig 8 ,
224 .Xr ifstated 8 ,
225 .Xr tcpdump 1
226 .Sh HISTORY
227 The
228 .Nm
229 device first appeared in
230 .Ox 3.3
231 and was imported into
232 .Dx 1.1
233 by Devon H. O'Dell and Simon Schubert.