Skip to content

Commit 3c4d755

Browse files
Dave Watsondavem330
Dave Watson
authored and
davem330
committed
tls: kernel TLS support
Software implementation of transport layer security, implemented using ULP infrastructure. tcp proto_ops are replaced with tls equivalents of sendmsg and sendpage. Only symmetric crypto is done in the kernel, keys are passed by setsockopt after the handshake is complete. All control messages are supported via CMSG data - the actual symmetric encryption is the same, just the message type needs to be passed separately. For user API, please see Documentation patch. Pieces that can be shared between hw and sw implementation are in tls_main.c Signed-off-by: Boris Pismenny <borisp@mellanox.com> Signed-off-by: Ilya Lesokhin <ilyal@mellanox.com> Signed-off-by: Aviad Yehezkel <aviadye@mellanox.com> Signed-off-by: Dave Watson <davejwatson@fb.com> Signed-off-by: David S. Miller <davem@davemloft.net>
1 parent e3b5616 commit 3c4d755

File tree

10 files changed

+1607
-0
lines changed

10 files changed

+1607
-0
lines changed

‎MAINTAINERS

+10
Original file line numberDiff line numberDiff line change
@@ -8978,6 +8978,16 @@ F: net/ipv6/
89788978
F: include/net/ip*
89798979
F: arch/x86/net/*
89808980

8981+
NETWORKING [TLS]
8982+
M: Ilya Lesokhin <ilyal@mellanox.com>
8983+
M: Aviad Yehezkel <aviadye@mellanox.com>
8984+
M: Dave Watson <davejwatson@fb.com>
8985+
L: netdev@vger.kernel.org
8986+
S: Maintained
8987+
F: net/tls/*
8988+
F: include/uapi/linux/tls.h
8989+
F: include/net/tls.h
8990+
89818991
NETWORKING [IPSEC]
89828992
M: Steffen Klassert <steffen.klassert@secunet.com>
89838993
M: Herbert Xu <herbert@gondor.apana.org.au>

‎include/linux/socket.h

+1
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,7 @@ struct ucred {
334334
#define SOL_ALG 279
335335
#define SOL_NFC 280
336336
#define SOL_KCM 281
337+
#define SOL_TLS 282
337338

338339
/* IPX options */
339340
#define IPX_TYPE 1

‎include/net/tls.h

