Commit | Line | Data |
---|---|---|
3c4d7559 DW |
1 | /* |
2 | * Copyright (c) 2016-2017, Mellanox Technologies. All rights reserved. | |
3 | * Copyright (c) 2016-2017, Dave Watson <davejwatson@fb.com>. 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 _TLS_OFFLOAD_H | |
35 | #define _TLS_OFFLOAD_H | |
36 | ||
37 | #include <linux/types.h> | |
b9f3eb49 | 38 | #include <asm/byteorder.h> |
a54667f6 | 39 | #include <linux/crypto.h> |
b9f3eb49 DL |
40 | #include <linux/socket.h> |
41 | #include <linux/tcp.h> | |
42 | #include <net/tcp.h> | |
c46234eb | 43 | #include <net/strparser.h> |
3c4d7559 DW |
44 | |
45 | #include <uapi/linux/tls.h> | |
46 | ||
47 | ||
48 | /* Maximum data size carried in a TLS record */ | |
49 | #define TLS_MAX_PAYLOAD_SIZE ((size_t)1 << 14) | |
50 | ||
51 | #define TLS_HEADER_SIZE 5 | |
52 | #define TLS_NONCE_OFFSET TLS_HEADER_SIZE | |
53 | ||
54 | #define TLS_CRYPTO_INFO_READY(info) ((info)->cipher_type) | |
55 | ||
56 | #define TLS_RECORD_TYPE_DATA 0x17 | |
57 | ||
58 | #define TLS_AAD_SPACE_SIZE 13 | |
dd0bed16 AG |
59 | #define TLS_DEVICE_NAME_MAX 32 |
60 | ||
61 | /* | |
62 | * This structure defines the routines for Inline TLS driver. | |
63 | * The following routines are optional and filled with a | |
64 | * null pointer if not defined. | |
65 | * | |
66 | * @name: Its the name of registered Inline tls device | |
67 | * @dev_list: Inline tls device list | |
68 | * int (*feature)(struct tls_device *device); | |
69 | * Called to return Inline TLS driver capability | |
70 | * | |
71 | * int (*hash)(struct tls_device *device, struct sock *sk); | |
72 | * This function sets Inline driver for listen and program | |
73 | * device specific functioanlity as required | |
74 | * | |
75 | * void (*unhash)(struct tls_device *device, struct sock *sk); | |
76 | * This function cleans listen state set by Inline TLS driver | |
77 | */ | |
78 | struct tls_device { | |
79 | char name[TLS_DEVICE_NAME_MAX]; | |
80 | struct list_head dev_list; | |
81 | int (*feature)(struct tls_device *device); | |
82 | int (*hash)(struct tls_device *device, struct sock *sk); | |
83 | void (*unhash)(struct tls_device *device, struct sock *sk); | |
84 | }; | |
3c4d7559 | 85 | |
4799ac81 BP |
86 | enum { |
87 | TLS_BASE, | |
88 | TLS_SW, | |
89 | #ifdef CONFIG_TLS_DEVICE | |
90 | TLS_HW, | |
91 | #endif | |
92 | TLS_HW_RECORD, | |
93 | TLS_NUM_CONFIG, | |
94 | }; | |
95 | ||
f66de3ee | 96 | struct tls_sw_context_tx { |
3c4d7559 | 97 | struct crypto_aead *aead_send; |
a54667f6 | 98 | struct crypto_wait async_wait; |
3c4d7559 | 99 | |
3c4d7559 DW |
100 | char aad_space[TLS_AAD_SPACE_SIZE]; |
101 | ||
102 | unsigned int sg_plaintext_size; | |
103 | int sg_plaintext_num_elem; | |
104 | struct scatterlist sg_plaintext_data[MAX_SKB_FRAGS]; | |
105 | ||
106 | unsigned int sg_encrypted_size; | |
107 | int sg_encrypted_num_elem; | |
108 | struct scatterlist sg_encrypted_data[MAX_SKB_FRAGS]; | |
109 | ||
110 | /* AAD | sg_plaintext_data | sg_tag */ | |
111 | struct scatterlist sg_aead_in[2]; | |
112 | /* AAD | sg_encrypted_data (data contain overhead for hdr&iv&tag) */ | |
113 | struct scatterlist sg_aead_out[2]; | |
114 | }; | |
115 | ||
f66de3ee BP |
116 | struct tls_sw_context_rx { |
117 | struct crypto_aead *aead_recv; | |
118 | struct crypto_wait async_wait; | |
119 | ||
120 | struct strparser strp; | |
121 | void (*saved_data_ready)(struct sock *sk); | |
a11e1d43 LT |
122 | unsigned int (*sk_poll)(struct file *file, struct socket *sock, |
123 | struct poll_table_struct *wait); | |
f66de3ee BP |
124 | struct sk_buff *recv_pkt; |
125 | u8 control; | |
126 | bool decrypted; | |
127 | }; | |
128 | ||
e8f69799 IL |
129 | struct tls_record_info { |
130 | struct list_head list; | |
131 | u32 end_seq; | |
132 | int len; | |
133 | int num_frags; | |
134 | skb_frag_t frags[MAX_SKB_FRAGS]; | |
135 | }; | |
136 | ||
d80a1b9d | 137 | struct tls_offload_context_tx { |
e8f69799 IL |
138 | struct crypto_aead *aead_send; |
139 | spinlock_t lock; /* protects records list */ | |
140 | struct list_head records_list; | |
141 | struct tls_record_info *open_record; | |
142 | struct tls_record_info *retransmit_hint; | |
143 | u64 hint_record_sn; | |
144 | u64 unacked_record_sn; | |
145 | ||
146 | struct scatterlist sg_tx_data[MAX_SKB_FRAGS]; | |
147 | void (*sk_destruct)(struct sock *sk); | |
148 | u8 driver_state[]; | |
149 | /* The TLS layer reserves room for driver specific state | |
150 | * Currently the belief is that there is not enough | |
151 | * driver specific state to justify another layer of indirection | |
152 | */ | |
153 | #define TLS_DRIVER_STATE_SIZE (max_t(size_t, 8, sizeof(void *))) | |
154 | }; | |
155 | ||
d80a1b9d BP |
156 | #define TLS_OFFLOAD_CONTEXT_SIZE_TX \ |
157 | (ALIGN(sizeof(struct tls_offload_context_tx), sizeof(void *)) + \ | |
e8f69799 IL |
158 | TLS_DRIVER_STATE_SIZE) |
159 | ||
3c4d7559 DW |
160 | enum { |
161 | TLS_PENDING_CLOSED_RECORD | |
162 | }; | |
163 | ||
dbe42559 DW |
164 | struct cipher_context { |
165 | u16 prepend_size; | |
166 | u16 tag_size; | |
167 | u16 overhead_size; | |
168 | u16 iv_size; | |
169 | char *iv; | |
170 | u16 rec_seq_size; | |
171 | char *rec_seq; | |
172 | }; | |
173 | ||
86029d10 SD |
174 | union tls_crypto_context { |
175 | struct tls_crypto_info info; | |
176 | struct tls12_crypto_info_aes_gcm_128 aes_gcm_128; | |
177 | }; | |
178 | ||
3c4d7559 | 179 | struct tls_context { |
86029d10 SD |
180 | union tls_crypto_context crypto_send; |
181 | union tls_crypto_context crypto_recv; | |
3c4d7559 | 182 | |
f66de3ee BP |
183 | struct list_head list; |
184 | struct net_device *netdev; | |
185 | refcount_t refcount; | |
186 | ||
187 | void *priv_ctx_tx; | |
188 | void *priv_ctx_rx; | |
3c4d7559 | 189 | |
f66de3ee BP |
190 | u8 tx_conf:3; |
191 | u8 rx_conf:3; | |
6d88207f | 192 | |
dbe42559 | 193 | struct cipher_context tx; |
c46234eb | 194 | struct cipher_context rx; |
3c4d7559 DW |
195 | |
196 | struct scatterlist *partially_sent_record; | |
197 | u16 partially_sent_offset; | |
198 | unsigned long flags; | |
c212d2c7 | 199 | bool in_tcp_sendpages; |
3c4d7559 DW |
200 | |
201 | u16 pending_open_record_frags; | |
202 | int (*push_pending_record)(struct sock *sk, int flags); | |
3c4d7559 DW |
203 | |
204 | void (*sk_write_space)(struct sock *sk); | |
4799ac81 | 205 | void (*sk_destruct)(struct sock *sk); |
3c4d7559 DW |
206 | void (*sk_proto_close)(struct sock *sk, long timeout); |
207 | ||
208 | int (*setsockopt)(struct sock *sk, int level, | |
209 | int optname, char __user *optval, | |
210 | unsigned int optlen); | |
211 | int (*getsockopt)(struct sock *sk, int level, | |
212 | int optname, char __user *optval, | |
213 | int __user *optlen); | |
dd0bed16 AG |
214 | int (*hash)(struct sock *sk); |
215 | void (*unhash)(struct sock *sk); | |
3c4d7559 DW |
216 | }; |
217 | ||
4799ac81 BP |
218 | struct tls_offload_context_rx { |
219 | /* sw must be the first member of tls_offload_context_rx */ | |
220 | struct tls_sw_context_rx sw; | |
221 | atomic64_t resync_req; | |
222 | u8 driver_state[]; | |
223 | /* The TLS layer reserves room for driver specific state | |
224 | * Currently the belief is that there is not enough | |
225 | * driver specific state to justify another layer of indirection | |
226 | */ | |
227 | }; | |
228 | ||
229 | #define TLS_OFFLOAD_CONTEXT_SIZE_RX \ | |
230 | (ALIGN(sizeof(struct tls_offload_context_rx), sizeof(void *)) + \ | |
231 | TLS_DRIVER_STATE_SIZE) | |
232 | ||
3c4d7559 DW |
233 | int wait_on_pending_writer(struct sock *sk, long *timeo); |
234 | int tls_sk_query(struct sock *sk, int optname, char __user *optval, | |
235 | int __user *optlen); | |
236 | int tls_sk_attach(struct sock *sk, int optname, char __user *optval, | |
237 | unsigned int optlen); | |
238 | ||
c46234eb | 239 | int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx); |
3c4d7559 DW |
240 | int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size); |
241 | int tls_sw_sendpage(struct sock *sk, struct page *page, | |
242 | int offset, size_t size, int flags); | |
243 | void tls_sw_close(struct sock *sk, long timeout); | |
f66de3ee BP |
244 | void tls_sw_free_resources_tx(struct sock *sk); |
245 | void tls_sw_free_resources_rx(struct sock *sk); | |
39f56e1a | 246 | void tls_sw_release_resources_rx(struct sock *sk); |
c46234eb DW |
247 | int tls_sw_recvmsg(struct sock *sk, struct msghdr *msg, size_t len, |
248 | int nonblock, int flags, int *addr_len); | |
a11e1d43 LT |
249 | unsigned int tls_sw_poll(struct file *file, struct socket *sock, |
250 | struct poll_table_struct *wait); | |
c46234eb DW |
251 | ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos, |
252 | struct pipe_inode_info *pipe, | |
253 | size_t len, unsigned int flags); | |
3c4d7559 | 254 | |
e8f69799 IL |
255 | int tls_set_device_offload(struct sock *sk, struct tls_context *ctx); |
256 | int tls_device_sendmsg(struct sock *sk, struct msghdr *msg, size_t size); | |
257 | int tls_device_sendpage(struct sock *sk, struct page *page, | |
258 | int offset, size_t size, int flags); | |
259 | void tls_device_sk_destruct(struct sock *sk); | |
260 | void tls_device_init(void); | |
261 | void tls_device_cleanup(void); | |
262 | ||
d80a1b9d | 263 | struct tls_record_info *tls_get_record(struct tls_offload_context_tx *context, |
e8f69799 IL |
264 | u32 seq, u64 *p_record_sn); |
265 | ||
266 | static inline bool tls_record_is_start_marker(struct tls_record_info *rec) | |
267 | { | |
268 | return rec->len == 0; | |
269 | } | |
270 | ||
271 | static inline u32 tls_record_start_seq(struct tls_record_info *rec) | |
272 | { | |
273 | return rec->end_seq - rec->len; | |
274 | } | |
3c4d7559 | 275 | |
e8f69799 | 276 | void tls_sk_destruct(struct sock *sk, struct tls_context *ctx); |
3c4d7559 DW |
277 | int tls_push_sg(struct sock *sk, struct tls_context *ctx, |
278 | struct scatterlist *sg, u16 first_offset, | |
279 | int flags); | |
280 | int tls_push_pending_closed_record(struct sock *sk, struct tls_context *ctx, | |
281 | int flags, long *timeo); | |
282 | ||
283 | static inline bool tls_is_pending_closed_record(struct tls_context *ctx) | |
284 | { | |
285 | return test_bit(TLS_PENDING_CLOSED_RECORD, &ctx->flags); | |
286 | } | |
287 | ||
288 | static inline int tls_complete_pending_work(struct sock *sk, | |
289 | struct tls_context *ctx, | |
290 | int flags, long *timeo) | |
291 | { | |
292 | int rc = 0; | |
293 | ||
294 | if (unlikely(sk->sk_write_pending)) | |
295 | rc = wait_on_pending_writer(sk, timeo); | |
296 | ||
297 | if (!rc && tls_is_pending_closed_record(ctx)) | |
298 | rc = tls_push_pending_closed_record(sk, ctx, flags, timeo); | |
299 | ||
300 | return rc; | |
301 | } | |
302 | ||
303 | static inline bool tls_is_partially_sent_record(struct tls_context *ctx) | |
304 | { | |
305 | return !!ctx->partially_sent_record; | |
306 | } | |
307 | ||
308 | static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx) | |
309 | { | |
310 | return tls_ctx->pending_open_record_frags; | |
311 | } | |
312 | ||
4799ac81 BP |
313 | struct sk_buff * |
314 | tls_validate_xmit_skb(struct sock *sk, struct net_device *dev, | |
315 | struct sk_buff *skb); | |
316 | ||
e8f69799 IL |
317 | static inline bool tls_is_sk_tx_device_offloaded(struct sock *sk) |
318 | { | |
4799ac81 BP |
319 | #ifdef CONFIG_SOCK_VALIDATE_XMIT |
320 | return sk_fullsock(sk) & | |
321 | (smp_load_acquire(&sk->sk_validate_xmit_skb) == | |
322 | &tls_validate_xmit_skb); | |
323 | #else | |
324 | return false; | |
325 | #endif | |
e8f69799 IL |
326 | } |
327 | ||
f4a8e43f | 328 | static inline void tls_err_abort(struct sock *sk, int err) |
3c4d7559 | 329 | { |
f4a8e43f | 330 | sk->sk_err = err; |
3c4d7559 DW |
331 | sk->sk_error_report(sk); |
332 | } | |
333 | ||
334 | static inline bool tls_bigint_increment(unsigned char *seq, int len) | |
335 | { | |
336 | int i; | |
337 | ||
338 | for (i = len - 1; i >= 0; i--) { | |
339 | ++seq[i]; | |
340 | if (seq[i] != 0) | |
341 | break; | |
342 | } | |
343 | ||
344 | return (i == -1); | |
345 | } | |
346 | ||
347 | static inline void tls_advance_record_sn(struct sock *sk, | |
dbe42559 | 348 | struct cipher_context *ctx) |
3c4d7559 DW |
349 | { |
350 | if (tls_bigint_increment(ctx->rec_seq, ctx->rec_seq_size)) | |
f4a8e43f | 351 | tls_err_abort(sk, EBADMSG); |
3c4d7559 DW |
352 | tls_bigint_increment(ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, |
353 | ctx->iv_size); | |
354 | } | |
355 | ||
356 | static inline void tls_fill_prepend(struct tls_context *ctx, | |
357 | char *buf, | |
358 | size_t plaintext_len, | |
359 | unsigned char record_type) | |
360 | { | |
dbe42559 | 361 | size_t pkt_len, iv_size = ctx->tx.iv_size; |
3c4d7559 | 362 | |
dbe42559 | 363 | pkt_len = plaintext_len + iv_size + ctx->tx.tag_size; |
3c4d7559 DW |
364 | |
365 | /* we cover nonce explicit here as well, so buf should be of | |
366 | * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE | |
367 | */ | |
368 | buf[0] = record_type; | |
86029d10 SD |
369 | buf[1] = TLS_VERSION_MINOR(ctx->crypto_send.info.version); |
370 | buf[2] = TLS_VERSION_MAJOR(ctx->crypto_send.info.version); | |
3c4d7559 DW |
371 | /* we can use IV for nonce explicit according to spec */ |
372 | buf[3] = pkt_len >> 8; | |
373 | buf[4] = pkt_len & 0xFF; | |
374 | memcpy(buf + TLS_NONCE_OFFSET, | |
dbe42559 | 375 | ctx->tx.iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, iv_size); |
3c4d7559 DW |
376 | } |
377 | ||
213ef6e7 IL |
378 | static inline void tls_make_aad(char *buf, |
379 | size_t size, | |
380 | char *record_sequence, | |
381 | int record_sequence_size, | |
382 | unsigned char record_type) | |
383 | { | |
384 | memcpy(buf, record_sequence, record_sequence_size); | |
385 | ||
386 | buf[8] = record_type; | |
387 | buf[9] = TLS_1_2_VERSION_MAJOR; | |
388 | buf[10] = TLS_1_2_VERSION_MINOR; | |
389 | buf[11] = size >> 8; | |
390 | buf[12] = size & 0xFF; | |
391 | } | |
392 | ||
3c4d7559 DW |
393 | static inline struct tls_context *tls_get_ctx(const struct sock *sk) |
394 | { | |
395 | struct inet_connection_sock *icsk = inet_csk(sk); | |
396 | ||
397 | return icsk->icsk_ulp_data; | |
398 | } | |
399 | ||
f66de3ee BP |
400 | static inline struct tls_sw_context_rx *tls_sw_ctx_rx( |
401 | const struct tls_context *tls_ctx) | |
402 | { | |
403 | return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx; | |
404 | } | |
405 | ||
406 | static inline struct tls_sw_context_tx *tls_sw_ctx_tx( | |
3c4d7559 DW |
407 | const struct tls_context *tls_ctx) |
408 | { | |
f66de3ee | 409 | return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx; |
3c4d7559 DW |
410 | } |
411 | ||
d80a1b9d BP |
412 | static inline struct tls_offload_context_tx * |
413 | tls_offload_ctx_tx(const struct tls_context *tls_ctx) | |
3c4d7559 | 414 | { |
d80a1b9d | 415 | return (struct tls_offload_context_tx *)tls_ctx->priv_ctx_tx; |
3c4d7559 DW |
416 | } |
417 | ||
4799ac81 BP |
418 | static inline struct tls_offload_context_rx * |
419 | tls_offload_ctx_rx(const struct tls_context *tls_ctx) | |
420 | { | |
421 | return (struct tls_offload_context_rx *)tls_ctx->priv_ctx_rx; | |
422 | } | |
423 | ||
424 | /* The TLS context is valid until sk_destruct is called */ | |
425 | static inline void tls_offload_rx_resync_request(struct sock *sk, __be32 seq) | |
426 | { | |
427 | struct tls_context *tls_ctx = tls_get_ctx(sk); | |
428 | struct tls_offload_context_rx *rx_ctx = tls_offload_ctx_rx(tls_ctx); | |
429 | ||
430 | atomic64_set(&rx_ctx->resync_req, ((((uint64_t)seq) << 32) | 1)); | |
431 | } | |
432 | ||
433 | ||
3c4d7559 DW |
434 | int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg, |
435 | unsigned char *record_type); | |
dd0bed16 AG |
436 | void tls_register_device(struct tls_device *device); |
437 | void tls_unregister_device(struct tls_device *device); | |
4799ac81 | 438 | int tls_device_decrypted(struct sock *sk, struct sk_buff *skb); |
dafb67f3 BP |
439 | int decrypt_skb(struct sock *sk, struct sk_buff *skb, |
440 | struct scatterlist *sgout); | |
3c4d7559 | 441 | |
e8f69799 IL |
442 | struct sk_buff *tls_validate_xmit_skb(struct sock *sk, |
443 | struct net_device *dev, | |
444 | struct sk_buff *skb); | |
445 | ||
446 | int tls_sw_fallback_init(struct sock *sk, | |
d80a1b9d | 447 | struct tls_offload_context_tx *offload_ctx, |
e8f69799 IL |
448 | struct tls_crypto_info *crypto_info); |
449 | ||
4799ac81 BP |
450 | int tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx); |
451 | ||
452 | void tls_device_offload_cleanup_rx(struct sock *sk); | |
453 | void handle_device_resync(struct sock *sk, u32 seq, u64 rcd_sn); | |
454 | ||
3c4d7559 | 455 | #endif /* _TLS_OFFLOAD_H */ |