share/man/man4/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 December 20 2011
  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 .Pp
 118 .Nm
 119 has the following
 120 .Xr sysctl 8
 121 tunables:
 122 .Bl -tag -width ".Va net.pfsync"
 123 .It Va net.pfsync.carp_demotion_factor
 124 Value added to
 125 .Va net.inet.carp.demotion
 126 while
 127 .Nm
 128 tries to perform its bulk update.
 129 See
 130 .Xr carp 4
 131 for more information.
 132 Default value is 240.
 133 .El
 134 .Sh EXAMPLES
 135 .Nm
 136 and
 137 .Xr carp 4
 138 can be used together to provide automatic failover of a pair of firewalls
 139 configured in parallel.
 140 One firewall will handle all traffic until it dies, is shut down, or is
 141 manually demoted, at which point the second firewall will take over
 142 automatically.
 143 .Pp
 144 Both firewalls in this example have three
 145 .Xr sis 4
 146 interfaces.
 147 sis0 is the external interface, on the 10.0.0.0/24 subnet; sis1 is the
 148 internal interface, on the 192.168.0.0/24 subnet; and sis2 is the
 149 .Nm
 150 interface, using the 192.168.254.0/24 subnet.
 151 A crossover cable connects the two firewalls via their sis2 interfaces.
 152 On all three interfaces, firewall A uses the .254 address, while firewall B
 153 uses .253.
 154 The interfaces are configured as follows (firewall A unless otherwise
 155 indicated):
 156 .Pp
 157 Interfaces configuration in
 158 .Pa /etc/rc.conf :
 159 .Bd -literal -offset indent
 160 network_interfaces="lo0 sis0 sis1 sis2"
 161 ifconfig_sis0="10.0.0.254/24"
 162 ifconfig_sis0_alias0="inet 10.0.0.1/24 vhid 1 pass foo"
 163 ifconfig_sis1="192.168.0.254/24"
 164 ifconfig_sis1_alias0="inet 192.168.0.1/24 vhid 2 pass bar"
 165 ifconfig_sis2="192.168.254.254/24"
 166 pfsync_enable="YES"
 167 pfsync_syncdev="sis2"
 168 .Ed
 169 .Pp
 170 .Xr pf 4
 171 must also be configured to allow
 172 .Nm
 173 and
 174 .Xr carp 4
 175 traffic through.
 176 The following should be added to the top of
 177 .Pa /etc/pf.conf :
 178 .Bd -literal -offset indent
 179 pass quick on { sis2 } proto pfsync keep state (no-sync)
 180 pass on { sis0 sis1 } proto carp keep state (no-sync)
 181 .Ed
 182 .Pp
 183 It is preferable that one firewall handle the forwarding of all the traffic,
 184 therefore the
 185 .Ar advskew
 186 on the backup firewall's
 187 .Xr carp 4
 188 vhids should be set to something higher than
 189 the primary's.
 190 For example, if firewall B is the backup, its
 191 carp1 configuration would look like this:
 192 would look like this:
 193 .Bd -literal -offset indent
 194 ifconfig_sis1_alias0="inet 192.168.0.1/24 vhid 2 pass bar advskew 100"
 195 .Ed
 196 .Pp
 197 The following must also be added to
 198 .Pa /etc/sysctl.conf :
 199 .Bd -literal -offset indent
 200 net.inet.carp.preempt=1
 201 .Ed
 202 .Sh SEE ALSO
 203 .Xr bpf 4 ,
 204 .Xr carp 4 ,
 205 .Xr enc 4 ,
 206 .Xr inet 4 ,
 207 .Xr inet6 4 ,
 208 .Xr ipsec 4 ,
 209 .Xr netintro 4 ,
 210 .Xr pf 4 ,
 211 .Xr pf.conf 5 ,
 212 .Xr protocols 5 ,
 213 .Xr rc.conf 5 ,
 214 .Xr ifconfig 8 ,
 215 .Xr tcpdump 1
 216 .Sh HISTORY
 217 The
 218 .Nm
 219 device first appeared in
 220 .Ox 3.3 .
 221 It was first imported to
 222 .Fx 5.3 .
 223 .Pp
 224 The
 225 .Nm
 226 protocol and kernel implementation were significantly modified in
 227 .Fx 9.0 .
 228 The newer protocol is not compatible with older one and will not interoperate
 229 with it.