include/uapi/linux/tls.h

   1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR Linux-OpenIB) */
   2 /*
   3  * Copyright (c) 2016-2017, Mellanox Technologies. 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 _UAPI_LINUX_TLS_H
  35 #define _UAPI_LINUX_TLS_H
  36
  37 #include <linux/types.h>
  38
  39 /* TLS socket options */
  40 #define TLS_TX                  1       /* Set transmit parameters */
  41 #define TLS_RX                  2       /* Set receive parameters */
  42 #define TLS_TX_ZEROCOPY_SENDFILE        3       /* transmit zerocopy sendfile */
  43
  44 /* Supported versions */
  45 #define TLS_VERSION_MINOR(ver)  ((ver) & 0xFF)
  46 #define TLS_VERSION_MAJOR(ver)  (((ver) >> 8) & 0xFF)
  47
  48 #define TLS_VERSION_NUMBER(id)  ((((id##_VERSION_MAJOR) & 0xFF) << 8) | \
  49                                  ((id##_VERSION_MINOR) & 0xFF))
  50
  51 #define TLS_1_2_VERSION_MAJOR   0x3
  52 #define TLS_1_2_VERSION_MINOR   0x3
  53 #define TLS_1_2_VERSION         TLS_VERSION_NUMBER(TLS_1_2)
  54
  55 #define TLS_1_3_VERSION_MAJOR   0x3
  56 #define TLS_1_3_VERSION_MINOR   0x4
  57 #define TLS_1_3_VERSION         TLS_VERSION_NUMBER(TLS_1_3)
  58
  59 /* Supported ciphers */
  60 #define TLS_CIPHER_AES_GCM_128                          51
  61 #define TLS_CIPHER_AES_GCM_128_IV_SIZE                  8
  62 #define TLS_CIPHER_AES_GCM_128_KEY_SIZE         16
  63 #define TLS_CIPHER_AES_GCM_128_SALT_SIZE                4
  64 #define TLS_CIPHER_AES_GCM_128_TAG_SIZE         16
  65 #define TLS_CIPHER_AES_GCM_128_REC_SEQ_SIZE             8
  66
  67 #define TLS_CIPHER_AES_GCM_256                          52
  68 #define TLS_CIPHER_AES_GCM_256_IV_SIZE                  8
  69 #define TLS_CIPHER_AES_GCM_256_KEY_SIZE         32
  70 #define TLS_CIPHER_AES_GCM_256_SALT_SIZE                4
  71 #define TLS_CIPHER_AES_GCM_256_TAG_SIZE         16
  72 #define TLS_CIPHER_AES_GCM_256_REC_SEQ_SIZE             8
  73
  74 #define TLS_CIPHER_AES_CCM_128                          53
  75 #define TLS_CIPHER_AES_CCM_128_IV_SIZE                  8
  76 #define TLS_CIPHER_AES_CCM_128_KEY_SIZE         16
  77 #define TLS_CIPHER_AES_CCM_128_SALT_SIZE                4
  78 #define TLS_CIPHER_AES_CCM_128_TAG_SIZE         16
  79 #define TLS_CIPHER_AES_CCM_128_REC_SEQ_SIZE             8
  80
  81 #define TLS_CIPHER_CHACHA20_POLY1305                    54
  82 #define TLS_CIPHER_CHACHA20_POLY1305_IV_SIZE            12
  83 #define TLS_CIPHER_CHACHA20_POLY1305_KEY_SIZE   32
  84 #define TLS_CIPHER_CHACHA20_POLY1305_SALT_SIZE          0
  85 #define TLS_CIPHER_CHACHA20_POLY1305_TAG_SIZE   16
  86 #define TLS_CIPHER_CHACHA20_POLY1305_REC_SEQ_SIZE       8
  87
  88 #define TLS_CIPHER_SM4_GCM                              55
  89 #define TLS_CIPHER_SM4_GCM_IV_SIZE                      8
  90 #define TLS_CIPHER_SM4_GCM_KEY_SIZE             16
  91 #define TLS_CIPHER_SM4_GCM_SALT_SIZE            4
  92 #define TLS_CIPHER_SM4_GCM_TAG_SIZE             16
  93 #define TLS_CIPHER_SM4_GCM_REC_SEQ_SIZE         8
  94
  95 #define TLS_CIPHER_SM4_CCM                              56
  96 #define TLS_CIPHER_SM4_CCM_IV_SIZE                      8
  97 #define TLS_CIPHER_SM4_CCM_KEY_SIZE             16
  98 #define TLS_CIPHER_SM4_CCM_SALT_SIZE            4
  99 #define TLS_CIPHER_SM4_CCM_TAG_SIZE             16
 100 #define TLS_CIPHER_SM4_CCM_REC_SEQ_SIZE         8
 101
 102 #define TLS_SET_RECORD_TYPE     1
 103 #define TLS_GET_RECORD_TYPE     2
 104
 105 struct tls_crypto_info {
 106         __u16 version;
 107         __u16 cipher_type;
 108 };
 109
 110 struct tls12_crypto_info_aes_gcm_128 {
 111         struct tls_crypto_info info;
 112         unsigned char iv[TLS_CIPHER_AES_GCM_128_IV_SIZE];
 113         unsigned char key[TLS_CIPHER_AES_GCM_128_KEY_SIZE];
 114         unsigned char salt[TLS_CIPHER_AES_GCM_128_SALT_SIZE];
 115         unsigned char rec_seq[TLS_CIPHER_AES_GCM_128_REC_SEQ_SIZE];
 116 };
 117
 118 struct tls12_crypto_info_aes_gcm_256 {
 119         struct tls_crypto_info info;
 120         unsigned char iv[TLS_CIPHER_AES_GCM_256_IV_SIZE];
 121         unsigned char key[TLS_CIPHER_AES_GCM_256_KEY_SIZE];
 122         unsigned char salt[TLS_CIPHER_AES_GCM_256_SALT_SIZE];
 123         unsigned char rec_seq[TLS_CIPHER_AES_GCM_256_REC_SEQ_SIZE];
 124 };
 125
 126 struct tls12_crypto_info_aes_ccm_128 {
 127         struct tls_crypto_info info;
 128         unsigned char iv[TLS_CIPHER_AES_CCM_128_IV_SIZE];
 129         unsigned char key[TLS_CIPHER_AES_CCM_128_KEY_SIZE];
 130         unsigned char salt[TLS_CIPHER_AES_CCM_128_SALT_SIZE];
 131         unsigned char rec_seq[TLS_CIPHER_AES_CCM_128_REC_SEQ_SIZE];
 132 };
 133
 134 struct tls12_crypto_info_chacha20_poly1305 {
 135         struct tls_crypto_info info;
 136         unsigned char iv[TLS_CIPHER_CHACHA20_POLY1305_IV_SIZE];
 137         unsigned char key[TLS_CIPHER_CHACHA20_POLY1305_KEY_SIZE];
 138         unsigned char salt[TLS_CIPHER_CHACHA20_POLY1305_SALT_SIZE];
 139         unsigned char rec_seq[TLS_CIPHER_CHACHA20_POLY1305_REC_SEQ_SIZE];
 140 };
 141
 142 struct tls12_crypto_info_sm4_gcm {
 143         struct tls_crypto_info info;
 144         unsigned char iv[TLS_CIPHER_SM4_GCM_IV_SIZE];
 145         unsigned char key[TLS_CIPHER_SM4_GCM_KEY_SIZE];
 146         unsigned char salt[TLS_CIPHER_SM4_GCM_SALT_SIZE];
 147         unsigned char rec_seq[TLS_CIPHER_SM4_GCM_REC_SEQ_SIZE];
 148 };
 149
 150 struct tls12_crypto_info_sm4_ccm {
 151         struct tls_crypto_info info;
 152         unsigned char iv[TLS_CIPHER_SM4_CCM_IV_SIZE];
 153         unsigned char key[TLS_CIPHER_SM4_CCM_KEY_SIZE];
 154         unsigned char salt[TLS_CIPHER_SM4_CCM_SALT_SIZE];
 155         unsigned char rec_seq[TLS_CIPHER_SM4_CCM_REC_SEQ_SIZE];
 156 };
 157
 158 enum {
 159         TLS_INFO_UNSPEC,
 160         TLS_INFO_VERSION,
 161         TLS_INFO_CIPHER,
 162         TLS_INFO_TXCONF,
 163         TLS_INFO_RXCONF,
 164         TLS_INFO_ZC_SENDFILE,
 165         __TLS_INFO_MAX,
 166 };
 167 #define TLS_INFO_MAX (__TLS_INFO_MAX - 1)
 168
 169 #define TLS_CONF_BASE 1
 170 #define TLS_CONF_SW 2
 171 #define TLS_CONF_HW 3
 172 #define TLS_CONF_HW_RECORD 4
 173
 174 #endif /* _UAPI_LINUX_TLS_H */