contrib/pf/man/pfsync.4

   1 .\"     $OpenBSD: pfsync.4,v 1.28 2009/02/17 10:05:18 dlg 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 .\" $FreeBSD$
  28 .\"
  29 .Dd February 17 2009
  30 .Dt PFSYNC 4
  31 .Os
  32 .Sh NAME
  33 .Nm pfsync
  34 .Nd packet filter state table sychronisation interface
  35 .Sh SYNOPSIS
  36 .Cd "device pfsync"
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 interface is a pseudo-device which exposes certain changes to the state
  41 table used by
  42 .Xr pf 4 .
  43 State changes can be viewed by invoking
  44 .Xr tcpdump 1
  45 on the
  46 .Nm
  47 interface.
  48 If configured with a physical synchronisation interface,
  49 .Nm
  50 will also send state changes out on that interface,
  51 and insert state changes received on that interface from other systems
  52 into the state table.
  53 .Pp
  54 By default, all local changes to the state table are exposed via
  55 .Nm .
  56 State changes from packets received by
  57 .Nm
  58 over the network are not rebroadcast.
  59 Updates to states created by a rule marked with the
  60 .Ar no-sync
  61 keyword are ignored by the
  62 .Nm
  63 interface (see
  64 .Xr pf.conf 5
  65 for details).
  66 .Pp
  67 The
  68 .Nm
  69 interface will attempt to collapse multiple state updates into a single
  70 packet where possible.
  71 The maximum number of times a single state can be updated before a
  72 .Nm
  73 packet will be sent out is controlled by the
  74 .Ar maxupd
  75 parameter to ifconfig
  76 (see
  77 .Xr ifconfig 8
  78 and the example below for more details).
  79 The sending out of a
  80 .Nm
  81 packet will be delayed by a maximum of one second.
  82 .Sh NETWORK SYNCHRONISATION
  83 States can be synchronised between two or more firewalls using this
  84 interface, by specifying a synchronisation interface using
  85 .Xr ifconfig 8 .
  86 For example, the following command sets fxp0 as the synchronisation
  87 interface:
  88 .Bd -literal -offset indent
  89 # ifconfig pfsync0 syncdev fxp0
  90 .Ed
  91 .Pp
  92 By default, state change messages are sent out on the synchronisation
  93 interface using IP multicast packets to the 244.0.0.240 group address.
  94 An alternative destination address for
  95 .Nm
  96 packets can be specified using the
  97 .Ic syncpeer
  98 keyword.
  99 This can be used in combination with
 100 .Xr ipsec 4
 101 to protect the synchronisation traffic.
 102 In such a configuration, the syncdev should be set to the
 103 .Xr enc 4
 104 interface, as this is where the traffic arrives when it is decapsulated,
 105 e.g.:
 106 .Bd -literal -offset indent
 107 # ifconfig pfsync0 syncpeer 10.0.0.2 syncdev enc0
 108 .Ed
 109 .Pp
 110 It is important that the pfsync traffic be well secured
 111 as there is no authentication on the protocol and it would
 112 be trivial to spoof packets which create states, bypassing the pf ruleset.
 113 Either run the pfsync protocol on a trusted network \- ideally a network
 114 dedicated to pfsync messages such as a crossover cable between two firewalls,
 115 or specify a peer address and protect the traffic with
 116 .Xr ipsec 4 .
 117 .Sh EXAMPLES
 118 .Nm
 119 and
 120 .Xr carp 4
 121 can be used together to provide automatic failover of a pair of firewalls
 122 configured in parallel.
 123 One firewall will handle all traffic until it dies, is shut down, or is
 124 manually demoted, at which point the second firewall will take over
 125 automatically.
 126 .Pp
 127 Both firewalls in this example have three
 128 .Xr sis 4
 129 interfaces.
 130 sis0 is the external interface, on the 10.0.0.0/24 subnet; sis1 is the
 131 internal interface, on the 192.168.0.0/24 subnet; and sis2 is the
 132 .Nm
 133 interface, using the 192.168.254.0/24 subnet.
 134 A crossover cable connects the two firewalls via their sis2 interfaces.
 135 On all three interfaces, firewall A uses the .254 address, while firewall B
 136 uses .253.
 137 The interfaces are configured as follows (firewall A unless otherwise
 138 indicated):
 139 .Pp
 140 Interfaces configuration in
 141 .Pa /etc/rc.conf :
 142 .Bd -literal -offset indent
 143 network_interfaces="lo0 sis0 sis1 sis2"
 144 cloned_interfaces="carp0 carp1"
 145 ifconfig_sis0="10.0.0.254/24"
 146 ifconfig_sis1="192.168.0.254/24"
 147 ifconfig_sis2="192.168.254.254/24"
 148 ifconfig_carp0="vhid 1 pass foo 10.0.0.1/24"
 149 ifconfig_carp1="vhid 2 pass bar 192.168.0.1/24"
 150 pfsync_enable="YES"
 151 pfsync_syncdev="sis2"
 152 .Ed
 153 .Pp
 154 .Xr pf 4
 155 must also be configured to allow
 156 .Nm
 157 and
 158 .Xr carp 4
 159 traffic through.
 160 The following should be added to the top of
 161 .Pa /etc/pf.conf :
 162 .Bd -literal -offset indent
 163 pass quick on { sis2 } proto pfsync keep state (no-sync)
 164 pass on { sis0 sis1 } proto carp keep state (no-sync)
 165 .Ed
 166 .Pp
 167 It is preferable that one firewall handle the forwarding of all the traffic,
 168 therefore the
 169 .Ar advskew
 170 on the backup firewall's
 171 .Xr carp 4
 172 interfaces should be set to something higher than
 173 the primary's.
 174 For example, if firewall B is the backup, its
 175 carp1 configuration would look like this:
 176 would look like this:
 177 .Bd -literal -offset indent
 178 ifconfig_carp1="vhid 2 pass bar advskew 100 192.168.0.1/24"
 179 .Ed
 180 .Pp
 181 The following must also be added to
 182 .Pa /etc/sysctl.conf :
 183 .Bd -literal -offset indent
 184 net.inet.carp.preempt=1
 185 .Ed
 186 .Sh SEE ALSO
 187 .Xr bpf 4 ,
 188 .Xr carp 4 ,
 189 .Xr enc 4 ,
 190 .Xr inet 4 ,
 191 .Xr inet6 4 ,
 192 .Xr ipsec 4 ,
 193 .Xr netintro 4 ,
 194 .Xr pf 4 ,
 195 .Xr pf.conf 5 ,
 196 .Xr protocols 5 ,
 197 .Xr rc.conf 5 ,
 198 .Xr ifconfig 8 ,
 199 .Xr ifstated 8 ,
 200 .Xr tcpdump 1
 201 .Sh HISTORY
 202 The
 203 .Nm
 204 device first appeared in
 205 .Ox 3.3 .
 206 .Pp
 207 The
 208 .Nm
 209 protocol and kernel implementation were significantly modified between
 210 .Ox 4.4
 211 and
 212 .Ox 4.5 .
 213 The two protocols are incompatible and will not interoperate.