+237
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,237 @@
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+
39+
#include <uapi/linux/tls.h>
40+
41+
42+
/* Maximum data size carried in a TLS record */
43+
#define TLS_MAX_PAYLOAD_SIZE ((size_t)1 << 14)
44+
45+
#define TLS_HEADER_SIZE 5
46+
#define TLS_NONCE_OFFSET TLS_HEADER_SIZE
47+
48+
#define TLS_CRYPTO_INFO_READY(info) ((info)->cipher_type)
49+
50+
#define TLS_RECORD_TYPE_DATA 0x17
51+
52+
#define TLS_AAD_SPACE_SIZE 13
53+
54+
struct tls_sw_context {
55+
struct crypto_aead *aead_send;
56+
57+
/* Sending context */
58+
char aad_space[TLS_AAD_SPACE_SIZE];
59+
60+
unsigned int sg_plaintext_size;
61+
int sg_plaintext_num_elem;
62+
struct scatterlist sg_plaintext_data[MAX_SKB_FRAGS];
63+
64+
unsigned int sg_encrypted_size;
65+
int sg_encrypted_num_elem;
66+
struct scatterlist sg_encrypted_data[MAX_SKB_FRAGS];
67+
68+
/* AAD | sg_plaintext_data | sg_tag */
69+
struct scatterlist sg_aead_in[2];
70+
/* AAD | sg_encrypted_data (data contain overhead for hdr&iv&tag) */
71+
struct scatterlist sg_aead_out[2];
72+
};
73+
74+
enum {
75+
TLS_PENDING_CLOSED_RECORD
76+
};
77+
78+
struct tls_context {
79+
union {
80+
struct tls_crypto_info crypto_send;
81+
struct tls12_crypto_info_aes_gcm_128 crypto_send_aes_gcm_128;
82+
};
83+
84+
void *priv_ctx;
85+
86+
u16 prepend_size;
87+
u16 tag_size;
88+
u16 overhead_size;
89+
u16 iv_size;
90+
char *iv;
91+
u16 rec_seq_size;
92+
char *rec_seq;
93+
94+
struct scatterlist *partially_sent_record;
95+
u16 partially_sent_offset;
96+
unsigned long flags;
97+
98+
u16 pending_open_record_frags;
99+
int (*push_pending_record)(struct sock *sk, int flags);
100+
void (*free_resources)(struct sock *sk);
101+
102+
void (*sk_write_space)(struct sock *sk);
103+
void (*sk_proto_close)(struct sock *sk, long timeout);
104+
105+
int (*setsockopt)(struct sock *sk, int level,
106+
int optname, char __user *optval,
107+
unsigned int optlen);
108+
int (*getsockopt)(struct sock *sk, int level,
109+
int optname, char __user *optval,
110+
int __user *optlen);
111+
};
112+
113+
int wait_on_pending_writer(struct sock *sk, long *timeo);
114+
int tls_sk_query(struct sock *sk, int optname, char __user *optval,
115+
int __user *optlen);
116+
int tls_sk_attach(struct sock *sk, int optname, char __user *optval,
117+
unsigned int optlen);
118+
119+
120+
int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx);
121+
int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
122+
int tls_sw_sendpage(struct sock *sk, struct page *page,
123+
int offset, size_t size, int flags);
124+
void tls_sw_close(struct sock *sk, long timeout);
125+
126+
void tls_sk_destruct(struct sock *sk, struct tls_context *ctx);
127+
void tls_icsk_clean_acked(struct sock *sk);
128+
129+
int tls_push_sg(struct sock *sk, struct tls_context *ctx,
130+
struct scatterlist *sg, u16 first_offset,
131+
int flags);
132+
int tls_push_pending_closed_record(struct sock *sk, struct tls_context *ctx,
133+
int flags, long *timeo);
134+
135+
static inline bool tls_is_pending_closed_record(struct tls_context *ctx)
136+
{
137+
return test_bit(TLS_PENDING_CLOSED_RECORD, &ctx->flags);
138+
}
139+
140+
static inline int tls_complete_pending_work(struct sock *sk,
141+
struct tls_context *ctx,
142+
int flags, long *timeo)
143+
{
144+
int rc = 0;
145+
146+
if (unlikely(sk->sk_write_pending))
147+
rc = wait_on_pending_writer(sk, timeo);
148+
149+
if (!rc && tls_is_pending_closed_record(ctx))
150+
rc = tls_push_pending_closed_record(sk, ctx, flags, timeo);
151+
152+
return rc;
153+
}
154+
155+
static inline bool tls_is_partially_sent_record(struct tls_context *ctx)
156+
{
157+
return !!ctx->partially_sent_record;
158+
}
159+
160+
static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx)
161+
{
162+
return tls_ctx->pending_open_record_frags;
163+
}
164+
165+
static inline void tls_err_abort(struct sock *sk)
166+
{
167+
sk->sk_err = -EBADMSG;
168+
sk->sk_error_report(sk);
169+
}
170+
171+
static inline bool tls_bigint_increment(unsigned char *seq, int len)
172+
{
173+
int i;
174+
175+
for (i = len - 1; i >= 0; i--) {
176+
++seq[i];
177+
if (seq[i] != 0)
178+
break;
179+
}
180+
181+
return (i == -1);
182+
}
183+
184+
static inline void tls_advance_record_sn(struct sock *sk,
185+
struct tls_context *ctx)
186+
{
187+
if (tls_bigint_increment(ctx->rec_seq, ctx->rec_seq_size))
188+
tls_err_abort(sk);
189+
tls_bigint_increment(ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE,
190+
ctx->iv_size);
191+
}
192+
193+
static inline void tls_fill_prepend(struct tls_context *ctx,
194+
char *buf,
195+
size_t plaintext_len,
196+
unsigned char record_type)
197+
{
198+
size_t pkt_len, iv_size = ctx->iv_size;
199+
200+
pkt_len = plaintext_len + iv_size + ctx->tag_size;
201+
202+
/* we cover nonce explicit here as well, so buf should be of
203+
* size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
204+
*/
205+
buf[0] = record_type;
206+
buf[1] = TLS_VERSION_MINOR(ctx->crypto_send.version);
207+
buf[2] = TLS_VERSION_MAJOR(ctx->crypto_send.version);
208+
/* we can use IV for nonce explicit according to spec */
209+
buf[3] = pkt_len >> 8;
210+
buf[4] = pkt_len & 0xFF;
211+
memcpy(buf + TLS_NONCE_OFFSET,
212+
ctx->iv + TLS_CIPHER_AES_GCM_128_SALT_SIZE, iv_size);
213+
}
214+
215+
static inline struct tls_context *tls_get_ctx(const struct sock *sk)
216+
{
217+
struct inet_connection_sock *icsk = inet_csk(sk);
218+
219+
return icsk->icsk_ulp_data;
220+
}
221+
222+
static inline struct tls_sw_context *tls_sw_ctx(
223+
const struct tls_context *tls_ctx)
224+
{
225+
return (struct tls_sw_context *)tls_ctx->priv_ctx;
226+
}
227+
228+
static inline struct tls_offload_context *tls_offload_ctx(
229+
const struct tls_context *tls_ctx)
230+
{
231+
return (struct tls_offload_context *)tls_ctx->priv_ctx;
232+
}
233+
234+
int tls_proccess_cmsg(struct sock *sk, struct msghdr *msg,
235+
unsigned char *record_type);
236+
237+
#endif /* _TLS_OFFLOAD_H */

