2 * Copyright (c) 2016-2017, Mellanox Technologies. All rights reserved.
3 * Copyright (c) 2016-2017, Dave Watson <davejwatson@fb.com>. All rights reserved.
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:
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
15 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
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.
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
34 #ifndef _TLS_OFFLOAD_H
35 #define _TLS_OFFLOAD_H
37 #include <linux/types.h>
38 #include <asm/byteorder.h>
39 #include <linux/crypto.h>
40 #include <linux/socket.h>
41 #include <linux/tcp.h>
43 #include <net/strparser.h>
45 #include <uapi/linux/tls.h>
48 /* Maximum data size carried in a TLS record */
49 #define TLS_MAX_PAYLOAD_SIZE ((size_t)1 << 14)
51 #define TLS_HEADER_SIZE 5
52 #define TLS_NONCE_OFFSET TLS_HEADER_SIZE
54 #define TLS_CRYPTO_INFO_READY(info) ((info)->cipher_type)
56 #define TLS_RECORD_TYPE_DATA 0x17
58 #define TLS_AAD_SPACE_SIZE 13
59 #define TLS_DEVICE_NAME_MAX 32
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.
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
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
75 * void (*unhash)(struct tls_device *device, struct sock *sk);
76 * This function cleans listen state set by Inline TLS driver
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
);
86 struct tls_sw_context
{
87 struct crypto_aead
*aead_send
;
88 struct crypto_aead
*aead_recv
;
89 struct crypto_wait async_wait
;
92 struct strparser strp
;
93 void (*saved_data_ready
)(struct sock
*sk
);
94 unsigned int (*sk_poll
)(struct file
*file
, struct socket
*sock
,
95 struct poll_table_struct
*wait
);
96 struct sk_buff
*recv_pkt
;
100 /* Sending context */
101 char aad_space
[TLS_AAD_SPACE_SIZE
];
103 unsigned int sg_plaintext_size
;
104 int sg_plaintext_num_elem
;
105 struct scatterlist sg_plaintext_data
[MAX_SKB_FRAGS
];
107 unsigned int sg_encrypted_size
;
108 int sg_encrypted_num_elem
;
109 struct scatterlist sg_encrypted_data
[MAX_SKB_FRAGS
];
111 /* AAD | sg_plaintext_data | sg_tag */
112 struct scatterlist sg_aead_in
[2];
113 /* AAD | sg_encrypted_data (data contain overhead for hdr&iv&tag) */
114 struct scatterlist sg_aead_out
[2];
118 TLS_PENDING_CLOSED_RECORD
121 struct cipher_context
{
133 struct tls_crypto_info crypto_send
;
134 struct tls12_crypto_info_aes_gcm_128 crypto_send_aes_gcm_128
;
137 struct tls_crypto_info crypto_recv
;
138 struct tls12_crypto_info_aes_gcm_128 crypto_recv_aes_gcm_128
;
145 struct cipher_context tx
;
146 struct cipher_context rx
;
148 struct scatterlist
*partially_sent_record
;
149 u16 partially_sent_offset
;
151 bool in_tcp_sendpages
;
153 u16 pending_open_record_frags
;
154 int (*push_pending_record
)(struct sock
*sk
, int flags
);
156 void (*sk_write_space
)(struct sock
*sk
);
157 void (*sk_proto_close
)(struct sock
*sk
, long timeout
);
159 int (*setsockopt
)(struct sock
*sk
, int level
,
160 int optname
, char __user
*optval
,
161 unsigned int optlen
);
162 int (*getsockopt
)(struct sock
*sk
, int level
,
163 int optname
, char __user
*optval
,
165 int (*hash
)(struct sock
*sk
);
166 void (*unhash
)(struct sock
*sk
);
169 int wait_on_pending_writer(struct sock
*sk
, long *timeo
);
170 int tls_sk_query(struct sock
*sk
, int optname
, char __user
*optval
,
172 int tls_sk_attach(struct sock
*sk
, int optname
, char __user
*optval
,
173 unsigned int optlen
);
176 int tls_set_sw_offload(struct sock
*sk
, struct tls_context
*ctx
, int tx
);
177 int tls_sw_sendmsg(struct sock
*sk
, struct msghdr
*msg
, size_t size
);
178 int tls_sw_sendpage(struct sock
*sk
, struct page
*page
,
179 int offset
, size_t size
, int flags
);
180 void tls_sw_close(struct sock
*sk
, long timeout
);
181 void tls_sw_free_resources(struct sock
*sk
);
182 int tls_sw_recvmsg(struct sock
*sk
, struct msghdr
*msg
, size_t len
,
183 int nonblock
, int flags
, int *addr_len
);
184 unsigned int tls_sw_poll(struct file
*file
, struct socket
*sock
,
185 struct poll_table_struct
*wait
);
186 ssize_t
tls_sw_splice_read(struct socket
*sock
, loff_t
*ppos
,
187 struct pipe_inode_info
*pipe
,
188 size_t len
, unsigned int flags
);
190 void tls_sk_destruct(struct sock
*sk
, struct tls_context
*ctx
);
191 void tls_icsk_clean_acked(struct sock
*sk
);
193 int tls_push_sg(struct sock
*sk
, struct tls_context
*ctx
,
194 struct scatterlist
*sg
, u16 first_offset
,
196 int tls_push_pending_closed_record(struct sock
*sk
, struct tls_context
*ctx
,
197 int flags
, long *timeo
);
199 static inline bool tls_is_pending_closed_record(struct tls_context
*ctx
)
201 return test_bit(TLS_PENDING_CLOSED_RECORD
, &ctx
->flags
);
204 static inline int tls_complete_pending_work(struct sock
*sk
,
205 struct tls_context
*ctx
,
206 int flags
, long *timeo
)
210 if (unlikely(sk
->sk_write_pending
))
211 rc
= wait_on_pending_writer(sk
, timeo
);
213 if (!rc
&& tls_is_pending_closed_record(ctx
))
214 rc
= tls_push_pending_closed_record(sk
, ctx
, flags
, timeo
);
219 static inline bool tls_is_partially_sent_record(struct tls_context
*ctx
)
221 return !!ctx
->partially_sent_record
;
224 static inline bool tls_is_pending_open_record(struct tls_context
*tls_ctx
)
226 return tls_ctx
->pending_open_record_frags
;
229 static inline void tls_err_abort(struct sock
*sk
, int err
)
232 sk
->sk_error_report(sk
);
235 static inline bool tls_bigint_increment(unsigned char *seq
, int len
)
239 for (i
= len
- 1; i
>= 0; i
--) {
248 static inline void tls_advance_record_sn(struct sock
*sk
,
249 struct cipher_context
*ctx
)
251 if (tls_bigint_increment(ctx
->rec_seq
, ctx
->rec_seq_size
))
252 tls_err_abort(sk
, EBADMSG
);
253 tls_bigint_increment(ctx
->iv
+ TLS_CIPHER_AES_GCM_128_SALT_SIZE
,
257 static inline void tls_fill_prepend(struct tls_context
*ctx
,
259 size_t plaintext_len
,
260 unsigned char record_type
)
262 size_t pkt_len
, iv_size
= ctx
->tx
.iv_size
;
264 pkt_len
= plaintext_len
+ iv_size
+ ctx
->tx
.tag_size
;
266 /* we cover nonce explicit here as well, so buf should be of
267 * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
269 buf
[0] = record_type
;
270 buf
[1] = TLS_VERSION_MINOR(ctx
->crypto_send
.version
);
271 buf
[2] = TLS_VERSION_MAJOR(ctx
->crypto_send
.version
);
272 /* we can use IV for nonce explicit according to spec */
273 buf
[3] = pkt_len
>> 8;
274 buf
[4] = pkt_len
& 0xFF;
275 memcpy(buf
+ TLS_NONCE_OFFSET
,
276 ctx
->tx
.iv
+ TLS_CIPHER_AES_GCM_128_SALT_SIZE
, iv_size
);
279 static inline void tls_make_aad(char *buf
,
281 char *record_sequence
,
282 int record_sequence_size
,
283 unsigned char record_type
)
285 memcpy(buf
, record_sequence
, record_sequence_size
);
287 buf
[8] = record_type
;
288 buf
[9] = TLS_1_2_VERSION_MAJOR
;
289 buf
[10] = TLS_1_2_VERSION_MINOR
;
291 buf
[12] = size
& 0xFF;
294 static inline struct tls_context
*tls_get_ctx(const struct sock
*sk
)
296 struct inet_connection_sock
*icsk
= inet_csk(sk
);
298 return icsk
->icsk_ulp_data
;
301 static inline struct tls_sw_context
*tls_sw_ctx(
302 const struct tls_context
*tls_ctx
)
304 return (struct tls_sw_context
*)tls_ctx
->priv_ctx
;
307 static inline struct tls_offload_context
*tls_offload_ctx(
308 const struct tls_context
*tls_ctx
)
310 return (struct tls_offload_context
*)tls_ctx
->priv_ctx
;
313 int tls_proccess_cmsg(struct sock
*sk
, struct msghdr
*msg
,
314 unsigned char *record_type
);
315 void tls_register_device(struct tls_device
*device
);
316 void tls_unregister_device(struct tls_device
*device
);
318 #endif /* _TLS_OFFLOAD_H */