tls.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  1. /*
  2. * Copyright (c) 2016 Tom Herbert <[email protected]>
  3. * Copyright (c) 2016-2017, Mellanox Technologies. All rights reserved.
  4. * Copyright (c) 2016-2017, Dave Watson <[email protected]>. All rights reserved.
  5. *
  6. * This software is available to you under a choice of one of two
  7. * licenses. You may choose to be licensed under the terms of the GNU
  8. * General Public License (GPL) Version 2, available from the file
  9. * COPYING in the main directory of this source tree, or the
  10. * OpenIB.org BSD license below:
  11. *
  12. * Redistribution and use in source and binary forms, with or
  13. * without modification, are permitted provided that the following
  14. * conditions are met:
  15. *
  16. * - Redistributions of source code must retain the above
  17. * copyright notice, this list of conditions and the following
  18. * disclaimer.
  19. *
  20. * - Redistributions in binary form must reproduce the above
  21. * copyright notice, this list of conditions and the following
  22. * disclaimer in the documentation and/or other materials
  23. * provided with the distribution.
  24. *
  25. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  29. * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  30. * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  31. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  32. * SOFTWARE.
  33. */
  34. #ifndef _TLS_INT_H
  35. #define _TLS_INT_H
  36. #include <asm/byteorder.h>
  37. #include <linux/types.h>
  38. #include <linux/skmsg.h>
  39. #include <net/tls.h>
  40. #define TLS_PAGE_ORDER (min_t(unsigned int, PAGE_ALLOC_COSTLY_ORDER, \
  41. TLS_MAX_PAYLOAD_SIZE >> PAGE_SHIFT))
  42. #define __TLS_INC_STATS(net, field) \
  43. __SNMP_INC_STATS((net)->mib.tls_statistics, field)
  44. #define TLS_INC_STATS(net, field) \
  45. SNMP_INC_STATS((net)->mib.tls_statistics, field)
  46. #define TLS_DEC_STATS(net, field) \
  47. SNMP_DEC_STATS((net)->mib.tls_statistics, field)
  48. /* TLS records are maintained in 'struct tls_rec'. It stores the memory pages
  49. * allocated or mapped for each TLS record. After encryption, the records are
  50. * stores in a linked list.
  51. */
  52. struct tls_rec {
  53. struct list_head list;
  54. int tx_ready;
  55. int tx_flags;
  56. struct sk_msg msg_plaintext;
  57. struct sk_msg msg_encrypted;
  58. /* AAD | msg_plaintext.sg.data | sg_tag */
  59. struct scatterlist sg_aead_in[2];
  60. /* AAD | msg_encrypted.sg.data (data contains overhead for hdr & iv & tag) */
  61. struct scatterlist sg_aead_out[2];
  62. char content_type;
  63. struct scatterlist sg_content_type;
  64. struct sock *sk;
  65. char aad_space[TLS_AAD_SPACE_SIZE];
  66. u8 iv_data[MAX_IV_SIZE];
  67. struct aead_request aead_req;
  68. u8 aead_req_ctx[];
  69. };
  70. int __net_init tls_proc_init(struct net *net);
  71. void __net_exit tls_proc_fini(struct net *net);
  72. struct tls_context *tls_ctx_create(struct sock *sk);
  73. void tls_ctx_free(struct sock *sk, struct tls_context *ctx);
  74. void update_sk_prot(struct sock *sk, struct tls_context *ctx);
  75. int wait_on_pending_writer(struct sock *sk, long *timeo);
  76. int tls_sk_query(struct sock *sk, int optname, char __user *optval,
  77. int __user *optlen);
  78. int tls_sk_attach(struct sock *sk, int optname, char __user *optval,
  79. unsigned int optlen);
  80. void tls_err_abort(struct sock *sk, int err);
  81. int tls_set_sw_offload(struct sock *sk, struct tls_context *ctx, int tx);
  82. void tls_update_rx_zc_capable(struct tls_context *tls_ctx);
  83. void tls_sw_strparser_arm(struct sock *sk, struct tls_context *ctx);
  84. void tls_sw_strparser_done(struct tls_context *tls_ctx);
  85. int tls_sw_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
  86. int tls_sw_sendpage_locked(struct sock *sk, struct page *page,
  87. int offset, size_t size, int flags);
  88. int tls_sw_sendpage(struct sock *sk, struct page *page,
  89. int offset, size_t size, int flags);
  90. void tls_sw_cancel_work_tx(struct tls_context *tls_ctx);
  91. void tls_sw_release_resources_tx(struct sock *sk);
  92. void tls_sw_free_ctx_tx(struct tls_context *tls_ctx);
  93. void tls_sw_free_resources_rx(struct sock *sk);
  94. void tls_sw_release_resources_rx(struct sock *sk);
  95. void tls_sw_free_ctx_rx(struct tls_context *tls_ctx);
  96. int tls_sw_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
  97. int flags, int *addr_len);
  98. bool tls_sw_sock_is_readable(struct sock *sk);
  99. ssize_t tls_sw_splice_read(struct socket *sock, loff_t *ppos,
  100. struct pipe_inode_info *pipe,
  101. size_t len, unsigned int flags);
  102. int tls_device_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
  103. int tls_device_sendpage(struct sock *sk, struct page *page,
  104. int offset, size_t size, int flags);
  105. int tls_tx_records(struct sock *sk, int flags);
  106. void tls_sw_write_space(struct sock *sk, struct tls_context *ctx);
  107. void tls_device_write_space(struct sock *sk, struct tls_context *ctx);
  108. int tls_process_cmsg(struct sock *sk, struct msghdr *msg,
  109. unsigned char *record_type);
  110. int decrypt_skb(struct sock *sk, struct scatterlist *sgout);
  111. int tls_sw_fallback_init(struct sock *sk,
  112. struct tls_offload_context_tx *offload_ctx,
  113. struct tls_crypto_info *crypto_info);
  114. int tls_strp_dev_init(void);
  115. void tls_strp_dev_exit(void);
  116. void tls_strp_done(struct tls_strparser *strp);
  117. void tls_strp_stop(struct tls_strparser *strp);
  118. int tls_strp_init(struct tls_strparser *strp, struct sock *sk);
  119. void tls_strp_data_ready(struct tls_strparser *strp);
  120. void tls_strp_check_rcv(struct tls_strparser *strp);
  121. void tls_strp_msg_done(struct tls_strparser *strp);
  122. int tls_rx_msg_size(struct tls_strparser *strp, struct sk_buff *skb);
  123. void tls_rx_msg_ready(struct tls_strparser *strp);
  124. void tls_strp_msg_load(struct tls_strparser *strp, bool force_refresh);
  125. int tls_strp_msg_cow(struct tls_sw_context_rx *ctx);
  126. struct sk_buff *tls_strp_msg_detach(struct tls_sw_context_rx *ctx);
  127. int tls_strp_msg_hold(struct tls_strparser *strp, struct sk_buff_head *dst);
  128. static inline struct tls_msg *tls_msg(struct sk_buff *skb)
  129. {
  130. struct sk_skb_cb *scb = (struct sk_skb_cb *)skb->cb;
  131. return &scb->tls;
  132. }
  133. static inline struct sk_buff *tls_strp_msg(struct tls_sw_context_rx *ctx)
  134. {
  135. DEBUG_NET_WARN_ON_ONCE(!ctx->strp.msg_ready || !ctx->strp.anchor->len);
  136. return ctx->strp.anchor;
  137. }
  138. static inline bool tls_strp_msg_ready(struct tls_sw_context_rx *ctx)
  139. {
  140. return ctx->strp.msg_ready;
  141. }
  142. static inline bool tls_strp_msg_mixed_decrypted(struct tls_sw_context_rx *ctx)
  143. {
  144. return ctx->strp.mixed_decrypted;
  145. }
  146. #ifdef CONFIG_TLS_DEVICE
  147. int tls_device_init(void);
  148. void tls_device_cleanup(void);
  149. int tls_set_device_offload(struct sock *sk, struct tls_context *ctx);
  150. void tls_device_free_resources_tx(struct sock *sk);
  151. int tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx);
  152. void tls_device_offload_cleanup_rx(struct sock *sk);
  153. void tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq);
  154. int tls_device_decrypted(struct sock *sk, struct tls_context *tls_ctx);
  155. #else
  156. static inline int tls_device_init(void) { return 0; }
  157. static inline void tls_device_cleanup(void) {}
  158. static inline int
  159. tls_set_device_offload(struct sock *sk, struct tls_context *ctx)
  160. {
  161. return -EOPNOTSUPP;
  162. }
  163. static inline void tls_device_free_resources_tx(struct sock *sk) {}
  164. static inline int
  165. tls_set_device_offload_rx(struct sock *sk, struct tls_context *ctx)
  166. {
  167. return -EOPNOTSUPP;
  168. }
  169. static inline void tls_device_offload_cleanup_rx(struct sock *sk) {}
  170. static inline void
  171. tls_device_rx_resync_new_rec(struct sock *sk, u32 rcd_len, u32 seq) {}
  172. static inline int
  173. tls_device_decrypted(struct sock *sk, struct tls_context *tls_ctx)
  174. {
  175. return 0;
  176. }
  177. #endif
  178. int tls_push_sg(struct sock *sk, struct tls_context *ctx,
  179. struct scatterlist *sg, u16 first_offset,
  180. int flags);
  181. int tls_push_partial_record(struct sock *sk, struct tls_context *ctx,
  182. int flags);
  183. void tls_free_partial_record(struct sock *sk, struct tls_context *ctx);
  184. static inline bool tls_is_partially_sent_record(struct tls_context *ctx)
  185. {
  186. return !!ctx->partially_sent_record;
  187. }
  188. static inline bool tls_is_pending_open_record(struct tls_context *tls_ctx)
  189. {
  190. return tls_ctx->pending_open_record_frags;
  191. }
  192. static inline bool tls_bigint_increment(unsigned char *seq, int len)
  193. {
  194. int i;
  195. for (i = len - 1; i >= 0; i--) {
  196. ++seq[i];
  197. if (seq[i] != 0)
  198. break;
  199. }
  200. return (i == -1);
  201. }
  202. static inline void tls_bigint_subtract(unsigned char *seq, int n)
  203. {
  204. u64 rcd_sn;
  205. __be64 *p;
  206. BUILD_BUG_ON(TLS_MAX_REC_SEQ_SIZE != 8);
  207. p = (__be64 *)seq;
  208. rcd_sn = be64_to_cpu(*p);
  209. *p = cpu_to_be64(rcd_sn - n);
  210. }
  211. static inline void
  212. tls_advance_record_sn(struct sock *sk, struct tls_prot_info *prot,
  213. struct cipher_context *ctx)
  214. {
  215. if (tls_bigint_increment(ctx->rec_seq, prot->rec_seq_size))
  216. tls_err_abort(sk, -EBADMSG);
  217. if (prot->version != TLS_1_3_VERSION &&
  218. prot->cipher_type != TLS_CIPHER_CHACHA20_POLY1305)
  219. tls_bigint_increment(ctx->iv + prot->salt_size,
  220. prot->iv_size);
  221. }
  222. static inline void
  223. tls_xor_iv_with_seq(struct tls_prot_info *prot, char *iv, char *seq)
  224. {
  225. int i;
  226. if (prot->version == TLS_1_3_VERSION ||
  227. prot->cipher_type == TLS_CIPHER_CHACHA20_POLY1305) {
  228. for (i = 0; i < 8; i++)
  229. iv[i + 4] ^= seq[i];
  230. }
  231. }
  232. static inline void
  233. tls_fill_prepend(struct tls_context *ctx, char *buf, size_t plaintext_len,
  234. unsigned char record_type)
  235. {
  236. struct tls_prot_info *prot = &ctx->prot_info;
  237. size_t pkt_len, iv_size = prot->iv_size;
  238. pkt_len = plaintext_len + prot->tag_size;
  239. if (prot->version != TLS_1_3_VERSION &&
  240. prot->cipher_type != TLS_CIPHER_CHACHA20_POLY1305) {
  241. pkt_len += iv_size;
  242. memcpy(buf + TLS_NONCE_OFFSET,
  243. ctx->tx.iv + prot->salt_size, iv_size);
  244. }
  245. /* we cover nonce explicit here as well, so buf should be of
  246. * size KTLS_DTLS_HEADER_SIZE + KTLS_DTLS_NONCE_EXPLICIT_SIZE
  247. */
  248. buf[0] = prot->version == TLS_1_3_VERSION ?
  249. TLS_RECORD_TYPE_DATA : record_type;
  250. /* Note that VERSION must be TLS_1_2 for both TLS1.2 and TLS1.3 */
  251. buf[1] = TLS_1_2_VERSION_MINOR;
  252. buf[2] = TLS_1_2_VERSION_MAJOR;
  253. /* we can use IV for nonce explicit according to spec */
  254. buf[3] = pkt_len >> 8;
  255. buf[4] = pkt_len & 0xFF;
  256. }
  257. static inline
  258. void tls_make_aad(char *buf, size_t size, char *record_sequence,
  259. unsigned char record_type, struct tls_prot_info *prot)
  260. {
  261. if (prot->version != TLS_1_3_VERSION) {
  262. memcpy(buf, record_sequence, prot->rec_seq_size);
  263. buf += 8;
  264. } else {
  265. size += prot->tag_size;
  266. }
  267. buf[0] = prot->version == TLS_1_3_VERSION ?
  268. TLS_RECORD_TYPE_DATA : record_type;
  269. buf[1] = TLS_1_2_VERSION_MAJOR;
  270. buf[2] = TLS_1_2_VERSION_MINOR;
  271. buf[3] = size >> 8;
  272. buf[4] = size & 0xFF;
  273. }
  274. #endif