2 * Driver interaction with Linux MACsec kernel module
3 * Copyright (c) 2016, Sabrina Dubroca <sd@queasysnail.net> and Red Hat, Inc.
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
10 #include <sys/ioctl.h>
12 #include <netpacket/packet.h>
13 #include <net/if_arp.h>
15 #include <netlink/netlink.h>
16 #include <netlink/genl/genl.h>
17 #include <netlink/genl/ctrl.h>
18 #include <netlink/route/link.h>
19 #include <netlink/route/link/macsec.h>
20 #include <linux/if_macsec.h>
23 #include "utils/common.h"
24 #include "utils/eloop.h"
25 #include "pae/ieee802_1x_kay.h"
27 #include "driver_wired_common.h"
29 #define DRV_PREFIX "macsec_linux: "
31 #define UNUSED_SCI 0xffffffffffffffff
34 struct macsec_drv_data *drv;
42 struct macsec_genl_ctx {
48 struct macsec_drv_data {
49 struct driver_wired_common_data common;
50 struct rtnl_link *link;
51 struct nl_cache *link_cache;
53 struct macsec_genl_ctx ctx;
55 struct netlink_data *netlink;
57 char ifname[IFNAMSIZ + 1];
63 Boolean controlled_port_enabled;
64 Boolean controlled_port_enabled_set;
66 Boolean protect_frames;
67 Boolean protect_frames_set;
72 Boolean replay_protect;
73 Boolean replay_protect_set;
78 Boolean encoding_sa_set;
82 static int dump_callback(struct nl_msg *msg, void *argp);
85 static struct nl_msg * msg_prepare(enum macsec_nl_commands cmd,
86 const struct macsec_genl_ctx *ctx,
93 wpa_printf(MSG_ERROR, DRV_PREFIX "failed to alloc message");
97 if (!genlmsg_put(msg, 0, 0, ctx->macsec_genl_id, 0, 0, cmd, 0)) {
98 wpa_printf(MSG_ERROR, DRV_PREFIX "failed to put header");
102 NLA_PUT_U32(msg, MACSEC_ATTR_IFINDEX, ifindex);
112 static int nla_put_rxsc_config(struct nl_msg *msg, u64 sci)
114 struct nlattr *nest = nla_nest_start(msg, MACSEC_ATTR_RXSC_CONFIG);
119 NLA_PUT_U64(msg, MACSEC_RXSC_ATTR_SCI, sci);
121 nla_nest_end(msg, nest);
130 static int init_genl_ctx(struct macsec_drv_data *drv)
132 struct macsec_genl_ctx *ctx = &drv->ctx;
134 ctx->sk = nl_socket_alloc();
136 wpa_printf(MSG_ERROR, DRV_PREFIX "failed to alloc genl socket");
140 if (genl_connect(ctx->sk) < 0) {
141 wpa_printf(MSG_ERROR,
142 DRV_PREFIX "connection to genl socket failed");
146 ctx->macsec_genl_id = genl_ctrl_resolve(ctx->sk, "macsec");
147 if (ctx->macsec_genl_id < 0) {
148 wpa_printf(MSG_ERROR, DRV_PREFIX "genl resolve failed");
152 memset(&ctx->cb_arg, 0, sizeof(ctx->cb_arg));
153 ctx->cb_arg.drv = drv;
155 nl_socket_modify_cb(ctx->sk, NL_CB_VALID, NL_CB_CUSTOM, dump_callback,
161 nl_socket_free(ctx->sk);
167 static int try_commit(struct macsec_drv_data *drv)
177 if (drv->controlled_port_enabled_set) {
178 struct rtnl_link *change = rtnl_link_alloc();
180 wpa_printf(MSG_DEBUG, DRV_PREFIX
181 "%s: try_commit controlled_port_enabled=%d",
182 drv->ifname, drv->controlled_port_enabled);
186 rtnl_link_set_name(change, drv->ifname);
188 if (drv->controlled_port_enabled)
189 rtnl_link_set_flags(change, IFF_UP);
191 rtnl_link_unset_flags(change, IFF_UP);
193 err = rtnl_link_change(drv->sk, change, change, 0);
197 rtnl_link_put(change);
199 drv->controlled_port_enabled_set = FALSE;
202 if (drv->protect_frames_set) {
203 wpa_printf(MSG_DEBUG, DRV_PREFIX
204 "%s: try_commit protect_frames=%d",
205 drv->ifname, drv->protect_frames);
206 rtnl_link_macsec_set_protect(drv->link, drv->protect_frames);
209 if (drv->encrypt_set) {
210 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: try_commit encrypt=%d",
211 drv->ifname, drv->encrypt);
212 rtnl_link_macsec_set_encrypt(drv->link, drv->encrypt);
215 if (drv->replay_protect_set) {
216 wpa_printf(MSG_DEBUG, DRV_PREFIX
217 "%s: try_commit replay_protect=%d replay_window=%d",
218 drv->ifname, drv->replay_protect,
220 rtnl_link_macsec_set_replay_protect(drv->link,
221 drv->replay_protect);
222 if (drv->replay_protect)
223 rtnl_link_macsec_set_window(drv->link,
227 if (drv->encoding_sa_set) {
228 wpa_printf(MSG_DEBUG, DRV_PREFIX
229 "%s: try_commit encoding_sa=%d",
230 drv->ifname, drv->encoding_sa);
231 rtnl_link_macsec_set_encoding_sa(drv->link, drv->encoding_sa);
234 err = rtnl_link_add(drv->sk, drv->link, 0);
238 drv->protect_frames_set = FALSE;
239 drv->encrypt_set = FALSE;
240 drv->replay_protect_set = FALSE;
246 static void macsec_drv_wpa_deinit(void *priv)
248 struct macsec_drv_data *drv = priv;
250 driver_wired_deinit_common(&drv->common);
255 static int macsec_check_macsec(void)
260 sk = nl_socket_alloc();
262 wpa_printf(MSG_ERROR, DRV_PREFIX "failed to alloc genl socket");
266 if (genl_connect(sk) < 0) {
267 wpa_printf(MSG_ERROR,
268 DRV_PREFIX "connection to genl socket failed");
272 if (genl_ctrl_resolve(sk, "macsec") < 0) {
273 wpa_printf(MSG_ERROR,
274 DRV_PREFIX "genl resolve failed - macsec kernel module not present?");
286 static void * macsec_drv_wpa_init(void *ctx, const char *ifname)
288 struct macsec_drv_data *drv;
290 if (macsec_check_macsec() < 0)
293 drv = os_zalloc(sizeof(*drv));
297 if (driver_wired_init_common(&drv->common, ifname, ctx) < 0) {
306 static int macsec_drv_macsec_init(void *priv, struct macsec_init_params *params)
308 struct macsec_drv_data *drv = priv;
311 wpa_printf(MSG_DEBUG, "%s", __func__);
313 drv->sk = nl_socket_alloc();
317 err = nl_connect(drv->sk, NETLINK_ROUTE);
319 wpa_printf(MSG_ERROR, DRV_PREFIX
320 "Unable to connect NETLINK_ROUTE socket: %s",
325 err = rtnl_link_alloc_cache(drv->sk, AF_UNSPEC, &drv->link_cache);
327 wpa_printf(MSG_ERROR, DRV_PREFIX "Unable to get link cache: %s",
332 drv->parent_ifi = rtnl_link_name2i(drv->link_cache, drv->common.ifname);
333 if (drv->parent_ifi == 0) {
334 wpa_printf(MSG_ERROR, DRV_PREFIX
335 "couldn't find ifindex for interface %s",
339 wpa_printf(MSG_DEBUG, DRV_PREFIX "ifname=%s parent_ifi=%d",
340 drv->common.ifname, drv->parent_ifi);
342 err = init_genl_ctx(drv);
349 nl_cache_free(drv->link_cache);
350 drv->link_cache = NULL;
352 nl_socket_free(drv->sk);
358 static int macsec_drv_macsec_deinit(void *priv)
360 struct macsec_drv_data *drv = priv;
362 wpa_printf(MSG_DEBUG, "%s", __func__);
365 nl_socket_free(drv->sk);
369 nl_cache_free(drv->link_cache);
370 drv->link_cache = NULL;
373 nl_socket_free(drv->ctx.sk);
379 static int macsec_drv_get_capability(void *priv, enum macsec_cap *cap)
381 wpa_printf(MSG_DEBUG, "%s", __func__);
383 *cap = MACSEC_CAP_INTEG_AND_CONF;
390 * macsec_drv_enable_protect_frames - Set protect frames status
391 * @priv: Private driver interface data
392 * @enabled: TRUE = protect frames enabled
393 * FALSE = protect frames disabled
394 * Returns: 0 on success, -1 on failure (or if not supported)
396 static int macsec_drv_enable_protect_frames(void *priv, Boolean enabled)
398 struct macsec_drv_data *drv = priv;
400 wpa_printf(MSG_DEBUG, "%s -> %s", __func__, enabled ? "TRUE" : "FALSE");
402 drv->protect_frames_set = TRUE;
403 drv->protect_frames = enabled;
405 return try_commit(drv);
410 * macsec_drv_enable_encrypt - Set protect frames status
411 * @priv: Private driver interface data
412 * @enabled: TRUE = protect frames enabled
413 * FALSE = protect frames disabled
414 * Returns: 0 on success, -1 on failure (or if not supported)
416 static int macsec_drv_enable_encrypt(void *priv, Boolean enabled)
418 struct macsec_drv_data *drv = priv;
420 wpa_printf(MSG_DEBUG, "%s -> %s", __func__, enabled ? "TRUE" : "FALSE");
422 drv->encrypt_set = TRUE;
423 drv->encrypt = enabled;
425 return try_commit(drv);
430 * macsec_drv_set_replay_protect - Set replay protect status and window size
431 * @priv: Private driver interface data
432 * @enabled: TRUE = replay protect enabled
433 * FALSE = replay protect disabled
434 * @window: replay window size, valid only when replay protect enabled
435 * Returns: 0 on success, -1 on failure (or if not supported)
437 static int macsec_drv_set_replay_protect(void *priv, Boolean enabled,
440 struct macsec_drv_data *drv = priv;
442 wpa_printf(MSG_DEBUG, "%s -> %s, %u", __func__,
443 enabled ? "TRUE" : "FALSE", window);
445 drv->replay_protect_set = TRUE;
446 drv->replay_protect = enabled;
448 drv->replay_window = window;
450 return try_commit(drv);
455 * macsec_drv_set_current_cipher_suite - Set current cipher suite
456 * @priv: Private driver interface data
457 * @cs: EUI64 identifier
458 * Returns: 0 on success, -1 on failure (or if not supported)
460 static int macsec_drv_set_current_cipher_suite(void *priv, u64 cs)
462 wpa_printf(MSG_DEBUG, "%s -> %016" PRIx64, __func__, cs);
468 * macsec_drv_enable_controlled_port - Set controlled port status
469 * @priv: Private driver interface data
470 * @enabled: TRUE = controlled port enabled
471 * FALSE = controlled port disabled
472 * Returns: 0 on success, -1 on failure (or if not supported)
474 static int macsec_drv_enable_controlled_port(void *priv, Boolean enabled)
476 struct macsec_drv_data *drv = priv;
478 wpa_printf(MSG_DEBUG, "%s -> %s", __func__, enabled ? "TRUE" : "FALSE");
480 drv->controlled_port_enabled = enabled;
481 drv->controlled_port_enabled_set = TRUE;
483 return try_commit(drv);
487 static struct nla_policy sa_policy[MACSEC_SA_ATTR_MAX + 1] = {
488 [MACSEC_SA_ATTR_AN] = { .type = NLA_U8 },
489 [MACSEC_SA_ATTR_ACTIVE] = { .type = NLA_U8 },
490 [MACSEC_SA_ATTR_PN] = { .type = NLA_U32 },
491 [MACSEC_SA_ATTR_KEYID] = { .type = NLA_BINARY },
494 static struct nla_policy sc_policy[MACSEC_RXSC_ATTR_MAX + 1] = {
495 [MACSEC_RXSC_ATTR_SCI] = { .type = NLA_U64 },
496 [MACSEC_RXSC_ATTR_ACTIVE] = { .type = NLA_U8 },
497 [MACSEC_RXSC_ATTR_SA_LIST] = { .type = NLA_NESTED },
500 static struct nla_policy main_policy[MACSEC_ATTR_MAX + 1] = {
501 [MACSEC_ATTR_IFINDEX] = { .type = NLA_U32 },
502 [MACSEC_ATTR_SECY] = { .type = NLA_NESTED },
503 [MACSEC_ATTR_TXSA_LIST] = { .type = NLA_NESTED },
504 [MACSEC_ATTR_RXSC_LIST] = { .type = NLA_NESTED },
507 static int dump_callback(struct nl_msg *msg, void *argp)
509 struct nlmsghdr *ret_hdr = nlmsg_hdr(msg);
510 struct nlattr *tb_msg[MACSEC_ATTR_MAX + 1];
511 struct cb_arg *arg = (struct cb_arg *) argp;
512 struct genlmsghdr *gnlh = (struct genlmsghdr *) nlmsg_data(ret_hdr);
515 if (ret_hdr->nlmsg_type != arg->drv->ctx.macsec_genl_id)
518 err = nla_parse(tb_msg, MACSEC_ATTR_MAX, genlmsg_attrdata(gnlh, 0),
519 genlmsg_attrlen(gnlh, 0), main_policy);
523 if (!tb_msg[MACSEC_ATTR_IFINDEX])
526 if (nla_get_u32(tb_msg[MACSEC_ATTR_IFINDEX]) != (u32) arg->ifindex)
529 if (arg->txsa < 4 && !tb_msg[MACSEC_ATTR_TXSA_LIST]) {
531 } else if (arg->txsa < 4) {
535 nla_for_each_nested(nla, tb_msg[MACSEC_ATTR_TXSA_LIST], rem) {
536 struct nlattr *tb[MACSEC_SA_ATTR_MAX + 1];
538 err = nla_parse_nested(tb, MACSEC_SA_ATTR_MAX, nla,
542 if (!tb[MACSEC_SA_ATTR_AN])
544 if (nla_get_u8(tb[MACSEC_SA_ATTR_AN]) != arg->txsa)
546 if (!tb[MACSEC_SA_ATTR_PN])
548 *arg->pn = nla_get_u32(tb[MACSEC_SA_ATTR_PN]);
555 if (arg->rxsci == UNUSED_SCI)
558 if (tb_msg[MACSEC_ATTR_RXSC_LIST]) {
562 nla_for_each_nested(nla, tb_msg[MACSEC_ATTR_RXSC_LIST], rem) {
563 struct nlattr *tb[MACSEC_RXSC_ATTR_MAX + 1];
565 err = nla_parse_nested(tb, MACSEC_RXSC_ATTR_MAX, nla,
569 if (!tb[MACSEC_RXSC_ATTR_SCI])
571 if (nla_get_u64(tb[MACSEC_RXSC_ATTR_SCI]) != arg->rxsci)
573 if (!tb[MACSEC_RXSC_ATTR_SA_LIST])
576 nla_for_each_nested(nla, tb[MACSEC_RXSC_ATTR_SA_LIST],
578 struct nlattr *tb_sa[MACSEC_SA_ATTR_MAX + 1];
580 err = nla_parse_nested(tb_sa,
581 MACSEC_SA_ATTR_MAX, nla,
585 if (!tb_sa[MACSEC_SA_ATTR_AN])
587 if (nla_get_u8(tb_sa[MACSEC_SA_ATTR_AN]) !=
590 if (!tb_sa[MACSEC_SA_ATTR_PN])
593 nla_get_u32(tb_sa[MACSEC_SA_ATTR_PN]);
608 static int nl_send_recv(struct nl_sock *sk, struct nl_msg *msg)
612 ret = nl_send_auto_complete(sk, msg);
614 wpa_printf(MSG_ERROR, DRV_PREFIX "%s: failed to send: %d (%s)",
615 __func__, ret, nl_geterror(-ret));
619 ret = nl_recvmsgs_default(sk);
621 wpa_printf(MSG_ERROR, DRV_PREFIX "%s: failed to recv: %d (%s)",
622 __func__, ret, nl_geterror(-ret));
629 static int do_dump(struct macsec_drv_data *drv, u8 txsa, u64 rxsci, u8 rxsa,
632 struct macsec_genl_ctx *ctx = &drv->ctx;
636 ctx->cb_arg.ifindex = drv->ifi;
637 ctx->cb_arg.rxsci = rxsci;
638 ctx->cb_arg.rxsa = rxsa;
639 ctx->cb_arg.txsa = txsa;
644 wpa_printf(MSG_ERROR, DRV_PREFIX "%s: failed to alloc message",
649 if (!genlmsg_put(msg, NL_AUTO_PORT, NL_AUTO_SEQ, ctx->macsec_genl_id, 0,
650 NLM_F_DUMP, MACSEC_CMD_GET_TXSC, 0)) {
651 wpa_printf(MSG_ERROR, DRV_PREFIX "%s: failed to put header",
656 ret = nl_send_recv(ctx->sk, msg);
658 wpa_printf(MSG_ERROR,
659 DRV_PREFIX "failed to communicate: %d (%s)",
660 ret, nl_geterror(-ret));
662 ctx->cb_arg.pn = NULL;
671 * macsec_drv_get_receive_lowest_pn - Get receive lowest PN
672 * @priv: Private driver interface data
673 * @sa: secure association
674 * Returns: 0 on success, -1 on failure (or if not supported)
676 static int macsec_drv_get_receive_lowest_pn(void *priv, struct receive_sa *sa)
678 struct macsec_drv_data *drv = priv;
681 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s", __func__);
683 err = do_dump(drv, 0xff, mka_sci_u64(&sa->sc->sci), sa->an,
685 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: result %d", __func__,
693 * macsec_drv_set_receive_lowest_pn - Set receive lowest PN
694 * @priv: Private driver interface data
695 * @sa: secure association
696 * Returns: 0 on success, -1 on failure (or if not supported)
698 static int macsec_drv_set_receive_lowest_pn(void *priv, struct receive_sa *sa)
700 struct macsec_drv_data *drv = priv;
701 struct macsec_genl_ctx *ctx = &drv->ctx;
706 wpa_printf(MSG_DEBUG,
707 DRV_PREFIX "%s: set_receive_lowest_pn -> %d: %d",
708 drv->ifname, sa->an, sa->next_pn);
710 msg = msg_prepare(MACSEC_CMD_UPD_RXSA, ctx, drv->ifi);
714 nest = nla_nest_start(msg, MACSEC_ATTR_SA_CONFIG);
716 goto nla_put_failure;
718 NLA_PUT_U8(msg, MACSEC_SA_ATTR_AN, sa->an);
719 NLA_PUT_U32(msg, MACSEC_SA_ATTR_PN, sa->next_pn);
721 nla_nest_end(msg, nest);
723 ret = nl_send_recv(ctx->sk, msg);
725 wpa_printf(MSG_ERROR,
726 DRV_PREFIX "failed to communicate: %d (%s)",
727 ret, nl_geterror(-ret));
737 * macsec_drv_get_transmit_next_pn - Get transmit next PN
738 * @priv: Private driver interface data
739 * @sa: secure association
740 * Returns: 0 on success, -1 on failure (or if not supported)
742 static int macsec_drv_get_transmit_next_pn(void *priv, struct transmit_sa *sa)
744 struct macsec_drv_data *drv = priv;
747 wpa_printf(MSG_DEBUG, "%s", __func__);
749 err = do_dump(drv, sa->an, UNUSED_SCI, 0xff, &sa->next_pn);
750 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: err %d result %d", __func__, err,
757 * macsec_drv_set_transmit_next_pn - Set transmit next pn
758 * @priv: Private driver interface data
759 * @sa: secure association
760 * Returns: 0 on success, -1 on failure (or if not supported)
762 static int macsec_drv_set_transmit_next_pn(void *priv, struct transmit_sa *sa)
764 struct macsec_drv_data *drv = priv;
765 struct macsec_genl_ctx *ctx = &drv->ctx;
770 wpa_printf(MSG_DEBUG, "%s -> %d: %d", __func__, sa->an, sa->next_pn);
772 msg = msg_prepare(MACSEC_CMD_UPD_TXSA, ctx, drv->ifi);
776 nest = nla_nest_start(msg, MACSEC_ATTR_SA_CONFIG);
778 goto nla_put_failure;
780 NLA_PUT_U8(msg, MACSEC_SA_ATTR_AN, sa->an);
781 NLA_PUT_U32(msg, MACSEC_SA_ATTR_PN, sa->next_pn);
783 nla_nest_end(msg, nest);
785 ret = nl_send_recv(ctx->sk, msg);
787 wpa_printf(MSG_ERROR,
788 DRV_PREFIX "failed to communicate: %d (%s)",
789 ret, nl_geterror(-ret));
798 #define SCISTR MACSTR "::%hx"
799 #define SCI2STR(addr, port) MAC2STR(addr), htons(port)
802 * macsec_drv_create_receive_sc - Create secure channel for receiving
803 * @priv: Private driver interface data
804 * @sc: secure channel
805 * @sci_addr: secure channel identifier - address
806 * @sci_port: secure channel identifier - port
807 * @conf_offset: confidentiality offset (0, 30, or 50)
808 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
810 * Returns: 0 on success, -1 on failure (or if not supported)
812 static int macsec_drv_create_receive_sc(void *priv, struct receive_sc *sc,
813 unsigned int conf_offset,
816 struct macsec_drv_data *drv = priv;
817 struct macsec_genl_ctx *ctx = &drv->ctx;
821 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: create_receive_sc -> " SCISTR
822 " (conf_offset=%u validation=%d)",
823 drv->ifname, SCI2STR(sc->sci.addr, sc->sci.port),
824 conf_offset, validation);
826 msg = msg_prepare(MACSEC_CMD_ADD_RXSC, ctx, drv->ifi);
830 if (nla_put_rxsc_config(msg, mka_sci_u64(&sc->sci)))
831 goto nla_put_failure;
833 ret = nl_send_recv(ctx->sk, msg);
835 wpa_printf(MSG_ERROR,
836 DRV_PREFIX "%s: failed to communicate: %d (%s)",
837 __func__, ret, nl_geterror(-ret));
847 * macsec_drv_delete_receive_sc - Delete secure connection for receiving
848 * @priv: private driver interface data from init()
849 * @sc: secure channel
850 * Returns: 0 on success, -1 on failure
852 static int macsec_drv_delete_receive_sc(void *priv, struct receive_sc *sc)
854 struct macsec_drv_data *drv = priv;
855 struct macsec_genl_ctx *ctx = &drv->ctx;
859 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: delete_receive_sc -> " SCISTR,
860 drv->ifname, SCI2STR(sc->sci.addr, sc->sci.port));
862 msg = msg_prepare(MACSEC_CMD_DEL_RXSC, ctx, drv->ifi);
866 if (nla_put_rxsc_config(msg, mka_sci_u64(&sc->sci)))
867 goto nla_put_failure;
869 ret = nl_send_recv(ctx->sk, msg);
871 wpa_printf(MSG_ERROR,
872 DRV_PREFIX "%s: failed to communicate: %d (%s)",
873 __func__, ret, nl_geterror(-ret));
883 * macsec_drv_create_receive_sa - Create secure association for receive
884 * @priv: private driver interface data from init()
885 * @sa: secure association
886 * Returns: 0 on success, -1 on failure
888 static int macsec_drv_create_receive_sa(void *priv, struct receive_sa *sa)
890 struct macsec_drv_data *drv = priv;
891 struct macsec_genl_ctx *ctx = &drv->ctx;
896 wpa_printf(MSG_DEBUG,
897 DRV_PREFIX "%s: create_receive_sa -> %d on " SCISTR
898 " (enable_receive=%d next_pn=%u)",
900 SCI2STR(sa->sc->sci.addr, sa->sc->sci.port),
901 sa->enable_receive, sa->next_pn);
902 wpa_hexdump(MSG_DEBUG, DRV_PREFIX "SA keyid",
903 &sa->pkey->key_identifier,
904 sizeof(sa->pkey->key_identifier));
905 wpa_hexdump_key(MSG_DEBUG, DRV_PREFIX "SA key",
906 sa->pkey->key, sa->pkey->key_len);
908 msg = msg_prepare(MACSEC_CMD_ADD_RXSA, ctx, drv->ifi);
912 if (nla_put_rxsc_config(msg, mka_sci_u64(&sa->sc->sci)))
913 goto nla_put_failure;
915 nest = nla_nest_start(msg, MACSEC_ATTR_SA_CONFIG);
917 goto nla_put_failure;
919 NLA_PUT_U8(msg, MACSEC_SA_ATTR_AN, sa->an);
920 NLA_PUT_U8(msg, MACSEC_SA_ATTR_ACTIVE, sa->enable_receive);
921 NLA_PUT_U32(msg, MACSEC_SA_ATTR_PN, sa->next_pn);
922 NLA_PUT(msg, MACSEC_SA_ATTR_KEYID, sizeof(sa->pkey->key_identifier),
923 &sa->pkey->key_identifier);
924 NLA_PUT(msg, MACSEC_SA_ATTR_KEY, sa->pkey->key_len, sa->pkey->key);
926 nla_nest_end(msg, nest);
928 ret = nl_send_recv(ctx->sk, msg);
930 wpa_printf(MSG_ERROR,
931 DRV_PREFIX "%s: failed to communicate: %d (%s)",
932 __func__, ret, nl_geterror(-ret));
942 * macsec_drv_delete_receive_sa - Delete secure association for receive
943 * @priv: private driver interface data from init()
944 * @sa: secure association
945 * Returns: 0 on success, -1 on failure
947 static int macsec_drv_delete_receive_sa(void *priv, struct receive_sa *sa)
949 struct macsec_drv_data *drv = priv;
950 struct macsec_genl_ctx *ctx = &drv->ctx;
955 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: delete_receive_sa -> %d on "
956 SCISTR, drv->ifname, sa->an,
957 SCI2STR(sa->sc->sci.addr, sa->sc->sci.port));
959 msg = msg_prepare(MACSEC_CMD_DEL_RXSA, ctx, drv->ifi);
963 if (nla_put_rxsc_config(msg, mka_sci_u64(&sa->sc->sci)))
964 goto nla_put_failure;
966 nest = nla_nest_start(msg, MACSEC_ATTR_SA_CONFIG);
968 goto nla_put_failure;
970 NLA_PUT_U8(msg, MACSEC_SA_ATTR_AN, sa->an);
972 nla_nest_end(msg, nest);
974 ret = nl_send_recv(ctx->sk, msg);
976 wpa_printf(MSG_ERROR,
977 DRV_PREFIX "%s: failed to communicate: %d (%s)",
978 __func__, ret, nl_geterror(-ret));
987 static int set_active_rx_sa(const struct macsec_genl_ctx *ctx, int ifindex,
988 u64 sci, unsigned char an, Boolean state)
994 msg = msg_prepare(MACSEC_CMD_UPD_RXSA, ctx, ifindex);
998 if (nla_put_rxsc_config(msg, sci))
999 goto nla_put_failure;
1001 nest = nla_nest_start(msg, MACSEC_ATTR_SA_CONFIG);
1003 goto nla_put_failure;
1005 NLA_PUT_U8(msg, MACSEC_SA_ATTR_AN, an);
1006 NLA_PUT_U8(msg, MACSEC_SA_ATTR_ACTIVE, !!state);
1008 nla_nest_end(msg, nest);
1010 ret = nl_send_recv(ctx->sk, msg);
1012 wpa_printf(MSG_ERROR,
1013 DRV_PREFIX "%s: failed to communicate: %d (%s)",
1014 __func__, ret, nl_geterror(-ret));
1023 * macsec_drv_enable_receive_sa - Enable the SA for receive
1024 * @priv: private driver interface data from init()
1025 * @sa: secure association
1026 * Returns: 0 on success, -1 on failure
1028 static int macsec_drv_enable_receive_sa(void *priv, struct receive_sa *sa)
1030 struct macsec_drv_data *drv = priv;
1031 struct macsec_genl_ctx *ctx = &drv->ctx;
1033 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: enable_receive_sa -> %d on "
1034 SCISTR, drv->ifname, sa->an,
1035 SCI2STR(sa->sc->sci.addr, sa->sc->sci.port));
1037 return set_active_rx_sa(ctx, drv->ifi, mka_sci_u64(&sa->sc->sci),
1043 * macsec_drv_disable_receive_sa - Disable SA for receive
1044 * @priv: private driver interface data from init()
1045 * @sa: secure association
1046 * Returns: 0 on success, -1 on failure
1048 static int macsec_drv_disable_receive_sa(void *priv, struct receive_sa *sa)
1050 struct macsec_drv_data *drv = priv;
1051 struct macsec_genl_ctx *ctx = &drv->ctx;
1053 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: disable_receive_sa -> %d on "
1054 SCISTR, drv->ifname, sa->an,
1055 SCI2STR(sa->sc->sci.addr, sa->sc->sci.port));
1057 return set_active_rx_sa(ctx, drv->ifi, mka_sci_u64(&sa->sc->sci),
1062 static struct rtnl_link * lookup_sc(struct nl_cache *cache, int parent, u64 sci)
1064 struct rtnl_link *needle;
1067 needle = rtnl_link_macsec_alloc();
1071 rtnl_link_set_link(needle, parent);
1072 rtnl_link_macsec_set_sci(needle, sci);
1074 match = nl_cache_find(cache, (struct nl_object *) needle);
1075 rtnl_link_put(needle);
1077 return (struct rtnl_link *) match;
1082 * macsec_drv_create_transmit_sc - Create secure connection for transmit
1083 * @priv: private driver interface data from init()
1084 * @sc: secure channel
1085 * @conf_offset: confidentiality offset
1086 * Returns: 0 on success, -1 on failure
1088 static int macsec_drv_create_transmit_sc(
1089 void *priv, struct transmit_sc *sc,
1090 unsigned int conf_offset)
1092 struct macsec_drv_data *drv = priv;
1093 struct rtnl_link *link;
1098 wpa_printf(MSG_DEBUG, DRV_PREFIX
1099 "%s: create_transmit_sc -> " SCISTR " (conf_offset=%d)",
1100 drv->common.ifname, SCI2STR(sc->sci.addr, sc->sci.port),
1104 wpa_printf(MSG_ERROR, DRV_PREFIX "NULL rtnl socket");
1108 link = rtnl_link_macsec_alloc();
1110 wpa_printf(MSG_ERROR, DRV_PREFIX "couldn't allocate link");
1114 rtnl_link_set_link(link, drv->parent_ifi);
1116 sci = mka_sci_u64(&sc->sci);
1117 rtnl_link_macsec_set_sci(link, sci);
1119 drv->created_link = TRUE;
1121 err = rtnl_link_add(drv->sk, link, NLM_F_CREATE);
1122 if (err == -NLE_BUSY) {
1123 wpa_printf(MSG_INFO,
1124 DRV_PREFIX "link already exists, using it");
1125 drv->created_link = FALSE;
1126 } else if (err < 0) {
1127 rtnl_link_put(link);
1128 wpa_printf(MSG_ERROR, DRV_PREFIX "couldn't create link: err %d",
1133 rtnl_link_put(link);
1135 nl_cache_refill(drv->sk, drv->link_cache);
1136 link = lookup_sc(drv->link_cache, drv->parent_ifi, sci);
1138 wpa_printf(MSG_ERROR, DRV_PREFIX "couldn't find link");
1142 drv->ifi = rtnl_link_get_ifindex(link);
1143 ifname = rtnl_link_get_name(link);
1144 wpa_printf(MSG_DEBUG,
1145 DRV_PREFIX "%s: create_transmit_sc: ifi=%d ifname=%s",
1146 drv->common.ifname, drv->ifi, ifname);
1147 os_strlcpy(drv->ifname, ifname, sizeof(drv->ifname));
1148 rtnl_link_put(link);
1150 drv->link = rtnl_link_macsec_alloc();
1152 wpa_printf(MSG_ERROR, DRV_PREFIX "couldn't allocate link");
1156 rtnl_link_set_name(drv->link, drv->ifname);
1158 /* In case some settings have already been done but we couldn't apply
1160 return try_commit(drv);
1165 * macsec_drv_delete_transmit_sc - Delete secure connection for transmit
1166 * @priv: private driver interface data from init()
1167 * @sc: secure channel
1168 * Returns: 0 on success, -1 on failure
1170 static int macsec_drv_delete_transmit_sc(void *priv, struct transmit_sc *sc)
1172 struct macsec_drv_data *drv = priv;
1175 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: delete_transmit_sc -> " SCISTR,
1176 drv->ifname, SCI2STR(sc->sci.addr, sc->sci.port));
1181 if (!drv->created_link) {
1182 rtnl_link_put(drv->link);
1184 wpa_printf(MSG_DEBUG, DRV_PREFIX
1185 "we didn't create the link, leave it alone");
1189 err = rtnl_link_delete(drv->sk, drv->link);
1191 wpa_printf(MSG_ERROR, DRV_PREFIX "couldn't delete link");
1192 rtnl_link_put(drv->link);
1200 * macsec_drv_create_transmit_sa - Create secure association for transmit
1201 * @priv: private driver interface data from init()
1202 * @sa: secure association
1203 * Returns: 0 on success, -1 on failure
1205 static int macsec_drv_create_transmit_sa(void *priv, struct transmit_sa *sa)
1207 struct macsec_drv_data *drv = priv;
1208 struct macsec_genl_ctx *ctx = &drv->ctx;
1210 struct nlattr *nest;
1213 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: create_transmit_sa -> %d on "
1214 SCISTR " (enable_transmit=%d next_pn=%u)",
1215 drv->ifname, sa->an,
1216 SCI2STR(sa->sc->sci.addr, sa->sc->sci.port),
1217 sa->enable_transmit, sa->next_pn);
1218 wpa_hexdump(MSG_DEBUG, DRV_PREFIX "SA keyid",
1219 &sa->pkey->key_identifier,
1220 sizeof(sa->pkey->key_identifier));
1221 wpa_hexdump_key(MSG_DEBUG, DRV_PREFIX "SA key",
1222 sa->pkey->key, sa->pkey->key_len);
1224 msg = msg_prepare(MACSEC_CMD_ADD_TXSA, ctx, drv->ifi);
1228 nest = nla_nest_start(msg, MACSEC_ATTR_SA_CONFIG);
1230 goto nla_put_failure;
1232 NLA_PUT_U8(msg, MACSEC_SA_ATTR_AN, sa->an);
1233 NLA_PUT_U32(msg, MACSEC_SA_ATTR_PN, sa->next_pn);
1234 NLA_PUT(msg, MACSEC_SA_ATTR_KEYID, sizeof(sa->pkey->key_identifier),
1235 &sa->pkey->key_identifier);
1236 NLA_PUT(msg, MACSEC_SA_ATTR_KEY, sa->pkey->key_len, sa->pkey->key);
1237 NLA_PUT_U8(msg, MACSEC_SA_ATTR_ACTIVE, sa->enable_transmit);
1239 nla_nest_end(msg, nest);
1241 ret = nl_send_recv(ctx->sk, msg);
1243 wpa_printf(MSG_ERROR,
1244 DRV_PREFIX "%s: failed to communicate: %d (%s)",
1245 __func__, ret, nl_geterror(-ret));
1255 * macsec_drv_delete_transmit_sa - Delete secure association for transmit
1256 * @priv: private driver interface data from init()
1257 * @sa: secure association
1258 * Returns: 0 on success, -1 on failure
1260 static int macsec_drv_delete_transmit_sa(void *priv, struct transmit_sa *sa)
1262 struct macsec_drv_data *drv = priv;
1263 struct macsec_genl_ctx *ctx = &drv->ctx;
1265 struct nlattr *nest;
1268 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: delete_transmit_sa -> %d on "
1269 SCISTR, drv->ifname, sa->an,
1270 SCI2STR(sa->sc->sci.addr, sa->sc->sci.port));
1272 msg = msg_prepare(MACSEC_CMD_DEL_TXSA, ctx, drv->ifi);
1276 nest = nla_nest_start(msg, MACSEC_ATTR_SA_CONFIG);
1278 goto nla_put_failure;
1280 NLA_PUT_U8(msg, MACSEC_SA_ATTR_AN, sa->an);
1282 nla_nest_end(msg, nest);
1284 ret = nl_send_recv(ctx->sk, msg);
1286 wpa_printf(MSG_ERROR,
1287 DRV_PREFIX "%s: failed to communicate: %d (%s)",
1288 __func__, ret, nl_geterror(-ret));
1297 static int set_active_tx_sa(const struct macsec_genl_ctx *ctx, int ifindex,
1298 unsigned char an, Boolean state)
1301 struct nlattr *nest;
1304 msg = msg_prepare(MACSEC_CMD_UPD_TXSA, ctx, ifindex);
1308 nest = nla_nest_start(msg, MACSEC_ATTR_SA_CONFIG);
1310 goto nla_put_failure;
1312 NLA_PUT_U8(msg, MACSEC_SA_ATTR_AN, an);
1313 NLA_PUT_U8(msg, MACSEC_SA_ATTR_ACTIVE, !!state);
1315 nla_nest_end(msg, nest);
1317 ret = nl_send_recv(ctx->sk, msg);
1319 wpa_printf(MSG_ERROR,
1320 DRV_PREFIX "%s: failed to communicate: %d (%s)",
1321 __func__, ret, nl_geterror(-ret));
1331 * macsec_drv_enable_transmit_sa - Enable SA for transmit
1332 * @priv: private driver interface data from init()
1333 * @sa: secure association
1334 * Returns: 0 on success, -1 on failure
1336 static int macsec_drv_enable_transmit_sa(void *priv, struct transmit_sa *sa)
1338 struct macsec_drv_data *drv = priv;
1339 struct macsec_genl_ctx *ctx = &drv->ctx;
1342 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: enable_transmit_sa -> %d on "
1343 SCISTR, drv->ifname, sa->an,
1344 SCI2STR(sa->sc->sci.addr, sa->sc->sci.port));
1346 ret = set_active_tx_sa(ctx, drv->ifi, sa->an, TRUE);
1348 wpa_printf(MSG_ERROR, DRV_PREFIX "failed to enable txsa");
1352 drv->encoding_sa_set = TRUE;
1353 drv->encoding_sa = sa->an;
1355 return try_commit(drv);
1360 * macsec_drv_disable_transmit_sa - Disable SA for transmit
1361 * @priv: private driver interface data from init()
1362 * @sa: secure association
1363 * Returns: 0 on success, -1 on failure
1365 static int macsec_drv_disable_transmit_sa(void *priv, struct transmit_sa *sa)
1367 struct macsec_drv_data *drv = priv;
1368 struct macsec_genl_ctx *ctx = &drv->ctx;
1370 wpa_printf(MSG_DEBUG, DRV_PREFIX "%s: disable_transmit_sa -> %d on "
1371 SCISTR, drv->ifname, sa->an,
1372 SCI2STR(sa->sc->sci.addr, sa->sc->sci.port));
1374 return set_active_tx_sa(ctx, drv->ifi, sa->an, FALSE);
1378 static int macsec_drv_status(void *priv, char *buf, size_t buflen)
1380 struct macsec_drv_data *drv = priv;
1387 res = os_snprintf(pos, end - pos,
1390 "parent_ifname=%s\n"
1392 drv->common.ifname, drv->ifi,
1393 drv->ifname, drv->parent_ifi);
1394 if (os_snprintf_error(end - pos, res))
1402 const struct wpa_driver_ops wpa_driver_macsec_linux_ops = {
1403 .name = "macsec_linux",
1404 .desc = "MACsec Ethernet driver for Linux",
1405 .get_ssid = driver_wired_get_ssid,
1406 .get_bssid = driver_wired_get_bssid,
1407 .get_capa = driver_wired_get_capa,
1408 .init = macsec_drv_wpa_init,
1409 .deinit = macsec_drv_wpa_deinit,
1411 .macsec_init = macsec_drv_macsec_init,
1412 .macsec_deinit = macsec_drv_macsec_deinit,
1413 .macsec_get_capability = macsec_drv_get_capability,
1414 .enable_protect_frames = macsec_drv_enable_protect_frames,
1415 .enable_encrypt = macsec_drv_enable_encrypt,
1416 .set_replay_protect = macsec_drv_set_replay_protect,
1417 .set_current_cipher_suite = macsec_drv_set_current_cipher_suite,
1418 .enable_controlled_port = macsec_drv_enable_controlled_port,
1419 .get_receive_lowest_pn = macsec_drv_get_receive_lowest_pn,
1420 .set_receive_lowest_pn = macsec_drv_set_receive_lowest_pn,
1421 .get_transmit_next_pn = macsec_drv_get_transmit_next_pn,
1422 .set_transmit_next_pn = macsec_drv_set_transmit_next_pn,
1423 .create_receive_sc = macsec_drv_create_receive_sc,
1424 .delete_receive_sc = macsec_drv_delete_receive_sc,
1425 .create_receive_sa = macsec_drv_create_receive_sa,
1426 .delete_receive_sa = macsec_drv_delete_receive_sa,
1427 .enable_receive_sa = macsec_drv_enable_receive_sa,
1428 .disable_receive_sa = macsec_drv_disable_receive_sa,
1429 .create_transmit_sc = macsec_drv_create_transmit_sc,
1430 .delete_transmit_sc = macsec_drv_delete_transmit_sc,
1431 .create_transmit_sa = macsec_drv_create_transmit_sa,
1432 .delete_transmit_sa = macsec_drv_delete_transmit_sa,
1433 .enable_transmit_sa = macsec_drv_enable_transmit_sa,
1434 .disable_transmit_sa = macsec_drv_disable_transmit_sa,
1436 .status = macsec_drv_status,