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