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 int esp6_output_head(struct xfrm_state *x, struct sk_buff *skb, struct esp_info *esp)
216 struct sk_buff *trailer;
217 int tailen = esp->tailen;
219 if (!skb_cloned(skb)) {
220 if (tailen <= skb_tailroom(skb)) {
223 tail = skb_tail_pointer(trailer);
226 } else if ((skb_shinfo(skb)->nr_frags < MAX_SKB_FRAGS)
227 && !skb_has_frag_list(skb)) {
229 struct sock *sk = skb->sk;
230 struct page_frag *pfrag = &x->xfrag;
232 esp->inplace = false;
234 allocsize = ALIGN(tailen, L1_CACHE_BYTES);
236 spin_lock_bh(&x->lock);
238 if (unlikely(!skb_page_frag_refill(allocsize, pfrag, GFP_ATOMIC))) {
239 spin_unlock_bh(&x->lock);
246 vaddr = kmap_atomic(page);
248 tail = vaddr + pfrag->offset;
250 esp_output_fill_trailer(tail, esp->tfclen, esp->plen, esp->proto);
252 kunmap_atomic(vaddr);
254 nfrags = skb_shinfo(skb)->nr_frags;
256 __skb_fill_page_desc(skb, nfrags, page, pfrag->offset,
258 skb_shinfo(skb)->nr_frags = ++nfrags;
260 pfrag->offset = pfrag->offset + allocsize;
262 spin_unlock_bh(&x->lock);
267 skb->data_len += tailen;
268 skb->truesize += tailen;
269 if (sk && sk_fullsock(sk))
270 refcount_add(tailen, &sk->sk_wmem_alloc);
277 nfrags = skb_cow_data(skb, tailen, &trailer);
280 tail = skb_tail_pointer(trailer);
283 esp_output_fill_trailer(tail, esp->tfclen, esp->plen, esp->proto);
284 pskb_put(skb, trailer, tailen);
289 EXPORT_SYMBOL_GPL(esp6_output_head);
291 int esp6_output_tail(struct xfrm_state *x, struct sk_buff *skb, struct esp_info *esp)
301 struct ip_esp_hdr *esph;
302 struct aead_request *req;
303 struct crypto_aead *aead;
304 struct scatterlist *sg, *dsg;
307 assoclen = sizeof(struct ip_esp_hdr);
310 if (x->props.flags & XFRM_STATE_ESN) {
311 seqhilen += sizeof(__be32);
312 assoclen += sizeof(__be32);
316 alen = crypto_aead_authsize(aead);
317 ivlen = crypto_aead_ivsize(aead);
319 tmp = esp_alloc_tmp(aead, esp->nfrags + 2, seqhilen);
323 seqhi = esp_tmp_seqhi(tmp);
324 iv = esp_tmp_iv(aead, tmp, seqhilen);
325 req = esp_tmp_req(aead, iv);
326 sg = esp_req_sg(aead, req);
331 dsg = &sg[esp->nfrags];
333 esph = esp_output_set_esn(skb, x, ip_esp_hdr(skb), seqhi);
335 sg_init_table(sg, esp->nfrags);
336 err = skb_to_sgvec(skb, sg,
337 (unsigned char *)esph - skb->data,
338 assoclen + ivlen + esp->clen + alen);
339 if (unlikely(err < 0))
344 struct page_frag *pfrag = &x->xfrag;
346 allocsize = ALIGN(skb->data_len, L1_CACHE_BYTES);
348 spin_lock_bh(&x->lock);
349 if (unlikely(!skb_page_frag_refill(allocsize, pfrag, GFP_ATOMIC))) {
350 spin_unlock_bh(&x->lock);
354 skb_shinfo(skb)->nr_frags = 1;
358 /* replace page frags in skb with new page */
359 __skb_fill_page_desc(skb, 0, page, pfrag->offset, skb->data_len);
360 pfrag->offset = pfrag->offset + allocsize;
361 spin_unlock_bh(&x->lock);
363 sg_init_table(dsg, skb_shinfo(skb)->nr_frags + 1);
364 err = skb_to_sgvec(skb, dsg,
365 (unsigned char *)esph - skb->data,
366 assoclen + ivlen + esp->clen + alen);
367 if (unlikely(err < 0))
371 if ((x->props.flags & XFRM_STATE_ESN))
372 aead_request_set_callback(req, 0, esp_output_done_esn, skb);
374 aead_request_set_callback(req, 0, esp_output_done, skb);
376 aead_request_set_crypt(req, sg, dsg, ivlen + esp->clen, iv);
377 aead_request_set_ad(req, assoclen);
379 memset(iv, 0, ivlen);
380 memcpy(iv + ivlen - min(ivlen, 8), (u8 *)&esp->seqno + 8 - min(ivlen, 8),
383 ESP_SKB_CB(skb)->tmp = tmp;
384 err = crypto_aead_encrypt(req);
395 if ((x->props.flags & XFRM_STATE_ESN))
396 esp_output_restore_header(skb);
400 esp_ssg_unref(x, tmp);
407 EXPORT_SYMBOL_GPL(esp6_output_tail);
409 static int esp6_output(struct xfrm_state *x, struct sk_buff *skb)
413 struct ip_esp_hdr *esph;
414 struct crypto_aead *aead;
419 esp.proto = *skb_mac_header(skb);
420 *skb_mac_header(skb) = IPPROTO_ESP;
422 /* skb is pure payload to encrypt */
425 alen = crypto_aead_authsize(aead);
429 struct xfrm_dst *dst = (struct xfrm_dst *)skb_dst(skb);
432 padto = min(x->tfcpad, xfrm_state_mtu(x, dst->child_mtu_cached));
433 if (skb->len < padto)
434 esp.tfclen = padto - skb->len;
436 blksize = ALIGN(crypto_aead_blocksize(aead), 4);
437 esp.clen = ALIGN(skb->len + 2 + esp.tfclen, blksize);
438 esp.plen = esp.clen - skb->len - esp.tfclen;
439 esp.tailen = esp.tfclen + esp.plen + alen;
441 esp.nfrags = esp6_output_head(x, skb, &esp);
445 esph = ip_esp_hdr(skb);
446 esph->spi = x->id.spi;
448 esph->seq_no = htonl(XFRM_SKB_CB(skb)->seq.output.low);
449 esp.seqno = cpu_to_be64(XFRM_SKB_CB(skb)->seq.output.low +
450 ((u64)XFRM_SKB_CB(skb)->seq.output.hi << 32));
452 skb_push(skb, -skb_network_offset(skb));
454 return esp6_output_tail(x, skb, &esp);
457 static inline int esp_remove_trailer(struct sk_buff *skb)
459 struct xfrm_state *x = xfrm_input_state(skb);
460 struct xfrm_offload *xo = xfrm_offload(skb);
461 struct crypto_aead *aead = x->data;
462 int alen, hlen, elen;
468 alen = crypto_aead_authsize(aead);
469 hlen = sizeof(struct ip_esp_hdr) + crypto_aead_ivsize(aead);
470 elen = skb->len - hlen;
472 if (xo && (xo->flags & XFRM_ESP_NO_TRAILER)) {
477 ret = skb_copy_bits(skb, skb->len - alen - 2, nexthdr, 2);
482 if (padlen + 2 + alen >= elen) {
483 net_dbg_ratelimited("ipsec esp packet is garbage padlen=%d, elen=%d\n",
484 padlen + 2, elen - alen);
488 trimlen = alen + padlen + 2;
489 if (skb->ip_summed == CHECKSUM_COMPLETE) {
490 csumdiff = skb_checksum(skb, skb->len - trimlen, trimlen, 0);
491 skb->csum = csum_block_sub(skb->csum, csumdiff,
494 pskb_trim(skb, skb->len - trimlen);
502 int esp6_input_done2(struct sk_buff *skb, int err)
504 struct xfrm_state *x = xfrm_input_state(skb);
505 struct xfrm_offload *xo = xfrm_offload(skb);
506 struct crypto_aead *aead = x->data;
507 int hlen = sizeof(struct ip_esp_hdr) + crypto_aead_ivsize(aead);
508 int hdr_len = skb_network_header_len(skb);
510 if (!xo || (xo && !(xo->flags & CRYPTO_DONE)))
511 kfree(ESP_SKB_CB(skb)->tmp);
516 err = esp_remove_trailer(skb);
517 if (unlikely(err < 0))
520 skb_postpull_rcsum(skb, skb_network_header(skb),
521 skb_network_header_len(skb));
522 skb_pull_rcsum(skb, hlen);
523 if (x->props.mode == XFRM_MODE_TUNNEL)
524 skb_reset_transport_header(skb);
526 skb_set_transport_header(skb, -hdr_len);
528 /* RFC4303: Drop dummy packets without any error */
529 if (err == IPPROTO_NONE)
535 EXPORT_SYMBOL_GPL(esp6_input_done2);
537 static void esp_input_done(struct crypto_async_request *base, int err)
539 struct sk_buff *skb = base->data;
541 xfrm_input_resume(skb, esp6_input_done2(skb, err));
544 static void esp_input_restore_header(struct sk_buff *skb)
546 esp_restore_header(skb, 0);
550 static void esp_input_set_header(struct sk_buff *skb, __be32 *seqhi)
552 struct xfrm_state *x = xfrm_input_state(skb);
554 /* For ESN we move the header forward by 4 bytes to
555 * accomodate the high bits. We will move it back after
558 if ((x->props.flags & XFRM_STATE_ESN)) {
559 struct ip_esp_hdr *esph = skb_push(skb, 4);
562 esph->spi = esph->seq_no;
563 esph->seq_no = XFRM_SKB_CB(skb)->seq.input.hi;
567 static void esp_input_done_esn(struct crypto_async_request *base, int err)
569 struct sk_buff *skb = base->data;
571 esp_input_restore_header(skb);
572 esp_input_done(base, err);
575 static int esp6_input(struct xfrm_state *x, struct sk_buff *skb)
577 struct crypto_aead *aead = x->data;
578 struct aead_request *req;
579 struct sk_buff *trailer;
580 int ivlen = crypto_aead_ivsize(aead);
581 int elen = skb->len - sizeof(struct ip_esp_hdr) - ivlen;
589 struct scatterlist *sg;
591 if (!pskb_may_pull(skb, sizeof(struct ip_esp_hdr) + ivlen)) {
601 assoclen = sizeof(struct ip_esp_hdr);
604 if (x->props.flags & XFRM_STATE_ESN) {
605 seqhilen += sizeof(__be32);
606 assoclen += seqhilen;
609 if (!skb_cloned(skb)) {
610 if (!skb_is_nonlinear(skb)) {
614 } else if (!skb_has_frag_list(skb)) {
615 nfrags = skb_shinfo(skb)->nr_frags;
622 nfrags = skb_cow_data(skb, 0, &trailer);
630 tmp = esp_alloc_tmp(aead, nfrags, seqhilen);
634 ESP_SKB_CB(skb)->tmp = tmp;
635 seqhi = esp_tmp_seqhi(tmp);
636 iv = esp_tmp_iv(aead, tmp, seqhilen);
637 req = esp_tmp_req(aead, iv);
638 sg = esp_req_sg(aead, req);
640 esp_input_set_header(skb, seqhi);
642 sg_init_table(sg, nfrags);
643 ret = skb_to_sgvec(skb, sg, 0, skb->len);
644 if (unlikely(ret < 0)) {
649 skb->ip_summed = CHECKSUM_NONE;
651 if ((x->props.flags & XFRM_STATE_ESN))
652 aead_request_set_callback(req, 0, esp_input_done_esn, skb);
654 aead_request_set_callback(req, 0, esp_input_done, skb);
656 aead_request_set_crypt(req, sg, sg, elen + ivlen, iv);
657 aead_request_set_ad(req, assoclen);
659 ret = crypto_aead_decrypt(req);
660 if (ret == -EINPROGRESS)
663 if ((x->props.flags & XFRM_STATE_ESN))
664 esp_input_restore_header(skb);
666 ret = esp6_input_done2(skb, ret);
672 static int esp6_err(struct sk_buff *skb, struct inet6_skb_parm *opt,
673 u8 type, u8 code, int offset, __be32 info)
675 struct net *net = dev_net(skb->dev);
676 const struct ipv6hdr *iph = (const struct ipv6hdr *)skb->data;
677 struct ip_esp_hdr *esph = (struct ip_esp_hdr *)(skb->data + offset);
678 struct xfrm_state *x;
680 if (type != ICMPV6_PKT_TOOBIG &&
681 type != NDISC_REDIRECT)
684 x = xfrm_state_lookup(net, skb->mark, (const xfrm_address_t *)&iph->daddr,
685 esph->spi, IPPROTO_ESP, AF_INET6);
689 if (type == NDISC_REDIRECT)
690 ip6_redirect(skb, net, skb->dev->ifindex, 0,
691 sock_net_uid(net, NULL));
693 ip6_update_pmtu(skb, net, info, 0, 0, sock_net_uid(net, NULL));
699 static void esp6_destroy(struct xfrm_state *x)
701 struct crypto_aead *aead = x->data;
706 crypto_free_aead(aead);
709 static int esp_init_aead(struct xfrm_state *x)
711 char aead_name[CRYPTO_MAX_ALG_NAME];
712 struct crypto_aead *aead;
716 if (snprintf(aead_name, CRYPTO_MAX_ALG_NAME, "%s(%s)",
717 x->geniv, x->aead->alg_name) >= CRYPTO_MAX_ALG_NAME)
720 aead = crypto_alloc_aead(aead_name, 0, 0);
727 err = crypto_aead_setkey(aead, x->aead->alg_key,
728 (x->aead->alg_key_len + 7) / 8);
732 err = crypto_aead_setauthsize(aead, x->aead->alg_icv_len / 8);
740 static int esp_init_authenc(struct xfrm_state *x)
742 struct crypto_aead *aead;
743 struct crypto_authenc_key_param *param;
747 char authenc_name[CRYPTO_MAX_ALG_NAME];
757 if ((x->props.flags & XFRM_STATE_ESN)) {
758 if (snprintf(authenc_name, CRYPTO_MAX_ALG_NAME,
759 "%s%sauthencesn(%s,%s)%s",
760 x->geniv ?: "", x->geniv ? "(" : "",
761 x->aalg ? x->aalg->alg_name : "digest_null",
763 x->geniv ? ")" : "") >= CRYPTO_MAX_ALG_NAME)
766 if (snprintf(authenc_name, CRYPTO_MAX_ALG_NAME,
767 "%s%sauthenc(%s,%s)%s",
768 x->geniv ?: "", x->geniv ? "(" : "",
769 x->aalg ? x->aalg->alg_name : "digest_null",
771 x->geniv ? ")" : "") >= CRYPTO_MAX_ALG_NAME)
775 aead = crypto_alloc_aead(authenc_name, 0, 0);
782 keylen = (x->aalg ? (x->aalg->alg_key_len + 7) / 8 : 0) +
783 (x->ealg->alg_key_len + 7) / 8 + RTA_SPACE(sizeof(*param));
785 key = kmalloc(keylen, GFP_KERNEL);
791 rta->rta_type = CRYPTO_AUTHENC_KEYA_PARAM;
792 rta->rta_len = RTA_LENGTH(sizeof(*param));
793 param = RTA_DATA(rta);
794 p += RTA_SPACE(sizeof(*param));
797 struct xfrm_algo_desc *aalg_desc;
799 memcpy(p, x->aalg->alg_key, (x->aalg->alg_key_len + 7) / 8);
800 p += (x->aalg->alg_key_len + 7) / 8;
802 aalg_desc = xfrm_aalg_get_byname(x->aalg->alg_name, 0);
806 if (aalg_desc->uinfo.auth.icv_fullbits / 8 !=
807 crypto_aead_authsize(aead)) {
808 pr_info("ESP: %s digestsize %u != %hu\n",
810 crypto_aead_authsize(aead),
811 aalg_desc->uinfo.auth.icv_fullbits / 8);
815 err = crypto_aead_setauthsize(
816 aead, x->aalg->alg_trunc_len / 8);
821 param->enckeylen = cpu_to_be32((x->ealg->alg_key_len + 7) / 8);
822 memcpy(p, x->ealg->alg_key, (x->ealg->alg_key_len + 7) / 8);
824 err = crypto_aead_setkey(aead, key, keylen);
833 static int esp6_init_state(struct xfrm_state *x)
835 struct crypto_aead *aead;
845 err = esp_init_aead(x);
847 err = esp_init_authenc(x);
854 x->props.header_len = sizeof(struct ip_esp_hdr) +
855 crypto_aead_ivsize(aead);
856 switch (x->props.mode) {
858 if (x->sel.family != AF_INET6)
859 x->props.header_len += IPV4_BEET_PHMAXLEN +
860 (sizeof(struct ipv6hdr) - sizeof(struct iphdr));
863 case XFRM_MODE_TRANSPORT:
865 case XFRM_MODE_TUNNEL:
866 x->props.header_len += sizeof(struct ipv6hdr);
870 align = ALIGN(crypto_aead_blocksize(aead), 4);
871 x->props.trailer_len = align + 1 + crypto_aead_authsize(aead);
877 static int esp6_rcv_cb(struct sk_buff *skb, int err)
882 static const struct xfrm_type esp6_type = {
883 .description = "ESP6",
884 .owner = THIS_MODULE,
885 .proto = IPPROTO_ESP,
886 .flags = XFRM_TYPE_REPLAY_PROT,
887 .init_state = esp6_init_state,
888 .destructor = esp6_destroy,
890 .output = esp6_output,
891 .hdr_offset = xfrm6_find_1stfragopt,
894 static struct xfrm6_protocol esp6_protocol = {
895 .handler = xfrm6_rcv,
896 .cb_handler = esp6_rcv_cb,
897 .err_handler = esp6_err,
901 static int __init esp6_init(void)
903 if (xfrm_register_type(&esp6_type, AF_INET6) < 0) {
904 pr_info("%s: can't add xfrm type\n", __func__);
907 if (xfrm6_protocol_register(&esp6_protocol, IPPROTO_ESP) < 0) {
908 pr_info("%s: can't add protocol\n", __func__);
909 xfrm_unregister_type(&esp6_type, AF_INET6);
916 static void __exit esp6_fini(void)
918 if (xfrm6_protocol_deregister(&esp6_protocol, IPPROTO_ESP) < 0)
919 pr_info("%s: can't remove protocol\n", __func__);
920 xfrm_unregister_type(&esp6_type, AF_INET6);
923 module_init(esp6_init);
924 module_exit(esp6_fini);
926 MODULE_LICENSE("GPL");
927 MODULE_ALIAS_XFRM_TYPE(AF_INET6, XFRM_PROTO_ESP);