summaryrefslogtreecommitdiff
path: root/docs/configuration/service/conntrack-sync.rst
blob: 5ef80396be719de8b8a0e6afd7f036213e9f9631 (plain)
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
.. _conntrack-sync:

##############
Conntrack Sync
##############

One of the important features built on top of the Netfilter framework is
connection tracking. Connection tracking allows the kernel to keep track of all
logical network connections or sessions, and thereby relate all of the packets
which may make up that connection. NAT relies on this information to translate
all related packets in the same way, and iptables can use this information to
act as a stateful firewall.

The connection state however is completely independent of any upper-level
state, such as TCP's or SCTP's state. Part of the reason for this is that when
merely forwarding packets, i.e. no local delivery, the TCP engine may not
necessarily be invoked at all. Even connectionless-mode transmissions such as
UDP, IPsec (AH/ESP), GRE and other tunneling protocols have, at least, a pseudo
connection state. The heuristic for such protocols is often based upon a preset
timeout value for inactivity, after whose expiration a Netfilter connection is
dropped.

Each Netfilter connection is uniquely identified by a (layer-3 protocol, source
address, destination address, layer-4 protocol, layer-4 key) tuple. The layer-4
key depends on the transport protocol; for TCP/UDP it is the port numbers, for
tunnels it can be their tunnel ID, but otherwise is just zero, as if it were
not part of the tuple. To be able to inspect the TCP port in all cases, packets
will be mandatorily defragmented.

It is possible to use either Multicast or Unicast to sync conntrack traffic.
Most examples below show Multicast, but unicast can be specified by using the
"peer" keywork after the specificed interface, as in the following example:

:cfgcmd:`set service conntrack-sync interface eth0 peer 192.168.0.250`

*************
Configuration
*************

.. cfgcmd:: set service conntrack-sync accept-protocol

    Accept only certain protocols: You may want to replicate the state of flows
    depending on their layer 4 protocol.

    Protocols are: tcp, sctp, dccp, udp, icmp and ipv6-icmp.

.. cfgcmd:: set service conntrack-sync event-listen-queue-size <size>

    The daemon doubles the size of the netlink event socket buffer size if it
    detects netlink event message dropping. This clause sets the maximum buffer
    size growth that can be reached.

    Queue size for listening to local conntrack events in MB.

.. cfgcmd:: set service conntrack-sync expect-sync <all|ftp|h323|nfs|sip|sqlnet>

    Protocol for which expect entries need to be synchronized.

.. cfgcmd:: set service conntrack-sync failover-mechanism vrrp sync-group <group>

    Failover mechanism to use for conntrack-sync.

    Only VRRP is supported. Required option.

.. cfgcmd:: set service conntrack-sync ignore-address <x.x.x.x>

    IP addresses or networks for which local conntrack entries will not be synced

.. cfgcmd:: set service conntrack-sync interface <name>

    Interface to use for syncing conntrack entries.

.. cfgcmd:: set service conntrack-sync interface <name> port <port>

   Port number used by connection.

.. cfgcmd:: set service conntrack-sync listen-address <ipv4address>

   Local IPv4 addresses for service to listen on.

.. cfgcmd:: set service conntrack-sync mcast-group <x.x.x.x>

    Multicast group to use for syncing conntrack entries.

    Defaults to 225.0.0.50.

.. cfgcmd:: set service conntrack-sync interface <name> peer <address>

    Peer to send unicast UDP conntrack sync entires to, if not using Multicast
    configuration from above above.

.. cfgcmd:: set service conntrack-sync sync-queue-size <size>

    Queue size for syncing conntrack entries in MB.

.. cfgcmd:: set service conntrack-sync disable-external-cache

   This diable the external cache and directly injects the flow-states into the
   in-kernel Connection Tracking System of the backup firewall.

<<<<<<< HEAD
=======
.. cfgcmd:: set service conntrack-sync disable-syslog

   Disable connection logging via Syslog.

.. cfgcmd:: set service conntrack-sync enable-startup-resync

   Order conntrackd to request a complete conntrack table resync against
   the other node at startup.

>>>>>>> f4e6d33a (conntrack-sync: T1244: Support for StartupResync in conntrackd)
*********
Operation
*********

