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 * const values_on_off
[] = { "off", "on" };
28 static const char * const 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)
85 "Usage: ip macsec add DEV tx sa { 0..3 } [ OPTS ] key ID KEY\n"
86 " ip macsec set DEV tx sa { 0..3 } [ OPTS ]\n"
87 " ip macsec del DEV tx sa { 0..3 }\n"
88 " ip macsec add DEV rx SCI [ on | off ]\n"
89 " ip macsec set DEV rx SCI [ on | off ]\n"
90 " ip macsec del DEV rx SCI\n"
91 " ip macsec add DEV rx SCI sa { 0..3 } [ OPTS ] key ID KEY\n"
92 " ip macsec set DEV rx SCI sa { 0..3 } [ OPTS ]\n"
93 " ip macsec del DEV rx SCI sa { 0..3 }\n"
95 " ip macsec show DEV\n"
96 "where OPTS := [ pn <u32> ] [ on | off ]\n"
97 " ID := 128-bit hex string\n"
98 " KEY := 128-bit or 256-bit hex string\n"
99 " SCI := { sci <u64> | port { 1..2^16-1 } address <lladdr> }\n");
104 static int one_of(const char *msg
, const char *realval
, const char * const *list
,
105 size_t len
, int *index
)
109 for (i
= 0; i
< len
; i
++) {
110 if (matches(realval
, list
[i
]) == 0) {
116 fprintf(stderr
, "Error: argument of \"%s\" must be one of ", msg
);
117 for (i
= 0; i
< len
; i
++)
118 fprintf(stderr
, "\"%s\", ", list
[i
]);
119 fprintf(stderr
, "not \"%s\"\n", realval
);
123 static int get_an(__u8
*val
, const char *arg
)
125 int ret
= get_u8(val
, arg
, 0);
136 static int get_sci(__u64
*sci
, const char *arg
)
138 return get_be64(sci
, arg
, 16);
141 static int get_port(__be16
*port
, const char *arg
)
143 return get_be16(port
, arg
, 0);
147 #define STR(a) _STR(a)
149 static void get_icvlen(__u8
*icvlen
, char *arg
)
151 int ret
= get_u8(icvlen
, arg
, 10);
154 invarg("expected ICV length", arg
);
156 if (*icvlen
< MACSEC_MIN_ICV_LEN
|| *icvlen
> MACSEC_STD_ICV_LEN
)
157 invarg("ICV length must be in the range {"
158 STR(MACSEC_MIN_ICV_LEN
) ".." STR(MACSEC_STD_ICV_LEN
)
162 static bool get_sa(int *argcp
, char ***argvp
, __u8
*an
)
165 char **argv
= *argvp
;
168 if (argc
<= 0 || strcmp(*argv
, "sa") != 0)
172 ret
= get_an(an
, *argv
);
174 invarg("expected an { 0..3 }", *argv
);
182 static int parse_sa_args(int *argcp
, char ***argvp
, struct sa_desc
*sa
)
185 char **argv
= *argvp
;
187 bool active_set
= false;
190 if (strcmp(*argv
, "pn") == 0) {
194 ret
= get_u32(&sa
->pn
, *argv
, 0);
196 invarg("expected pn", *argv
);
198 invarg("expected pn != 0", *argv
);
199 } else if (strcmp(*argv
, "key") == 0) {
203 if (!hexstring_a2n(*argv
, sa
->key_id
, MACSEC_KEYID_LEN
,
205 invarg("expected key id", *argv
);
207 if (!hexstring_a2n(*argv
, sa
->key
, MACSEC_MAX_KEY_LEN
,
209 invarg("expected key", *argv
);
210 } else if (strcmp(*argv
, "on") == 0) {
212 duparg2("on/off", "on");
215 } else if (strcmp(*argv
, "off") == 0) {
217 duparg2("on/off", "off");
221 fprintf(stderr
, "macsec: unknown command \"%s\"?\n",
234 static __u64
make_sci(char *addr
, __be16 port
)
238 memcpy(&sci
, addr
, ETH_ALEN
);
239 memcpy(((char *)&sci
) + ETH_ALEN
, &port
, sizeof(port
));
244 static bool sci_complete(bool sci
, bool port
, bool addr
, bool port_only
)
246 return sci
|| (port
&& (addr
|| port_only
));
249 static int get_sci_portaddr(struct sci
*sci
, int *argcp
, char ***argvp
,
250 bool port_only
, bool optional
)
253 char **argv
= *argvp
;
255 bool p
= false, a
= false, s
= false;
258 if (strcmp(*argv
, "sci") == 0) {
260 invarg("expected address", *argv
);
262 invarg("expected port", *argv
);
264 ret
= get_sci(&sci
->sci
, *argv
);
266 invarg("expected sci", *argv
);
268 } else if (strcmp(*argv
, "port") == 0) {
270 ret
= get_port(&sci
->port
, *argv
);
272 invarg("expected port", *argv
);
274 invarg("expected port != 0", *argv
);
276 } else if (strcmp(*argv
, "address") == 0) {
278 ret
= ll_addr_a2n(sci
->abuf
, sizeof(sci
->abuf
), *argv
);
280 invarg("expected lladdr", *argv
);
282 } else if (optional
) {
285 invarg("expected sci, port, or address", *argv
);
290 if (sci_complete(s
, p
, a
, port_only
))
294 if (!optional
&& !sci_complete(s
, p
, a
, port_only
))
298 sci
->sci
= make_sci(sci
->abuf
, sci
->port
);
306 static bool parse_rxsci(int *argcp
, char ***argvp
, struct rxsc_desc
*rxsc
,
307 struct sa_desc
*rxsa
)
309 struct sci sci
= { 0 };
312 get_sci_portaddr(&sci
, argcp
, argvp
, false, false) < 0) {
313 fprintf(stderr
, "expected sci\n");
319 return get_sa(argcp
, argvp
, &rxsa
->an
);
322 static int parse_rxsci_args(int *argcp
, char ***argvp
, struct rxsc_desc
*rxsc
)
325 char **argv
= *argvp
;
326 bool active_set
= false;
329 if (strcmp(*argv
, "on") == 0) {
331 duparg2("on/off", "on");
334 } else if (strcmp(*argv
, "off") == 0) {
336 duparg2("on/off", "off");
337 rxsc
->active
= false;
340 fprintf(stderr
, "macsec: unknown command \"%s\"?\n",
360 static const enum macsec_nl_commands macsec_commands
[__CMD_MAX
][2][2] = {
362 [0] = {-1, MACSEC_CMD_ADD_RXSC
},
363 [1] = {MACSEC_CMD_ADD_TXSA
, MACSEC_CMD_ADD_RXSA
},
366 [0] = {-1, MACSEC_CMD_UPD_RXSC
},
367 [1] = {MACSEC_CMD_UPD_TXSA
, MACSEC_CMD_UPD_RXSA
},
370 [0] = {-1, MACSEC_CMD_DEL_RXSC
},
371 [1] = {MACSEC_CMD_DEL_TXSA
, MACSEC_CMD_DEL_RXSA
},
375 static int do_modify_nl(enum cmd c
, enum macsec_nl_commands cmd
, int ifindex
,
376 struct rxsc_desc
*rxsc
, struct sa_desc
*sa
)
378 struct rtattr
*attr_sa
;
380 MACSEC_GENL_REQ(req
, MACSEC_BUFLEN
, cmd
, NLM_F_REQUEST
);
382 addattr32(&req
.n
, MACSEC_BUFLEN
, MACSEC_ATTR_IFINDEX
, ifindex
);
384 struct rtattr
*attr_rxsc
;
386 attr_rxsc
= addattr_nest(&req
.n
, MACSEC_BUFLEN
,
387 MACSEC_ATTR_RXSC_CONFIG
);
388 addattr64(&req
.n
, MACSEC_BUFLEN
,
389 MACSEC_RXSC_ATTR_SCI
, rxsc
->sci
);
390 if (c
!= CMD_DEL
&& rxsc
->active
!= 0xff)
391 addattr8(&req
.n
, MACSEC_BUFLEN
,
392 MACSEC_RXSC_ATTR_ACTIVE
, rxsc
->active
);
394 addattr_nest_end(&req
.n
, attr_rxsc
);
400 attr_sa
= addattr_nest(&req
.n
, MACSEC_BUFLEN
, MACSEC_ATTR_SA_CONFIG
);
402 addattr8(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_AN
, sa
->an
);
406 addattr32(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_PN
,
410 addattr_l(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_KEYID
,
411 sa
->key_id
, MACSEC_KEYID_LEN
);
412 addattr_l(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_KEY
,
413 sa
->key
, sa
->key_len
);
416 if (sa
->active
!= 0xff) {
417 addattr8(&req
.n
, MACSEC_BUFLEN
,
418 MACSEC_SA_ATTR_ACTIVE
, sa
->active
);
422 addattr_nest_end(&req
.n
, attr_sa
);
425 if (rtnl_talk(&genl_rth
, &req
.n
, NULL
) < 0)
431 static bool check_sa_args(enum cmd c
, struct sa_desc
*sa
)
435 fprintf(stderr
, "cannot create SA without key\n");
440 fprintf(stderr
, "must specify a packet number != 0\n");
443 } else if (c
== CMD_UPD
) {
445 fprintf(stderr
, "cannot change key on SA\n");
453 static int do_modify_txsa(enum cmd c
, int argc
, char **argv
, int ifindex
)
455 struct sa_desc txsa
= {0};
456 enum macsec_nl_commands cmd
;
461 if (argc
== 0 || !get_sa(&argc
, &argv
, &txsa
.an
))
467 if (parse_sa_args(&argc
, &argv
, &txsa
))
470 if (check_sa_args(c
, &txsa
))
474 cmd
= macsec_commands
[c
][1][0];
475 return do_modify_nl(c
, cmd
, ifindex
, NULL
, &txsa
);
478 static int do_modify_rxsci(enum cmd c
, int argc
, char **argv
, int ifindex
)
480 struct rxsc_desc rxsc
= {0};
481 struct sa_desc rxsa
= {0};
483 enum macsec_nl_commands cmd
;
485 rxsc
.ifindex
= ifindex
;
490 sa_set
= parse_rxsci(&argc
, &argv
, &rxsc
, &rxsa
);
495 if (sa_set
&& (parse_sa_args(&argc
, &argv
, &rxsa
) ||
496 check_sa_args(c
, &rxsa
)))
498 if (!sa_set
&& parse_rxsci_args(&argc
, &argv
, &rxsc
))
502 cmd
= macsec_commands
[c
][sa_set
][1];
503 return do_modify_nl(c
, cmd
, rxsc
.ifindex
, &rxsc
, &rxsa
);
506 static int do_modify(enum cmd c
, int argc
, char **argv
)
513 ifindex
= ll_name_to_index(*argv
);
515 fprintf(stderr
, "Device \"%s\" does not exist.\n", *argv
);
523 if (strcmp(*argv
, "tx") == 0)
524 return do_modify_txsa(c
, argc
-1, argv
+1, ifindex
);
525 if (strcmp(*argv
, "rx") == 0)
526 return do_modify_rxsci(c
, argc
-1, argv
+1, ifindex
);
538 static int validate_dump(struct rtattr
**attrs
)
540 return attrs
[MACSEC_ATTR_IFINDEX
] && attrs
[MACSEC_ATTR_SECY
] &&
541 attrs
[MACSEC_ATTR_TXSA_LIST
] && attrs
[MACSEC_ATTR_RXSC_LIST
] &&
542 attrs
[MACSEC_ATTR_TXSC_STATS
] && attrs
[MACSEC_ATTR_SECY_STATS
];
546 static int validate_secy_dump(struct rtattr
**attrs
)
548 return attrs
[MACSEC_SECY_ATTR_SCI
] &&
549 attrs
[MACSEC_SECY_ATTR_ENCODING_SA
] &&
550 attrs
[MACSEC_SECY_ATTR_CIPHER_SUITE
] &&
551 attrs
[MACSEC_SECY_ATTR_ICV_LEN
] &&
552 attrs
[MACSEC_SECY_ATTR_PROTECT
] &&
553 attrs
[MACSEC_SECY_ATTR_REPLAY
] &&
554 attrs
[MACSEC_SECY_ATTR_OPER
] &&
555 attrs
[MACSEC_SECY_ATTR_VALIDATE
] &&
556 attrs
[MACSEC_SECY_ATTR_ENCRYPT
] &&
557 attrs
[MACSEC_SECY_ATTR_INC_SCI
] &&
558 attrs
[MACSEC_SECY_ATTR_ES
] &&
559 attrs
[MACSEC_SECY_ATTR_SCB
];
562 static void print_flag(struct rtattr
*attrs
[], const char *desc
,
570 flag
= rta_getattr_u8(attrs
[field
]);
571 if (is_json_context())
572 print_bool(PRINT_JSON
, desc
, NULL
, flag
);
574 print_string(PRINT_FP
, NULL
, "%s ", desc
);
575 print_string(PRINT_FP
, NULL
, "%s ",
576 flag
? "on" : "off");
580 static void print_key(struct rtattr
*key
)
584 print_string(PRINT_ANY
, "key", " key %s\n",
585 hexstring_n2a(RTA_DATA(key
), RTA_PAYLOAD(key
),
586 keyid
, sizeof(keyid
)));
589 #define CIPHER_NAME_GCM_AES_128 "GCM-AES-128"
590 #define CIPHER_NAME_GCM_AES_256 "GCM-AES-256"
591 #define DEFAULT_CIPHER_NAME CIPHER_NAME_GCM_AES_128
593 static const char *cs_id_to_name(__u64 cid
)
596 case MACSEC_DEFAULT_CIPHER_ID
:
597 return DEFAULT_CIPHER_NAME
;
598 case MACSEC_CIPHER_ID_GCM_AES_128
:
599 /* MACSEC_DEFAULT_CIPHER_ALT: */
600 return CIPHER_NAME_GCM_AES_128
;
601 case MACSEC_CIPHER_ID_GCM_AES_256
:
602 return CIPHER_NAME_GCM_AES_256
;
608 static void print_attrs(struct rtattr
*attrs
[])
610 print_flag(attrs
, "protect", MACSEC_SECY_ATTR_PROTECT
);
612 if (attrs
[MACSEC_SECY_ATTR_VALIDATE
]) {
613 __u8 val
= rta_getattr_u8(attrs
[MACSEC_SECY_ATTR_VALIDATE
]);
615 print_string(PRINT_ANY
, "validate",
616 "validate %s ", validate_str
[val
]);
619 print_flag(attrs
, "sc", MACSEC_RXSC_ATTR_ACTIVE
);
620 print_flag(attrs
, "sa", MACSEC_SA_ATTR_ACTIVE
);
621 print_flag(attrs
, "encrypt", MACSEC_SECY_ATTR_ENCRYPT
);
622 print_flag(attrs
, "send_sci", MACSEC_SECY_ATTR_INC_SCI
);
623 print_flag(attrs
, "end_station", MACSEC_SECY_ATTR_ES
);
624 print_flag(attrs
, "scb", MACSEC_SECY_ATTR_SCB
);
625 print_flag(attrs
, "replay", MACSEC_SECY_ATTR_REPLAY
);
627 if (attrs
[MACSEC_SECY_ATTR_WINDOW
]) {
628 __u32 win
= rta_getattr_u32(attrs
[MACSEC_SECY_ATTR_WINDOW
]);
630 print_uint(PRINT_ANY
, "window", "window %u ", win
);
633 if (attrs
[MACSEC_SECY_ATTR_CIPHER_SUITE
]) {
634 __u64 cid
= rta_getattr_u64(attrs
[MACSEC_SECY_ATTR_CIPHER_SUITE
]);
637 print_string(PRINT_ANY
, "cipher_suite",
638 " cipher suite: %s,", cs_id_to_name(cid
));
641 if (attrs
[MACSEC_SECY_ATTR_ICV_LEN
]) {
642 __u8 icv_len
= rta_getattr_u8(attrs
[MACSEC_SECY_ATTR_ICV_LEN
]);
644 print_uint(PRINT_ANY
, "icv_length",
645 " using ICV length %u\n", icv_len
);
649 static __u64
getattr_u64(const struct rtattr
*stat
)
651 size_t len
= RTA_PAYLOAD(stat
);
655 return rta_getattr_u64(stat
);
657 return rta_getattr_u32(stat
);
659 return rta_getattr_u16(stat
);
661 return rta_getattr_u8(stat
);
663 fprintf(stderr
, "invalid attribute length %zu\n",
669 static void print_fp_stats(const char *prefix
,
670 const char *names
[], unsigned int num
,
671 struct rtattr
*stats
[])
676 printf("%sstats:", prefix
);
678 for (i
= 1; i
< num
; i
++) {
681 printf(" %s", names
[i
]);
684 printf("\n%s ", prefix
);
686 for (i
= 1; i
< num
; i
++) {
690 pad
= strlen(names
[i
]) + 1;
692 printf("%*llu", pad
, getattr_u64(stats
[i
]));
694 printf("%*c", pad
, '-');
699 static void print_json_stats(const char *names
[], unsigned int num
,
700 struct rtattr
*stats
[])
704 for (i
= 1; i
< num
; i
++) {
705 if (!names
[i
] || !stats
[i
])
708 print_u64(PRINT_JSON
, names
[i
],
709 NULL
, getattr_u64(stats
[i
]));
713 static void print_stats(const char *prefix
,
714 const char *names
[], unsigned int num
,
715 struct rtattr
*stats
[])
718 if (is_json_context())
719 print_json_stats(names
, num
, stats
);
721 print_fp_stats(prefix
, names
, num
, stats
);
724 static const char *txsc_stats_names
[NUM_MACSEC_TXSC_STATS_ATTR
] = {
725 [MACSEC_TXSC_STATS_ATTR_OUT_PKTS_PROTECTED
] = "OutPktsProtected",
726 [MACSEC_TXSC_STATS_ATTR_OUT_PKTS_ENCRYPTED
] = "OutPktsEncrypted",
727 [MACSEC_TXSC_STATS_ATTR_OUT_OCTETS_PROTECTED
] = "OutOctetsProtected",
728 [MACSEC_TXSC_STATS_ATTR_OUT_OCTETS_ENCRYPTED
] = "OutOctetsEncrypted",
731 static void print_txsc_stats(const char *prefix
, struct rtattr
*attr
)
733 struct rtattr
*stats
[MACSEC_TXSC_STATS_ATTR_MAX
+ 1];
735 if (!attr
|| show_stats
== 0)
738 parse_rtattr_nested(stats
, MACSEC_TXSC_STATS_ATTR_MAX
, attr
);
740 print_stats(prefix
, txsc_stats_names
, NUM_MACSEC_TXSC_STATS_ATTR
,
744 static const char *secy_stats_names
[NUM_MACSEC_SECY_STATS_ATTR
] = {
745 [MACSEC_SECY_STATS_ATTR_OUT_PKTS_UNTAGGED
] = "OutPktsUntagged",
746 [MACSEC_SECY_STATS_ATTR_IN_PKTS_UNTAGGED
] = "InPktsUntagged",
747 [MACSEC_SECY_STATS_ATTR_OUT_PKTS_TOO_LONG
] = "OutPktsTooLong",
748 [MACSEC_SECY_STATS_ATTR_IN_PKTS_NO_TAG
] = "InPktsNoTag",
749 [MACSEC_SECY_STATS_ATTR_IN_PKTS_BAD_TAG
] = "InPktsBadTag",
750 [MACSEC_SECY_STATS_ATTR_IN_PKTS_UNKNOWN_SCI
] = "InPktsUnknownSCI",
751 [MACSEC_SECY_STATS_ATTR_IN_PKTS_NO_SCI
] = "InPktsNoSCI",
752 [MACSEC_SECY_STATS_ATTR_IN_PKTS_OVERRUN
] = "InPktsOverrun",
755 static void print_secy_stats(const char *prefix
, struct rtattr
*attr
)
757 struct rtattr
*stats
[MACSEC_SECY_STATS_ATTR_MAX
+ 1];
759 if (!attr
|| show_stats
== 0)
762 parse_rtattr_nested(stats
, MACSEC_SECY_STATS_ATTR_MAX
, attr
);
764 print_stats(prefix
, secy_stats_names
,
765 NUM_MACSEC_SECY_STATS_ATTR
, stats
);
768 static const char *rxsa_stats_names
[NUM_MACSEC_SA_STATS_ATTR
] = {
769 [MACSEC_SA_STATS_ATTR_IN_PKTS_OK
] = "InPktsOK",
770 [MACSEC_SA_STATS_ATTR_IN_PKTS_INVALID
] = "InPktsInvalid",
771 [MACSEC_SA_STATS_ATTR_IN_PKTS_NOT_VALID
] = "InPktsNotValid",
772 [MACSEC_SA_STATS_ATTR_IN_PKTS_NOT_USING_SA
] = "InPktsNotUsingSA",
773 [MACSEC_SA_STATS_ATTR_IN_PKTS_UNUSED_SA
] = "InPktsUnusedSA",
776 static void print_rxsa_stats(const char *prefix
, struct rtattr
*attr
)
778 struct rtattr
*stats
[MACSEC_SA_STATS_ATTR_MAX
+ 1];
780 if (!attr
|| show_stats
== 0)
783 parse_rtattr_nested(stats
, MACSEC_SA_STATS_ATTR_MAX
, attr
);
785 print_stats(prefix
, rxsa_stats_names
, NUM_MACSEC_SA_STATS_ATTR
, stats
);
788 static const char *txsa_stats_names
[NUM_MACSEC_SA_STATS_ATTR
] = {
789 [MACSEC_SA_STATS_ATTR_OUT_PKTS_PROTECTED
] = "OutPktsProtected",
790 [MACSEC_SA_STATS_ATTR_OUT_PKTS_ENCRYPTED
] = "OutPktsEncrypted",
793 static void print_txsa_stats(const char *prefix
, struct rtattr
*attr
)
795 struct rtattr
*stats
[MACSEC_SA_STATS_ATTR_MAX
+ 1];
797 if (!attr
|| show_stats
== 0)
800 parse_rtattr_nested(stats
, MACSEC_SA_STATS_ATTR_MAX
, attr
);
802 print_stats(prefix
, txsa_stats_names
, NUM_MACSEC_SA_STATS_ATTR
, stats
);
805 static void print_tx_sc(const char *prefix
, __u64 sci
, __u8 encoding_sa
,
806 struct rtattr
*txsc_stats
, struct rtattr
*secy_stats
,
809 struct rtattr
*sa_attr
[MACSEC_SA_ATTR_MAX
+ 1];
813 print_string(PRINT_FP
, NULL
, "%s", prefix
);
814 print_0xhex(PRINT_ANY
, "sci",
815 "TXSC: %016llx", ntohll(sci
));
816 print_uint(PRINT_ANY
, "encoding_sa",
817 " on SA %d\n", encoding_sa
);
819 print_secy_stats(prefix
, secy_stats
);
820 print_txsc_stats(prefix
, txsc_stats
);
822 open_json_array(PRINT_JSON
, "sa_list");
823 rem
= RTA_PAYLOAD(sa
);
824 for (a
= RTA_DATA(sa
); RTA_OK(a
, rem
); a
= RTA_NEXT(a
, rem
)) {
827 open_json_object(NULL
);
828 parse_rtattr_nested(sa_attr
, MACSEC_SA_ATTR_MAX
, a
);
829 state
= rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_ACTIVE
]);
831 print_string(PRINT_FP
, NULL
, "%s", prefix
);
832 print_string(PRINT_FP
, NULL
, "%s", prefix
);
833 print_uint(PRINT_ANY
, "an", "%d:",
834 rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_AN
]));
835 print_uint(PRINT_ANY
, "pn", " PN %u,",
836 rta_getattr_u32(sa_attr
[MACSEC_SA_ATTR_PN
]));
838 print_bool(PRINT_JSON
, "active", NULL
, state
);
839 print_string(PRINT_FP
, NULL
,
840 " state %s,", state
? "on" : "off");
841 print_key(sa_attr
[MACSEC_SA_ATTR_KEYID
]);
843 print_txsa_stats(prefix
, sa_attr
[MACSEC_SA_ATTR_STATS
]);
846 close_json_array(PRINT_JSON
, NULL
);
849 static const char *rxsc_stats_names
[NUM_MACSEC_RXSC_STATS_ATTR
] = {
850 [MACSEC_RXSC_STATS_ATTR_IN_OCTETS_VALIDATED
] = "InOctetsValidated",
851 [MACSEC_RXSC_STATS_ATTR_IN_OCTETS_DECRYPTED
] = "InOctetsDecrypted",
852 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_UNCHECKED
] = "InPktsUnchecked",
853 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_DELAYED
] = "InPktsDelayed",
854 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_OK
] = "InPktsOK",
855 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_INVALID
] = "InPktsInvalid",
856 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_LATE
] = "InPktsLate",
857 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_NOT_VALID
] = "InPktsNotValid",
858 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_NOT_USING_SA
] = "InPktsNotUsingSA",
859 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_UNUSED_SA
] = "InPktsUnusedSA",
862 static void print_rxsc_stats(const char *prefix
, struct rtattr
*attr
)
864 struct rtattr
*stats
[MACSEC_RXSC_STATS_ATTR_MAX
+ 1];
866 if (!attr
|| show_stats
== 0)
869 parse_rtattr_nested(stats
, MACSEC_RXSC_STATS_ATTR_MAX
, attr
);
871 print_stats(prefix
, rxsc_stats_names
,
872 NUM_MACSEC_RXSC_STATS_ATTR
, stats
);
875 static void print_rx_sc(const char *prefix
, __be64 sci
, __u8 active
,
876 struct rtattr
*rxsc_stats
, struct rtattr
*sa
)
878 struct rtattr
*sa_attr
[MACSEC_SA_ATTR_MAX
+ 1];
882 print_string(PRINT_FP
, NULL
, "%s", prefix
);
883 print_0xhex(PRINT_ANY
, "sci",
884 "RXSC: %016llx,", ntohll(sci
));
885 print_bool(PRINT_JSON
, "active", NULL
, active
);
886 print_string(PRINT_FP
, NULL
,
887 " state %s\n", active
? "on" : "off");
888 print_rxsc_stats(prefix
, rxsc_stats
);
890 open_json_array(PRINT_JSON
, "sa_list");
891 rem
= RTA_PAYLOAD(sa
);
892 for (a
= RTA_DATA(sa
); RTA_OK(a
, rem
); a
= RTA_NEXT(a
, rem
)) {
895 open_json_object(NULL
);
896 parse_rtattr_nested(sa_attr
, MACSEC_SA_ATTR_MAX
, a
);
897 state
= rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_ACTIVE
]);
899 print_string(PRINT_FP
, NULL
, "%s", prefix
);
900 print_string(PRINT_FP
, NULL
, "%s", prefix
);
901 print_uint(PRINT_ANY
, "an", "%u:",
902 rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_AN
]));
903 print_uint(PRINT_ANY
, "pn", " PN %u,",
904 rta_getattr_u32(sa_attr
[MACSEC_SA_ATTR_PN
]));
906 print_bool(PRINT_JSON
, "active", NULL
, state
);
907 print_string(PRINT_FP
, NULL
, " state %s,",
908 state
? "on" : "off");
910 print_key(sa_attr
[MACSEC_SA_ATTR_KEYID
]);
912 print_rxsa_stats(prefix
, sa_attr
[MACSEC_SA_ATTR_STATS
]);
915 close_json_array(PRINT_JSON
, NULL
);
918 static void print_rxsc_list(struct rtattr
*sc
)
920 int rem
= RTA_PAYLOAD(sc
);
923 open_json_array(PRINT_JSON
, "rx_sc");
924 for (c
= RTA_DATA(sc
); RTA_OK(c
, rem
); c
= RTA_NEXT(c
, rem
)) {
925 struct rtattr
*sc_attr
[MACSEC_RXSC_ATTR_MAX
+ 1];
927 open_json_object(NULL
);
929 parse_rtattr_nested(sc_attr
, MACSEC_RXSC_ATTR_MAX
, c
);
931 rta_getattr_u64(sc_attr
[MACSEC_RXSC_ATTR_SCI
]),
932 rta_getattr_u32(sc_attr
[MACSEC_RXSC_ATTR_ACTIVE
]),
933 sc_attr
[MACSEC_RXSC_ATTR_STATS
],
934 sc_attr
[MACSEC_RXSC_ATTR_SA_LIST
]);
937 close_json_array(PRINT_JSON
, NULL
);
940 static int process(struct nlmsghdr
*n
, void *arg
)
942 struct genlmsghdr
*ghdr
;
943 struct rtattr
*attrs
[MACSEC_ATTR_MAX
+ 1];
944 struct rtattr
*attrs_secy
[MACSEC_SECY_ATTR_MAX
+ 1];
945 int len
= n
->nlmsg_len
;
950 if (n
->nlmsg_type
!= genl_family
)
953 len
-= NLMSG_LENGTH(GENL_HDRLEN
);
957 ghdr
= NLMSG_DATA(n
);
958 if (ghdr
->cmd
!= MACSEC_CMD_GET_TXSC
)
961 parse_rtattr(attrs
, MACSEC_ATTR_MAX
, (void *) ghdr
+ GENL_HDRLEN
, len
);
962 if (!validate_dump(attrs
)) {
963 fprintf(stderr
, "incomplete dump message\n");
967 ifindex
= rta_getattr_u32(attrs
[MACSEC_ATTR_IFINDEX
]);
968 parse_rtattr_nested(attrs_secy
, MACSEC_SECY_ATTR_MAX
,
969 attrs
[MACSEC_ATTR_SECY
]);
971 if (!validate_secy_dump(attrs_secy
)) {
972 fprintf(stderr
, "incomplete dump message\n");
976 sci
= rta_getattr_u64(attrs_secy
[MACSEC_SECY_ATTR_SCI
]);
977 encoding_sa
= rta_getattr_u8(attrs_secy
[MACSEC_SECY_ATTR_ENCODING_SA
]);
979 if (filter
.ifindex
&& ifindex
!= filter
.ifindex
)
982 if (filter
.sci
&& sci
!= filter
.sci
)
985 open_json_object(NULL
);
986 print_uint(PRINT_ANY
, "ifindex", "%u: ", ifindex
);
987 print_color_string(PRINT_ANY
, COLOR_IFNAME
, "ifname",
988 "%s: ", ll_index_to_name(ifindex
));
990 print_attrs(attrs_secy
);
992 print_tx_sc(" ", sci
, encoding_sa
,
993 attrs
[MACSEC_ATTR_TXSC_STATS
],
994 attrs
[MACSEC_ATTR_SECY_STATS
],
995 attrs
[MACSEC_ATTR_TXSA_LIST
]);
997 if (attrs
[MACSEC_ATTR_RXSC_LIST
])
998 print_rxsc_list(attrs
[MACSEC_ATTR_RXSC_LIST
]);
1000 close_json_object();
1005 static int do_dump(int ifindex
)
1007 MACSEC_GENL_REQ(req
, MACSEC_BUFLEN
, MACSEC_CMD_GET_TXSC
,
1008 NLM_F_REQUEST
| NLM_F_DUMP
);
1010 memset(&filter
, 0, sizeof(filter
));
1011 filter
.ifindex
= ifindex
;
1013 req
.n
.nlmsg_seq
= genl_rth
.dump
= ++genl_rth
.seq
;
1014 if (rtnl_send(&genl_rth
, &req
, req
.n
.nlmsg_len
) < 0) {
1015 perror("Failed to send dump request");
1020 if (rtnl_dump_filter(&genl_rth
, process
, stdout
) < 0) {
1022 fprintf(stderr
, "Dump terminated\n");
1030 static int do_show(int argc
, char **argv
)
1037 ifindex
= ll_name_to_index(*argv
);
1039 fprintf(stderr
, "Device \"%s\" does not exist.\n", *argv
);
1045 return do_dump(ifindex
);
1051 int do_ipmacsec(int argc
, char **argv
)
1056 if (matches(*argv
, "help") == 0)
1059 if (genl_init_handle(&genl_rth
, MACSEC_GENL_NAME
, &genl_family
))
1062 if (matches(*argv
, "show") == 0)
1063 return do_show(argc
-1, argv
+1);
1065 if (matches(*argv
, "add") == 0)
1066 return do_modify(CMD_ADD
, argc
-1, argv
+1);
1067 if (matches(*argv
, "set") == 0)
1068 return do_modify(CMD_UPD
, argc
-1, argv
+1);
1069 if (matches(*argv
, "delete") == 0)
1070 return do_modify(CMD_DEL
, argc
-1, argv
+1);
1072 fprintf(stderr
, "Command \"%s\" is unknown, try \"ip macsec help\".\n",
1077 /* device creation */
1078 static void macsec_print_opt(struct link_util
*lu
, FILE *f
, struct rtattr
*tb
[])
1083 if (tb
[IFLA_MACSEC_SCI
]) {
1084 if (is_json_context()) {
1087 snprintf(b1
, sizeof(b1
), "%016llx",
1088 ntohll(rta_getattr_u64(tb
[IFLA_MACSEC_SCI
])));
1089 print_string(PRINT_JSON
, "sci", NULL
, b1
);
1091 fprintf(f
, "sci %016llx ",
1092 ntohll(rta_getattr_u64(tb
[IFLA_MACSEC_SCI
])));
1096 print_flag(tb
, "protect", IFLA_MACSEC_PROTECT
);
1098 if (tb
[IFLA_MACSEC_CIPHER_SUITE
]) {
1100 = rta_getattr_u64(tb
[IFLA_MACSEC_CIPHER_SUITE
]);
1102 print_string(PRINT_ANY
,
1105 cs_id_to_name(csid
));
1108 if (tb
[IFLA_MACSEC_ICV_LEN
]) {
1109 if (is_json_context()) {
1112 snprintf(b2
, sizeof(b2
), "%hhu",
1113 rta_getattr_u8(tb
[IFLA_MACSEC_ICV_LEN
]));
1114 print_uint(PRINT_JSON
, "icv_len", NULL
, atoi(b2
));
1116 fprintf(f
, "icvlen %hhu ",
1117 rta_getattr_u8(tb
[IFLA_MACSEC_ICV_LEN
]));
1121 if (tb
[IFLA_MACSEC_ENCODING_SA
]) {
1122 if (is_json_context()) {
1125 snprintf(b2
, sizeof(b2
), "%hhu",
1126 rta_getattr_u8(tb
[IFLA_MACSEC_ENCODING_SA
]));
1127 print_uint(PRINT_JSON
, "encoding_sa", NULL
, atoi(b2
));
1129 fprintf(f
, "encodingsa %hhu ",
1130 rta_getattr_u8(tb
[IFLA_MACSEC_ENCODING_SA
]));
1134 if (tb
[IFLA_MACSEC_VALIDATION
]) {
1135 __u8 val
= rta_getattr_u8(tb
[IFLA_MACSEC_VALIDATION
]);
1137 print_string(PRINT_ANY
,
1143 const char *inc_sci
, *es
, *replay
;
1145 if (is_json_context()) {
1146 inc_sci
= "inc_sci";
1147 replay
= "replay_protect";
1150 inc_sci
= "send_sci";
1155 print_flag(tb
, "encrypt", IFLA_MACSEC_ENCRYPT
);
1156 print_flag(tb
, inc_sci
, IFLA_MACSEC_INC_SCI
);
1157 print_flag(tb
, es
, IFLA_MACSEC_ES
);
1158 print_flag(tb
, "scb", IFLA_MACSEC_SCB
);
1159 print_flag(tb
, replay
, IFLA_MACSEC_REPLAY_PROTECT
);
1161 if (tb
[IFLA_MACSEC_WINDOW
])
1162 print_int(PRINT_ANY
,
1165 rta_getattr_u32(tb
[IFLA_MACSEC_WINDOW
]));
1168 static bool check_txsc_flags(bool es
, bool scb
, bool sci
)
1170 if (sci
&& (es
|| scb
))
1177 static void usage(FILE *f
)
1180 "Usage: ... macsec [ [ address <lladdr> ] port { 1..2^16-1 } | sci <u64> ]\n"
1181 " [ cipher { default | gcm-aes-128 | gcm-aes-256 } ]\n"
1182 " [ icvlen { 8..16 } ]\n"
1183 " [ encrypt { on | off } ]\n"
1184 " [ send_sci { on | off } ]\n"
1185 " [ end_station { on | off } ]\n"
1186 " [ scb { on | off } ]\n"
1187 " [ protect { on | off } ]\n"
1188 " [ replay { on | off} window { 0..2^32-1 } ]\n"
1189 " [ validate { strict | check | disabled } ]\n"
1190 " [ encodingsa { 0..3 } ]\n"
1194 static int macsec_parse_opt(struct link_util
*lu
, int argc
, char **argv
,
1198 __u8 encoding_sa
= 0xff;
1200 struct cipher_args cipher
= {0};
1201 enum macsec_validation_type validate
;
1202 bool es
= false, scb
= false, send_sci
= false;
1203 int replay_protect
= -1;
1204 struct sci sci
= { 0 };
1206 ret
= get_sci_portaddr(&sci
, &argc
, &argv
, true, true);
1208 fprintf(stderr
, "expected sci\n");
1214 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_SCI
,
1215 &sci
.sci
, sizeof(sci
.sci
));
1217 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_PORT
,
1218 &sci
.port
, sizeof(sci
.port
));
1222 if (strcmp(*argv
, "cipher") == 0) {
1225 duparg("cipher", *argv
);
1226 if (strcmp(*argv
, "default") == 0)
1227 cipher
.id
= MACSEC_DEFAULT_CIPHER_ID
;
1228 else if (strcmp(*argv
, "gcm-aes-128") == 0 ||
1229 strcmp(*argv
, "GCM-AES-128") == 0)
1230 cipher
.id
= MACSEC_CIPHER_ID_GCM_AES_128
;
1231 else if (strcmp(*argv
, "gcm-aes-256") == 0 ||
1232 strcmp(*argv
, "GCM-AES-256") == 0)
1233 cipher
.id
= MACSEC_CIPHER_ID_GCM_AES_256
;
1235 invarg("expected: default, gcm-aes-128 or"
1236 " gcm-aes-256", *argv
);
1237 } else if (strcmp(*argv
, "icvlen") == 0) {
1240 duparg("icvlen", *argv
);
1241 get_icvlen(&cipher
.icv_len
, *argv
);
1242 } else if (strcmp(*argv
, "encrypt") == 0) {
1246 ret
= one_of("encrypt", *argv
, values_on_off
,
1247 ARRAY_SIZE(values_on_off
), &i
);
1250 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ENCRYPT
, i
);
1251 } else if (strcmp(*argv
, "send_sci") == 0) {
1255 ret
= one_of("send_sci", *argv
, values_on_off
,
1256 ARRAY_SIZE(values_on_off
), &i
);
1260 addattr8(n
, MACSEC_BUFLEN
,
1261 IFLA_MACSEC_INC_SCI
, send_sci
);
1262 } else if (strcmp(*argv
, "end_station") == 0) {
1266 ret
= one_of("end_station", *argv
, values_on_off
,
1267 ARRAY_SIZE(values_on_off
), &i
);
1271 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ES
, es
);
1272 } else if (strcmp(*argv
, "scb") == 0) {
1276 ret
= one_of("scb", *argv
, values_on_off
,
1277 ARRAY_SIZE(values_on_off
), &i
);
1281 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_SCB
, scb
);
1282 } else if (strcmp(*argv
, "protect") == 0) {
1286 ret
= one_of("protect", *argv
, values_on_off
,
1287 ARRAY_SIZE(values_on_off
), &i
);
1290 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_PROTECT
, i
);
1291 } else if (strcmp(*argv
, "replay") == 0) {
1295 ret
= one_of("replay", *argv
, values_on_off
,
1296 ARRAY_SIZE(values_on_off
), &i
);
1299 replay_protect
= !!i
;
1300 } else if (strcmp(*argv
, "window") == 0) {
1302 ret
= get_u32(&window
, *argv
, 0);
1304 invarg("expected replay window size", *argv
);
1305 } else if (strcmp(*argv
, "validate") == 0) {
1307 ret
= one_of("validate", *argv
,
1308 validate_str
, ARRAY_SIZE(validate_str
),
1312 addattr8(n
, MACSEC_BUFLEN
,
1313 IFLA_MACSEC_VALIDATION
, validate
);
1314 } else if (strcmp(*argv
, "encodingsa") == 0) {
1315 if (encoding_sa
!= 0xff)
1316 duparg2("encodingsa", "encodingsa");
1318 ret
= get_an(&encoding_sa
, *argv
);
1320 invarg("expected an { 0..3 }", *argv
);
1322 fprintf(stderr
, "macsec: unknown command \"%s\"?\n",
1331 if (!check_txsc_flags(es
, scb
, send_sci
)) {
1333 "invalid combination of send_sci/end_station/scb\n");
1337 if (window
!= -1 && replay_protect
== -1) {
1339 "replay window set, but replay protection not enabled. did you mean 'replay on window %u'?\n",
1342 } else if (window
== -1 && replay_protect
== 1) {
1344 "replay protection enabled, but no window set. did you mean 'replay on window VALUE'?\n");
1349 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_CIPHER_SUITE
,
1350 &cipher
.id
, sizeof(cipher
.id
));
1352 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ICV_LEN
,
1353 &cipher
.icv_len
, sizeof(cipher
.icv_len
));
1355 if (replay_protect
!= -1) {
1356 addattr32(n
, MACSEC_BUFLEN
, IFLA_MACSEC_WINDOW
, window
);
1357 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_REPLAY_PROTECT
,
1361 if (encoding_sa
!= 0xff) {
1362 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ENCODING_SA
,
1363 &encoding_sa
, sizeof(encoding_sa
));
1369 static void macsec_print_help(struct link_util
*lu
, int argc
, char **argv
,
1375 struct link_util macsec_link_util
= {
1377 .maxattr
= IFLA_MACSEC_MAX
,
1378 .parse_opt
= macsec_parse_opt
,
1379 .print_help
= macsec_print_help
,
1380 .print_opt
= macsec_print_opt
,