1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C)2002 USAGI/WIDE Project
7 * Mitsuru KANDA @USAGI : IPv6 Support
8 * Kazunori MIYAZAWA @USAGI :
11 * This file is derived from net/ipv4/esp.c
14 #define pr_fmt(fmt) "IPv6: " fmt
16 #include <crypto/aead.h>
17 #include <crypto/authenc.h>
18 #include <linux/err.h>
19 #include <linux/module.h>
23 #include <linux/scatterlist.h>
24 #include <linux/kernel.h>
25 #include <linux/pfkeyv2.h>
26 #include <linux/random.h>
27 #include <linux/slab.h>
28 #include <linux/spinlock.h>
29 #include <net/ip6_route.h>
32 #include <net/protocol.h>
33 #include <linux/icmpv6.h>
35 #include <linux/highmem.h>
38 struct xfrm_skb_cb xfrm;
42 #define ESP_SKB_CB(__skb) ((struct esp_skb_cb *)&((__skb)->cb[0]))
45 * Allocate an AEAD request structure with extra space for SG and IV.
47 * For alignment considerations the upper 32 bits of the sequence number are
48 * placed at the front, if present. Followed by the IV, the request and finally
51 * TODO: Use spare space in skb for this where possible.
53 static void *esp_alloc_tmp(struct crypto_aead *aead, int nfrags, int seqihlen)
59 len += crypto_aead_ivsize(aead);
62 len += crypto_aead_alignmask(aead) &
63 ~(crypto_tfm_ctx_alignment() - 1);
64 len = ALIGN(len, crypto_tfm_ctx_alignment());
67 len += sizeof(struct aead_request) + crypto_aead_reqsize(aead);
68 len = ALIGN(len, __alignof__(struct scatterlist));
70 len += sizeof(struct scatterlist) * nfrags;
72 return kmalloc(len, GFP_ATOMIC);
75 static inline __be32 *esp_tmp_seqhi(void *tmp)
77 return PTR_ALIGN((__be32 *)tmp, __alignof__(__be32));
80 static inline u8 *esp_tmp_iv(struct crypto_aead *aead, void *tmp, int seqhilen)
82 return crypto_aead_ivsize(aead) ?
83 PTR_ALIGN((u8 *)tmp + seqhilen,
84 crypto_aead_alignmask(aead) + 1) : tmp + seqhilen;
87 static inline struct aead_request *esp_tmp_req(struct crypto_aead *aead, u8 *iv)
89 struct aead_request *req;
91 req = (void *)PTR_ALIGN(iv + crypto_aead_ivsize(aead),
92 crypto_tfm_ctx_alignment());
93 aead_request_set_tfm(req, aead);
97 static inline struct scatterlist *esp_req_sg(struct crypto_aead *aead,
98 struct aead_request *req)
100 return (void *)ALIGN((unsigned long)(req + 1) +
101 crypto_aead_reqsize(aead),
102 __alignof__(struct scatterlist));
105 static void esp_ssg_unref(struct xfrm_state *x, void *tmp)
107 struct crypto_aead *aead = x->data;
110 struct aead_request *req;
111 struct scatterlist *sg;
113 if (x->props.flags & XFRM_STATE_ESN)
114 seqhilen += sizeof(__be32);
116 iv = esp_tmp_iv(aead, tmp, seqhilen);
117 req = esp_tmp_req(aead, iv);
119 /* Unref skb_frag_pages in the src scatterlist if necessary.
120 * Skip the first sg which comes from skb->data.
122 if (req->src != req->dst)
123 for (sg = sg_next(req->src); sg; sg = sg_next(sg))
124 put_page(sg_page(sg));
127 static void esp_output_done(struct crypto_async_request *base, int err)
129 struct sk_buff *skb = base->data;
130 struct xfrm_offload *xo = xfrm_offload(skb);
132 struct xfrm_state *x;
134 if (xo && (xo->flags & XFRM_DEV_RESUME)) {
135 struct sec_path *sp = skb_sec_path(skb);
137 x = sp->xvec[sp->len - 1];
139 x = skb_dst(skb)->xfrm;
142 tmp = ESP_SKB_CB(skb)->tmp;
143 esp_ssg_unref(x, tmp);
146 if (xo && (xo->flags & XFRM_DEV_RESUME)) {
148 XFRM_INC_STATS(xs_net(x), LINUX_MIB_XFRMOUTSTATEPROTOERROR);
153 skb_push(skb, skb->data - skb_mac_header(skb));
155 xfrm_dev_resume(skb);
157 xfrm_output_resume(skb, err);
161 /* Move ESP header back into place. */
162 static void esp_restore_header(struct sk_buff *skb, unsigned int offset)
164 struct ip_esp_hdr *esph = (void *)(skb->data + offset);
165 void *tmp = ESP_SKB_CB(skb)->tmp;
166 __be32 *seqhi = esp_tmp_seqhi(tmp);
168 esph->seq_no = esph->spi;
172 static void esp_output_restore_header(struct sk_buff *skb)
174 esp_restore_header(skb, skb_transport_offset(skb) - sizeof(__be32));
177 static struct ip_esp_hdr *esp_output_set_esn(struct sk_buff *skb,
178 struct xfrm_state *x,
179 struct ip_esp_hdr *esph,
182 /* For ESN we move the header forward by 4 bytes to
183 * accomodate the high bits. We will move it back after
186 if ((x->props.flags & XFRM_STATE_ESN)) {
187 struct xfrm_offload *xo = xfrm_offload(skb);
189 esph = (void *)(skb_transport_header(skb) - sizeof(__be32));
192 esph->seq_no = htonl(xo->seq.hi);
194 esph->seq_no = htonl(XFRM_SKB_CB(skb)->seq.output.hi);
197 esph->spi = x->id.spi;
202 static void esp_output_done_esn(struct crypto_async_request *base, int err)
204 struct sk_buff *skb = base->data;
206 esp_output_restore_header(skb);
207 esp_output_done(base, err);
210 static void esp_output_fill_trailer(u8 *tail, int tfclen, int plen, __u8 proto)
212 /* Fill padding... */
214 memset(tail, 0, tfclen);
219 for (i = 0; i < plen - 2; i++)
222 tail[plen - 2] = plen - 2;
223 tail[plen - 1] = proto;
226 int esp6_output_head(struct xfrm_state *x, struct sk_buff *skb, struct esp_info *esp)
232 struct sk_buff *trailer;
233 int tailen = esp->tailen;
235 if (!skb_cloned(skb)) {
236 if (tailen <= skb_tailroom(skb)) {
239 tail = skb_tail_pointer(trailer);
242 } else if ((skb_shinfo(skb)->nr_frags < MAX_SKB_FRAGS)
243 && !skb_has_frag_list(skb)) {
245 struct sock *sk = skb->sk;
246 struct page_frag *pfrag = &x->xfrag;
248 esp->inplace = false;
250 allocsize = ALIGN(tailen, L1_CACHE_BYTES);
252 spin_lock_bh(&x->lock);
254 if (unlikely(!skb_page_frag_refill(allocsize, pfrag, GFP_ATOMIC))) {
255 spin_unlock_bh(&x->lock);
262 vaddr = kmap_atomic(page);
264 tail = vaddr + pfrag->offset;
266 esp_output_fill_trailer(tail, esp->tfclen, esp->plen, esp->proto);
268 kunmap_atomic(vaddr);
270 nfrags = skb_shinfo(skb)->nr_frags;
272 __skb_fill_page_desc(skb, nfrags, page, pfrag->offset,
274 skb_shinfo(skb)->nr_frags = ++nfrags;
276 pfrag->offset = pfrag->offset + allocsize;
278 spin_unlock_bh(&x->lock);
283 skb->data_len += tailen;
284 skb->truesize += tailen;
285 if (sk && sk_fullsock(sk))
286 refcount_add(tailen, &sk->sk_wmem_alloc);
293 nfrags = skb_cow_data(skb, tailen, &trailer);
296 tail = skb_tail_pointer(trailer);
299 esp_output_fill_trailer(tail, esp->tfclen, esp->plen, esp->proto);
300 pskb_put(skb, trailer, tailen);
305 EXPORT_SYMBOL_GPL(esp6_output_head);
307 int esp6_output_tail(struct xfrm_state *x, struct sk_buff *skb, struct esp_info *esp)
317 struct ip_esp_hdr *esph;
318 struct aead_request *req;
319 struct crypto_aead *aead;
320 struct scatterlist *sg, *dsg;
323 assoclen = sizeof(struct ip_esp_hdr);
326 if (x->props.flags & XFRM_STATE_ESN) {
327 seqhilen += sizeof(__be32);
328 assoclen += sizeof(__be32);
332 alen = crypto_aead_authsize(aead);
333 ivlen = crypto_aead_ivsize(aead);
335 tmp = esp_alloc_tmp(aead, esp->nfrags + 2, seqhilen);
339 seqhi = esp_tmp_seqhi(tmp);
340 iv = esp_tmp_iv(aead, tmp, seqhilen);
341 req = esp_tmp_req(aead, iv);
342 sg = esp_req_sg(aead, req);
347 dsg = &sg[esp->nfrags];
349 esph = esp_output_set_esn(skb, x, ip_esp_hdr(skb), seqhi);
351 sg_init_table(sg, esp->nfrags);
352 err = skb_to_sgvec(skb, sg,
353 (unsigned char *)esph - skb->data,
354 assoclen + ivlen + esp->clen + alen);
355 if (unlikely(err < 0))
360 struct page_frag *pfrag = &x->xfrag;
362 allocsize = ALIGN(skb->data_len, L1_CACHE_BYTES);
364 spin_lock_bh(&x->lock);
365 if (unlikely(!skb_page_frag_refill(allocsize, pfrag, GFP_ATOMIC))) {
366 spin_unlock_bh(&x->lock);
370 skb_shinfo(skb)->nr_frags = 1;
374 /* replace page frags in skb with new page */
375 __skb_fill_page_desc(skb, 0, page, pfrag->offset, skb->data_len);
376 pfrag->offset = pfrag->offset + allocsize;
377 spin_unlock_bh(&x->lock);
379 sg_init_table(dsg, skb_shinfo(skb)->nr_frags + 1);
380 err = skb_to_sgvec(skb, dsg,
381 (unsigned char *)esph - skb->data,
382 assoclen + ivlen + esp->clen + alen);
383 if (unlikely(err < 0))
387 if ((x->props.flags & XFRM_STATE_ESN))
388 aead_request_set_callback(req, 0, esp_output_done_esn, skb);
390 aead_request_set_callback(req, 0, esp_output_done, skb);
392 aead_request_set_crypt(req, sg, dsg, ivlen + esp->clen, iv);
393 aead_request_set_ad(req, assoclen);
395 memset(iv, 0, ivlen);
396 memcpy(iv + ivlen - min(ivlen, 8), (u8 *)&esp->seqno + 8 - min(ivlen, 8),
399 ESP_SKB_CB(skb)->tmp = tmp;
400 err = crypto_aead_encrypt(req);
411 if ((x->props.flags & XFRM_STATE_ESN))
412 esp_output_restore_header(skb);
416 esp_ssg_unref(x, tmp);
423 EXPORT_SYMBOL_GPL(esp6_output_tail);
425 static int esp6_output(struct xfrm_state *x, struct sk_buff *skb)
429 struct ip_esp_hdr *esph;
430 struct crypto_aead *aead;
435 esp.proto = *skb_mac_header(skb);
436 *skb_mac_header(skb) = IPPROTO_ESP;
438 /* skb is pure payload to encrypt */
441 alen = crypto_aead_authsize(aead);
445 struct xfrm_dst *dst = (struct xfrm_dst *)skb_dst(skb);
448 padto = min(x->tfcpad, xfrm_state_mtu(x, dst->child_mtu_cached));
449 if (skb->len < padto)
450 esp.tfclen = padto - skb->len;
452 blksize = ALIGN(crypto_aead_blocksize(aead), 4);
453 esp.clen = ALIGN(skb->len + 2 + esp.tfclen, blksize);
454 esp.plen = esp.clen - skb->len - esp.tfclen;
455 esp.tailen = esp.tfclen + esp.plen + alen;
457 esp.nfrags = esp6_output_head(x, skb, &esp);
461 esph = ip_esp_hdr(skb);
462 esph->spi = x->id.spi;
464 esph->seq_no = htonl(XFRM_SKB_CB(skb)->seq.output.low);
465 esp.seqno = cpu_to_be64(XFRM_SKB_CB(skb)->seq.output.low +
466 ((u64)XFRM_SKB_CB(skb)->seq.output.hi << 32));
468 skb_push(skb, -skb_network_offset(skb));
470 return esp6_output_tail(x, skb, &esp);
473 static inline int esp_remove_trailer(struct sk_buff *skb)
475 struct xfrm_state *x = xfrm_input_state(skb);
476 struct xfrm_offload *xo = xfrm_offload(skb);
477 struct crypto_aead *aead = x->data;
478 int alen, hlen, elen;
484 alen = crypto_aead_authsize(aead);
485 hlen = sizeof(struct ip_esp_hdr) + crypto_aead_ivsize(aead);
486 elen = skb->len - hlen;
488 if (xo && (xo->flags & XFRM_ESP_NO_TRAILER)) {
493 ret = skb_copy_bits(skb, skb->len - alen - 2, nexthdr, 2);
498 if (padlen + 2 + alen >= elen) {
499 net_dbg_ratelimited("ipsec esp packet is garbage padlen=%d, elen=%d\n",
500 padlen + 2, elen - alen);
504 trimlen = alen + padlen + 2;
505 if (skb->ip_summed == CHECKSUM_COMPLETE) {
506 csumdiff = skb_checksum(skb, skb->len - trimlen, trimlen, 0);
507 skb->csum = csum_block_sub(skb->csum, csumdiff,
510 pskb_trim(skb, skb->len - trimlen);
518 int esp6_input_done2(struct sk_buff *skb, int err)
520 struct xfrm_state *x = xfrm_input_state(skb);
521 struct xfrm_offload *xo = xfrm_offload(skb);
522 struct crypto_aead *aead = x->data;
523 int hlen = sizeof(struct ip_esp_hdr) + crypto_aead_ivsize(aead);
524 int hdr_len = skb_network_header_len(skb);
526 if (!xo || (xo && !(xo->flags & CRYPTO_DONE)))
527 kfree(ESP_SKB_CB(skb)->tmp);
532 err = esp_remove_trailer(skb);
533 if (unlikely(err < 0))
536 skb_postpull_rcsum(skb, skb_network_header(skb),
537 skb_network_header_len(skb));
538 skb_pull_rcsum(skb, hlen);
539 if (x->props.mode == XFRM_MODE_TUNNEL)
540 skb_reset_transport_header(skb);
542 skb_set_transport_header(skb, -hdr_len);
544 /* RFC4303: Drop dummy packets without any error */
545 if (err == IPPROTO_NONE)
551 EXPORT_SYMBOL_GPL(esp6_input_done2);
553 static void esp_input_done(struct crypto_async_request *base, int err)
555 struct sk_buff *skb = base->data;
557 xfrm_input_resume(skb, esp6_input_done2(skb, err));
560 static void esp_input_restore_header(struct sk_buff *skb)
562 esp_restore_header(skb, 0);
566 static void esp_input_set_header(struct sk_buff *skb, __be32 *seqhi)
568 struct xfrm_state *x = xfrm_input_state(skb);
570 /* For ESN we move the header forward by 4 bytes to
571 * accomodate the high bits. We will move it back after
574 if ((x->props.flags & XFRM_STATE_ESN)) {
575 struct ip_esp_hdr *esph = skb_push(skb, 4);
578 esph->spi = esph->seq_no;
579 esph->seq_no = XFRM_SKB_CB(skb)->seq.input.hi;
583 static void esp_input_done_esn(struct crypto_async_request *base, int err)
585 struct sk_buff *skb = base->data;
587 esp_input_restore_header(skb);
588 esp_input_done(base, err);
591 static int esp6_input(struct xfrm_state *x, struct sk_buff *skb)
593 struct crypto_aead *aead = x->data;
594 struct aead_request *req;
595 struct sk_buff *trailer;
596 int ivlen = crypto_aead_ivsize(aead);
597 int elen = skb->len - sizeof(struct ip_esp_hdr) - ivlen;
605 struct scatterlist *sg;
607 if (!pskb_may_pull(skb, sizeof(struct ip_esp_hdr) + ivlen)) {
617 assoclen = sizeof(struct ip_esp_hdr);
620 if (x->props.flags & XFRM_STATE_ESN) {
621 seqhilen += sizeof(__be32);
622 assoclen += seqhilen;
625 if (!skb_cloned(skb)) {
626 if (!skb_is_nonlinear(skb)) {
630 } else if (!skb_has_frag_list(skb)) {
631 nfrags = skb_shinfo(skb)->nr_frags;
638 nfrags = skb_cow_data(skb, 0, &trailer);
646 tmp = esp_alloc_tmp(aead, nfrags, seqhilen);
650 ESP_SKB_CB(skb)->tmp = tmp;
651 seqhi = esp_tmp_seqhi(tmp);
652 iv = esp_tmp_iv(aead, tmp, seqhilen);
653 req = esp_tmp_req(aead, iv);
654 sg = esp_req_sg(aead, req);
656 esp_input_set_header(skb, seqhi);
658 sg_init_table(sg, nfrags);
659 ret = skb_to_sgvec(skb, sg, 0, skb->len);
660 if (unlikely(ret < 0)) {
665 skb->ip_summed = CHECKSUM_NONE;
667 if ((x->props.flags & XFRM_STATE_ESN))
668 aead_request_set_callback(req, 0, esp_input_done_esn, skb);
670 aead_request_set_callback(req, 0, esp_input_done, skb);
672 aead_request_set_crypt(req, sg, sg, elen + ivlen, iv);
673 aead_request_set_ad(req, assoclen);
675 ret = crypto_aead_decrypt(req);
676 if (ret == -EINPROGRESS)
679 if ((x->props.flags & XFRM_STATE_ESN))
680 esp_input_restore_header(skb);
682 ret = esp6_input_done2(skb, ret);
688 static int esp6_err(struct sk_buff *skb, struct inet6_skb_parm *opt,
689 u8 type, u8 code, int offset, __be32 info)
691 struct net *net = dev_net(skb->dev);
692 const struct ipv6hdr *iph = (const struct ipv6hdr *)skb->data;
693 struct ip_esp_hdr *esph = (struct ip_esp_hdr *)(skb->data + offset);
694 struct xfrm_state *x;
696 if (type != ICMPV6_PKT_TOOBIG &&
697 type != NDISC_REDIRECT)
700 x = xfrm_state_lookup(net, skb->mark, (const xfrm_address_t *)&iph->daddr,
701 esph->spi, IPPROTO_ESP, AF_INET6);
705 if (type == NDISC_REDIRECT)
706 ip6_redirect(skb, net, skb->dev->ifindex, 0,
707 sock_net_uid(net, NULL));
709 ip6_update_pmtu(skb, net, info, 0, 0, sock_net_uid(net, NULL));
715 static void esp6_destroy(struct xfrm_state *x)
717 struct crypto_aead *aead = x->data;
722 crypto_free_aead(aead);
725 static int esp_init_aead(struct xfrm_state *x)
727 char aead_name[CRYPTO_MAX_ALG_NAME];
728 struct crypto_aead *aead;
732 if (snprintf(aead_name, CRYPTO_MAX_ALG_NAME, "%s(%s)",
733 x->geniv, x->aead->alg_name) >= CRYPTO_MAX_ALG_NAME)
736 aead = crypto_alloc_aead(aead_name, 0, 0);
743 err = crypto_aead_setkey(aead, x->aead->alg_key,
744 (x->aead->alg_key_len + 7) / 8);
748 err = crypto_aead_setauthsize(aead, x->aead->alg_icv_len / 8);
756 static int esp_init_authenc(struct xfrm_state *x)
758 struct crypto_aead *aead;
759 struct crypto_authenc_key_param *param;
763 char authenc_name[CRYPTO_MAX_ALG_NAME];
773 if ((x->props.flags & XFRM_STATE_ESN)) {
774 if (snprintf(authenc_name, CRYPTO_MAX_ALG_NAME,
775 "%s%sauthencesn(%s,%s)%s",
776 x->geniv ?: "", x->geniv ? "(" : "",
777 x->aalg ? x->aalg->alg_name : "digest_null",
779 x->geniv ? ")" : "") >= CRYPTO_MAX_ALG_NAME)
782 if (snprintf(authenc_name, CRYPTO_MAX_ALG_NAME,
783 "%s%sauthenc(%s,%s)%s",
784 x->geniv ?: "", x->geniv ? "(" : "",
785 x->aalg ? x->aalg->alg_name : "digest_null",
787 x->geniv ? ")" : "") >= CRYPTO_MAX_ALG_NAME)
791 aead = crypto_alloc_aead(authenc_name, 0, 0);
798 keylen = (x->aalg ? (x->aalg->alg_key_len + 7) / 8 : 0) +
799 (x->ealg->alg_key_len + 7) / 8 + RTA_SPACE(sizeof(*param));
801 key = kmalloc(keylen, GFP_KERNEL);
807 rta->rta_type = CRYPTO_AUTHENC_KEYA_PARAM;
808 rta->rta_len = RTA_LENGTH(sizeof(*param));
809 param = RTA_DATA(rta);
810 p += RTA_SPACE(sizeof(*param));
813 struct xfrm_algo_desc *aalg_desc;
815 memcpy(p, x->aalg->alg_key, (x->aalg->alg_key_len + 7) / 8);
816 p += (x->aalg->alg_key_len + 7) / 8;
818 aalg_desc = xfrm_aalg_get_byname(x->aalg->alg_name, 0);
822 if (aalg_desc->uinfo.auth.icv_fullbits / 8 !=
823 crypto_aead_authsize(aead)) {
824 pr_info("ESP: %s digestsize %u != %hu\n",
826 crypto_aead_authsize(aead),
827 aalg_desc->uinfo.auth.icv_fullbits / 8);
831 err = crypto_aead_setauthsize(
832 aead, x->aalg->alg_trunc_len / 8);
837 param->enckeylen = cpu_to_be32((x->ealg->alg_key_len + 7) / 8);
838 memcpy(p, x->ealg->alg_key, (x->ealg->alg_key_len + 7) / 8);
840 err = crypto_aead_setkey(aead, key, keylen);
849 static int esp6_init_state(struct xfrm_state *x)
851 struct crypto_aead *aead;
861 err = esp_init_aead(x);
863 err = esp_init_authenc(x);
870 x->props.header_len = sizeof(struct ip_esp_hdr) +
871 crypto_aead_ivsize(aead);
872 switch (x->props.mode) {
874 if (x->sel.family != AF_INET6)
875 x->props.header_len += IPV4_BEET_PHMAXLEN +
876 (sizeof(struct ipv6hdr) - sizeof(struct iphdr));
879 case XFRM_MODE_TRANSPORT:
881 case XFRM_MODE_TUNNEL:
882 x->props.header_len += sizeof(struct ipv6hdr);
886 align = ALIGN(crypto_aead_blocksize(aead), 4);
887 x->props.trailer_len = align + 1 + crypto_aead_authsize(aead);
893 static int esp6_rcv_cb(struct sk_buff *skb, int err)
898 static const struct xfrm_type esp6_type = {
899 .description = "ESP6",
900 .owner = THIS_MODULE,
901 .proto = IPPROTO_ESP,
902 .flags = XFRM_TYPE_REPLAY_PROT,
903 .init_state = esp6_init_state,
904 .destructor = esp6_destroy,
906 .output = esp6_output,
907 .hdr_offset = xfrm6_find_1stfragopt,
910 static struct xfrm6_protocol esp6_protocol = {
911 .handler = xfrm6_rcv,
912 .cb_handler = esp6_rcv_cb,
913 .err_handler = esp6_err,
917 static int __init esp6_init(void)
919 if (xfrm_register_type(&esp6_type, AF_INET6) < 0) {
920 pr_info("%s: can't add xfrm type\n", __func__);
923 if (xfrm6_protocol_register(&esp6_protocol, IPPROTO_ESP) < 0) {
924 pr_info("%s: can't add protocol\n", __func__);
925 xfrm_unregister_type(&esp6_type, AF_INET6);
932 static void __exit esp6_fini(void)
934 if (xfrm6_protocol_deregister(&esp6_protocol, IPPROTO_ESP) < 0)
935 pr_info("%s: can't remove protocol\n", __func__);
936 xfrm_unregister_type(&esp6_type, AF_INET6);
939 module_init(esp6_init);
940 module_exit(esp6_fini);
942 MODULE_LICENSE("GPL");
943 MODULE_ALIAS_XFRM_TYPE(AF_INET6, XFRM_PROTO_ESP);