if_macsec.h 6.4 KB

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