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