1IP-MACSEC(8)                         Linux                        IP-MACSEC(8)
2
3
4

NAME

6       ip-macsec - MACsec device configuration
7

SYNOPSIS

9       ip  link  add  link DEVICE name NAME type macsec [ [ address <lladdr> ]
10       port PORT | sci <u64> ]  [  cipher  {  default  |  gcm-aes-128  |  gcm-
11       aes-256"}][" icvlen ICVLEN ] [ encrypt { on | off } ] [ send_sci { on |
12       off } ] [ end_station { on | off } ] [ scb { on | off } ] [  protect  {
13       on  |  off  }  ] [ replay { on | off } ] [ window WINDOW ] [ validate {
14       strict | check | disabled } ] [ encodingsa SA ] [ offload { off | phy |
15       mac } ]
16
17       ip macsec add DEV tx sa { 0..3 } [ OPTS ] key ID KEY
18       ip macsec set DEV tx sa { 0..3 } [ OPTS ]
19       ip macsec del DEV tx sa { 0..3 }
20
21       ip macsec add DEV rx SCI [ on | off ]
22       ip macsec set DEV rx SCI [ on | off ]
23       ip macsec del DEV rx SCI
24
25       ip macsec add DEV rx SCI sa { 0..3 } [ OPTS ] key ID KEY
26       ip macsec set DEV rx SCI sa { 0..3 } [ OPTS ]
27       ip macsec del DEV rx SCI sa { 0..3 }
28
29       ip macsec offload DEV { off | phy | mac }
30
31       ip macsec show [ DEV ]
32
33       OPTS := [ pn { 1..2^32-1 } ] [ on | off ]
34       SCI := { sci <u64> | port PORT address <lladdr> }
35       PORT := { 1..2^16-1 }
36
37
38

DESCRIPTION

40       The  ip  macsec commands are used to configure transmit secure associa‐
41       tions and receive secure channels and their secure  associations  on  a
42       MACsec  device  created  with  the ip link add command using the macsec
43       type.
44
45

EXAMPLES

47   Create a MACsec device on link eth0 (offload is disabled by default)
48       # ip link add link eth0 macsec0 type macsec port 11 encrypt on
49
50   Configure a secure association on that device
51       # ip macsec add macsec0 tx sa 0 pn 1024 on key 01 81818181818181818181818181818181
52
53   Configure a receive channel
54       # ip macsec add macsec0 rx port 1234 address c6:19:52:8f:e6:a0
55
56   Configure a receive association
57       # ip macsec add macsec0 rx port 1234 address c6:19:52:8f:e6:a0 sa 0 pn 1 on key 00 82828282828282828282828282828282
58
59   Display MACsec configuration
60       # ip macsec show
61
62   Configure offloading on an interface
63       # ip macsec offload macsec0 phy
64
65   Configure offloading upon MACsec device creation
66       # ip link add link eth0 macsec0 type macsec port 11 encrypt on offload mac
67
68

NOTES

70       This tool can be used to configure the 802.1AE keys of  the  interface.
71       Note  that  802.1AE  uses  GCM-AES  with  a  initialization vector (IV)
72       derived from the packet number. The same key must not be used with  the
73       same  IV  more  than once. Instead, keys must be frequently regenerated
74       and distibuted.  This tool is thus mostly for debugging and testing, or
75       in  combination  with  a  user-space  application that reconfigures the
76       keys. It is wrong to just configure the keys statically and assume them
77       to  work  indefinitely. The suggested and standardized way for key man‐
78       agement is 802.1X-2010, which is implemented by wpa_supplicant.
79
80

SEE ALSO

82       ip-link(8) wpa_supplicant(8)
83

AUTHOR

85       Sabrina Dubroca <sd@queasysnail.net>
86
87
88
89iproute                           07 Mar 2016                     IP-MACSEC(8)