include/net/tls.h

   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         unsigned int (*sk_poll)(struct file *file, struct socket *sock,
 113                                 struct poll_table_struct *wait);
 114         struct sk_buff *recv_pkt;
 115         u8 control;
 116         bool decrypted;
 117 };
 118
 119 enum {
 120         TLS_PENDING_CLOSED_RECORD
 121 };
 122
 123 struct cipher_context {
 124         u16 prepend_size;
 125         u16 tag_size;
 126         u16 overhead_size;
 127         u16 iv_size;
 128         char *iv;
 129         u16 rec_seq_size;
 130         char *rec_seq;
 131 };
 132
 133 struct tls_context {
 134         union {
 135                 struct tls_crypto_info crypto_send;
 136                 struct tls12_crypto_info_aes_gcm_128 crypto_send_aes_gcm_128;
 137         };
 138         union {
 139                 struct tls_crypto_info crypto_recv;
 140                 struct tls12_crypto_info_aes_gcm_128 crypto_recv_aes_gcm_128;
 141         };
 142
 143         struct list_head list;
 144         struct net_device *netdev;
 145         refcount_t refcount;
 146
 147         void *priv_ctx_tx;
 148         void *priv_ctx_rx;
 149
 150         u8 tx_conf:3;
 151         u8 rx_conf:3;
 152
 153         struct cipher_context tx;
 154         struct cipher_context rx;
 155
 156         struct scatterlist *partially_sent_record;
 157         u16 partially_sent_offset;
 158         unsigned long flags;
 159
 160         u16 pending_open_record_frags;
 161         int (*push_pending_record)(struct sock *sk, int flags);
 162
 163         void (*sk_write_space)(struct sock *sk);
 164         void (*sk_proto_close)(struct sock *sk, long timeout);
 165
 166         int  (*setsockopt)(struct sock *sk, int level,
 167                            int optname, char __user *optval,
 168                            unsigned int optlen);
 169         int  (*getsockopt)(struct sock *sk, int level,
 170                            int optname, char __user *optval,
 171                            int __user *optlen);
 172         int  (*hash)(struct sock *sk);
 173         void (*unhash)(struct sock *sk);
 174 };
 175
 176 int wait_on_pending_writer(struct sock *sk, long *timeo);
 177 int tls_sk_query(struct sock *sk, int optname, char __user *optval,
 178                 int __user *optlen);
 179 int tls_sk_attach(struct sock *sk, int optname, char __user *optval,
 180                   unsigned int optlen);
 181
 182
 183 int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx);
 184 int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
 185 int tls_sw_sendpage(struct sock *sk, struct page *page,
 186                     int offset, size_t size, int flags);
 187 void tls_sw_close(struct sock *sk, long timeout);
 188 void tls_sw_free_resources_tx(struct sock *sk);
 189 void tls_sw_free_resources_rx(struct sock *sk);
 190 int tls_sw_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
 191                    int nonblock, int flags, int *addr_len);
 192 unsigned int tls_sw_poll(struct file *file, struct socket *sock,
 193                          struct poll_table_struct *wait);
 194 ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos,
 195                            struct pipe_inode_info *pipe,
 196                            size_t len, unsigned int flags);
 197
 198 void tls_sk_destruct(struct sock *sk, struct tls_context *ctx);
 199 void tls_icsk_clean_acked(struct sock *sk);
 200
 201 int tls_push_sg(struct sock *sk, struct tls_context *ctx,
 202                 struct scatterlist *sg, u16 first_offset,
 203                 int flags);
 204 int tls_push_pending_closed_record(struct sock *sk, struct tls_context *ctx,
 205                                    int flags, long *timeo);
 206
 207 static inline bool tls_is_pending_closed_record(struct tls_context *ctx)
 208 {
 209         return test_bit(TLS_PENDING_CLOSED_RECORD, &ctx->flags);
 210 }
 211
 212 static inline int tls_complete_pending_work(struct sock *sk,
 213                                             struct tls_context *ctx,
 214                                             int flags, long *timeo)
 215 {
 216         int rc = 0;
 217
 218         if (unlikely(sk->sk_write_pending))
 219                 rc = wait_on_pending_writer(sk, timeo);
 220
 221         if (!rc && tls_is_pending_closed_record(ctx))
 222                 rc = tls_push_pending_closed_record(sk, ctx, flags, timeo);
 223
 224         return rc;
 225 }
 226
 227 static inline bool tls_is_partially_sent_record(struct tls_context *ctx)
 228 {
 229         return !!ctx->partially_sent_record;
 230 }
 231
 232 static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx)
 233 {
 234         return tls_ctx->pending_open_record_frags;
 235 }
 236
 237 static inline void tls_err_abort(struct sock *sk, int err)
 238 {
 239         sk->sk_err = err;
 240         sk->sk_error_report(sk);
 241 }
 242
 243 static inline bool tls_bigint_increment(unsigned char *seq, int len)
 244 {
 245         int i;
 246
 247         for (i = len - 1; i >= 0; i--) {
 248                 ++seq[i];
 249                 if (seq[i] != 0)
 250                         break;
 251         }
 252
 253         return (i == -1);
 254 }
 255
 256 static inline void tls_advance_record_sn(struct sock *sk,
 257                                          struct cipher_context *ctx)
 258 {
 259         if (tls_bigint_increment(ctx->rec_seq, ctx->rec_seq_size))
 260                 tls_err_abort(sk, EBADMSG);
 261         tls_bigint_increment(ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE,
 262                              ctx->iv_size);
 263 }
 264
 265 static inline void tls_fill_prepend(struct tls_context *ctx,
 266                              char *buf,
 267                              size_t plaintext_len,
 268                              unsigned char record_type)
 269 {
 270         size_t pkt_len, iv_size = ctx->tx.iv_size;
 271
 272         pkt_len = plaintext_len + iv_size + ctx->tx.tag_size;
 273
 274         /* we cover nonce explicit here as well, so buf should be of
 275          * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
 276          */
 277         buf[0] = record_type;
 278         buf[1] = TLS_VERSION_MINOR(ctx->crypto_send.version);
 279         buf[2] = TLS_VERSION_MAJOR(ctx->crypto_send.version);
 280         /* we can use IV for nonce explicit according to spec */
 281         buf[3] = pkt_len >> 8;
 282         buf[4] = pkt_len & 0xFF;
 283         memcpy(buf + TLS_NONCE_OFFSET,
 284                ctx->tx.iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, iv_size);
 285 }
 286
 287 static inline void tls_make_aad(char *buf,
 288                                 size_t size,
 289                                 char *record_sequence,
 290                                 int record_sequence_size,
 291                                 unsigned char record_type)
 292 {
 293         memcpy(buf, record_sequence, record_sequence_size);
 294
 295         buf[8] = record_type;
 296         buf[9] = TLS_1_2_VERSION_MAJOR;
 297         buf[10] = TLS_1_2_VERSION_MINOR;
 298         buf[11] = size >> 8;
 299         buf[12] = size & 0xFF;
 300 }
 301
 302 static inline struct tls_context *tls_get_ctx(const struct sock *sk)
 303 {
 304         struct inet_connection_sock *icsk = inet_csk(sk);
 305
 306         return icsk->icsk_ulp_data;
 307 }
 308
 309 static inline struct tls_sw_context_rx *tls_sw_ctx_rx(
 310                 const struct tls_context *tls_ctx)
 311 {
 312         return (struct tls_sw_context_rx *)tls_ctx->priv_ctx_rx;
 313 }
 314
 315 static inline struct tls_sw_context_tx *tls_sw_ctx_tx(
 316                 const struct tls_context *tls_ctx)
 317 {
 318         return (struct tls_sw_context_tx *)tls_ctx->priv_ctx_tx;
 319 }
 320
 321 static inline struct tls_offload_context *tls_offload_ctx(
 322                 const struct tls_context *tls_ctx)
 323 {
 324         return (struct tls_offload_context *)tls_ctx->priv_ctx_tx;
 325 }
 326
 327 int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
 328                       unsigned char *record_type);
 329 void tls_register_device(struct tls_device *device);
 330 void tls_unregister_device(struct tls_device *device);
 331
 332 #endif /* _TLS_OFFLOAD_H */