summaryrefslogtreecommitdiff
path: root/docs/configuration/interfaces/macsec.rst
blob: 1ab7f361ca9ca8db7eb3c297857db48f9a7c8f05 (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
:lastproofread: 2023-01-20

.. _macsec-interface:

######
MACsec
######

MACsec is an IEEE standard (IEEE 802.1AE) for MAC security, introduced in 2006.
It defines a way to establish a protocol independent connection between two
hosts with data confidentiality, authenticity and/or integrity, using
GCM-AES-128. MACsec operates on the Ethernet layer and as such is a layer 2
protocol, which means it's designed to secure traffic within a layer 2 network,
including DHCP or ARP requests. It does not compete with other security
solutions such as IPsec (layer 3) or TLS (layer 4), as all those solutions are
used for their own specific use cases.

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

Common interface configuration
==============================

.. cmdinclude:: /_include/interface-common-with-dhcp.txt
   :var0: macsec
   :var1: macsec0

MACsec options
==============

.. cfgcmd:: set interfaces macsec <interface> security cipher <gcm-aes-128|gcm-aes-256>

  Select cipher suite used for cryptographic operations. This setting is
  mandatory.

.. cfgcmd:: set interfaces macsec <interface> security encrypt

  MACsec only provides authentication by default, encryption is optional. This
  command will enable encryption for all outgoing packets.

.. cfgcmd:: set interfaces macsec <interface> source-interface <physical-source>

  A physical interface is required to connect this MACsec instance to. Traffic
  leaving this interface will now be authenticated/encrypted.

Static Keys
-----------
Static :abbr:`SAK (Secure Authentication Key)` mode can be configured manually on each
device wishing to use MACsec. Keys must be set statically on all devices for traffic
to flow properly. Key rotation is dependent on the administrator updating all keys
manually across connected devices. Static SAK mode can not be used with MKA.

.. cfgcmd:: set interfaces macsec <interface> security static key <key>

  Set the device's transmit (TX) key. This key must be a hex string that is 16-bytes 
  (GCM-AES-128) or 32-bytes (GCM-AES-256).

.. cfgcmd:: set interfaces macsec <interface> security static peer <peer> mac <mac address>

  Set the peer's MAC address

.. cfgcmd:: set interfaces macsec <interface> security static peer <peer> key <key>

  Set the peer's key used to receive (RX) traffic

.. cfgcmd:: set interfaces macsec <interface> security static peer <peer> disable

  Disable the peer configuration

Key Management
--------------

:abbr:`MKA (MACsec Key Agreement protocol)` is used to synchronize keys between
individual peers.

.. cfgcmd:: set interfaces macsec <interface> security mka cak <key>

  IEEE 802.1X/MACsec pre-shared key mode. This allows configuring MACsec with
  a pre-shared key using a :abbr:`CAK (MACsec connectivity association key)` and
  :abbr:`CKN (MACsec connectivity association name)` pair.

.. cfgcmd:: set interfaces macsec <interface> security mka ckn <key>

  :abbr:`CKN (MACsec connectivity association name)` key

.. cfgcmd:: set interfaces macsec <interface> security mka priority <priority>

  The peer with lower priority will become the key server and start
  distributing SAKs.

Replay protection
-----------------

.. cfgcmd:: set interfaces macsec <interface> security replay-window <window>

  IEEE 802.1X/MACsec replay protection window. This determines a window in which
  replay is tolerated, to allow receipt of frames that have been misordered by
  the network.

  - ``0``: No replay window, strict check
  - ``1-4294967295``: Number of packets that could be misordered

*********
Operation
*********

.. opcmd:: run generate macsec mka cak <gcm-aes-128|gcm-aes-256>

  Generate :abbr:`MKA (MACsec Key Agreement protocol)` CAK key 128 or 256 bits.

  .. code-block:: none

    vyos@vyos:~$ generate macsec mka cak gcm-aes-128
    20693b6e08bfa482703a563898c9e3ad

.. opcmd:: run generate macsec mka ckn

  Generate :abbr:`MKA (MACsec Key Agreement protocol)` CAK key.

  .. code-block:: none

    vyos@vyos:~$ generate macsec mka ckn
    88737efef314ee319b2cbf30210a5f164957d884672c143aefdc0f5f6bc49eb2

.. opcmd:: show interfaces macsec

  List all MACsec interfaces.

  .. code-block:: none

    vyos@vyos:~$ show interfaces macsec
    17: macsec1: protect on validate strict sc off sa off encrypt on send_sci on end_station off scb off replay off
        cipher suite: GCM-AES-128, using ICV length 16
        TXSC: 005056bfefaa0001 on SA 0
    20: macsec0: protect on validate strict sc off sa off encrypt off send_sci on end_station off scb off replay off
        cipher suite: GCM-AES-128, using ICV length 16
        TXSC: 005056bfefaa0001 on SA 0

.. opcmd:: show interfaces macsec <interface>

  Show specific MACsec interface information

  .. code-block:: none

    vyos@vyos:~$ show interfaces macsec macsec1
    17: macsec1: protect on validate strict sc off sa off encrypt on send_sci on end_station off scb off replay off
        cipher suite: GCM-AES-128, using ICV length 16
        TXSC: 005056bfefaa0001 on SA 0

********
Examples
********

* Two routers connected both via eth1 through an untrusted switch
* R1 has 192.0.2.1/24 & 2001:db8::1/64
* R2 has 192.0.2.2/24 & 2001:db8::2/64

**R1**

.. code-block:: none

  set interfaces macsec macsec1 address '192.0.2.1/24'
  set interfaces macsec macsec1 address '2001:db8::1/64'
  set interfaces macsec macsec1 security cipher 'gcm-aes-128'
  set interfaces macsec macsec1 security encrypt
  set interfaces macsec macsec1 security mka cak '232e44b7fda6f8e2d88a07bf78a7aff4'
  set interfaces macsec macsec1 security mka ckn '40916f4b23e3d548ad27eedd2d10c6f98c2d21684699647d63d41b500dfe8836'
  set interfaces macsec macsec1 source-interface 'eth1'

**R2**

.. code-block:: none

  set interfaces macsec macsec1 address '192.0.2.2/24'
  set interfaces macsec macsec1 address '2001:db8::2/64'
  set interfaces macsec macsec1 security cipher 'gcm-aes-128'
  set interfaces macsec macsec1 security encrypt
  set interfaces macsec macsec1 security mka cak '232e44b7fda6f8e2d88a07bf78a7aff4'
  set interfaces macsec macsec1 security mka ckn '40916f4b23e3d548ad27eedd2d10c6f98c2d21684699647d63d41b500dfe8836'
  set interfaces macsec macsec1 source-interface 'eth1'

Pinging (IPv6) the other host and intercepting the traffic in ``eth1`` will
show you the content is encrypted.

.. code-block:: none

  17:35:44.586668 00:50:56:bf:ef:aa > 00:50:56:b3:ad:d6, ethertype Unknown (0x88e5), length 150:
          0x0000:  2c00 0000 000a 0050 56bf efaa 0001 d9fb  ,......PV.......
          0x0010:  920a 8b8d 68ed 9609 29dd e767 25a4 4466  ....h...)..g%.Df
          0x0020:  5293 487b 9990 8517 3b15 22c7 ea5c ac83  R.H{....;."..\..
          0x0030:  4c6e 13cf 0743 f917 2c4e 694e 87d1 0f09  Ln...C..,NiN....
          0x0040:  0f77 5d53 ed75 cfe1 54df 0e5a c766 93cb  .w]S.u..T..Z.f..
          0x0050:  c4f2 6e23 f200 6dfe 3216 c858 dcaa a73b  ..n#..m.2..X...;
          0x0060:  4dd1 9358 d9e4 ed0e 072f 1acc 31c4 f669  M..X...../..1..i
          0x0070:  e93a 9f38 8a62 17c6 2857 6ac5 ec11 8b0e  .:.8.b..(Wj.....
          0x0080:  6b30 92a5 7ccc 720b                      k0..|.r.

Disabling the encryption on the link by removing ``security encrypt`` will show
the unencrypted but authenticated content.

.. code-block:: none

  17:37:00.746155 00:50:56:bf:ef:aa > 00:50:56:b3:ad:d6, ethertype Unknown (0x88e5), length 150:
          0x0000:  2000 0000 0009 0050 56bf efaa 0001 86dd  .......PV.......
          0x0010:  6009 86f3 0040 3a40 2001 0db8 0000 0000  `....@:@........
          0x0020:  0000 0000 0000 0001 2001 0db8 0000 0000  ................
          0x0030:  0000 0000 0000 0002 8100 d977 0f30 0003  ...........w.0..
          0x0040:  1ca0 c65e 0000 0000 8d93 0b00 0000 0000  ...^............
          0x0050:  1011 1213 1415 1617 1819 1a1b 1c1d 1e1f  ................
          0x0060:  2021 2223 2425 2627 2829 2a2b 2c2d 2e2f  .!"#$%&'()*+,-./
          0x0070:  3031 3233 3435 3637 87d5 eed3 3a39 d52b  01234567....:9.+
          0x0080:  a282 c842 5254 ef28                      ...BRT.(

**R1 Static Key**

.. code-block:: none

  set interfaces macsec macsec1 address '192.0.2.1/24'
  set interfaces macsec macsec1 address '2001:db8::1/64'
  set interfaces macsec macsec1 security cipher 'gcm-aes-128'
  set interfaces macsec macsec1 security encrypt
  set interfaces macsec macsec1 security static key 'ddd6f4a7be4d8bbaf88b26f10e1c05f7'
  set interfaces macsec macsec1 security static peer R2 mac 00:11:22:33:44:02
  set interfaces macsec macsec1 security static peer R2 key 'eadcc0aa9cf203f3ce651b332bd6e6c7'
  set interfaces macsec macsec1 source-interface 'eth1'

**R2 Static Key**

.. code-block:: none

  set interfaces macsec macsec1 address '192.0.2.2/24'
  set interfaces macsec macsec1 address '2001:db8::2/64'
  set interfaces macsec macsec1 security cipher 'gcm-aes-128'
  set interfaces macsec macsec1 security encrypt
  set interfaces macsec macsec1 security static key 'eadcc0aa9cf203f3ce651b332bd6e6c7'
  set interfaces macsec macsec1 security static peer R2 mac 00:11:22:33:44:01
  set interfaces macsec macsec1 security static peer R2 key 'ddd6f4a7be4d8bbaf88b26f10e1c05f7'
  set interfaces macsec macsec1 source-interface 'eth1'

***************
MACsec over wan
***************

MACsec is an interesting alternative to existing tunneling solutions that 
protects layer 2 by performing integrity, origin authentication, and optionally 
encryption. The typical use case is to use MACsec between hosts and access 
switches, between two hosts, or between two switches. in this example below, 
we use VXLAN and MACsec to secure the tunnel.

**R1 MACsec01**

.. code-block:: none

  set interfaces macsec macsec1 address '192.0.2.1/24'
  set interfaces macsec macsec1 address '2001:db8::1/64'
  set interfaces macsec macsec1 security cipher 'gcm-aes-128'
  set interfaces macsec macsec1 security encrypt
  set interfaces macsec macsec1 security static key 'ddd6f4a7be4d8bbaf88b26f10e1c05f7'
  set interfaces macsec macsec1 security static peer SEC02 key 'eadcc0aa9cf203f3ce651b332bd6e6c7'
  set interfaces macsec macsec1 security static peer SEC02 mac '00:11:22:33:44:02'
  set interfaces macsec macsec1 source-interface 'vxlan1'
  set interfaces vxlan vxlan1 mac '00:11:22:33:44:01'
  set interfaces vxlan vxlan1 remote '10.1.3.3'
  set interfaces vxlan vxlan1 source-address '172.16.100.1'
  set interfaces vxlan vxlan1 vni '10'
  set protocols static route 10.1.3.3/32 next-hop 172.16.100.2

**R2 MACsec02**

.. code-block:: none

  set interfaces macsec macsec1 address '192.0.2.2/24'
  set interfaces macsec macsec1 address '2001:db8::2/64'
  set interfaces macsec macsec1 security cipher 'gcm-aes-128'
  set interfaces macsec macsec1 security encrypt
  set interfaces macsec macsec1 security static key 'eadcc0aa9cf203f3ce651b332bd6e6c7'
  set interfaces macsec macsec1 security static peer SEC01 key 'ddd6f4a7be4d8bbaf88b26f10e1c05f7'
  set interfaces macsec macsec1 security static peer SEC01 mac '00:11:22:33:44:01'
  set interfaces macsec macsec1 source-interface 'vxlan1'
  set interfaces vxlan vxlan1 mac '00:11:22:33:44:02'
  set interfaces vxlan vxlan1 remote '10.1.2.2'
  set interfaces vxlan vxlan1 source-address '172.16.100.2'
  set interfaces vxlan vxlan1 vni '10'
  set protocols static route 10.1.2.2/32 next-hop 172.16.100.1