xref: /linux/include/uapi/linux/tls.h (revision 8f7aa3d3c7323f4ca2768a9e74ebbe359c4f8f88)
1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR Linux-OpenIB) */
2 /*
3  * Copyright (c) 2016-2017, Mellanox Technologies. All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * OpenIB.org BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33 
34 #ifndef _UAPI_LINUX_TLS_H
35 #define _UAPI_LINUX_TLS_H
36 
37 #include <linux/types.h>
38 
39 /* TLS socket options */
40 #define TLS_TX			1	/* Set transmit parameters */
41 #define TLS_RX			2	/* Set receive parameters */
42 #define TLS_TX_ZEROCOPY_RO	3	/* TX zerocopy (only sendfile now) */
43 #define TLS_RX_EXPECT_NO_PAD	4	/* Attempt opportunistic zero-copy */
44 #define TLS_TX_MAX_PAYLOAD_LEN	5	/* Maximum plaintext size */
45 
46 /* Supported versions */
47 #define TLS_VERSION_MINOR(ver)	((ver) & 0xFF)
48 #define TLS_VERSION_MAJOR(ver)	(((ver) >> 8) & 0xFF)
49 
50 #define TLS_VERSION_NUMBER(id)	((((id##_VERSION_MAJOR) & 0xFF) << 8) |	\
51 				 ((id##_VERSION_MINOR) & 0xFF))
52 
53 #define TLS_1_2_VERSION_MAJOR	0x3
54 #define TLS_1_2_VERSION_MINOR	0x3
55 #define TLS_1_2_VERSION		TLS_VERSION_NUMBER(TLS_1_2)
56 
57 #define TLS_1_3_VERSION_MAJOR	0x3
58 #define TLS_1_3_VERSION_MINOR	0x4
59 #define TLS_1_3_VERSION		TLS_VERSION_NUMBER(TLS_1_3)
60 
61 /* Supported ciphers */
62 #define TLS_CIPHER_AES_GCM_128				51
63 #define TLS_CIPHER_AES_GCM_128_IV_SIZE			8
64 #define TLS_CIPHER_AES_GCM_128_KEY_SIZE		16
65 #define TLS_CIPHER_AES_GCM_128_SALT_SIZE		4
66 #define TLS_CIPHER_AES_GCM_128_TAG_SIZE		16
67 #define TLS_CIPHER_AES_GCM_128_REC_SEQ_SIZE		8
68 
69 #define TLS_CIPHER_AES_GCM_256				52
70 #define TLS_CIPHER_AES_GCM_256_IV_SIZE			8
71 #define TLS_CIPHER_AES_GCM_256_KEY_SIZE		32
72 #define TLS_CIPHER_AES_GCM_256_SALT_SIZE		4
73 #define TLS_CIPHER_AES_GCM_256_TAG_SIZE		16
74 #define TLS_CIPHER_AES_GCM_256_REC_SEQ_SIZE		8
75 
76 #define TLS_CIPHER_AES_CCM_128				53
77 #define TLS_CIPHER_AES_CCM_128_IV_SIZE			8
78 #define TLS_CIPHER_AES_CCM_128_KEY_SIZE		16
79 #define TLS_CIPHER_AES_CCM_128_SALT_SIZE		4
80 #define TLS_CIPHER_AES_CCM_128_TAG_SIZE		16
81 #define TLS_CIPHER_AES_CCM_128_REC_SEQ_SIZE		8
82 
83 #define TLS_CIPHER_CHACHA20_POLY1305			54
84 #define TLS_CIPHER_CHACHA20_POLY1305_IV_SIZE		12
85 #define TLS_CIPHER_CHACHA20_POLY1305_KEY_SIZE	32
86 #define TLS_CIPHER_CHACHA20_POLY1305_SALT_SIZE		0
87 #define TLS_CIPHER_CHACHA20_POLY1305_TAG_SIZE	16
88 #define TLS_CIPHER_CHACHA20_POLY1305_REC_SEQ_SIZE	8
89 
90 #define TLS_CIPHER_SM4_GCM				55
91 #define TLS_CIPHER_SM4_GCM_IV_SIZE			8
92 #define TLS_CIPHER_SM4_GCM_KEY_SIZE		16
93 #define TLS_CIPHER_SM4_GCM_SALT_SIZE		4
94 #define TLS_CIPHER_SM4_GCM_TAG_SIZE		16
95 #define TLS_CIPHER_SM4_GCM_REC_SEQ_SIZE		8
96 
97 #define TLS_CIPHER_SM4_CCM				56
98 #define TLS_CIPHER_SM4_CCM_IV_SIZE			8
99 #define TLS_CIPHER_SM4_CCM_KEY_SIZE		16
100 #define TLS_CIPHER_SM4_CCM_SALT_SIZE		4
101 #define TLS_CIPHER_SM4_CCM_TAG_SIZE		16
102 #define TLS_CIPHER_SM4_CCM_REC_SEQ_SIZE		8
103 
104 #define TLS_CIPHER_ARIA_GCM_128				57
105 #define TLS_CIPHER_ARIA_GCM_128_IV_SIZE			8
106 #define TLS_CIPHER_ARIA_GCM_128_KEY_SIZE		16
107 #define TLS_CIPHER_ARIA_GCM_128_SALT_SIZE		4
108 #define TLS_CIPHER_ARIA_GCM_128_TAG_SIZE		16
109 #define TLS_CIPHER_ARIA_GCM_128_REC_SEQ_SIZE		8
110 
111 #define TLS_CIPHER_ARIA_GCM_256				58
112 #define TLS_CIPHER_ARIA_GCM_256_IV_SIZE			8
113 #define TLS_CIPHER_ARIA_GCM_256_KEY_SIZE		32
114 #define TLS_CIPHER_ARIA_GCM_256_SALT_SIZE		4
115 #define TLS_CIPHER_ARIA_GCM_256_TAG_SIZE		16
116 #define TLS_CIPHER_ARIA_GCM_256_REC_SEQ_SIZE		8
117 
118 #define TLS_SET_RECORD_TYPE	1
119 #define TLS_GET_RECORD_TYPE	2
120 
121 struct tls_crypto_info {
122 	__u16 version;
123 	__u16 cipher_type;
124 };
125 
126 struct tls12_crypto_info_aes_gcm_128 {
127 	struct tls_crypto_info info;
128 	unsigned char iv[TLS_CIPHER_AES_GCM_128_IV_SIZE];
129 	unsigned char key[TLS_CIPHER_AES_GCM_128_KEY_SIZE];
130 	unsigned char salt[TLS_CIPHER_AES_GCM_128_SALT_SIZE];
131 	unsigned char rec_seq[TLS_CIPHER_AES_GCM_128_REC_SEQ_SIZE];
132 };
133 
134 struct tls12_crypto_info_aes_gcm_256 {
135 	struct tls_crypto_info info;
136 	unsigned char iv[TLS_CIPHER_AES_GCM_256_IV_SIZE];
137 	unsigned char key[TLS_CIPHER_AES_GCM_256_KEY_SIZE];
138 	unsigned char salt[TLS_CIPHER_AES_GCM_256_SALT_SIZE];
139 	unsigned char rec_seq[TLS_CIPHER_AES_GCM_256_REC_SEQ_SIZE];
140 };
141 
142 struct tls12_crypto_info_aes_ccm_128 {
143 	struct tls_crypto_info info;
144 	unsigned char iv[TLS_CIPHER_AES_CCM_128_IV_SIZE];
145 	unsigned char key[TLS_CIPHER_AES_CCM_128_KEY_SIZE];
146 	unsigned char salt[TLS_CIPHER_AES_CCM_128_SALT_SIZE];
147 	unsigned char rec_seq[TLS_CIPHER_AES_CCM_128_REC_SEQ_SIZE];
148 };
149 
150 struct tls12_crypto_info_chacha20_poly1305 {
151 	struct tls_crypto_info info;
152 	unsigned char iv[TLS_CIPHER_CHACHA20_POLY1305_IV_SIZE];
153 	unsigned char key[TLS_CIPHER_CHACHA20_POLY1305_KEY_SIZE];
154 	unsigned char salt[TLS_CIPHER_CHACHA20_POLY1305_SALT_SIZE];
155 	unsigned char rec_seq[TLS_CIPHER_CHACHA20_POLY1305_REC_SEQ_SIZE];
156 };
157 
158 struct tls12_crypto_info_sm4_gcm {
159 	struct tls_crypto_info info;
160 	unsigned char iv[TLS_CIPHER_SM4_GCM_IV_SIZE];
161 	unsigned char key[TLS_CIPHER_SM4_GCM_KEY_SIZE];
162 	unsigned char salt[TLS_CIPHER_SM4_GCM_SALT_SIZE];
163 	unsigned char rec_seq[TLS_CIPHER_SM4_GCM_REC_SEQ_SIZE];
164 };
165 
166 struct tls12_crypto_info_sm4_ccm {
167 	struct tls_crypto_info info;
168 	unsigned char iv[TLS_CIPHER_SM4_CCM_IV_SIZE];
169 	unsigned char key[TLS_CIPHER_SM4_CCM_KEY_SIZE];
170 	unsigned char salt[TLS_CIPHER_SM4_CCM_SALT_SIZE];
171 	unsigned char rec_seq[TLS_CIPHER_SM4_CCM_REC_SEQ_SIZE];
172 };
173 
174 struct tls12_crypto_info_aria_gcm_128 {
175 	struct tls_crypto_info info;
176 	unsigned char iv[TLS_CIPHER_ARIA_GCM_128_IV_SIZE];
177 	unsigned char key[TLS_CIPHER_ARIA_GCM_128_KEY_SIZE];
178 	unsigned char salt[TLS_CIPHER_ARIA_GCM_128_SALT_SIZE];
179 	unsigned char rec_seq[TLS_CIPHER_ARIA_GCM_128_REC_SEQ_SIZE];
180 };
181 
182 struct tls12_crypto_info_aria_gcm_256 {
183 	struct tls_crypto_info info;
184 	unsigned char iv[TLS_CIPHER_ARIA_GCM_256_IV_SIZE];
185 	unsigned char key[TLS_CIPHER_ARIA_GCM_256_KEY_SIZE];
186 	unsigned char salt[TLS_CIPHER_ARIA_GCM_256_SALT_SIZE];
187 	unsigned char rec_seq[TLS_CIPHER_ARIA_GCM_256_REC_SEQ_SIZE];
188 };
189 
190 enum {
191 	TLS_INFO_UNSPEC,
192 	TLS_INFO_VERSION,
193 	TLS_INFO_CIPHER,
194 	TLS_INFO_TXCONF,
195 	TLS_INFO_RXCONF,
196 	TLS_INFO_ZC_RO_TX,
197 	TLS_INFO_RX_NO_PAD,
198 	TLS_INFO_TX_MAX_PAYLOAD_LEN,
199 	__TLS_INFO_MAX,
200 };
201 #define TLS_INFO_MAX (__TLS_INFO_MAX - 1)
202 
203 #define TLS_CONF_BASE 1
204 #define TLS_CONF_SW 2
205 #define TLS_CONF_HW 3
206 #define TLS_CONF_HW_RECORD 4
207 
208 #endif /* _UAPI_LINUX_TLS_H */
209