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 ]
15
16       ip macsec add DEV tx sa { 0..3 } [ OPTS ] key ID KEY
17       ip macsec set DEV tx sa { 0..3 } [ OPTS ]
18       ip macsec del DEV tx sa { 0..3 }
19
20       ip macsec add DEV rx SCI [ on | off ]
21       ip macsec set DEV rx SCI [ on | off ]
22       ip macsec del DEV rx SCI
23
24       ip macsec add DEV rx SCI sa { 0..3 } [ OPTS ] key ID KEY
25       ip macsec set DEV rx SCI sa { 0..3 } [ OPTS ]
26       ip macsec del DEV rx SCI sa { 0..3 }
27
28       ip macsec show [ DEV ]
29
30       OPTS := [ pn { 1..2^32-1 } ] [ on | off ]
31       SCI := { sci <u64> | port PORT address <lladdr> }
32       PORT := { 1..2^16-1 }
33
34
35

DESCRIPTION

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

EXAMPLES

44   Create a MACsec device on link eth0
45       # ip link add link eth0 macsec0 type macsec port 11 encrypt on
46
47   Configure a secure association on that device
48       # ip macsec add macsec0 tx sa 0 pn 1024 on key 01 81818181818181818181818181818181
49
50   Configure a receive channel
51       # ip macsec add macsec0 rx port 1234 address c6:19:52:8f:e6:a0
52
53   Configure a receive association
54       # ip macsec add macsec0 rx port 1234 address c6:19:52:8f:e6:a0 sa 0 pn 1 on key 00 82828282828282828282828282828282
55
56   Display MACsec configuration
57       # ip macsec show
58
59

NOTES

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

SEE ALSO

73       ip-link(8) wpa_supplicant(8)
74

AUTHOR

76       Sabrina Dubroca <sd@queasysnail.net>
77
78
79
80iproute                           07 Mar 2016                     IP-MACSEC(8)