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 /* cipher IDs as per IEEE802.1AE-2018 (Table 14-1) */ 26 #define MACSEC_CIPHER_ID_GCM_AES_128 0x0080C20001000001ULL 27 #define MACSEC_CIPHER_ID_GCM_AES_256 0x0080C20001000002ULL 28 #define MACSEC_CIPHER_ID_GCM_AES_XPN_128 0x0080C20001000003ULL 29 #define MACSEC_CIPHER_ID_GCM_AES_XPN_256 0x0080C20001000004ULL 30 31 /* deprecated cipher ID for GCM-AES-128 */ 32 #define MACSEC_DEFAULT_CIPHER_ID 0x0080020001000001ULL 33 #define MACSEC_DEFAULT_CIPHER_ALT MACSEC_CIPHER_ID_GCM_AES_128 34 35 #define MACSEC_MIN_ICV_LEN 8 36 #define MACSEC_MAX_ICV_LEN 32 37 /* upper limit for ICV length as recommended by IEEE802.1AE-2006 */ 38 #define MACSEC_STD_ICV_LEN 16 39 40 enum macsec_attrs { 41 MACSEC_ATTR_UNSPEC, 42 MACSEC_ATTR_IFINDEX, /* u32, ifindex of the MACsec netdevice */ 43 MACSEC_ATTR_RXSC_CONFIG, /* config, nested macsec_rxsc_attrs */ 44 MACSEC_ATTR_SA_CONFIG, /* config, nested macsec_sa_attrs */ 45 MACSEC_ATTR_SECY, /* dump, nested macsec_secy_attrs */ 46 MACSEC_ATTR_TXSA_LIST, /* dump, nested, macsec_sa_attrs for each TXSA */ 47 MACSEC_ATTR_RXSC_LIST, /* dump, nested, macsec_rxsc_attrs for each RXSC */ 48 MACSEC_ATTR_TXSC_STATS, /* dump, nested, macsec_txsc_stats_attr */ 49 MACSEC_ATTR_SECY_STATS, /* dump, nested, macsec_secy_stats_attr */ 50 MACSEC_ATTR_OFFLOAD, /* config, nested, macsec_offload_attrs */ 51 __MACSEC_ATTR_END, 52 NUM_MACSEC_ATTR = __MACSEC_ATTR_END, 53 MACSEC_ATTR_MAX = __MACSEC_ATTR_END - 1, 54 }; 55 56 enum macsec_secy_attrs { 57 MACSEC_SECY_ATTR_UNSPEC, 58 MACSEC_SECY_ATTR_SCI, 59 MACSEC_SECY_ATTR_ENCODING_SA, 60 MACSEC_SECY_ATTR_WINDOW, 61 MACSEC_SECY_ATTR_CIPHER_SUITE, 62 MACSEC_SECY_ATTR_ICV_LEN, 63 MACSEC_SECY_ATTR_PROTECT, 64 MACSEC_SECY_ATTR_REPLAY, 65 MACSEC_SECY_ATTR_OPER, 66 MACSEC_SECY_ATTR_VALIDATE, 67 MACSEC_SECY_ATTR_ENCRYPT, 68 MACSEC_SECY_ATTR_INC_SCI, 69 MACSEC_SECY_ATTR_ES, 70 MACSEC_SECY_ATTR_SCB, 71 MACSEC_SECY_ATTR_PAD, 72 __MACSEC_SECY_ATTR_END, 73 NUM_MACSEC_SECY_ATTR = __MACSEC_SECY_ATTR_END, 74 MACSEC_SECY_ATTR_MAX = __MACSEC_SECY_ATTR_END - 1, 75 }; 76 77 enum macsec_rxsc_attrs { 78 MACSEC_RXSC_ATTR_UNSPEC, 79 MACSEC_RXSC_ATTR_SCI, /* config/dump, u64 */ 80 MACSEC_RXSC_ATTR_ACTIVE, /* config/dump, u8 0..1 */ 81 MACSEC_RXSC_ATTR_SA_LIST, /* dump, nested */ 82 MACSEC_RXSC_ATTR_STATS, /* dump, nested, macsec_rxsc_stats_attr */ 83 MACSEC_RXSC_ATTR_PAD, 84 __MACSEC_RXSC_ATTR_END, 85 NUM_MACSEC_RXSC_ATTR = __MACSEC_RXSC_ATTR_END, 86 MACSEC_RXSC_ATTR_MAX = __MACSEC_RXSC_ATTR_END - 1, 87 }; 88 89 enum macsec_sa_attrs { 90 MACSEC_SA_ATTR_UNSPEC, 91 MACSEC_SA_ATTR_AN, /* config/dump, u8 0..3 */ 92 MACSEC_SA_ATTR_ACTIVE, /* config/dump, u8 0..1 */ 93 MACSEC_SA_ATTR_PN, /* config/dump, u32/u64 (u64 if XPN) */ 94 MACSEC_SA_ATTR_KEY, /* config, data */ 95 MACSEC_SA_ATTR_KEYID, /* config/dump, 128-bit */ 96 MACSEC_SA_ATTR_STATS, /* dump, nested, macsec_sa_stats_attr */ 97 MACSEC_SA_ATTR_PAD, 98 MACSEC_SA_ATTR_SSCI, /* config/dump, u32 - XPN only */ 99 MACSEC_SA_ATTR_SALT, /* config, 96-bit - XPN only */ 100 __MACSEC_SA_ATTR_END, 101 NUM_MACSEC_SA_ATTR = __MACSEC_SA_ATTR_END, 102 MACSEC_SA_ATTR_MAX = __MACSEC_SA_ATTR_END - 1, 103 }; 104 105 enum macsec_offload_attrs { 106 MACSEC_OFFLOAD_ATTR_UNSPEC, 107 MACSEC_OFFLOAD_ATTR_TYPE, /* config/dump, u8 0..2 */ 108 MACSEC_OFFLOAD_ATTR_PAD, 109 __MACSEC_OFFLOAD_ATTR_END, 110 NUM_MACSEC_OFFLOAD_ATTR = __MACSEC_OFFLOAD_ATTR_END, 111 MACSEC_OFFLOAD_ATTR_MAX = __MACSEC_OFFLOAD_ATTR_END - 1, 112 }; 113 114 enum macsec_nl_commands { 115 MACSEC_CMD_GET_TXSC, 116 MACSEC_CMD_ADD_RXSC, 117 MACSEC_CMD_DEL_RXSC, 118 MACSEC_CMD_UPD_RXSC, 119 MACSEC_CMD_ADD_TXSA, 120 MACSEC_CMD_DEL_TXSA, 121 MACSEC_CMD_UPD_TXSA, 122 MACSEC_CMD_ADD_RXSA, 123 MACSEC_CMD_DEL_RXSA, 124 MACSEC_CMD_UPD_RXSA, 125 MACSEC_CMD_UPD_OFFLOAD, 126 }; 127 128 /* u64 per-RXSC stats */ 129 enum macsec_rxsc_stats_attr { 130 MACSEC_RXSC_STATS_ATTR_UNSPEC, 131 MACSEC_RXSC_STATS_ATTR_IN_OCTETS_VALIDATED, 132 MACSEC_RXSC_STATS_ATTR_IN_OCTETS_DECRYPTED, 133 MACSEC_RXSC_STATS_ATTR_IN_PKTS_UNCHECKED, 134 MACSEC_RXSC_STATS_ATTR_IN_PKTS_DELAYED, 135 MACSEC_RXSC_STATS_ATTR_IN_PKTS_OK, 136 MACSEC_RXSC_STATS_ATTR_IN_PKTS_INVALID, 137 MACSEC_RXSC_STATS_ATTR_IN_PKTS_LATE, 138 MACSEC_RXSC_STATS_ATTR_IN_PKTS_NOT_VALID, 139 MACSEC_RXSC_STATS_ATTR_IN_PKTS_NOT_USING_SA, 140 MACSEC_RXSC_STATS_ATTR_IN_PKTS_UNUSED_SA, 141 MACSEC_RXSC_STATS_ATTR_PAD, 142 __MACSEC_RXSC_STATS_ATTR_END, 143 NUM_MACSEC_RXSC_STATS_ATTR = __MACSEC_RXSC_STATS_ATTR_END, 144 MACSEC_RXSC_STATS_ATTR_MAX = __MACSEC_RXSC_STATS_ATTR_END - 1, 145 }; 146 147 /* u32 per-{RX,TX}SA stats */ 148 enum macsec_sa_stats_attr { 149 MACSEC_SA_STATS_ATTR_UNSPEC, 150 MACSEC_SA_STATS_ATTR_IN_PKTS_OK, 151 MACSEC_SA_STATS_ATTR_IN_PKTS_INVALID, 152 MACSEC_SA_STATS_ATTR_IN_PKTS_NOT_VALID, 153 MACSEC_SA_STATS_ATTR_IN_PKTS_NOT_USING_SA, 154 MACSEC_SA_STATS_ATTR_IN_PKTS_UNUSED_SA, 155 MACSEC_SA_STATS_ATTR_OUT_PKTS_PROTECTED, 156 MACSEC_SA_STATS_ATTR_OUT_PKTS_ENCRYPTED, 157 __MACSEC_SA_STATS_ATTR_END, 158 NUM_MACSEC_SA_STATS_ATTR = __MACSEC_SA_STATS_ATTR_END, 159 MACSEC_SA_STATS_ATTR_MAX = __MACSEC_SA_STATS_ATTR_END - 1, 160 }; 161 162 /* u64 per-TXSC stats */ 163 enum macsec_txsc_stats_attr { 164 MACSEC_TXSC_STATS_ATTR_UNSPEC, 165 MACSEC_TXSC_STATS_ATTR_OUT_PKTS_PROTECTED, 166 MACSEC_TXSC_STATS_ATTR_OUT_PKTS_ENCRYPTED, 167 MACSEC_TXSC_STATS_ATTR_OUT_OCTETS_PROTECTED, 168 MACSEC_TXSC_STATS_ATTR_OUT_OCTETS_ENCRYPTED, 169 MACSEC_TXSC_STATS_ATTR_PAD, 170 __MACSEC_TXSC_STATS_ATTR_END, 171 NUM_MACSEC_TXSC_STATS_ATTR = __MACSEC_TXSC_STATS_ATTR_END, 172 MACSEC_TXSC_STATS_ATTR_MAX = __MACSEC_TXSC_STATS_ATTR_END - 1, 173 }; 174 175 /* u64 per-SecY stats */ 176 enum macsec_secy_stats_attr { 177 MACSEC_SECY_STATS_ATTR_UNSPEC, 178 MACSEC_SECY_STATS_ATTR_OUT_PKTS_UNTAGGED, 179 MACSEC_SECY_STATS_ATTR_IN_PKTS_UNTAGGED, 180 MACSEC_SECY_STATS_ATTR_OUT_PKTS_TOO_LONG, 181 MACSEC_SECY_STATS_ATTR_IN_PKTS_NO_TAG, 182 MACSEC_SECY_STATS_ATTR_IN_PKTS_BAD_TAG, 183 MACSEC_SECY_STATS_ATTR_IN_PKTS_UNKNOWN_SCI, 184 MACSEC_SECY_STATS_ATTR_IN_PKTS_NO_SCI, 185 MACSEC_SECY_STATS_ATTR_IN_PKTS_OVERRUN, 186 MACSEC_SECY_STATS_ATTR_PAD, 187 __MACSEC_SECY_STATS_ATTR_END, 188 NUM_MACSEC_SECY_STATS_ATTR = __MACSEC_SECY_STATS_ATTR_END, 189 MACSEC_SECY_STATS_ATTR_MAX = __MACSEC_SECY_STATS_ATTR_END - 1, 190 }; 191 192 #endif /* _UAPI_MACSEC_H */ 193