2 * ipmacsec.c "ip macsec".
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
9 * Authors: Sabrina Dubroca <sd@queasysnail.net>
16 #include <linux/genetlink.h>
17 #include <linux/if_ether.h>
18 #include <linux/if_macsec.h>
22 #include "ip_common.h"
26 static const char *values_on_off
[] = { "off", "on" };
28 static const char *VALIDATE_STR
[] = {
29 [MACSEC_VALIDATE_DISABLED
] = "disabled",
30 [MACSEC_VALIDATE_CHECK
] = "check",
31 [MACSEC_VALIDATE_STRICT
] = "strict",
43 __u8 key_id
[MACSEC_KEYID_LEN
];
45 __u8 key
[MACSEC_MAX_KEY_LEN
];
58 struct cipher_args cipher
;
60 enum macsec_validation_type validate
;
70 #define MACSEC_BUFLEN 1024
74 static struct rtnl_handle genl_rth
;
75 static int genl_family
= -1;
77 #define MACSEC_GENL_REQ(_req, _bufsiz, _cmd, _flags) \
78 GENL_REQUEST(_req, _bufsiz, genl_family, 0, MACSEC_GENL_VERSION, \
82 static void ipmacsec_usage(void)
84 fprintf(stderr
, "Usage: ip macsec add DEV tx sa { 0..3 } [ OPTS ] key ID KEY\n");
85 fprintf(stderr
, " ip macsec set DEV tx sa { 0..3 } [ OPTS ]\n");
86 fprintf(stderr
, " ip macsec del DEV tx sa { 0..3 }\n");
87 fprintf(stderr
, " ip macsec add DEV rx SCI [ on | off ]\n");
88 fprintf(stderr
, " ip macsec set DEV rx SCI [ on | off ]\n");
89 fprintf(stderr
, " ip macsec del DEV rx SCI\n");
90 fprintf(stderr
, " ip macsec add DEV rx SCI sa { 0..3 } [ OPTS ] key ID KEY\n");
91 fprintf(stderr
, " ip macsec set DEV rx SCI sa { 0..3 } [ OPTS ]\n");
92 fprintf(stderr
, " ip macsec del DEV rx SCI sa { 0..3 }\n");
93 fprintf(stderr
, " ip macsec show\n");
94 fprintf(stderr
, " ip macsec show DEV\n");
95 fprintf(stderr
, "where OPTS := [ pn <u32> ] [ on | off ]\n");
96 fprintf(stderr
, " ID := 128-bit hex string\n");
97 fprintf(stderr
, " KEY := 128-bit hex string\n");
98 fprintf(stderr
, " SCI := { sci <u64> | port { 1..2^16-1 } address <lladdr> }\n");
103 static int one_of(const char *msg
, const char *realval
, const char **list
,
104 size_t len
, int *index
)
108 for (i
= 0; i
< len
; i
++) {
109 if (matches(realval
, list
[i
]) == 0) {
115 fprintf(stderr
, "Error: argument of \"%s\" must be one of ", msg
);
116 for (i
= 0; i
< len
; i
++)
117 fprintf(stderr
, "\"%s\", ", list
[i
]);
118 fprintf(stderr
, "not \"%s\"\n", realval
);
122 static int get_an(__u8
*val
, const char *arg
)
124 int ret
= get_u8(val
, arg
, 0);
135 static int get_sci(__u64
*sci
, const char *arg
)
137 return get_be64(sci
, arg
, 16);
140 static int get_port(__be16
*port
, const char *arg
)
142 return get_be16(port
, arg
, 0);
146 #define STR(a) _STR(a)
148 static void get_icvlen(__u8
*icvlen
, char *arg
)
150 int ret
= get_u8(icvlen
, arg
, 10);
153 invarg("expected ICV length", arg
);
155 if (*icvlen
< MACSEC_MIN_ICV_LEN
|| *icvlen
> MACSEC_STD_ICV_LEN
)
156 invarg("ICV length must be in the range {"
157 STR(MACSEC_MIN_ICV_LEN
) ".." STR(MACSEC_STD_ICV_LEN
)
161 static bool get_sa(int *argcp
, char ***argvp
, __u8
*an
)
164 char **argv
= *argvp
;
167 if (argc
<= 0 || strcmp(*argv
, "sa") != 0)
171 ret
= get_an(an
, *argv
);
173 invarg("expected an { 0..3 }", *argv
);
181 static int parse_sa_args(int *argcp
, char ***argvp
, struct sa_desc
*sa
)
184 char **argv
= *argvp
;
186 bool active_set
= false;
189 if (strcmp(*argv
, "pn") == 0) {
193 ret
= get_u32(&sa
->pn
, *argv
, 0);
195 invarg("expected pn", *argv
);
197 invarg("expected pn != 0", *argv
);
198 } else if (strcmp(*argv
, "key") == 0) {
202 if (!hexstring_a2n(*argv
, sa
->key_id
, MACSEC_KEYID_LEN
,
204 invarg("expected key id", *argv
);
206 if (!hexstring_a2n(*argv
, sa
->key
, MACSEC_MAX_KEY_LEN
,
208 invarg("expected key", *argv
);
209 } else if (strcmp(*argv
, "on") == 0) {
211 duparg2("on/off", "on");
214 } else if (strcmp(*argv
, "off") == 0) {
216 duparg2("on/off", "off");
220 fprintf(stderr
, "macsec: unknown command \"%s\"?\n",
233 static __u64
make_sci(char *addr
, __be16 port
)
237 memcpy(&sci
, addr
, ETH_ALEN
);
238 memcpy(((char *)&sci
) + ETH_ALEN
, &port
, sizeof(port
));
243 static bool sci_complete(bool sci
, bool port
, bool addr
, bool port_only
)
245 return sci
|| (port
&& (addr
|| port_only
));
248 static int get_sci_portaddr(struct sci
*sci
, int *argcp
, char ***argvp
,
249 bool port_only
, bool optional
)
252 char **argv
= *argvp
;
254 bool p
= false, a
= false, s
= false;
257 if (strcmp(*argv
, "sci") == 0) {
259 invarg("expected address", *argv
);
261 invarg("expected port", *argv
);
263 ret
= get_sci(&sci
->sci
, *argv
);
265 invarg("expected sci", *argv
);
267 } else if (strcmp(*argv
, "port") == 0) {
269 ret
= get_port(&sci
->port
, *argv
);
271 invarg("expected port", *argv
);
273 invarg("expected port != 0", *argv
);
275 } else if (strcmp(*argv
, "address") == 0) {
277 ret
= ll_addr_a2n(sci
->abuf
, sizeof(sci
->abuf
), *argv
);
279 invarg("expected lladdr", *argv
);
281 } else if (optional
) {
284 invarg("expected sci, port, or address", *argv
);
289 if (sci_complete(s
, p
, a
, port_only
))
293 if (!optional
&& !sci_complete(s
, p
, a
, port_only
))
297 sci
->sci
= make_sci(sci
->abuf
, sci
->port
);
305 static bool parse_rxsci(int *argcp
, char ***argvp
, struct rxsc_desc
*rxsc
,
306 struct sa_desc
*rxsa
)
308 struct sci sci
= { 0 };
311 get_sci_portaddr(&sci
, argcp
, argvp
, false, false) < 0) {
312 fprintf(stderr
, "expected sci\n");
318 return get_sa(argcp
, argvp
, &rxsa
->an
);
321 static int parse_rxsci_args(int *argcp
, char ***argvp
, struct rxsc_desc
*rxsc
)
324 char **argv
= *argvp
;
325 bool active_set
= false;
328 if (strcmp(*argv
, "on") == 0) {
330 duparg2("on/off", "on");
333 } else if (strcmp(*argv
, "off") == 0) {
335 duparg2("on/off", "off");
336 rxsc
->active
= false;
339 fprintf(stderr
, "macsec: unknown command \"%s\"?\n",
359 static const enum macsec_nl_commands macsec_commands
[__CMD_MAX
][2][2] = {
361 [0] = {-1, MACSEC_CMD_ADD_RXSC
},
362 [1] = {MACSEC_CMD_ADD_TXSA
, MACSEC_CMD_ADD_RXSA
},
365 [0] = {-1, MACSEC_CMD_UPD_RXSC
},
366 [1] = {MACSEC_CMD_UPD_TXSA
, MACSEC_CMD_UPD_RXSA
},
369 [0] = {-1, MACSEC_CMD_DEL_RXSC
},
370 [1] = {MACSEC_CMD_DEL_TXSA
, MACSEC_CMD_DEL_RXSA
},
374 static int do_modify_nl(enum cmd c
, enum macsec_nl_commands cmd
, int ifindex
,
375 struct rxsc_desc
*rxsc
, struct sa_desc
*sa
)
377 struct rtattr
*attr_sa
;
379 MACSEC_GENL_REQ(req
, MACSEC_BUFLEN
, cmd
, NLM_F_REQUEST
);
381 addattr32(&req
.n
, MACSEC_BUFLEN
, MACSEC_ATTR_IFINDEX
, ifindex
);
383 struct rtattr
*attr_rxsc
;
385 attr_rxsc
= addattr_nest(&req
.n
, MACSEC_BUFLEN
,
386 MACSEC_ATTR_RXSC_CONFIG
);
387 addattr64(&req
.n
, MACSEC_BUFLEN
,
388 MACSEC_RXSC_ATTR_SCI
, rxsc
->sci
);
389 if (c
!= CMD_DEL
&& rxsc
->active
!= 0xff)
390 addattr8(&req
.n
, MACSEC_BUFLEN
,
391 MACSEC_RXSC_ATTR_ACTIVE
, rxsc
->active
);
393 addattr_nest_end(&req
.n
, attr_rxsc
);
399 attr_sa
= addattr_nest(&req
.n
, MACSEC_BUFLEN
, MACSEC_ATTR_SA_CONFIG
);
401 addattr8(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_AN
, sa
->an
);
405 addattr32(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_PN
,
409 addattr_l(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_KEYID
,
410 sa
->key_id
, MACSEC_KEYID_LEN
);
411 addattr_l(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_KEY
,
412 sa
->key
, sa
->key_len
);
415 if (sa
->active
!= 0xff) {
416 addattr8(&req
.n
, MACSEC_BUFLEN
,
417 MACSEC_SA_ATTR_ACTIVE
, sa
->active
);
421 addattr_nest_end(&req
.n
, attr_sa
);
424 if (rtnl_talk(&genl_rth
, &req
.n
, NULL
) < 0)
430 static bool check_sa_args(enum cmd c
, struct sa_desc
*sa
)
434 fprintf(stderr
, "cannot create SA without key\n");
439 fprintf(stderr
, "must specify a packet number != 0\n");
442 } else if (c
== CMD_UPD
) {
444 fprintf(stderr
, "cannot change key on SA\n");
452 static int do_modify_txsa(enum cmd c
, int argc
, char **argv
, int ifindex
)
454 struct sa_desc txsa
= {0};
455 enum macsec_nl_commands cmd
;
460 if (argc
== 0 || !get_sa(&argc
, &argv
, &txsa
.an
))
466 if (parse_sa_args(&argc
, &argv
, &txsa
))
469 if (check_sa_args(c
, &txsa
))
473 cmd
= macsec_commands
[c
][1][0];
474 return do_modify_nl(c
, cmd
, ifindex
, NULL
, &txsa
);
477 static int do_modify_rxsci(enum cmd c
, int argc
, char **argv
, int ifindex
)
479 struct rxsc_desc rxsc
= {0};
480 struct sa_desc rxsa
= {0};
482 enum macsec_nl_commands cmd
;
484 rxsc
.ifindex
= ifindex
;
489 sa_set
= parse_rxsci(&argc
, &argv
, &rxsc
, &rxsa
);
494 if (sa_set
&& (parse_sa_args(&argc
, &argv
, &rxsa
) ||
495 check_sa_args(c
, &rxsa
)))
497 if (!sa_set
&& parse_rxsci_args(&argc
, &argv
, &rxsc
))
501 cmd
= macsec_commands
[c
][sa_set
][1];
502 return do_modify_nl(c
, cmd
, rxsc
.ifindex
, &rxsc
, &rxsa
);
505 static int do_modify(enum cmd c
, int argc
, char **argv
)
512 ifindex
= ll_name_to_index(*argv
);
514 fprintf(stderr
, "Device \"%s\" does not exist.\n", *argv
);
522 if (strcmp(*argv
, "tx") == 0)
523 return do_modify_txsa(c
, argc
-1, argv
+1, ifindex
);
524 if (strcmp(*argv
, "rx") == 0)
525 return do_modify_rxsci(c
, argc
-1, argv
+1, ifindex
);
537 static int validate_dump(struct rtattr
**attrs
)
539 return attrs
[MACSEC_ATTR_IFINDEX
] && attrs
[MACSEC_ATTR_SECY
] &&
540 attrs
[MACSEC_ATTR_TXSA_LIST
] && attrs
[MACSEC_ATTR_RXSC_LIST
] &&
541 attrs
[MACSEC_ATTR_TXSC_STATS
] && attrs
[MACSEC_ATTR_SECY_STATS
];
545 static int validate_secy_dump(struct rtattr
**attrs
)
547 return attrs
[MACSEC_SECY_ATTR_SCI
] &&
548 attrs
[MACSEC_SECY_ATTR_ENCODING_SA
] &&
549 attrs
[MACSEC_SECY_ATTR_CIPHER_SUITE
] &&
550 attrs
[MACSEC_SECY_ATTR_ICV_LEN
] &&
551 attrs
[MACSEC_SECY_ATTR_PROTECT
] &&
552 attrs
[MACSEC_SECY_ATTR_REPLAY
] &&
553 attrs
[MACSEC_SECY_ATTR_OPER
] &&
554 attrs
[MACSEC_SECY_ATTR_VALIDATE
] &&
555 attrs
[MACSEC_SECY_ATTR_ENCRYPT
] &&
556 attrs
[MACSEC_SECY_ATTR_INC_SCI
] &&
557 attrs
[MACSEC_SECY_ATTR_ES
] &&
558 attrs
[MACSEC_SECY_ATTR_SCB
];
561 static void print_flag(FILE *f
, struct rtattr
*attrs
[], const char *desc
,
565 const char *v
= values_on_off
[!!rta_getattr_u8(attrs
[field
])];
567 if (is_json_context())
568 print_string(PRINT_JSON
, desc
, NULL
, v
);
570 fprintf(f
, "%s %s ", desc
, v
);
574 #define DEFAULT_CIPHER_NAME "GCM-AES-128"
576 static const char *cs_id_to_name(__u64 cid
)
579 case MACSEC_DEFAULT_CIPHER_ID
:
580 case MACSEC_DEFAULT_CIPHER_ALT
:
581 return DEFAULT_CIPHER_NAME
;
587 static void print_cipher_suite(const char *prefix
, __u64 cid
, __u8 icv_len
)
589 printf("%scipher suite: %s, using ICV length %d\n", prefix
,
590 cs_id_to_name(cid
), icv_len
);
593 static void print_attrs(const char *prefix
, struct rtattr
*attrs
[])
595 print_flag(stdout
, attrs
, "protect", MACSEC_SECY_ATTR_PROTECT
);
597 if (attrs
[MACSEC_SECY_ATTR_VALIDATE
]) {
598 __u8 val
= rta_getattr_u8(attrs
[MACSEC_SECY_ATTR_VALIDATE
]);
600 printf("validate %s ", VALIDATE_STR
[val
]);
603 print_flag(stdout
, attrs
, "sc", MACSEC_RXSC_ATTR_ACTIVE
);
604 print_flag(stdout
, attrs
, "sa", MACSEC_SA_ATTR_ACTIVE
);
605 print_flag(stdout
, attrs
, "encrypt", MACSEC_SECY_ATTR_ENCRYPT
);
606 print_flag(stdout
, attrs
, "send_sci", MACSEC_SECY_ATTR_INC_SCI
);
607 print_flag(stdout
, attrs
, "end_station", MACSEC_SECY_ATTR_ES
);
608 print_flag(stdout
, attrs
, "scb", MACSEC_SECY_ATTR_SCB
);
610 print_flag(stdout
, attrs
, "replay", MACSEC_SECY_ATTR_REPLAY
);
611 if (attrs
[MACSEC_SECY_ATTR_WINDOW
]) {
613 rta_getattr_u32(attrs
[MACSEC_SECY_ATTR_WINDOW
]));
616 if (attrs
[MACSEC_SECY_ATTR_CIPHER_SUITE
] &&
617 attrs
[MACSEC_SECY_ATTR_ICV_LEN
]) {
619 print_cipher_suite(prefix
,
620 rta_getattr_u64(attrs
[MACSEC_SECY_ATTR_CIPHER_SUITE
]),
621 rta_getattr_u8(attrs
[MACSEC_SECY_ATTR_ICV_LEN
]));
626 static void print_one_stat(const char **names
, struct rtattr
**attr
, int idx
,
629 int pad
= strlen(names
[idx
]) + 1;
633 printf("%*llu", pad
, rta_getattr_u64(attr
[idx
]));
635 printf("%*u", pad
, rta_getattr_u32(attr
[idx
]));
637 printf("%*c", pad
, '-');
641 static const char *txsc_stats_names
[NUM_MACSEC_TXSC_STATS_ATTR
] = {
642 [MACSEC_TXSC_STATS_ATTR_OUT_PKTS_PROTECTED
] = "OutPktsProtected",
643 [MACSEC_TXSC_STATS_ATTR_OUT_PKTS_ENCRYPTED
] = "OutPktsEncrypted",
644 [MACSEC_TXSC_STATS_ATTR_OUT_OCTETS_PROTECTED
] = "OutOctetsProtected",
645 [MACSEC_TXSC_STATS_ATTR_OUT_OCTETS_ENCRYPTED
] = "OutOctetsEncrypted",
648 static void print_txsc_stats(const char *prefix
, struct rtattr
*attr
)
650 struct rtattr
*stats
[MACSEC_TXSC_STATS_ATTR_MAX
+ 1];
653 if (!attr
|| show_stats
== 0)
656 parse_rtattr_nested(stats
, MACSEC_TXSC_STATS_ATTR_MAX
+ 1, attr
);
657 printf("%sstats:", prefix
);
659 for (i
= 1; i
< NUM_MACSEC_TXSC_STATS_ATTR
; i
++) {
660 if (!txsc_stats_names
[i
])
662 printf(" %s", txsc_stats_names
[i
]);
665 printf("\n%s ", prefix
);
667 for (i
= 1; i
< NUM_MACSEC_TXSC_STATS_ATTR
; i
++) {
668 if (!txsc_stats_names
[i
])
670 print_one_stat(txsc_stats_names
, stats
, i
, true);
676 static const char *secy_stats_names
[NUM_MACSEC_SECY_STATS_ATTR
] = {
677 [MACSEC_SECY_STATS_ATTR_OUT_PKTS_UNTAGGED
] = "OutPktsUntagged",
678 [MACSEC_SECY_STATS_ATTR_IN_PKTS_UNTAGGED
] = "InPktsUntagged",
679 [MACSEC_SECY_STATS_ATTR_OUT_PKTS_TOO_LONG
] = "OutPktsTooLong",
680 [MACSEC_SECY_STATS_ATTR_IN_PKTS_NO_TAG
] = "InPktsNoTag",
681 [MACSEC_SECY_STATS_ATTR_IN_PKTS_BAD_TAG
] = "InPktsBadTag",
682 [MACSEC_SECY_STATS_ATTR_IN_PKTS_UNKNOWN_SCI
] = "InPktsUnknownSCI",
683 [MACSEC_SECY_STATS_ATTR_IN_PKTS_NO_SCI
] = "InPktsNoSCI",
684 [MACSEC_SECY_STATS_ATTR_IN_PKTS_OVERRUN
] = "InPktsOverrun",
687 static void print_secy_stats(const char *prefix
, struct rtattr
*attr
)
689 struct rtattr
*stats
[MACSEC_SECY_STATS_ATTR_MAX
+ 1];
692 if (!attr
|| show_stats
== 0)
695 parse_rtattr_nested(stats
, MACSEC_SECY_STATS_ATTR_MAX
+ 1, attr
);
696 printf("%sstats:", prefix
);
698 for (i
= 1; i
< NUM_MACSEC_SECY_STATS_ATTR
; i
++) {
699 if (!secy_stats_names
[i
])
701 printf(" %s", secy_stats_names
[i
]);
704 printf("\n%s ", prefix
);
706 for (i
= 1; i
< NUM_MACSEC_SECY_STATS_ATTR
; i
++) {
707 if (!secy_stats_names
[i
])
709 print_one_stat(secy_stats_names
, stats
, i
, true);
715 static const char *rxsa_stats_names
[NUM_MACSEC_SA_STATS_ATTR
] = {
716 [MACSEC_SA_STATS_ATTR_IN_PKTS_OK
] = "InPktsOK",
717 [MACSEC_SA_STATS_ATTR_IN_PKTS_INVALID
] = "InPktsInvalid",
718 [MACSEC_SA_STATS_ATTR_IN_PKTS_NOT_VALID
] = "InPktsNotValid",
719 [MACSEC_SA_STATS_ATTR_IN_PKTS_NOT_USING_SA
] = "InPktsNotUsingSA",
720 [MACSEC_SA_STATS_ATTR_IN_PKTS_UNUSED_SA
] = "InPktsUnusedSA",
723 static void print_rxsa_stats(const char *prefix
, struct rtattr
*attr
)
725 struct rtattr
*stats
[MACSEC_SA_STATS_ATTR_MAX
+ 1];
728 if (!attr
|| show_stats
== 0)
731 parse_rtattr_nested(stats
, MACSEC_SA_STATS_ATTR_MAX
+ 1, attr
);
732 printf("%s%s ", prefix
, prefix
);
734 for (i
= 1; i
< NUM_MACSEC_SA_STATS_ATTR
; i
++) {
735 if (!rxsa_stats_names
[i
])
737 printf(" %s", rxsa_stats_names
[i
]);
740 printf("\n%s%s ", prefix
, prefix
);
742 for (i
= 1; i
< NUM_MACSEC_SA_STATS_ATTR
; i
++) {
743 if (!rxsa_stats_names
[i
])
745 print_one_stat(rxsa_stats_names
, stats
, i
, false);
751 static const char *txsa_stats_names
[NUM_MACSEC_SA_STATS_ATTR
] = {
752 [MACSEC_SA_STATS_ATTR_OUT_PKTS_PROTECTED
] = "OutPktsProtected",
753 [MACSEC_SA_STATS_ATTR_OUT_PKTS_ENCRYPTED
] = "OutPktsEncrypted",
756 static void print_txsa_stats(const char *prefix
, struct rtattr
*attr
)
758 struct rtattr
*stats
[MACSEC_SA_STATS_ATTR_MAX
+ 1];
760 if (!attr
|| show_stats
== 0)
763 parse_rtattr_nested(stats
, MACSEC_SA_STATS_ATTR_MAX
+ 1, attr
);
764 printf("%s%s %s %s\n", prefix
, prefix
,
765 txsa_stats_names
[MACSEC_SA_STATS_ATTR_OUT_PKTS_PROTECTED
],
766 txsa_stats_names
[MACSEC_SA_STATS_ATTR_OUT_PKTS_ENCRYPTED
]);
767 printf("%s%s ", prefix
, prefix
);
769 print_one_stat(txsa_stats_names
, stats
,
770 MACSEC_SA_STATS_ATTR_OUT_PKTS_PROTECTED
, false);
771 print_one_stat(txsa_stats_names
, stats
,
772 MACSEC_SA_STATS_ATTR_OUT_PKTS_ENCRYPTED
, false);
776 static void print_tx_sc(const char *prefix
, __u64 sci
, __u8 encoding_sa
,
777 struct rtattr
*txsc_stats
, struct rtattr
*secy_stats
,
780 struct rtattr
*sa_attr
[MACSEC_SA_ATTR_MAX
+ 1];
784 printf("%sTXSC: %016llx on SA %d\n", prefix
, ntohll(sci
), encoding_sa
);
785 print_secy_stats(prefix
, secy_stats
);
786 print_txsc_stats(prefix
, txsc_stats
);
788 rem
= RTA_PAYLOAD(sa
);
789 for (a
= RTA_DATA(sa
); RTA_OK(a
, rem
); a
= RTA_NEXT(a
, rem
)) {
793 parse_rtattr_nested(sa_attr
, MACSEC_SA_ATTR_MAX
+ 1, a
);
794 state
= rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_ACTIVE
]);
795 printf("%s%s%d: PN %u, state %s, key %s\n", prefix
, prefix
,
796 rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_AN
]),
797 rta_getattr_u32(sa_attr
[MACSEC_SA_ATTR_PN
]),
798 values_on_off
[state
],
799 hexstring_n2a(RTA_DATA(sa_attr
[MACSEC_SA_ATTR_KEYID
]),
800 RTA_PAYLOAD(sa_attr
[MACSEC_SA_ATTR_KEYID
]),
801 keyid
, sizeof(keyid
)));
802 print_txsa_stats(prefix
, sa_attr
[MACSEC_SA_ATTR_STATS
]);
806 static const char *rxsc_stats_names
[NUM_MACSEC_RXSC_STATS_ATTR
] = {
807 [MACSEC_RXSC_STATS_ATTR_IN_OCTETS_VALIDATED
] = "InOctetsValidated",
808 [MACSEC_RXSC_STATS_ATTR_IN_OCTETS_DECRYPTED
] = "InOctetsDecrypted",
809 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_UNCHECKED
] = "InPktsUnchecked",
810 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_DELAYED
] = "InPktsDelayed",
811 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_OK
] = "InPktsOK",
812 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_INVALID
] = "InPktsInvalid",
813 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_LATE
] = "InPktsLate",
814 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_NOT_VALID
] = "InPktsNotValid",
815 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_NOT_USING_SA
] = "InPktsNotUsingSA",
816 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_UNUSED_SA
] = "InPktsUnusedSA",
819 static void print_rxsc_stats(const char *prefix
, struct rtattr
*attr
)
821 struct rtattr
*stats
[MACSEC_RXSC_STATS_ATTR_MAX
+ 1];
824 if (!attr
|| show_stats
== 0)
827 parse_rtattr_nested(stats
, MACSEC_RXSC_STATS_ATTR_MAX
+ 1, attr
);
828 printf("%sstats:", prefix
);
829 for (i
= 1; i
< NUM_MACSEC_RXSC_STATS_ATTR
; i
++) {
830 if (!rxsc_stats_names
[i
])
832 printf(" %s", rxsc_stats_names
[i
]);
835 printf("\n%s ", prefix
);
837 for (i
= 1; i
< NUM_MACSEC_RXSC_STATS_ATTR
; i
++) {
838 if (!rxsc_stats_names
[i
])
840 print_one_stat(rxsc_stats_names
, stats
, i
, true);
846 static void print_rx_sc(const char *prefix
, __u64 sci
, __u8 active
,
847 struct rtattr
*rxsc_stats
, struct rtattr
*sa
)
849 struct rtattr
*sa_attr
[MACSEC_SA_ATTR_MAX
+ 1];
853 printf("%sRXSC: %016llx, state %s\n", prefix
, ntohll(sci
),
854 values_on_off
[!!active
]);
855 print_rxsc_stats(prefix
, rxsc_stats
);
857 rem
= RTA_PAYLOAD(sa
);
858 for (a
= RTA_DATA(sa
); RTA_OK(a
, rem
); a
= RTA_NEXT(a
, rem
)) {
862 parse_rtattr_nested(sa_attr
, MACSEC_SA_ATTR_MAX
+ 1, a
);
863 state
= rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_ACTIVE
]);
864 printf("%s%s%d: PN %u, state %s, key %s\n", prefix
, prefix
,
865 rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_AN
]),
866 rta_getattr_u32(sa_attr
[MACSEC_SA_ATTR_PN
]),
867 values_on_off
[state
],
868 hexstring_n2a(RTA_DATA(sa_attr
[MACSEC_SA_ATTR_KEYID
]),
869 RTA_PAYLOAD(sa_attr
[MACSEC_SA_ATTR_KEYID
]),
870 keyid
, sizeof(keyid
)));
871 print_rxsa_stats(prefix
, sa_attr
[MACSEC_SA_ATTR_STATS
]);
875 static int process(const struct sockaddr_nl
*who
, struct nlmsghdr
*n
,
878 struct genlmsghdr
*ghdr
;
879 struct rtattr
*attrs
[MACSEC_ATTR_MAX
+ 1], *sc
, *c
;
880 struct rtattr
*attrs_secy
[MACSEC_SECY_ATTR_MAX
+ 1];
881 int len
= n
->nlmsg_len
;
887 if (n
->nlmsg_type
!= genl_family
)
890 len
-= NLMSG_LENGTH(GENL_HDRLEN
);
894 ghdr
= NLMSG_DATA(n
);
895 if (ghdr
->cmd
!= MACSEC_CMD_GET_TXSC
)
898 parse_rtattr(attrs
, MACSEC_ATTR_MAX
, (void *) ghdr
+ GENL_HDRLEN
, len
);
899 if (!validate_dump(attrs
)) {
900 printf("incomplete dump message\n");
904 ifindex
= rta_getattr_u32(attrs
[MACSEC_ATTR_IFINDEX
]);
905 parse_rtattr_nested(attrs_secy
, MACSEC_SECY_ATTR_MAX
+ 1,
906 attrs
[MACSEC_ATTR_SECY
]);
908 if (!validate_secy_dump(attrs_secy
)) {
909 printf("incomplete dump message\n");
913 sci
= rta_getattr_u64(attrs_secy
[MACSEC_SECY_ATTR_SCI
]);
914 encoding_sa
= rta_getattr_u8(attrs_secy
[MACSEC_SECY_ATTR_ENCODING_SA
]);
916 if (filter
.ifindex
&& ifindex
!= filter
.ifindex
)
919 if (filter
.sci
&& sci
!= filter
.sci
)
922 printf("%d: %s: ", ifindex
, ll_index_to_name(ifindex
));
923 print_attrs(" ", attrs_secy
);
925 print_tx_sc(" ", sci
, encoding_sa
,
926 attrs
[MACSEC_ATTR_TXSC_STATS
],
927 attrs
[MACSEC_ATTR_SECY_STATS
],
928 attrs
[MACSEC_ATTR_TXSA_LIST
]);
930 if (!attrs
[MACSEC_ATTR_RXSC_LIST
])
933 sc
= attrs
[MACSEC_ATTR_RXSC_LIST
];
934 rem
= RTA_PAYLOAD(sc
);
935 for (c
= RTA_DATA(sc
); RTA_OK(c
, rem
); c
= RTA_NEXT(c
, rem
)) {
936 struct rtattr
*sc_attr
[MACSEC_RXSC_ATTR_MAX
+ 1];
938 parse_rtattr_nested(sc_attr
, MACSEC_RXSC_ATTR_MAX
+ 1, c
);
940 rta_getattr_u64(sc_attr
[MACSEC_RXSC_ATTR_SCI
]),
941 rta_getattr_u32(sc_attr
[MACSEC_RXSC_ATTR_ACTIVE
]),
942 sc_attr
[MACSEC_RXSC_ATTR_STATS
],
943 sc_attr
[MACSEC_RXSC_ATTR_SA_LIST
]);
949 static int do_dump(int ifindex
)
951 MACSEC_GENL_REQ(req
, MACSEC_BUFLEN
, MACSEC_CMD_GET_TXSC
,
952 NLM_F_REQUEST
| NLM_F_DUMP
);
954 memset(&filter
, 0, sizeof(filter
));
955 filter
.ifindex
= ifindex
;
957 req
.n
.nlmsg_seq
= genl_rth
.dump
= ++genl_rth
.seq
;
958 if (rtnl_send(&genl_rth
, &req
, req
.n
.nlmsg_len
) < 0) {
959 perror("Failed to send dump request");
963 if (rtnl_dump_filter(&genl_rth
, process
, stdout
) < 0) {
964 fprintf(stderr
, "Dump terminated\n");
971 static int do_show(int argc
, char **argv
)
978 ifindex
= ll_name_to_index(*argv
);
980 fprintf(stderr
, "Device \"%s\" does not exist.\n", *argv
);
986 return do_dump(ifindex
);
992 int do_ipmacsec(int argc
, char **argv
)
997 if (matches(*argv
, "help") == 0)
1000 if (genl_init_handle(&genl_rth
, MACSEC_GENL_NAME
, &genl_family
))
1003 if (matches(*argv
, "show") == 0)
1004 return do_show(argc
-1, argv
+1);
1006 if (matches(*argv
, "add") == 0)
1007 return do_modify(CMD_ADD
, argc
-1, argv
+1);
1008 if (matches(*argv
, "set") == 0)
1009 return do_modify(CMD_UPD
, argc
-1, argv
+1);
1010 if (matches(*argv
, "delete") == 0)
1011 return do_modify(CMD_DEL
, argc
-1, argv
+1);
1013 fprintf(stderr
, "Command \"%s\" is unknown, try \"ip macsec help\".\n",
1018 /* device creation */
1019 static void macsec_print_opt(struct link_util
*lu
, FILE *f
, struct rtattr
*tb
[])
1024 if (tb
[IFLA_MACSEC_SCI
]) {
1025 if (is_json_context()) {
1028 snprintf(b1
, sizeof(b1
), "%016llx",
1029 ntohll(rta_getattr_u64(tb
[IFLA_MACSEC_SCI
])));
1030 print_string(PRINT_JSON
, "sci", NULL
, b1
);
1032 fprintf(f
, "sci %016llx ",
1033 ntohll(rta_getattr_u64(tb
[IFLA_MACSEC_SCI
])));
1037 print_flag(f
, tb
, "protect", IFLA_MACSEC_PROTECT
);
1039 if (tb
[IFLA_MACSEC_CIPHER_SUITE
]) {
1040 __u64 csid
= rta_getattr_u64(tb
[IFLA_MACSEC_CIPHER_SUITE
]);
1042 print_string(PRINT_ANY
,
1045 cs_id_to_name(csid
));
1048 if (tb
[IFLA_MACSEC_ICV_LEN
]) {
1049 if (is_json_context()) {
1052 snprintf(b2
, sizeof(b2
), "%hhu",
1053 rta_getattr_u8(tb
[IFLA_MACSEC_ICV_LEN
]));
1054 print_uint(PRINT_JSON
, "icv_len", NULL
, atoi(b2
));
1056 fprintf(f
, "icvlen %hhu ",
1057 rta_getattr_u8(tb
[IFLA_MACSEC_ICV_LEN
]));
1061 if (tb
[IFLA_MACSEC_ENCODING_SA
]) {
1062 if (is_json_context()) {
1065 snprintf(b2
, sizeof(b2
), "%hhu",
1066 rta_getattr_u8(tb
[IFLA_MACSEC_ENCODING_SA
]));
1067 print_uint(PRINT_JSON
, "encoding_sa", NULL
, atoi(b2
));
1069 fprintf(f
, "encodingsa %hhu ",
1070 rta_getattr_u8(tb
[IFLA_MACSEC_ENCODING_SA
]));
1074 if (tb
[IFLA_MACSEC_VALIDATION
]) {
1075 __u8 val
= rta_getattr_u8(tb
[IFLA_MACSEC_VALIDATION
]);
1077 print_string(PRINT_ANY
,
1083 const char *inc_sci
, *es
, *replay
;
1085 if (is_json_context()) {
1086 inc_sci
= "inc_sci";
1087 replay
= "replay_protect";
1090 inc_sci
= "send_sci";
1095 print_flag(f
, tb
, "encrypt", IFLA_MACSEC_ENCRYPT
);
1096 print_flag(f
, tb
, inc_sci
, IFLA_MACSEC_INC_SCI
);
1097 print_flag(f
, tb
, es
, IFLA_MACSEC_ES
);
1098 print_flag(f
, tb
, "scb", IFLA_MACSEC_SCB
);
1099 print_flag(f
, tb
, replay
, IFLA_MACSEC_REPLAY_PROTECT
);
1101 if (tb
[IFLA_MACSEC_WINDOW
])
1102 print_int(PRINT_ANY
,
1105 rta_getattr_u32(tb
[IFLA_MACSEC_WINDOW
]));
1108 static bool check_txsc_flags(bool es
, bool scb
, bool sci
)
1110 if (sci
&& (es
|| scb
))
1117 static void usage(FILE *f
)
1120 "Usage: ... macsec [ [ address <lladdr> ] port { 1..2^16-1 } | sci <u64> ]\n"
1121 " [ cipher { default | gcm-aes-128 } ]\n"
1122 " [ icvlen { 8..16 } ]\n"
1123 " [ encrypt { on | off } ]\n"
1124 " [ send_sci { on | off } ]\n"
1125 " [ end_station { on | off } ]\n"
1126 " [ scb { on | off } ]\n"
1127 " [ protect { on | off } ]\n"
1128 " [ replay { on | off} window { 0..2^32-1 } ]\n"
1129 " [ validate { strict | check | disabled } ]\n"
1130 " [ encodingsa { 0..3 } ]\n"
1134 static int macsec_parse_opt(struct link_util
*lu
, int argc
, char **argv
,
1138 __u8 encoding_sa
= 0xff;
1140 struct cipher_args cipher
= {0};
1141 enum macsec_validation_type validate
;
1142 bool es
= false, scb
= false, send_sci
= false;
1143 int replay_protect
= -1;
1144 struct sci sci
= { 0 };
1146 ret
= get_sci_portaddr(&sci
, &argc
, &argv
, true, true);
1148 fprintf(stderr
, "expected sci\n");
1154 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_SCI
,
1155 &sci
.sci
, sizeof(sci
.sci
));
1157 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_PORT
,
1158 &sci
.port
, sizeof(sci
.port
));
1162 if (strcmp(*argv
, "cipher") == 0) {
1165 duparg("cipher", *argv
);
1166 if (strcmp(*argv
, "default") == 0 ||
1167 strcmp(*argv
, "gcm-aes-128") == 0 ||
1168 strcmp(*argv
, "GCM-AES-128") == 0)
1169 cipher
.id
= MACSEC_DEFAULT_CIPHER_ID
;
1171 invarg("expected: default or gcm-aes-128",
1173 } else if (strcmp(*argv
, "icvlen") == 0) {
1176 duparg("icvlen", *argv
);
1177 get_icvlen(&cipher
.icv_len
, *argv
);
1178 } else if (strcmp(*argv
, "encrypt") == 0) {
1182 ret
= one_of("encrypt", *argv
, values_on_off
,
1183 ARRAY_SIZE(values_on_off
), &i
);
1186 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ENCRYPT
, i
);
1187 } else if (strcmp(*argv
, "send_sci") == 0) {
1191 ret
= one_of("send_sci", *argv
, values_on_off
,
1192 ARRAY_SIZE(values_on_off
), &i
);
1196 addattr8(n
, MACSEC_BUFLEN
,
1197 IFLA_MACSEC_INC_SCI
, send_sci
);
1198 } else if (strcmp(*argv
, "end_station") == 0) {
1202 ret
= one_of("end_station", *argv
, values_on_off
,
1203 ARRAY_SIZE(values_on_off
), &i
);
1207 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ES
, es
);
1208 } else if (strcmp(*argv
, "scb") == 0) {
1212 ret
= one_of("scb", *argv
, values_on_off
,
1213 ARRAY_SIZE(values_on_off
), &i
);
1217 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_SCB
, scb
);
1218 } else if (strcmp(*argv
, "protect") == 0) {
1222 ret
= one_of("protect", *argv
, values_on_off
,
1223 ARRAY_SIZE(values_on_off
), &i
);
1226 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_PROTECT
, i
);
1227 } else if (strcmp(*argv
, "replay") == 0) {
1231 ret
= one_of("replay", *argv
, values_on_off
,
1232 ARRAY_SIZE(values_on_off
), &i
);
1235 replay_protect
= !!i
;
1236 } else if (strcmp(*argv
, "window") == 0) {
1238 ret
= get_u32(&window
, *argv
, 0);
1240 invarg("expected replay window size", *argv
);
1241 } else if (strcmp(*argv
, "validate") == 0) {
1243 ret
= one_of("validate", *argv
,
1244 VALIDATE_STR
, ARRAY_SIZE(VALIDATE_STR
),
1248 addattr8(n
, MACSEC_BUFLEN
,
1249 IFLA_MACSEC_VALIDATION
, validate
);
1250 } else if (strcmp(*argv
, "encodingsa") == 0) {
1251 if (encoding_sa
!= 0xff)
1252 duparg2("encodingsa", "encodingsa");
1254 ret
= get_an(&encoding_sa
, *argv
);
1256 invarg("expected an { 0..3 }", *argv
);
1258 fprintf(stderr
, "macsec: unknown command \"%s\"?\n",
1267 if (!check_txsc_flags(es
, scb
, send_sci
)) {
1268 fprintf(stderr
, "invalid combination of send_sci/end_station/scb\n");
1272 if (window
!= -1 && replay_protect
== -1) {
1274 "replay window set, but replay protection not enabled. did you mean 'replay on window %u'?\n",
1277 } else if (window
== -1 && replay_protect
== 1) {
1279 "replay protection enabled, but no window set. did you mean 'replay on window VALUE'?\n");
1284 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_CIPHER_SUITE
,
1285 &cipher
.id
, sizeof(cipher
.id
));
1287 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ICV_LEN
,
1288 &cipher
.icv_len
, sizeof(cipher
.icv_len
));
1290 if (replay_protect
!= -1) {
1291 addattr32(n
, MACSEC_BUFLEN
, IFLA_MACSEC_WINDOW
, window
);
1292 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_REPLAY_PROTECT
,
1296 if (encoding_sa
!= 0xff) {
1297 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ENCODING_SA
,
1298 &encoding_sa
, sizeof(encoding_sa
));
1304 static void macsec_print_help(struct link_util
*lu
, int argc
, char **argv
,
1310 struct link_util macsec_link_util
= {
1312 .maxattr
= IFLA_MACSEC_MAX
,
1313 .parse_opt
= macsec_parse_opt
,
1314 .print_help
= macsec_print_help
,
1315 .print_opt
= macsec_print_opt
,