.. opcmd:: show conntrack table ipv4

  Make sure conntrack is enabled by running and show connection tracking table.

  .. code-block:: none

    vyos@vyos:~$ show conntrack table ipv4
    TCP state codes: SS - SYN SENT, SR - SYN RECEIVED, ES - ESTABLISHED,
                     FW - FIN WAIT, CW - CLOSE WAIT, LA - LAST ACK,
                     TW - TIME WAIT, CL - CLOSE, LI - LISTEN

    CONN ID    Source                 Destination            Protocol         TIMEOUT
    1015736576 10.35.100.87:58172     172.31.20.12:22        tcp [6] ES       430279
    1006235648 10.35.101.221:57483    172.31.120.21:22       tcp [6] ES       413310
    1006237088 10.100.68.100          172.31.120.21          icmp [1]         29
    1015734848 10.35.100.87:56282     172.31.20.12:22        tcp [6] ES       300
    1015734272 172.31.20.12:60286     239.10.10.14:694       udp [17]         29
    1006239392 10.35.101.221          172.31.120.21          icmp [1]         29

  .. note::
  
    If the table is empty and you have a warning message, it means
    conntrack is not enabled. To enable conntrack, just create a NAT or a firewall
    rule. :cfgcmd:`set firewall state-policy established action accept`

.. opcmd:: show conntrack-sync cache external

  Show connection syncing external cache entries

.. opcmd:: show conntrack-sync cache internal

  Show connection syncing internal cache entries

.. opcmd:: show conntrack-sync statistics

  Retrieve current statistics of connection tracking subsystem.

  .. code-block:: none

    vyos@vyos:~$ show conntrack-sync statistics
    Main Table Statistics:

    cache internal:
    current active connections:            19606
    connections created:                 6298470    failed:            0
    connections updated:                 3786793    failed:            0
    connections destroyed:               6278864    failed:            0

    cache external:
    current active connections:            15771
    connections created:                 1660193    failed:            0
    connections updated:                   77204    failed:            0
    connections destroyed:               1644422    failed:            0

    traffic processed:
                       0 Bytes                         0 Pckts

    multicast traffic (active device=eth0.5):
               976826240 Bytes sent            212898000 Bytes recv
                 8302333 Pckts sent              2009929 Pckts recv
                       0 Error send                    0 Error recv

    message tracking:
                       0 Malformed msgs                  263 Lost msgs


.. opcmd:: show conntrack-sync status

  Retrieve current status of connection tracking subsystem.

  .. code-block:: none

    vyos@vyos:~$ show conntrack-sync status
    sync-interface        : eth0.5
    failover-mechanism    : vrrp [sync-group GEFOEKOM]
    last state transition : no transition yet!
    ExpectationSync       : disabled


*******
Example
*******

The next example is a simple configuration of conntrack-sync.

.. figure:: /_static/images/service_conntrack_sync-schema.png
   :scale: 60 %
   :alt: Conntrack Sync Example

Now configure conntrack-sync service on ``router1`` **and** ``router2``

.. code-block:: none

  set high-availablilty vrrp group internal virtual-address ... etc ...
  set high-availability vrrp sync-group syncgrp member 'internal'
  set service conntrack-sync accept-protocol 'tcp'
  set service conntrack-sync accept-protocol 'udp'
  set service conntrack-sync accept-protocol 'icmp'
  set service conntrack-sync failover-mechanism vrrp sync-group 'syncgrp'
  set service conntrack-sync interface 'eth0'
  set service conntrack-sync mcast-group '225.0.0.50'

On the active router, you should have information in the internal-cache of
conntrack-sync. The same current active connections number should be shown in
the external-cache of the standby router

On active router run:

.. code-block:: none

  $ show conntrack-sync statistics

  Main Table Statistics:

  cache internal:
  current active connections:               10
  connections created:                    8517    failed:            0
  connections updated:                     127    failed:            0
  connections destroyed:                  8507    failed:            0

  cache external:
  current active connections:                0
  connections created:                       0    failed:            0
  connections updated:                       0    failed:            0
  connections destroyed:                     0    failed:            0

  traffic processed:
                     0 Bytes                         0 Pckts

  multicast traffic (active device=eth0):
                868780 Bytes sent               224136 Bytes recv
                 20595 Pckts sent                14034 Pckts recv
                     0 Error send                    0 Error recv

  message tracking:
                     0 Malformed msgs                    0 Lost msgs

On standby router run:

.. code-block:: none


  $ show conntrack-sync statistics

  Main Table Statistics:

  cache internal:
  current active connections:                0
  connections created:                       0    failed:            0
  connections updated:                       0    failed:            0
  connections destroyed:                     0    failed:            0

  cache external:
  current active connections:               10
  connections created:                     888    failed:            0
  connections updated:                     134    failed:            0
  connections destroyed:                   878    failed:            0

  traffic processed:
                     0 Bytes                         0 Pckts

  multicast traffic (active device=eth0):
                234184 Bytes sent               907504 Bytes recv
                 14663 Pckts sent                21495 Pckts recv
                     0 Error send                    0 Error recv

  message tracking:
                     0 Malformed msgs                    0 Lost msgs