1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */ 2 /* 3 * include/uapi/linux/if_macsec.h - MACsec device 4 * 5 * Copyright (c) 2015 Sabrina Dubroca <sd@queasysnail.net> 6 * 7 * This program is free software; you can redistribute it and/or modify 8 * it under the terms of the GNU General Public License as published by 9 * the Free Software Foundation; either version 2 of the License, or 10 * (at your option) any later version. 11 */ 12 13 #ifndef _UAPI_MACSEC_H 14 #define _UAPI_MACSEC_H 15 16 #include <linux/types.h> 17 18 #define MACSEC_GENL_NAME "macsec" 19 #define MACSEC_GENL_VERSION 1 20 21 #define MACSEC_MAX_KEY_LEN 128 22 23 #define MACSEC_KEYID_LEN 16 24 25 #define MACSEC_DEFAULT_CIPHER_ID 0x0080020001000001ULL 26 #define MACSEC_DEFAULT_CIPHER_ALT 0x0080C20001000001ULL 27 28 #define MACSEC_MIN_ICV_LEN 8 29 #define MACSEC_MAX_ICV_LEN 32 30 /* upper limit for ICV length as recommended by IEEE802.1AE-2006 */ 31 #define MACSEC_STD_ICV_LEN 16 32 33 enum macsec_attrs { 34 MACSEC_ATTR_UNSPEC, 35 MACSEC_ATTR_IFINDEX, /* u32, ifindex of the MACsec netdevice */ 36 MACSEC_ATTR_RXSC_CONFIG, /* config, nested macsec_rxsc_attrs */ 37 MACSEC_ATTR_SA_CONFIG, /* config, nested macsec_sa_attrs */ 38 MACSEC_ATTR_SECY, /* dump, nested macsec_secy_attrs */ 39 MACSEC_ATTR_TXSA_LIST, /* dump, nested, macsec_sa_attrs for each TXSA */ 40 MACSEC_ATTR_RXSC_LIST, /* dump, nested, macsec_rxsc_attrs for each RXSC */ 41 MACSEC_ATTR_TXSC_STATS, /* dump, nested, macsec_txsc_stats_attr */ 42 MACSEC_ATTR_SECY_STATS, /* dump, nested, macsec_secy_stats_attr */ 43 __MACSEC_ATTR_END, 44 NUM_MACSEC_ATTR = __MACSEC_ATTR_END, 45 MACSEC_ATTR_MAX = __MACSEC_ATTR_END - 1, 46 }; 47 48 enum macsec_secy_attrs { 49 MACSEC_SECY_ATTR_UNSPEC, 50 MACSEC_SECY_ATTR_SCI, 51 MACSEC_SECY_ATTR_ENCODING_SA, 52 MACSEC_SECY_ATTR_WINDOW, 53 MACSEC_SECY_ATTR_CIPHER_SUITE, 54 MACSEC_SECY_ATTR_ICV_LEN, 55 MACSEC_SECY_ATTR_PROTECT, 56 MACSEC_SECY_ATTR_REPLAY, 57 MACSEC_SECY_ATTR_OPER, 58 MACSEC_SECY_ATTR_VALIDATE, 59 MACSEC_SECY_ATTR_ENCRYPT, 60 MACSEC_SECY_ATTR_INC_SCI, 61 MACSEC_SECY_ATTR_ES, 62 MACSEC_SECY_ATTR_SCB, 63 MACSEC_SECY_ATTR_PAD, 64 __MACSEC_SECY_ATTR_END, 65 NUM_MACSEC_SECY_ATTR = __MACSEC_SECY_ATTR_END, 66 MACSEC_SECY_ATTR_MAX = __MACSEC_SECY_ATTR_END - 1, 67 }; 68 69 enum macsec_rxsc_attrs { 70 MACSEC_RXSC_ATTR_UNSPEC, 71 MACSEC_RXSC_ATTR_SCI, /* config/dump, u64 */ 72 MACSEC_RXSC_ATTR_ACTIVE, /* config/dump, u8 0..1 */ 73 MACSEC_RXSC_ATTR_SA_LIST, /* dump, nested */ 74 MACSEC_RXSC_ATTR_STATS, /* dump, nested, macsec_rxsc_stats_attr */ 75 MACSEC_RXSC_ATTR_PAD, 76 __MACSEC_RXSC_ATTR_END, 77 NUM_MACSEC_RXSC_ATTR = __MACSEC_RXSC_ATTR_END, 78 MACSEC_RXSC_ATTR_MAX = __MACSEC_RXSC_ATTR_END - 1, 79 }; 80 81 enum macsec_sa_attrs { 82 MACSEC_SA_ATTR_UNSPEC, 83 MACSEC_SA_ATTR_AN, /* config/dump, u8 0..3 */ 84 MACSEC_SA_ATTR_ACTIVE, /* config/dump, u8 0..1 */ 85 MACSEC_SA_ATTR_PN, /* config/dump, u32 */ 86 MACSEC_SA_ATTR_KEY, /* config, data */ 87 MACSEC_SA_ATTR_KEYID, /* config/dump, 128-bit */ 88 MACSEC_SA_ATTR_STATS, /* dump, nested, macsec_sa_stats_attr */ 89 MACSEC_SA_ATTR_PAD, 90 __MACSEC_SA_ATTR_END, 91 NUM_MACSEC_SA_ATTR = __MACSEC_SA_ATTR_END, 92 MACSEC_SA_ATTR_MAX = __MACSEC_SA_ATTR_END - 1, 93 }; 94 95 enum macsec_nl_commands { 96 MACSEC_CMD_GET_TXSC, 97 MACSEC_CMD_ADD_RXSC, 98 MACSEC_CMD_DEL_RXSC, 99 MACSEC_CMD_UPD_RXSC, 100 MACSEC_CMD_ADD_TXSA, 101 MACSEC_CMD_DEL_TXSA, 102 MACSEC_CMD_UPD_TXSA, 103 MACSEC_CMD_ADD_RXSA, 104 MACSEC_CMD_DEL_RXSA, 105 MACSEC_CMD_UPD_RXSA, 106 }; 107 108 /* u64 per-RXSC stats */ 109 enum macsec_rxsc_stats_attr { 110 MACSEC_RXSC_STATS_ATTR_UNSPEC, 111 MACSEC_RXSC_STATS_ATTR_IN_OCTETS_VALIDATED, 112 MACSEC_RXSC_STATS_ATTR_IN_OCTETS_DECRYPTED, 113 MACSEC_RXSC_STATS_ATTR_IN_PKTS_UNCHECKED, 114 MACSEC_RXSC_STATS_ATTR_IN_PKTS_DELAYED, 115 MACSEC_RXSC_STATS_ATTR_IN_PKTS_OK, 116 MACSEC_RXSC_STATS_ATTR_IN_PKTS_INVALID, 117 MACSEC_RXSC_STATS_ATTR_IN_PKTS_LATE, 118 MACSEC_RXSC_STATS_ATTR_IN_PKTS_NOT_VALID, 119 MACSEC_RXSC_STATS_ATTR_IN_PKTS_NOT_USING_SA, 120 MACSEC_RXSC_STATS_ATTR_IN_PKTS_UNUSED_SA, 121 MACSEC_RXSC_STATS_ATTR_PAD, 122 __MACSEC_RXSC_STATS_ATTR_END, 123 NUM_MACSEC_RXSC_STATS_ATTR = __MACSEC_RXSC_STATS_ATTR_END, 124 MACSEC_RXSC_STATS_ATTR_MAX = __MACSEC_RXSC_STATS_ATTR_END - 1, 125 }; 126 127 /* u32 per-{RX,TX}SA stats */ 128 enum macsec_sa_stats_attr { 129 MACSEC_SA_STATS_ATTR_UNSPEC, 130 MACSEC_SA_STATS_ATTR_IN_PKTS_OK, 131 MACSEC_SA_STATS_ATTR_IN_PKTS_INVALID, 132 MACSEC_SA_STATS_ATTR_IN_PKTS_NOT_VALID, 133 MACSEC_SA_STATS_ATTR_IN_PKTS_NOT_USING_SA, 134 MACSEC_SA_STATS_ATTR_IN_PKTS_UNUSED_SA, 135 MACSEC_SA_STATS_ATTR_OUT_PKTS_PROTECTED, 136 MACSEC_SA_STATS_ATTR_OUT_PKTS_ENCRYPTED, 137 __MACSEC_SA_STATS_ATTR_END, 138 NUM_MACSEC_SA_STATS_ATTR = __MACSEC_SA_STATS_ATTR_END, 139 MACSEC_SA_STATS_ATTR_MAX = __MACSEC_SA_STATS_ATTR_END - 1, 140 }; 141 142 /* u64 per-TXSC stats */ 143 enum macsec_txsc_stats_attr { 144 MACSEC_TXSC_STATS_ATTR_UNSPEC, 145 MACSEC_TXSC_STATS_ATTR_OUT_PKTS_PROTECTED, 146 MACSEC_TXSC_STATS_ATTR_OUT_PKTS_ENCRYPTED, 147 MACSEC_TXSC_STATS_ATTR_OUT_OCTETS_PROTECTED, 148 MACSEC_TXSC_STATS_ATTR_OUT_OCTETS_ENCRYPTED, 149 MACSEC_TXSC_STATS_ATTR_PAD, 150 __MACSEC_TXSC_STATS_ATTR_END, 151 NUM_MACSEC_TXSC_STATS_ATTR = __MACSEC_TXSC_STATS_ATTR_END, 152 MACSEC_TXSC_STATS_ATTR_MAX = __MACSEC_TXSC_STATS_ATTR_END - 1, 153 }; 154 155 /* u64 per-SecY stats */ 156 enum macsec_secy_stats_attr { 157 MACSEC_SECY_STATS_ATTR_UNSPEC, 158 MACSEC_SECY_STATS_ATTR_OUT_PKTS_UNTAGGED, 159 MACSEC_SECY_STATS_ATTR_IN_PKTS_UNTAGGED, 160 MACSEC_SECY_STATS_ATTR_OUT_PKTS_TOO_LONG, 161 MACSEC_SECY_STATS_ATTR_IN_PKTS_NO_TAG, 162 MACSEC_SECY_STATS_ATTR_IN_PKTS_BAD_TAG, 163 MACSEC_SECY_STATS_ATTR_IN_PKTS_UNKNOWN_SCI, 164 MACSEC_SECY_STATS_ATTR_IN_PKTS_NO_SCI, 165 MACSEC_SECY_STATS_ATTR_IN_PKTS_OVERRUN, 166 MACSEC_SECY_STATS_ATTR_PAD, 167 __MACSEC_SECY_STATS_ATTR_END, 168 NUM_MACSEC_SECY_STATS_ATTR = __MACSEC_SECY_STATS_ATTR_END, 169 MACSEC_SECY_STATS_ATTR_MAX = __MACSEC_SECY_STATS_ATTR_END - 1, 170 }; 171 172 #endif /* _UAPI_MACSEC_H */ 173