‎include/uapi/linux/tls.h

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
/*
2+
* Copyright (c) 2016-2017, Mellanox Technologies. All rights reserved.
3+
*
4+
* This software is available to you under a choice of one of two
5+
* licenses. You may choose to be licensed under the terms of the GNU
6+
* General Public License (GPL) Version 2, available from the file
7+
* COPYING in the main directory of this source tree, or the
8+
* OpenIB.org BSD license below:
9+
*
10+
* Redistribution and use in source and binary forms, with or
11+
* without modification, are permitted provided that the following
12+
* conditions are met:
13+
*
14+
* - Redistributions of source code must retain the above
15+
* copyright notice, this list of conditions and the following
16+
* disclaimer.
17+
*
18+
* - Redistributions in binary form must reproduce the above
19+
* copyright notice, this list of conditions and the following
20+
* disclaimer in the documentation and/or other materials
21+
* provided with the distribution.
22+
*
23+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24+
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25+
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26+
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27+
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28+
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29+
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30+
* SOFTWARE.
31+
*/
32+
33+
#ifndef _UAPI_LINUX_TLS_H
34+
#define _UAPI_LINUX_TLS_H
35+
36+
#include <linux/types.h>
37+
#include <asm/byteorder.h>
38+
#include <linux/socket.h>
39+
#include <linux/tcp.h>
40+
#include <net/tcp.h>
41+
42+
/* TLS socket options */
43+
#define TLS_TX 1 /* Set transmit parameters */
44+
45+
/* Supported versions */
46+
#define TLS_VERSION_MINOR(ver) ((ver) & 0xFF)
47+
#define TLS_VERSION_MAJOR(ver) (((ver) >> 8) & 0xFF)
48+
49+
#define TLS_VERSION_NUMBER(id) ((((id##_VERSION_MAJOR) & 0xFF) << 8) | \
50+
((id##_VERSION_MINOR) & 0xFF))
51+
52+
#define TLS_1_2_VERSION_MAJOR 0x3
53+
#define TLS_1_2_VERSION_MINOR 0x3
54+
#define TLS_1_2_VERSION TLS_VERSION_NUMBER(TLS_1_2)
55+
56+
/* Supported ciphers */
57+
#define TLS_CIPHER_AES_GCM_128 51
58+
#define TLS_CIPHER_AES_GCM_128_IV_SIZE 8
59+
#define TLS_CIPHER_AES_GCM_128_KEY_SIZE 16
60+
#define TLS_CIPHER_AES_GCM_128_SALT_SIZE 4
61+
#define TLS_CIPHER_AES_GCM_128_TAG_SIZE 16
62+
#define TLS_CIPHER_AES_GCM_128_REC_SEQ_SIZE 8
63+
64+
#define TLS_SET_RECORD_TYPE 1
65+
66+
struct tls_crypto_info {
67+
__u16 version;
68+
__u16 cipher_type;
69+
};
70+
71+
struct tls12_crypto_info_aes_gcm_128 {
72+
struct tls_crypto_info info;
73+
unsigned char iv[TLS_CIPHER_AES_GCM_128_IV_SIZE];
74+
unsigned char key[TLS_CIPHER_AES_GCM_128_KEY_SIZE];
75+
unsigned char salt[TLS_CIPHER_AES_GCM_128_SALT_SIZE];
76+
unsigned char rec_seq[TLS_CIPHER_AES_GCM_128_REC_SEQ_SIZE];
77+
};
78+
79+
#endif /* _UAPI_LINUX_TLS_H */

‎net/Kconfig

+1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ menu "Networking options"
5555

5656
source "net/packet/Kconfig"
5757
source "net/unix/Kconfig"
58+
source "net/tls/Kconfig"
5859
source "net/xfrm/Kconfig"
5960
source "net/iucv/Kconfig"
6061
source "net/smc/Kconfig"

‎net/Makefile

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ obj-$(CONFIG_LLC) += llc/
1515
obj-$(CONFIG_NET) += ethernet/ 802/ sched/ netlink/ bpf/
1616
obj-$(CONFIG_NETFILTER) += netfilter/
1717
obj-$(CONFIG_INET) += ipv4/
18+
obj-$(CONFIG_TLS) += tls/
1819
obj-$(CONFIG_XFRM) += xfrm/
1920
obj-$(CONFIG_UNIX) += unix/
2021
obj-$(CONFIG_NET) += ipv6/

‎net/tls/Kconfig

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#
2+
# TLS configuration
3+
#
4+
config TLS
5+
tristate "Transport Layer Security support"
6+
depends on NET
7+
default m
8+
---help---
9+
Enable kernel support for TLS protocol. This allows symmetric
10+
encryption handling of the TLS protocol to be done in-kernel.
11+
12+
If unsure, say M.

‎net/tls/Makefile

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#
2+
# Makefile for the TLS subsystem.
3+
#
4+
5+
obj-$(CONFIG_TLS) += tls.o
6+
7+
tls-y := tls_main.o tls_sw.o

0 commit comments

Comments
 (0)