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",
34 static const char * const offload_str
[] = {
35 [MACSEC_OFFLOAD_OFF
] = "off",
36 [MACSEC_OFFLOAD_PHY
] = "phy",
48 __u8 key_id
[MACSEC_KEYID_LEN
];
50 __u8 key
[MACSEC_MAX_KEY_LEN
];
63 struct cipher_args cipher
;
65 enum macsec_validation_type validate
;
75 #define MACSEC_BUFLEN 1024
79 static struct rtnl_handle genl_rth
;
80 static int genl_family
= -1;
82 #define MACSEC_GENL_REQ(_req, _bufsiz, _cmd, _flags) \
83 GENL_REQUEST(_req, _bufsiz, genl_family, 0, MACSEC_GENL_VERSION, \
87 static void ipmacsec_usage(void)
90 "Usage: ip macsec add DEV tx sa { 0..3 } [ OPTS ] key ID KEY\n"
91 " ip macsec set DEV tx sa { 0..3 } [ OPTS ]\n"
92 " ip macsec del DEV tx sa { 0..3 }\n"
93 " ip macsec add DEV rx SCI [ on | off ]\n"
94 " ip macsec set DEV rx SCI [ on | off ]\n"
95 " ip macsec del DEV rx SCI\n"
96 " ip macsec add DEV rx SCI sa { 0..3 } [ OPTS ] key ID KEY\n"
97 " ip macsec set DEV rx SCI sa { 0..3 } [ OPTS ]\n"
98 " ip macsec del DEV rx SCI sa { 0..3 }\n"
100 " ip macsec show DEV\n"
101 " ip macsec offload DEV [ off | phy ]\n"
102 "where OPTS := [ pn <u32> ] [ on | off ]\n"
103 " ID := 128-bit hex string\n"
104 " KEY := 128-bit or 256-bit hex string\n"
105 " SCI := { sci <u64> | port { 1..2^16-1 } address <lladdr> }\n");
110 static int one_of(const char *msg
, const char *realval
, const char * const *list
,
111 size_t len
, int *index
)
115 for (i
= 0; i
< len
; i
++) {
116 if (matches(realval
, list
[i
]) == 0) {
122 fprintf(stderr
, "Error: argument of \"%s\" must be one of ", msg
);
123 for (i
= 0; i
< len
; i
++)
124 fprintf(stderr
, "\"%s\", ", list
[i
]);
125 fprintf(stderr
, "not \"%s\"\n", realval
);
129 static int get_an(__u8
*val
, const char *arg
)
131 int ret
= get_u8(val
, arg
, 0);
142 static int get_sci(__u64
*sci
, const char *arg
)
144 return get_be64(sci
, arg
, 16);
147 static int get_port(__be16
*port
, const char *arg
)
149 return get_be16(port
, arg
, 0);
153 #define STR(a) _STR(a)
155 static void get_icvlen(__u8
*icvlen
, char *arg
)
157 int ret
= get_u8(icvlen
, arg
, 10);
160 invarg("expected ICV length", arg
);
162 if (*icvlen
< MACSEC_MIN_ICV_LEN
|| *icvlen
> MACSEC_STD_ICV_LEN
)
163 invarg("ICV length must be in the range {"
164 STR(MACSEC_MIN_ICV_LEN
) ".." STR(MACSEC_STD_ICV_LEN
)
168 static bool get_sa(int *argcp
, char ***argvp
, __u8
*an
)
171 char **argv
= *argvp
;
174 if (argc
<= 0 || strcmp(*argv
, "sa") != 0)
178 ret
= get_an(an
, *argv
);
180 invarg("expected an { 0..3 }", *argv
);
188 static int parse_sa_args(int *argcp
, char ***argvp
, struct sa_desc
*sa
)
191 char **argv
= *argvp
;
193 bool active_set
= false;
196 if (strcmp(*argv
, "pn") == 0) {
200 ret
= get_u32(&sa
->pn
, *argv
, 0);
202 invarg("expected pn", *argv
);
204 invarg("expected pn != 0", *argv
);
205 } else if (strcmp(*argv
, "key") == 0) {
209 if (!hexstring_a2n(*argv
, sa
->key_id
, MACSEC_KEYID_LEN
,
211 invarg("expected key id", *argv
);
213 if (!hexstring_a2n(*argv
, sa
->key
, MACSEC_MAX_KEY_LEN
,
215 invarg("expected key", *argv
);
216 } else if (strcmp(*argv
, "on") == 0) {
218 duparg2("on/off", "on");
221 } else if (strcmp(*argv
, "off") == 0) {
223 duparg2("on/off", "off");
227 fprintf(stderr
, "macsec: unknown command \"%s\"?\n",
240 static __u64
make_sci(char *addr
, __be16 port
)
244 memcpy(&sci
, addr
, ETH_ALEN
);
245 memcpy(((char *)&sci
) + ETH_ALEN
, &port
, sizeof(port
));
250 static bool sci_complete(bool sci
, bool port
, bool addr
, bool port_only
)
252 return sci
|| (port
&& (addr
|| port_only
));
255 static int get_sci_portaddr(struct sci
*sci
, int *argcp
, char ***argvp
,
256 bool port_only
, bool optional
)
259 char **argv
= *argvp
;
261 bool p
= false, a
= false, s
= false;
264 if (strcmp(*argv
, "sci") == 0) {
266 invarg("expected address", *argv
);
268 invarg("expected port", *argv
);
270 ret
= get_sci(&sci
->sci
, *argv
);
272 invarg("expected sci", *argv
);
274 } else if (strcmp(*argv
, "port") == 0) {
276 ret
= get_port(&sci
->port
, *argv
);
278 invarg("expected port", *argv
);
280 invarg("expected port != 0", *argv
);
282 } else if (strcmp(*argv
, "address") == 0) {
284 ret
= ll_addr_a2n(sci
->abuf
, sizeof(sci
->abuf
), *argv
);
286 invarg("expected lladdr", *argv
);
288 } else if (optional
) {
291 invarg("expected sci, port, or address", *argv
);
296 if (sci_complete(s
, p
, a
, port_only
))
300 if (!optional
&& !sci_complete(s
, p
, a
, port_only
))
304 sci
->sci
= make_sci(sci
->abuf
, sci
->port
);
312 static bool parse_rxsci(int *argcp
, char ***argvp
, struct rxsc_desc
*rxsc
,
313 struct sa_desc
*rxsa
)
315 struct sci sci
= { 0 };
318 get_sci_portaddr(&sci
, argcp
, argvp
, false, false) < 0) {
319 fprintf(stderr
, "expected sci\n");
325 return get_sa(argcp
, argvp
, &rxsa
->an
);
328 static int parse_rxsci_args(int *argcp
, char ***argvp
, struct rxsc_desc
*rxsc
)
331 char **argv
= *argvp
;
332 bool active_set
= false;
335 if (strcmp(*argv
, "on") == 0) {
337 duparg2("on/off", "on");
340 } else if (strcmp(*argv
, "off") == 0) {
342 duparg2("on/off", "off");
343 rxsc
->active
= false;
346 fprintf(stderr
, "macsec: unknown command \"%s\"?\n",
367 static const enum macsec_nl_commands macsec_commands
[__CMD_MAX
][2][2] = {
369 [0] = {-1, MACSEC_CMD_ADD_RXSC
},
370 [1] = {MACSEC_CMD_ADD_TXSA
, MACSEC_CMD_ADD_RXSA
},
373 [0] = {-1, MACSEC_CMD_UPD_RXSC
},
374 [1] = {MACSEC_CMD_UPD_TXSA
, MACSEC_CMD_UPD_RXSA
},
377 [0] = {-1, MACSEC_CMD_DEL_RXSC
},
378 [1] = {MACSEC_CMD_DEL_TXSA
, MACSEC_CMD_DEL_RXSA
},
381 [0] = {-1, MACSEC_CMD_UPD_OFFLOAD
},
385 static int do_modify_nl(enum cmd c
, enum macsec_nl_commands cmd
, int ifindex
,
386 struct rxsc_desc
*rxsc
, struct sa_desc
*sa
)
388 struct rtattr
*attr_sa
;
390 MACSEC_GENL_REQ(req
, MACSEC_BUFLEN
, cmd
, NLM_F_REQUEST
);
392 addattr32(&req
.n
, MACSEC_BUFLEN
, MACSEC_ATTR_IFINDEX
, ifindex
);
394 struct rtattr
*attr_rxsc
;
396 attr_rxsc
= addattr_nest(&req
.n
, MACSEC_BUFLEN
,
397 MACSEC_ATTR_RXSC_CONFIG
);
398 addattr64(&req
.n
, MACSEC_BUFLEN
,
399 MACSEC_RXSC_ATTR_SCI
, rxsc
->sci
);
400 if (c
!= CMD_DEL
&& rxsc
->active
!= 0xff)
401 addattr8(&req
.n
, MACSEC_BUFLEN
,
402 MACSEC_RXSC_ATTR_ACTIVE
, rxsc
->active
);
404 addattr_nest_end(&req
.n
, attr_rxsc
);
410 attr_sa
= addattr_nest(&req
.n
, MACSEC_BUFLEN
, MACSEC_ATTR_SA_CONFIG
);
412 addattr8(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_AN
, sa
->an
);
416 addattr32(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_PN
,
420 addattr_l(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_KEYID
,
421 sa
->key_id
, MACSEC_KEYID_LEN
);
422 addattr_l(&req
.n
, MACSEC_BUFLEN
, MACSEC_SA_ATTR_KEY
,
423 sa
->key
, sa
->key_len
);
426 if (sa
->active
!= 0xff) {
427 addattr8(&req
.n
, MACSEC_BUFLEN
,
428 MACSEC_SA_ATTR_ACTIVE
, sa
->active
);
432 addattr_nest_end(&req
.n
, attr_sa
);
435 if (rtnl_talk(&genl_rth
, &req
.n
, NULL
) < 0)
441 static bool check_sa_args(enum cmd c
, struct sa_desc
*sa
)
445 fprintf(stderr
, "cannot create SA without key\n");
450 fprintf(stderr
, "must specify a packet number != 0\n");
453 } else if (c
== CMD_UPD
) {
455 fprintf(stderr
, "cannot change key on SA\n");
463 static int do_modify_txsa(enum cmd c
, int argc
, char **argv
, int ifindex
)
465 struct sa_desc txsa
= {0};
466 enum macsec_nl_commands cmd
;
471 if (argc
== 0 || !get_sa(&argc
, &argv
, &txsa
.an
))
477 if (parse_sa_args(&argc
, &argv
, &txsa
))
480 if (check_sa_args(c
, &txsa
))
484 cmd
= macsec_commands
[c
][1][0];
485 return do_modify_nl(c
, cmd
, ifindex
, NULL
, &txsa
);
488 static int do_modify_rxsci(enum cmd c
, int argc
, char **argv
, int ifindex
)
490 struct rxsc_desc rxsc
= {0};
491 struct sa_desc rxsa
= {0};
493 enum macsec_nl_commands cmd
;
495 rxsc
.ifindex
= ifindex
;
500 sa_set
= parse_rxsci(&argc
, &argv
, &rxsc
, &rxsa
);
505 if (sa_set
&& (parse_sa_args(&argc
, &argv
, &rxsa
) ||
506 check_sa_args(c
, &rxsa
)))
508 if (!sa_set
&& parse_rxsci_args(&argc
, &argv
, &rxsc
))
512 cmd
= macsec_commands
[c
][sa_set
][1];
513 return do_modify_nl(c
, cmd
, rxsc
.ifindex
, &rxsc
, &rxsa
);
516 static int do_modify(enum cmd c
, int argc
, char **argv
)
523 ifindex
= ll_name_to_index(*argv
);
525 fprintf(stderr
, "Device \"%s\" does not exist.\n", *argv
);
533 if (strcmp(*argv
, "tx") == 0)
534 return do_modify_txsa(c
, argc
-1, argv
+1, ifindex
);
535 if (strcmp(*argv
, "rx") == 0)
536 return do_modify_rxsci(c
, argc
-1, argv
+1, ifindex
);
542 static int do_offload(enum cmd c
, int argc
, char **argv
)
544 enum macsec_offload offload
;
551 ifindex
= ll_name_to_index(*argv
);
553 fprintf(stderr
, "Device \"%s\" does not exist.\n", *argv
);
561 ret
= one_of("offload", *argv
, offload_str
, ARRAY_SIZE(offload_str
),
566 MACSEC_GENL_REQ(req
, MACSEC_BUFLEN
, macsec_commands
[c
][0][1], NLM_F_REQUEST
);
568 addattr32(&req
.n
, MACSEC_BUFLEN
, MACSEC_ATTR_IFINDEX
, ifindex
);
570 attr
= addattr_nest(&req
.n
, MACSEC_BUFLEN
, MACSEC_ATTR_OFFLOAD
);
571 addattr8(&req
.n
, MACSEC_BUFLEN
, MACSEC_OFFLOAD_ATTR_TYPE
, offload
);
572 addattr_nest_end(&req
.n
, attr
);
574 if (rtnl_talk(&genl_rth
, &req
.n
, NULL
) < 0)
586 static int validate_dump(struct rtattr
**attrs
)
588 return attrs
[MACSEC_ATTR_IFINDEX
] && attrs
[MACSEC_ATTR_SECY
] &&
589 attrs
[MACSEC_ATTR_TXSA_LIST
] && attrs
[MACSEC_ATTR_RXSC_LIST
] &&
590 attrs
[MACSEC_ATTR_TXSC_STATS
] && attrs
[MACSEC_ATTR_SECY_STATS
];
594 static int validate_secy_dump(struct rtattr
**attrs
)
596 return attrs
[MACSEC_SECY_ATTR_SCI
] &&
597 attrs
[MACSEC_SECY_ATTR_ENCODING_SA
] &&
598 attrs
[MACSEC_SECY_ATTR_CIPHER_SUITE
] &&
599 attrs
[MACSEC_SECY_ATTR_ICV_LEN
] &&
600 attrs
[MACSEC_SECY_ATTR_PROTECT
] &&
601 attrs
[MACSEC_SECY_ATTR_REPLAY
] &&
602 attrs
[MACSEC_SECY_ATTR_OPER
] &&
603 attrs
[MACSEC_SECY_ATTR_VALIDATE
] &&
604 attrs
[MACSEC_SECY_ATTR_ENCRYPT
] &&
605 attrs
[MACSEC_SECY_ATTR_INC_SCI
] &&
606 attrs
[MACSEC_SECY_ATTR_ES
] &&
607 attrs
[MACSEC_SECY_ATTR_SCB
];
610 static void print_flag(struct rtattr
*attrs
[], const char *desc
,
618 flag
= rta_getattr_u8(attrs
[field
]);
619 if (is_json_context())
620 print_bool(PRINT_JSON
, desc
, NULL
, flag
);
622 print_string(PRINT_FP
, NULL
, "%s ", desc
);
623 print_string(PRINT_FP
, NULL
, "%s ",
624 flag
? "on" : "off");
628 static void print_key(struct rtattr
*key
)
632 print_string(PRINT_ANY
, "key", " key %s\n",
633 hexstring_n2a(RTA_DATA(key
), RTA_PAYLOAD(key
),
634 keyid
, sizeof(keyid
)));
637 #define CIPHER_NAME_GCM_AES_128 "GCM-AES-128"
638 #define CIPHER_NAME_GCM_AES_256 "GCM-AES-256"
639 #define DEFAULT_CIPHER_NAME CIPHER_NAME_GCM_AES_128
641 static const char *cs_id_to_name(__u64 cid
)
644 case MACSEC_DEFAULT_CIPHER_ID
:
645 return DEFAULT_CIPHER_NAME
;
646 case MACSEC_CIPHER_ID_GCM_AES_128
:
647 /* MACSEC_DEFAULT_CIPHER_ALT: */
648 return CIPHER_NAME_GCM_AES_128
;
649 case MACSEC_CIPHER_ID_GCM_AES_256
:
650 return CIPHER_NAME_GCM_AES_256
;
656 static const char *offload_to_str(__u8 offload
)
658 if (offload
>= ARRAY_SIZE(offload_str
))
661 return offload_str
[offload
];
664 static void print_attrs(struct rtattr
*attrs
[])
666 print_flag(attrs
, "protect", MACSEC_SECY_ATTR_PROTECT
);
668 if (attrs
[MACSEC_SECY_ATTR_VALIDATE
]) {
669 __u8 val
= rta_getattr_u8(attrs
[MACSEC_SECY_ATTR_VALIDATE
]);
671 print_string(PRINT_ANY
, "validate",
672 "validate %s ", validate_str
[val
]);
675 print_flag(attrs
, "sc", MACSEC_RXSC_ATTR_ACTIVE
);
676 print_flag(attrs
, "sa", MACSEC_SA_ATTR_ACTIVE
);
677 print_flag(attrs
, "encrypt", MACSEC_SECY_ATTR_ENCRYPT
);
678 print_flag(attrs
, "send_sci", MACSEC_SECY_ATTR_INC_SCI
);
679 print_flag(attrs
, "end_station", MACSEC_SECY_ATTR_ES
);
680 print_flag(attrs
, "scb", MACSEC_SECY_ATTR_SCB
);
681 print_flag(attrs
, "replay", MACSEC_SECY_ATTR_REPLAY
);
683 if (attrs
[MACSEC_SECY_ATTR_WINDOW
]) {
684 __u32 win
= rta_getattr_u32(attrs
[MACSEC_SECY_ATTR_WINDOW
]);
686 print_uint(PRINT_ANY
, "window", "window %u ", win
);
689 if (attrs
[MACSEC_SECY_ATTR_CIPHER_SUITE
]) {
690 __u64 cid
= rta_getattr_u64(attrs
[MACSEC_SECY_ATTR_CIPHER_SUITE
]);
693 print_string(PRINT_ANY
, "cipher_suite",
694 " cipher suite: %s,", cs_id_to_name(cid
));
697 if (attrs
[MACSEC_SECY_ATTR_ICV_LEN
]) {
698 __u8 icv_len
= rta_getattr_u8(attrs
[MACSEC_SECY_ATTR_ICV_LEN
]);
700 print_uint(PRINT_ANY
, "icv_length",
701 " using ICV length %u\n", icv_len
);
705 static __u64
getattr_u64(const struct rtattr
*stat
)
707 size_t len
= RTA_PAYLOAD(stat
);
711 return rta_getattr_u64(stat
);
713 return rta_getattr_u32(stat
);
715 return rta_getattr_u16(stat
);
717 return rta_getattr_u8(stat
);
719 fprintf(stderr
, "invalid attribute length %zu\n",
725 static void print_fp_stats(const char *prefix
,
726 const char *names
[], unsigned int num
,
727 struct rtattr
*stats
[])
732 printf("%sstats:", prefix
);
734 for (i
= 1; i
< num
; i
++) {
737 printf(" %s", names
[i
]);
740 printf("\n%s ", prefix
);
742 for (i
= 1; i
< num
; i
++) {
746 pad
= strlen(names
[i
]) + 1;
748 printf("%*llu", pad
, getattr_u64(stats
[i
]));
750 printf("%*c", pad
, '-');
755 static void print_json_stats(const char *names
[], unsigned int num
,
756 struct rtattr
*stats
[])
760 for (i
= 1; i
< num
; i
++) {
761 if (!names
[i
] || !stats
[i
])
764 print_u64(PRINT_JSON
, names
[i
],
765 NULL
, getattr_u64(stats
[i
]));
769 static void print_stats(const char *prefix
,
770 const char *names
[], unsigned int num
,
771 struct rtattr
*stats
[])
774 if (is_json_context())
775 print_json_stats(names
, num
, stats
);
777 print_fp_stats(prefix
, names
, num
, stats
);
780 static const char *txsc_stats_names
[NUM_MACSEC_TXSC_STATS_ATTR
] = {
781 [MACSEC_TXSC_STATS_ATTR_OUT_PKTS_PROTECTED
] = "OutPktsProtected",
782 [MACSEC_TXSC_STATS_ATTR_OUT_PKTS_ENCRYPTED
] = "OutPktsEncrypted",
783 [MACSEC_TXSC_STATS_ATTR_OUT_OCTETS_PROTECTED
] = "OutOctetsProtected",
784 [MACSEC_TXSC_STATS_ATTR_OUT_OCTETS_ENCRYPTED
] = "OutOctetsEncrypted",
787 static void print_txsc_stats(const char *prefix
, struct rtattr
*attr
)
789 struct rtattr
*stats
[MACSEC_TXSC_STATS_ATTR_MAX
+ 1];
791 if (!attr
|| show_stats
== 0)
794 parse_rtattr_nested(stats
, MACSEC_TXSC_STATS_ATTR_MAX
, attr
);
796 print_stats(prefix
, txsc_stats_names
, NUM_MACSEC_TXSC_STATS_ATTR
,
800 static const char *secy_stats_names
[NUM_MACSEC_SECY_STATS_ATTR
] = {
801 [MACSEC_SECY_STATS_ATTR_OUT_PKTS_UNTAGGED
] = "OutPktsUntagged",
802 [MACSEC_SECY_STATS_ATTR_IN_PKTS_UNTAGGED
] = "InPktsUntagged",
803 [MACSEC_SECY_STATS_ATTR_OUT_PKTS_TOO_LONG
] = "OutPktsTooLong",
804 [MACSEC_SECY_STATS_ATTR_IN_PKTS_NO_TAG
] = "InPktsNoTag",
805 [MACSEC_SECY_STATS_ATTR_IN_PKTS_BAD_TAG
] = "InPktsBadTag",
806 [MACSEC_SECY_STATS_ATTR_IN_PKTS_UNKNOWN_SCI
] = "InPktsUnknownSCI",
807 [MACSEC_SECY_STATS_ATTR_IN_PKTS_NO_SCI
] = "InPktsNoSCI",
808 [MACSEC_SECY_STATS_ATTR_IN_PKTS_OVERRUN
] = "InPktsOverrun",
811 static void print_secy_stats(const char *prefix
, struct rtattr
*attr
)
813 struct rtattr
*stats
[MACSEC_SECY_STATS_ATTR_MAX
+ 1];
815 if (!attr
|| show_stats
== 0)
818 parse_rtattr_nested(stats
, MACSEC_SECY_STATS_ATTR_MAX
, attr
);
820 print_stats(prefix
, secy_stats_names
,
821 NUM_MACSEC_SECY_STATS_ATTR
, stats
);
824 static const char *rxsa_stats_names
[NUM_MACSEC_SA_STATS_ATTR
] = {
825 [MACSEC_SA_STATS_ATTR_IN_PKTS_OK
] = "InPktsOK",
826 [MACSEC_SA_STATS_ATTR_IN_PKTS_INVALID
] = "InPktsInvalid",
827 [MACSEC_SA_STATS_ATTR_IN_PKTS_NOT_VALID
] = "InPktsNotValid",
828 [MACSEC_SA_STATS_ATTR_IN_PKTS_NOT_USING_SA
] = "InPktsNotUsingSA",
829 [MACSEC_SA_STATS_ATTR_IN_PKTS_UNUSED_SA
] = "InPktsUnusedSA",
832 static void print_rxsa_stats(const char *prefix
, struct rtattr
*attr
)
834 struct rtattr
*stats
[MACSEC_SA_STATS_ATTR_MAX
+ 1];
836 if (!attr
|| show_stats
== 0)
839 parse_rtattr_nested(stats
, MACSEC_SA_STATS_ATTR_MAX
, attr
);
841 print_stats(prefix
, rxsa_stats_names
, NUM_MACSEC_SA_STATS_ATTR
, stats
);
844 static const char *txsa_stats_names
[NUM_MACSEC_SA_STATS_ATTR
] = {
845 [MACSEC_SA_STATS_ATTR_OUT_PKTS_PROTECTED
] = "OutPktsProtected",
846 [MACSEC_SA_STATS_ATTR_OUT_PKTS_ENCRYPTED
] = "OutPktsEncrypted",
849 static void print_txsa_stats(const char *prefix
, struct rtattr
*attr
)
851 struct rtattr
*stats
[MACSEC_SA_STATS_ATTR_MAX
+ 1];
853 if (!attr
|| show_stats
== 0)
856 parse_rtattr_nested(stats
, MACSEC_SA_STATS_ATTR_MAX
, attr
);
858 print_stats(prefix
, txsa_stats_names
, NUM_MACSEC_SA_STATS_ATTR
, stats
);
861 static void print_tx_sc(const char *prefix
, __u64 sci
, __u8 encoding_sa
,
862 struct rtattr
*txsc_stats
, struct rtattr
*secy_stats
,
865 struct rtattr
*sa_attr
[MACSEC_SA_ATTR_MAX
+ 1];
869 print_string(PRINT_FP
, NULL
, "%s", prefix
);
870 print_0xhex(PRINT_ANY
, "sci",
871 "TXSC: %016llx", ntohll(sci
));
872 print_uint(PRINT_ANY
, "encoding_sa",
873 " on SA %d\n", encoding_sa
);
875 print_secy_stats(prefix
, secy_stats
);
876 print_txsc_stats(prefix
, txsc_stats
);
878 open_json_array(PRINT_JSON
, "sa_list");
879 rem
= RTA_PAYLOAD(sa
);
880 for (a
= RTA_DATA(sa
); RTA_OK(a
, rem
); a
= RTA_NEXT(a
, rem
)) {
883 open_json_object(NULL
);
884 parse_rtattr_nested(sa_attr
, MACSEC_SA_ATTR_MAX
, a
);
885 state
= rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_ACTIVE
]);
887 print_string(PRINT_FP
, NULL
, "%s", prefix
);
888 print_string(PRINT_FP
, NULL
, "%s", prefix
);
889 print_uint(PRINT_ANY
, "an", "%d:",
890 rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_AN
]));
891 print_uint(PRINT_ANY
, "pn", " PN %u,",
892 rta_getattr_u32(sa_attr
[MACSEC_SA_ATTR_PN
]));
894 print_bool(PRINT_JSON
, "active", NULL
, state
);
895 print_string(PRINT_FP
, NULL
,
896 " state %s,", state
? "on" : "off");
897 print_key(sa_attr
[MACSEC_SA_ATTR_KEYID
]);
899 print_txsa_stats(prefix
, sa_attr
[MACSEC_SA_ATTR_STATS
]);
902 close_json_array(PRINT_JSON
, NULL
);
905 static const char *rxsc_stats_names
[NUM_MACSEC_RXSC_STATS_ATTR
] = {
906 [MACSEC_RXSC_STATS_ATTR_IN_OCTETS_VALIDATED
] = "InOctetsValidated",
907 [MACSEC_RXSC_STATS_ATTR_IN_OCTETS_DECRYPTED
] = "InOctetsDecrypted",
908 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_UNCHECKED
] = "InPktsUnchecked",
909 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_DELAYED
] = "InPktsDelayed",
910 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_OK
] = "InPktsOK",
911 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_INVALID
] = "InPktsInvalid",
912 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_LATE
] = "InPktsLate",
913 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_NOT_VALID
] = "InPktsNotValid",
914 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_NOT_USING_SA
] = "InPktsNotUsingSA",
915 [MACSEC_RXSC_STATS_ATTR_IN_PKTS_UNUSED_SA
] = "InPktsUnusedSA",
918 static void print_rxsc_stats(const char *prefix
, struct rtattr
*attr
)
920 struct rtattr
*stats
[MACSEC_RXSC_STATS_ATTR_MAX
+ 1];
922 if (!attr
|| show_stats
== 0)
925 parse_rtattr_nested(stats
, MACSEC_RXSC_STATS_ATTR_MAX
, attr
);
927 print_stats(prefix
, rxsc_stats_names
,
928 NUM_MACSEC_RXSC_STATS_ATTR
, stats
);
931 static void print_rx_sc(const char *prefix
, __be64 sci
, __u8 active
,
932 struct rtattr
*rxsc_stats
, struct rtattr
*sa
)
934 struct rtattr
*sa_attr
[MACSEC_SA_ATTR_MAX
+ 1];
938 print_string(PRINT_FP
, NULL
, "%s", prefix
);
939 print_0xhex(PRINT_ANY
, "sci",
940 "RXSC: %016llx,", ntohll(sci
));
941 print_bool(PRINT_JSON
, "active", NULL
, active
);
942 print_string(PRINT_FP
, NULL
,
943 " state %s\n", active
? "on" : "off");
944 print_rxsc_stats(prefix
, rxsc_stats
);
946 open_json_array(PRINT_JSON
, "sa_list");
947 rem
= RTA_PAYLOAD(sa
);
948 for (a
= RTA_DATA(sa
); RTA_OK(a
, rem
); a
= RTA_NEXT(a
, rem
)) {
951 open_json_object(NULL
);
952 parse_rtattr_nested(sa_attr
, MACSEC_SA_ATTR_MAX
, a
);
953 state
= rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_ACTIVE
]);
955 print_string(PRINT_FP
, NULL
, "%s", prefix
);
956 print_string(PRINT_FP
, NULL
, "%s", prefix
);
957 print_uint(PRINT_ANY
, "an", "%u:",
958 rta_getattr_u8(sa_attr
[MACSEC_SA_ATTR_AN
]));
959 print_uint(PRINT_ANY
, "pn", " PN %u,",
960 rta_getattr_u32(sa_attr
[MACSEC_SA_ATTR_PN
]));
962 print_bool(PRINT_JSON
, "active", NULL
, state
);
963 print_string(PRINT_FP
, NULL
, " state %s,",
964 state
? "on" : "off");
966 print_key(sa_attr
[MACSEC_SA_ATTR_KEYID
]);
968 print_rxsa_stats(prefix
, sa_attr
[MACSEC_SA_ATTR_STATS
]);
971 close_json_array(PRINT_JSON
, NULL
);
974 static void print_rxsc_list(struct rtattr
*sc
)
976 int rem
= RTA_PAYLOAD(sc
);
979 open_json_array(PRINT_JSON
, "rx_sc");
980 for (c
= RTA_DATA(sc
); RTA_OK(c
, rem
); c
= RTA_NEXT(c
, rem
)) {
981 struct rtattr
*sc_attr
[MACSEC_RXSC_ATTR_MAX
+ 1];
983 open_json_object(NULL
);
985 parse_rtattr_nested(sc_attr
, MACSEC_RXSC_ATTR_MAX
, c
);
987 rta_getattr_u64(sc_attr
[MACSEC_RXSC_ATTR_SCI
]),
988 rta_getattr_u32(sc_attr
[MACSEC_RXSC_ATTR_ACTIVE
]),
989 sc_attr
[MACSEC_RXSC_ATTR_STATS
],
990 sc_attr
[MACSEC_RXSC_ATTR_SA_LIST
]);
993 close_json_array(PRINT_JSON
, NULL
);
996 static int process(struct nlmsghdr
*n
, void *arg
)
998 struct genlmsghdr
*ghdr
;
999 struct rtattr
*attrs
[MACSEC_ATTR_MAX
+ 1];
1000 struct rtattr
*attrs_secy
[MACSEC_SECY_ATTR_MAX
+ 1];
1001 int len
= n
->nlmsg_len
;
1006 if (n
->nlmsg_type
!= genl_family
)
1009 len
-= NLMSG_LENGTH(GENL_HDRLEN
);
1013 ghdr
= NLMSG_DATA(n
);
1014 if (ghdr
->cmd
!= MACSEC_CMD_GET_TXSC
)
1017 parse_rtattr(attrs
, MACSEC_ATTR_MAX
, (void *) ghdr
+ GENL_HDRLEN
, len
);
1018 if (!validate_dump(attrs
)) {
1019 fprintf(stderr
, "incomplete dump message\n");
1023 ifindex
= rta_getattr_u32(attrs
[MACSEC_ATTR_IFINDEX
]);
1024 parse_rtattr_nested(attrs_secy
, MACSEC_SECY_ATTR_MAX
,
1025 attrs
[MACSEC_ATTR_SECY
]);
1027 if (!validate_secy_dump(attrs_secy
)) {
1028 fprintf(stderr
, "incomplete dump message\n");
1032 sci
= rta_getattr_u64(attrs_secy
[MACSEC_SECY_ATTR_SCI
]);
1033 encoding_sa
= rta_getattr_u8(attrs_secy
[MACSEC_SECY_ATTR_ENCODING_SA
]);
1035 if (filter
.ifindex
&& ifindex
!= filter
.ifindex
)
1038 if (filter
.sci
&& sci
!= filter
.sci
)
1041 open_json_object(NULL
);
1042 print_uint(PRINT_ANY
, "ifindex", "%u: ", ifindex
);
1043 print_color_string(PRINT_ANY
, COLOR_IFNAME
, "ifname",
1044 "%s: ", ll_index_to_name(ifindex
));
1046 print_attrs(attrs_secy
);
1048 print_tx_sc(" ", sci
, encoding_sa
,
1049 attrs
[MACSEC_ATTR_TXSC_STATS
],
1050 attrs
[MACSEC_ATTR_SECY_STATS
],
1051 attrs
[MACSEC_ATTR_TXSA_LIST
]);
1053 if (attrs
[MACSEC_ATTR_RXSC_LIST
])
1054 print_rxsc_list(attrs
[MACSEC_ATTR_RXSC_LIST
]);
1056 if (attrs
[MACSEC_ATTR_OFFLOAD
]) {
1057 struct rtattr
*attrs_offload
[MACSEC_OFFLOAD_ATTR_MAX
+ 1];
1060 parse_rtattr_nested(attrs_offload
, MACSEC_OFFLOAD_ATTR_MAX
,
1061 attrs
[MACSEC_ATTR_OFFLOAD
]);
1063 offload
= rta_getattr_u8(attrs_offload
[MACSEC_OFFLOAD_ATTR_TYPE
]);
1064 print_string(PRINT_ANY
, "offload",
1065 " offload: %s ", offload_to_str(offload
));
1069 close_json_object();
1074 static int do_dump(int ifindex
)
1076 MACSEC_GENL_REQ(req
, MACSEC_BUFLEN
, MACSEC_CMD_GET_TXSC
,
1077 NLM_F_REQUEST
| NLM_F_DUMP
);
1079 memset(&filter
, 0, sizeof(filter
));
1080 filter
.ifindex
= ifindex
;
1082 req
.n
.nlmsg_seq
= genl_rth
.dump
= ++genl_rth
.seq
;
1083 if (rtnl_send(&genl_rth
, &req
, req
.n
.nlmsg_len
) < 0) {
1084 perror("Failed to send dump request");
1089 if (rtnl_dump_filter(&genl_rth
, process
, stdout
) < 0) {
1091 fprintf(stderr
, "Dump terminated\n");
1099 static int do_show(int argc
, char **argv
)
1106 ifindex
= ll_name_to_index(*argv
);
1108 fprintf(stderr
, "Device \"%s\" does not exist.\n", *argv
);
1114 return do_dump(ifindex
);
1120 int do_ipmacsec(int argc
, char **argv
)
1125 if (matches(*argv
, "help") == 0)
1128 if (genl_init_handle(&genl_rth
, MACSEC_GENL_NAME
, &genl_family
))
1131 if (matches(*argv
, "show") == 0)
1132 return do_show(argc
-1, argv
+1);
1134 if (matches(*argv
, "add") == 0)
1135 return do_modify(CMD_ADD
, argc
-1, argv
+1);
1136 if (matches(*argv
, "set") == 0)
1137 return do_modify(CMD_UPD
, argc
-1, argv
+1);
1138 if (matches(*argv
, "delete") == 0)
1139 return do_modify(CMD_DEL
, argc
-1, argv
+1);
1140 if (matches(*argv
, "offload") == 0)
1141 return do_offload(CMD_OFFLOAD
, argc
-1, argv
+1);
1143 fprintf(stderr
, "Command \"%s\" is unknown, try \"ip macsec help\".\n",
1148 /* device creation */
1149 static void macsec_print_opt(struct link_util
*lu
, FILE *f
, struct rtattr
*tb
[])
1154 if (tb
[IFLA_MACSEC_SCI
]) {
1155 if (is_json_context()) {
1158 snprintf(b1
, sizeof(b1
), "%016llx",
1159 ntohll(rta_getattr_u64(tb
[IFLA_MACSEC_SCI
])));
1160 print_string(PRINT_JSON
, "sci", NULL
, b1
);
1162 fprintf(f
, "sci %016llx ",
1163 ntohll(rta_getattr_u64(tb
[IFLA_MACSEC_SCI
])));
1167 print_flag(tb
, "protect", IFLA_MACSEC_PROTECT
);
1169 if (tb
[IFLA_MACSEC_CIPHER_SUITE
]) {
1171 = rta_getattr_u64(tb
[IFLA_MACSEC_CIPHER_SUITE
]);
1173 print_string(PRINT_ANY
,
1176 cs_id_to_name(csid
));
1179 if (tb
[IFLA_MACSEC_ICV_LEN
]) {
1180 if (is_json_context()) {
1183 snprintf(b2
, sizeof(b2
), "%hhu",
1184 rta_getattr_u8(tb
[IFLA_MACSEC_ICV_LEN
]));
1185 print_uint(PRINT_JSON
, "icv_len", NULL
, atoi(b2
));
1187 fprintf(f
, "icvlen %hhu ",
1188 rta_getattr_u8(tb
[IFLA_MACSEC_ICV_LEN
]));
1192 if (tb
[IFLA_MACSEC_ENCODING_SA
]) {
1193 if (is_json_context()) {
1196 snprintf(b2
, sizeof(b2
), "%hhu",
1197 rta_getattr_u8(tb
[IFLA_MACSEC_ENCODING_SA
]));
1198 print_uint(PRINT_JSON
, "encoding_sa", NULL
, atoi(b2
));
1200 fprintf(f
, "encodingsa %hhu ",
1201 rta_getattr_u8(tb
[IFLA_MACSEC_ENCODING_SA
]));
1205 if (tb
[IFLA_MACSEC_VALIDATION
]) {
1206 __u8 val
= rta_getattr_u8(tb
[IFLA_MACSEC_VALIDATION
]);
1208 print_string(PRINT_ANY
,
1214 const char *inc_sci
, *es
, *replay
;
1216 if (is_json_context()) {
1217 inc_sci
= "inc_sci";
1218 replay
= "replay_protect";
1221 inc_sci
= "send_sci";
1226 print_flag(tb
, "encrypt", IFLA_MACSEC_ENCRYPT
);
1227 print_flag(tb
, inc_sci
, IFLA_MACSEC_INC_SCI
);
1228 print_flag(tb
, es
, IFLA_MACSEC_ES
);
1229 print_flag(tb
, "scb", IFLA_MACSEC_SCB
);
1230 print_flag(tb
, replay
, IFLA_MACSEC_REPLAY_PROTECT
);
1232 if (tb
[IFLA_MACSEC_WINDOW
])
1233 print_int(PRINT_ANY
,
1236 rta_getattr_u32(tb
[IFLA_MACSEC_WINDOW
]));
1239 static bool check_txsc_flags(bool es
, bool scb
, bool sci
)
1241 if (sci
&& (es
|| scb
))
1248 static void usage(FILE *f
)
1251 "Usage: ... macsec [ [ address <lladdr> ] port { 1..2^16-1 } | sci <u64> ]\n"
1252 " [ cipher { default | gcm-aes-128 | gcm-aes-256 } ]\n"
1253 " [ icvlen { 8..16 } ]\n"
1254 " [ encrypt { on | off } ]\n"
1255 " [ send_sci { on | off } ]\n"
1256 " [ end_station { on | off } ]\n"
1257 " [ scb { on | off } ]\n"
1258 " [ protect { on | off } ]\n"
1259 " [ replay { on | off} window { 0..2^32-1 } ]\n"
1260 " [ validate { strict | check | disabled } ]\n"
1261 " [ encodingsa { 0..3 } ]\n"
1265 static int macsec_parse_opt(struct link_util
*lu
, int argc
, char **argv
,
1269 __u8 encoding_sa
= 0xff;
1271 struct cipher_args cipher
= {0};
1272 enum macsec_validation_type validate
;
1273 bool es
= false, scb
= false, send_sci
= false;
1274 int replay_protect
= -1;
1275 struct sci sci
= { 0 };
1277 ret
= get_sci_portaddr(&sci
, &argc
, &argv
, true, true);
1279 fprintf(stderr
, "expected sci\n");
1285 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_SCI
,
1286 &sci
.sci
, sizeof(sci
.sci
));
1288 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_PORT
,
1289 &sci
.port
, sizeof(sci
.port
));
1293 if (strcmp(*argv
, "cipher") == 0) {
1296 duparg("cipher", *argv
);
1297 if (strcmp(*argv
, "default") == 0)
1298 cipher
.id
= MACSEC_DEFAULT_CIPHER_ID
;
1299 else if (strcmp(*argv
, "gcm-aes-128") == 0 ||
1300 strcmp(*argv
, "GCM-AES-128") == 0)
1301 cipher
.id
= MACSEC_CIPHER_ID_GCM_AES_128
;
1302 else if (strcmp(*argv
, "gcm-aes-256") == 0 ||
1303 strcmp(*argv
, "GCM-AES-256") == 0)
1304 cipher
.id
= MACSEC_CIPHER_ID_GCM_AES_256
;
1306 invarg("expected: default, gcm-aes-128 or"
1307 " gcm-aes-256", *argv
);
1308 } else if (strcmp(*argv
, "icvlen") == 0) {
1311 duparg("icvlen", *argv
);
1312 get_icvlen(&cipher
.icv_len
, *argv
);
1313 } else if (strcmp(*argv
, "encrypt") == 0) {
1317 ret
= one_of("encrypt", *argv
, values_on_off
,
1318 ARRAY_SIZE(values_on_off
), &i
);
1321 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ENCRYPT
, i
);
1322 } else if (strcmp(*argv
, "send_sci") == 0) {
1326 ret
= one_of("send_sci", *argv
, values_on_off
,
1327 ARRAY_SIZE(values_on_off
), &i
);
1331 addattr8(n
, MACSEC_BUFLEN
,
1332 IFLA_MACSEC_INC_SCI
, send_sci
);
1333 } else if (strcmp(*argv
, "end_station") == 0) {
1337 ret
= one_of("end_station", *argv
, values_on_off
,
1338 ARRAY_SIZE(values_on_off
), &i
);
1342 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ES
, es
);
1343 } else if (strcmp(*argv
, "scb") == 0) {
1347 ret
= one_of("scb", *argv
, values_on_off
,
1348 ARRAY_SIZE(values_on_off
), &i
);
1352 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_SCB
, scb
);
1353 } else if (strcmp(*argv
, "protect") == 0) {
1357 ret
= one_of("protect", *argv
, values_on_off
,
1358 ARRAY_SIZE(values_on_off
), &i
);
1361 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_PROTECT
, i
);
1362 } else if (strcmp(*argv
, "replay") == 0) {
1366 ret
= one_of("replay", *argv
, values_on_off
,
1367 ARRAY_SIZE(values_on_off
), &i
);
1370 replay_protect
= !!i
;
1371 } else if (strcmp(*argv
, "window") == 0) {
1373 ret
= get_u32(&window
, *argv
, 0);
1375 invarg("expected replay window size", *argv
);
1376 } else if (strcmp(*argv
, "validate") == 0) {
1378 ret
= one_of("validate", *argv
,
1379 validate_str
, ARRAY_SIZE(validate_str
),
1383 addattr8(n
, MACSEC_BUFLEN
,
1384 IFLA_MACSEC_VALIDATION
, validate
);
1385 } else if (strcmp(*argv
, "encodingsa") == 0) {
1386 if (encoding_sa
!= 0xff)
1387 duparg2("encodingsa", "encodingsa");
1389 ret
= get_an(&encoding_sa
, *argv
);
1391 invarg("expected an { 0..3 }", *argv
);
1393 fprintf(stderr
, "macsec: unknown command \"%s\"?\n",
1402 if (!check_txsc_flags(es
, scb
, send_sci
)) {
1404 "invalid combination of send_sci/end_station/scb\n");
1408 if (window
!= -1 && replay_protect
== -1) {
1410 "replay window set, but replay protection not enabled. did you mean 'replay on window %u'?\n",
1413 } else if (window
== -1 && replay_protect
== 1) {
1415 "replay protection enabled, but no window set. did you mean 'replay on window VALUE'?\n");
1420 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_CIPHER_SUITE
,
1421 &cipher
.id
, sizeof(cipher
.id
));
1423 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ICV_LEN
,
1424 &cipher
.icv_len
, sizeof(cipher
.icv_len
));
1426 if (replay_protect
!= -1) {
1427 addattr32(n
, MACSEC_BUFLEN
, IFLA_MACSEC_WINDOW
, window
);
1428 addattr8(n
, MACSEC_BUFLEN
, IFLA_MACSEC_REPLAY_PROTECT
,
1432 if (encoding_sa
!= 0xff) {
1433 addattr_l(n
, MACSEC_BUFLEN
, IFLA_MACSEC_ENCODING_SA
,
1434 &encoding_sa
, sizeof(encoding_sa
));
1440 static void macsec_print_help(struct link_util
*lu
, int argc
, char **argv
,
1446 struct link_util macsec_link_util
= {
1448 .maxattr
= IFLA_MACSEC_MAX
,
1449 .parse_opt
= macsec_parse_opt
,
1450 .print_help
= macsec_print_help
,
1451 .print_opt
= macsec_print_opt
,