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> 38 #include <asm/byteorder.h> 39 #include <linux/crypto.h> 40 #include <linux/socket.h> 41 #include <linux/tcp.h> 42 #include <net/tcp.h> 43 #include <net/strparser.h> 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 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 }; 85 86 struct tls_sw_context_tx { 87 struct crypto_aead *aead_send; 88 struct crypto_wait async_wait; 89 90 char aad_space[TLS_AAD_SPACE_SIZE]; 91 92 unsigned int sg_plaintext_size; 93 int sg_plaintext_num_elem; 94 struct scatterlist sg_plaintext_data[MAX_SKB_FRAGS]; 95 96 unsigned int sg_encrypted_size; 97 int sg_encrypted_num_elem; 98 struct scatterlist sg_encrypted_data[MAX_SKB_FRAGS]; 99 100 /* AAD | sg_plaintext_data | sg_tag */ 101 struct scatterlist sg_aead_in[2]; 102 /* AAD | sg_encrypted_data (data contain overhead for hdr&iv&tag) */ 103 struct scatterlist sg_aead_out[2]; 104 }; 105 106 struct tls_sw_context_rx { 107 struct crypto_aead *aead_recv; 108 struct crypto_wait async_wait; 109 110 struct strparser strp; 111 void (*saved_data_ready)(struct sock *sk); 112 __poll_t (*sk_poll_mask)(struct socket *sock, __poll_t events); 113 struct sk_buff *recv_pkt; 114 u8 control; 115 bool decrypted; 116 117 char rx_aad_ciphertext[TLS_AAD_SPACE_SIZE]; 118 char rx_aad_plaintext[TLS_AAD_SPACE_SIZE]; 119 120 }; 121 122 struct tls_record_info { 123 struct list_head list; 124 u32 end_seq; 125 int len; 126 int num_frags; 127 skb_frag_t frags[MAX_SKB_FRAGS]; 128 }; 129 130 struct tls_offload_context { 131 struct crypto_aead *aead_send; 132 spinlock_t lock; /* protects records list */ 133 struct list_head records_list; 134 struct tls_record_info *open_record; 135 struct tls_record_info *retransmit_hint; 136 u64 hint_record_sn; 137 u64 unacked_record_sn; 138 139 struct scatterlist sg_tx_data[MAX_SKB_FRAGS]; 140 void (*sk_destruct)(struct sock *sk); 141 u8 driver_state[]; 142 /* The TLS layer reserves room for driver specific state 143 * Currently the belief is that there is not enough 144 * driver specific state to justify another layer of indirection 145 */ 146 #define TLS_DRIVER_STATE_SIZE (max_t(size_t, 8, sizeof(void *))) 147 }; 148 149 #define TLS_OFFLOAD_CONTEXT_SIZE \ 150 (ALIGN(sizeof(struct tls_offload_context), sizeof(void *)) + \ 151 TLS_DRIVER_STATE_SIZE) 152 153 enum { 154 TLS_PENDING_CLOSED_RECORD 155 }; 156 157 struct cipher_context { 158 u16 prepend_size; 159 u16 tag_size; 160 u16 overhead_size; 161 u16 iv_size; 162 char *iv; 163 u16 rec_seq_size; 164 char *rec_seq; 165 }; 166 167 struct tls_context { 168 union { 169 struct tls_crypto_info crypto_send; 170 struct tls12_crypto_info_aes_gcm_128 crypto_send_aes_gcm_128; 171 }; 172 union { 173 struct tls_crypto_info crypto_recv; 174 struct tls12_crypto_info_aes_gcm_128 crypto_recv_aes_gcm_128; 175 }; 176 177 struct list_head list; 178 struct net_device *netdev; 179 refcount_t refcount; 180 181 void *priv_ctx_tx; 182 void *priv_ctx_rx; 183 184 u8 tx_conf:3; 185 u8 rx_conf:3; 186 187 struct cipher_context tx; 188 struct cipher_context rx; 189 190 struct scatterlist *partially_sent_record; 191 u16 partially_sent_offset; 192 unsigned long flags; 193 bool in_tcp_sendpages; 194 195 u16 pending_open_record_frags; 196 int (*push_pending_record)(struct sock *sk, int flags); 197 198 void (*sk_write_space)(struct sock *sk); 199 void (*sk_proto_close)(struct sock *sk, long timeout); 200 201 int (*setsockopt)(struct sock *sk, int level, 202 int optname, char __user *optval, 203 unsigned int optlen); 204 int (*getsockopt)(struct sock *sk, int level, 205 int optname, char __user *optval, 206 int __user *optlen); 207 int (*hash)(struct sock *sk); 208 void (*unhash)(struct sock *sk); 209 }; 210 211 int wait_on_pending_writer(struct sock *sk, long *timeo); 212 int tls_sk_query(struct sock *sk, int optname, char __user *optval, 213 int __user *optlen); 214 int tls_sk_attach(struct sock *sk, int optname, char __user *optval, 215 unsigned int optlen); 216 217 218 int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx); 219 int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size); 220 int tls_sw_sendpage(struct sock *sk, struct page *page, 221 int offset, size_t size, int flags); 222 void tls_sw_close(struct sock *sk, long timeout); 223 void tls_sw_free_resources_tx(struct sock *sk); 224 void tls_sw_free_resources_rx(struct sock *sk); 225 int tls_sw_recvmsg(struct sock *sk, struct msghdr *msg, size_t len, 226 int nonblock, int flags, int *addr_len); 227 __poll_t tls_sw_poll_mask(struct socket *sock, __poll_t events); 228 ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos, 229 struct pipe_inode_info *pipe, 230 size_t len, unsigned int flags); 231 232 int tls_set_device_offload(struct sock *sk, struct tls_context *ctx); 233 int tls_device_sendmsg(struct sock *sk, struct msghdr *msg, size_t size); 234 int tls_device_sendpage(struct sock *sk, struct page *page, 235 int offset, size_t size, int flags); 236 void tls_device_sk_destruct(struct sock *sk); 237 void tls_device_init(void); 238 void tls_device_cleanup(void); 239 240 struct tls_record_info *tls_get_record(struct tls_offload_context *context, 241 u32 seq, u64 *p_record_sn); 242 243 static inline bool tls_record_is_start_marker(struct tls_record_info *rec) 244 { 245 return rec->len == 0; 246 } 247 248 static inline u32 tls_record_start_seq(struct tls_record_info *rec) 249 { 250 return rec->end_seq - rec->len; 251 } 252 253 void tls_sk_destruct(struct sock *sk, struct tls_context *ctx); 254 int tls_push_sg(struct sock *sk, struct tls_context *ctx, 255 struct scatterlist *sg, u16 first_offset, 256 int flags); 257 int tls_push_pending_closed_record(struct sock *sk, struct tls_context *ctx, 258 int flags, long *timeo); 259 260 static inline bool tls_is_pending_closed_record(struct tls_context *ctx) 261 { 262 return test_bit(TLS_PENDING_CLOSED_RECORD, &ctx->flags); 263 } 264 265 static inline int tls_complete_pending_work(struct sock *sk, 266 struct tls_context *ctx, 267 int flags, long *timeo) 268 { 269 int rc = 0; 270 271 if (unlikely(sk->sk_write_pending)) 272 rc = wait_on_pending_writer(sk, timeo); 273 274 if (!rc && tls_is_pending_closed_record(ctx)) 275 rc = tls_push_pending_closed_record(sk, ctx, flags, timeo); 276 277 return rc; 278 } 279 280 static inline bool tls_is_partially_sent_record(struct tls_context *ctx) 281 { 282 return !!ctx->partially_sent_record; 283 } 284 285 static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx) 286 { 287 return tls_ctx->pending_open_record_frags; 288 } 289 290 static inline bool tls_is_sk_tx_device_offloaded(struct sock *sk) 291 { 292 return sk_fullsock(sk) && 293 /* matches smp_store_release in tls_set_device_offload */ 294 smp_load_acquire(&sk->sk_destruct) == &tls_device_sk_destruct; 295 } 296 297 static inline void tls_err_abort(struct sock *sk, int err) 298 { 299 sk->sk_err = err; 300 sk->sk_error_report(sk); 301 } 302 303 static inline bool tls_bigint_increment(unsigned char *seq, int len) 304 { 305 int i; 306 307 for (i = len - 1; i >= 0; i--) { 308 ++seq[i]; 309 if (seq[i] != 0) 310 break; 311 } 312 313 return (i == -1); 314 } 315 316 static inline void tls_advance_record_sn(struct sock *sk, 317 struct cipher_context *ctx) 318 { 319 if (tls_bigint_increment(ctx->rec_seq, ctx->rec_seq_size)) 320 tls_err_abort(sk, EBADMSG); 321 tls_bigint_increment(ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, 322 ctx->iv_size); 323 } 324 325 static inline void tls_fill_prepend(struct tls_context *ctx, 326 char *buf, 327 size_t plaintext_len, 328 unsigned char record_type) 329 { 330 size_t pkt_len, iv_size = ctx->tx.iv_size; 331 332 pkt_len = plaintext_len + iv_size + ctx->tx.tag_size; 333 334 /* we cover nonce explicit here as well, so buf should be of 335 * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE 336 */ 337 buf[0] = record_type; 338 buf[1] = TLS_VERSION_MINOR(ctx->crypto_send.version); 339 buf[2] = TLS_VERSION_MAJOR(ctx->crypto_send.version); 340 /* we can use IV for nonce explicit according to spec */ 341 buf[3] = pkt_len >> 8; 342 buf[4] = pkt_len & 0xFF; 343 memcpy(buf + TLS_NONCE_OFFSET, 344 ctx->tx.iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, iv_size); 345 } 346 347 static inline void tls_make_aad(char *buf, 348 size_t size, 349 char *record_sequence, 350 int record_sequence_size, 351 unsigned char record_type) 352 { 353 memcpy(buf, record_sequence, record_sequence_size); 354 355 buf[8] = record_type; 356 buf[9] = TLS_1_2_VERSION_MAJOR; 357 buf[10] = TLS_1_2_VERSION_MINOR; 358 buf[11] = size >> 8; 359 buf[12] = size & 0xFF; 360 } 361 362 static inline struct tls_context *tls_get_ctx(const struct sock *sk) 363 { 364 struct inet_connection_sock *icsk = inet_csk(sk); 365 366 return icsk->icsk_ulp_data; 367 } 368 369 static inline struct tls_sw_context_rx *tls_sw_ctx_rx( 370 const struct tls_context *tls_ctx) 371 { 372 return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx; 373 } 374 375 static inline struct tls_sw_context_tx *tls_sw_ctx_tx( 376 const struct tls_context *tls_ctx) 377 { 378 return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx; 379 } 380 381 static inline struct tls_offload_context *tls_offload_ctx( 382 const struct tls_context *tls_ctx) 383 { 384 return (struct tls_offload_context *)tls_ctx->priv_ctx_tx; 385 } 386 387 int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg, 388 unsigned char *record_type); 389 void tls_register_device(struct tls_device *device); 390 void tls_unregister_device(struct tls_device *device); 391 392 struct sk_buff *tls_validate_xmit_skb(struct sock *sk, 393 struct net_device *dev, 394 struct sk_buff *skb); 395 396 int tls_sw_fallback_init(struct sock *sk, 397 struct tls_offload_context *offload_ctx, 398 struct tls_crypto_info *crypto_info); 399 400 #endif /* _TLS_OFFLOAD_H */ 401