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>
44 #include <uapi/linux/tls.h>
47 /* Maximum data size carried in a TLS record */
48 #define TLS_MAX_PAYLOAD_SIZE ((size_t)1 << 14)
50 #define TLS_HEADER_SIZE 5
51 #define TLS_NONCE_OFFSET TLS_HEADER_SIZE
53 #define TLS_CRYPTO_INFO_READY(info) ((info)->cipher_type)
55 #define TLS_RECORD_TYPE_DATA 0x17
57 #define TLS_AAD_SPACE_SIZE 13
59 struct tls_sw_context
{
60 struct crypto_aead
*aead_send
;
61 struct crypto_wait async_wait
;
64 char aad_space
[TLS_AAD_SPACE_SIZE
];
66 unsigned int sg_plaintext_size
;
67 int sg_plaintext_num_elem
;
68 struct scatterlist sg_plaintext_data
[MAX_SKB_FRAGS
];
70 unsigned int sg_encrypted_size
;
71 int sg_encrypted_num_elem
;
72 struct scatterlist sg_encrypted_data
[MAX_SKB_FRAGS
];
74 /* AAD | sg_plaintext_data | sg_tag */
75 struct scatterlist sg_aead_in
[2];
76 /* AAD | sg_encrypted_data (data contain overhead for hdr&iv&tag) */
77 struct scatterlist sg_aead_out
[2];
81 TLS_PENDING_CLOSED_RECORD
86 struct tls_crypto_info crypto_send
;
87 struct tls12_crypto_info_aes_gcm_128 crypto_send_aes_gcm_128
;
102 struct scatterlist
*partially_sent_record
;
103 u16 partially_sent_offset
;
105 bool in_tcp_sendpages
;
107 u16 pending_open_record_frags
;
108 int (*push_pending_record
)(struct sock
*sk
, int flags
);
110 void (*sk_write_space
)(struct sock
*sk
);
111 void (*sk_proto_close
)(struct sock
*sk
, long timeout
);
113 int (*setsockopt
)(struct sock
*sk
, int level
,
114 int optname
, char __user
*optval
,
115 unsigned int optlen
);
116 int (*getsockopt
)(struct sock
*sk
, int level
,
117 int optname
, char __user
*optval
,
121 int wait_on_pending_writer(struct sock
*sk
, long *timeo
);
122 int tls_sk_query(struct sock
*sk
, int optname
, char __user
*optval
,
124 int tls_sk_attach(struct sock
*sk
, int optname
, char __user
*optval
,
125 unsigned int optlen
);
128 int tls_set_sw_offload(struct sock
*sk
, struct tls_context
*ctx
);
129 int tls_sw_sendmsg(struct sock
*sk
, struct msghdr
*msg
, size_t size
);
130 int tls_sw_sendpage(struct sock
*sk
, struct page
*page
,
131 int offset
, size_t size
, int flags
);
132 void tls_sw_close(struct sock
*sk
, long timeout
);
133 void tls_sw_free_tx_resources(struct sock
*sk
);
135 void tls_sk_destruct(struct sock
*sk
, struct tls_context
*ctx
);
136 void tls_icsk_clean_acked(struct sock
*sk
);
138 int tls_push_sg(struct sock
*sk
, struct tls_context
*ctx
,
139 struct scatterlist
*sg
, u16 first_offset
,
141 int tls_push_pending_closed_record(struct sock
*sk
, struct tls_context
*ctx
,
142 int flags
, long *timeo
);
144 static inline bool tls_is_pending_closed_record(struct tls_context
*ctx
)
146 return test_bit(TLS_PENDING_CLOSED_RECORD
, &ctx
->flags
);
149 static inline int tls_complete_pending_work(struct sock
*sk
,
150 struct tls_context
*ctx
,
151 int flags
, long *timeo
)
155 if (unlikely(sk
->sk_write_pending
))
156 rc
= wait_on_pending_writer(sk
, timeo
);
158 if (!rc
&& tls_is_pending_closed_record(ctx
))
159 rc
= tls_push_pending_closed_record(sk
, ctx
, flags
, timeo
);
164 static inline bool tls_is_partially_sent_record(struct tls_context
*ctx
)
166 return !!ctx
->partially_sent_record
;
169 static inline bool tls_is_pending_open_record(struct tls_context
*tls_ctx
)
171 return tls_ctx
->pending_open_record_frags
;
174 static inline void tls_err_abort(struct sock
*sk
)
176 sk
->sk_err
= EBADMSG
;
177 sk
->sk_error_report(sk
);
180 static inline bool tls_bigint_increment(unsigned char *seq
, int len
)
184 for (i
= len
- 1; i
>= 0; i
--) {
193 static inline void tls_advance_record_sn(struct sock
*sk
,
194 struct tls_context
*ctx
)
196 if (tls_bigint_increment(ctx
->rec_seq
, ctx
->rec_seq_size
))
198 tls_bigint_increment(ctx
->iv
+ TLS_CIPHER_AES_GCM_128_SALT_SIZE
,
202 static inline void tls_fill_prepend(struct tls_context
*ctx
,
204 size_t plaintext_len
,
205 unsigned char record_type
)
207 size_t pkt_len
, iv_size
= ctx
->iv_size
;
209 pkt_len
= plaintext_len
+ iv_size
+ ctx
->tag_size
;
211 /* we cover nonce explicit here as well, so buf should be of
212 * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
214 buf
[0] = record_type
;
215 buf
[1] = TLS_VERSION_MINOR(ctx
->crypto_send
.version
);
216 buf
[2] = TLS_VERSION_MAJOR(ctx
->crypto_send
.version
);
217 /* we can use IV for nonce explicit according to spec */
218 buf
[3] = pkt_len
>> 8;
219 buf
[4] = pkt_len
& 0xFF;
220 memcpy(buf
+ TLS_NONCE_OFFSET
,
221 ctx
->iv
+ TLS_CIPHER_AES_GCM_128_SALT_SIZE
, iv_size
);
224 static inline void tls_make_aad(char *buf
,
226 char *record_sequence
,
227 int record_sequence_size
,
228 unsigned char record_type
)
230 memcpy(buf
, record_sequence
, record_sequence_size
);
232 buf
[8] = record_type
;
233 buf
[9] = TLS_1_2_VERSION_MAJOR
;
234 buf
[10] = TLS_1_2_VERSION_MINOR
;
236 buf
[12] = size
& 0xFF;
239 static inline struct tls_context
*tls_get_ctx(const struct sock
*sk
)
241 struct inet_connection_sock
*icsk
= inet_csk(sk
);
243 return icsk
->icsk_ulp_data
;
246 static inline struct tls_sw_context
*tls_sw_ctx(
247 const struct tls_context
*tls_ctx
)
249 return (struct tls_sw_context
*)tls_ctx
->priv_ctx
;
252 static inline struct tls_offload_context
*tls_offload_ctx(
253 const struct tls_context
*tls_ctx
)
255 return (struct tls_offload_context
*)tls_ctx
->priv_ctx
;
258 int tls_proccess_cmsg(struct sock
*sk
, struct msghdr
*msg
,
259 unsigned char *record_type
);
261 #endif /* _TLS_OFFLOAD_H */