2 * Copyright (C)2002 USAGI/WIDE Project
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
19 * Mitsuru KANDA @USAGI : IPv6 Support
20 * Kazunori MIYAZAWA @USAGI :
23 * This file is derived from net/ipv4/esp.c
26 #define pr_fmt(fmt) "IPv6: " fmt
28 #include <crypto/aead.h>
29 #include <crypto/authenc.h>
30 #include <linux/err.h>
31 #include <linux/module.h>
35 #include <linux/scatterlist.h>
36 #include <linux/kernel.h>
37 #include <linux/pfkeyv2.h>
38 #include <linux/random.h>
39 #include <linux/slab.h>
40 #include <linux/spinlock.h>
41 #include <net/ip6_route.h>
44 #include <net/protocol.h>
45 #include <linux/icmpv6.h>
47 #include <linux/highmem.h>
50 struct xfrm_skb_cb xfrm;
54 #define ESP_SKB_CB(__skb) ((struct esp_skb_cb *)&((__skb)->cb[0]))
56 static u32 esp6_get_mtu(struct xfrm_state *x, int mtu);
59 * Allocate an AEAD request structure with extra space for SG and IV.
61 * For alignment considerations the upper 32 bits of the sequence number are
62 * placed at the front, if present. Followed by the IV, the request and finally
65 * TODO: Use spare space in skb for this where possible.
67 static void *esp_alloc_tmp(struct crypto_aead *aead, int nfrags, int seqihlen)
73 len += crypto_aead_ivsize(aead);
76 len += crypto_aead_alignmask(aead) &
77 ~(crypto_tfm_ctx_alignment() - 1);
78 len = ALIGN(len, crypto_tfm_ctx_alignment());
81 len += sizeof(struct aead_request) + crypto_aead_reqsize(aead);
82 len = ALIGN(len, __alignof__(struct scatterlist));
84 len += sizeof(struct scatterlist) * nfrags;
86 return kmalloc(len, GFP_ATOMIC);
89 static inline __be32 *esp_tmp_seqhi(void *tmp)
91 return PTR_ALIGN((__be32 *)tmp, __alignof__(__be32));
94 static inline u8 *esp_tmp_iv(struct crypto_aead *aead, void *tmp, int seqhilen)
96 return crypto_aead_ivsize(aead) ?
97 PTR_ALIGN((u8 *)tmp + seqhilen,
98 crypto_aead_alignmask(aead) + 1) : tmp + seqhilen;
101 static inline struct aead_request *esp_tmp_req(struct crypto_aead *aead, u8 *iv)
103 struct aead_request *req;
105 req = (void *)PTR_ALIGN(iv + crypto_aead_ivsize(aead),
106 crypto_tfm_ctx_alignment());
107 aead_request_set_tfm(req, aead);
111 static inline struct scatterlist *esp_req_sg(struct crypto_aead *aead,
112 struct aead_request *req)
114 return (void *)ALIGN((unsigned long)(req + 1) +
115 crypto_aead_reqsize(aead),
116 __alignof__(struct scatterlist));
119 static void esp_ssg_unref(struct xfrm_state *x, void *tmp)
122 struct crypto_aead *aead = x->data;
125 struct aead_request *req;
126 struct scatterlist *sg;
128 if (x->props.flags & XFRM_STATE_ESN)
129 seqhilen += sizeof(__be32);
131 seqhi = esp_tmp_seqhi(tmp);
132 iv = esp_tmp_iv(aead, tmp, seqhilen);
133 req = esp_tmp_req(aead, iv);
135 /* Unref skb_frag_pages in the src scatterlist if necessary.
136 * Skip the first sg which comes from skb->data.
138 if (req->src != req->dst)
139 for (sg = sg_next(req->src); sg; sg = sg_next(sg))
140 put_page(sg_page(sg));
143 static void esp_output_done(struct crypto_async_request *base, int err)
145 struct sk_buff *skb = base->data;
147 struct dst_entry *dst = skb_dst(skb);
148 struct xfrm_state *x = dst->xfrm;
150 tmp = ESP_SKB_CB(skb)->tmp;
151 esp_ssg_unref(x, tmp);
153 xfrm_output_resume(skb, err);
156 /* Move ESP header back into place. */
157 static void esp_restore_header(struct sk_buff *skb, unsigned int offset)
159 struct ip_esp_hdr *esph = (void *)(skb->data + offset);
160 void *tmp = ESP_SKB_CB(skb)->tmp;
161 __be32 *seqhi = esp_tmp_seqhi(tmp);
163 esph->seq_no = esph->spi;
167 static void esp_output_restore_header(struct sk_buff *skb)
169 esp_restore_header(skb, skb_transport_offset(skb) - sizeof(__be32));
172 static struct ip_esp_hdr *esp_output_set_esn(struct sk_buff *skb,
173 struct xfrm_state *x,
174 struct ip_esp_hdr *esph,
177 /* For ESN we move the header forward by 4 bytes to
178 * accomodate the high bits. We will move it back after
181 if ((x->props.flags & XFRM_STATE_ESN)) {
182 struct xfrm_offload *xo = xfrm_offload(skb);
184 esph = (void *)(skb_transport_header(skb) - sizeof(__be32));
187 esph->seq_no = htonl(xo->seq.hi);
189 esph->seq_no = htonl(XFRM_SKB_CB(skb)->seq.output.hi);
192 esph->spi = x->id.spi;
197 static void esp_output_done_esn(struct crypto_async_request *base, int err)
199 struct sk_buff *skb = base->data;
201 esp_output_restore_header(skb);
202 esp_output_done(base, err);
205 static void esp_output_fill_trailer(u8 *tail, int tfclen, int plen, __u8 proto)
207 /* Fill padding... */
209 memset(tail, 0, tfclen);
214 for (i = 0; i < plen - 2; i++)
217 tail[plen - 2] = plen - 2;
218 tail[plen - 1] = proto;
221 int esp6_output_head(struct xfrm_state *x, struct sk_buff *skb, struct esp_info *esp)
227 struct ip_esp_hdr *esph;
228 struct sk_buff *trailer;
229 int tailen = esp->tailen;
231 esph = ip_esp_hdr(skb);
233 if (!skb_cloned(skb)) {
234 if (tailen <= skb_availroom(skb)) {
237 tail = skb_tail_pointer(trailer);
240 } else if ((skb_shinfo(skb)->nr_frags < MAX_SKB_FRAGS)
241 && !skb_has_frag_list(skb)) {
243 struct sock *sk = skb->sk;
244 struct page_frag *pfrag = &x->xfrag;
246 esp->inplace = false;
248 allocsize = ALIGN(tailen, L1_CACHE_BYTES);
250 spin_lock_bh(&x->lock);
252 if (unlikely(!skb_page_frag_refill(allocsize, pfrag, GFP_ATOMIC))) {
253 spin_unlock_bh(&x->lock);
260 vaddr = kmap_atomic(page);
262 tail = vaddr + pfrag->offset;
264 esp_output_fill_trailer(tail, esp->tfclen, esp->plen, esp->proto);
266 kunmap_atomic(vaddr);
268 spin_unlock_bh(&x->lock);
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;
280 skb->data_len += tailen;
281 skb->truesize += tailen;
283 atomic_add(tailen, &sk->sk_wmem_alloc);
290 nfrags = skb_cow_data(skb, tailen, &trailer);
293 tail = skb_tail_pointer(trailer);
296 esp_output_fill_trailer(tail, esp->tfclen, esp->plen, esp->proto);
297 pskb_put(skb, trailer, tailen);
302 EXPORT_SYMBOL_GPL(esp6_output_head);
304 int esp6_output_tail(struct xfrm_state *x, struct sk_buff *skb, struct esp_info *esp)
314 struct ip_esp_hdr *esph;
315 struct aead_request *req;
316 struct crypto_aead *aead;
317 struct scatterlist *sg, *dsg;
320 assoclen = sizeof(struct ip_esp_hdr);
323 if (x->props.flags & XFRM_STATE_ESN) {
324 seqhilen += sizeof(__be32);
325 assoclen += sizeof(__be32);
329 alen = crypto_aead_authsize(aead);
330 ivlen = crypto_aead_ivsize(aead);
332 tmp = esp_alloc_tmp(aead, esp->nfrags + 2, seqhilen);
334 spin_unlock_bh(&x->lock);
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 skb_to_sgvec(skb, sg,
353 (unsigned char *)esph - skb->data,
354 assoclen + ivlen + esp->clen + alen);
358 struct page_frag *pfrag = &x->xfrag;
360 allocsize = ALIGN(skb->data_len, L1_CACHE_BYTES);
362 spin_lock_bh(&x->lock);
363 if (unlikely(!skb_page_frag_refill(allocsize, pfrag, GFP_ATOMIC))) {
364 spin_unlock_bh(&x->lock);
369 skb_shinfo(skb)->nr_frags = 1;
373 /* replace page frags in skb with new page */
374 __skb_fill_page_desc(skb, 0, page, pfrag->offset, skb->data_len);
375 pfrag->offset = pfrag->offset + allocsize;
376 spin_unlock_bh(&x->lock);
378 sg_init_table(dsg, skb_shinfo(skb)->nr_frags + 1);
379 skb_to_sgvec(skb, dsg,
380 (unsigned char *)esph - skb->data,
381 assoclen + ivlen + esp->clen + alen);
384 if ((x->props.flags & XFRM_STATE_ESN))
385 aead_request_set_callback(req, 0, esp_output_done_esn, skb);
387 aead_request_set_callback(req, 0, esp_output_done, skb);
389 aead_request_set_crypt(req, sg, dsg, ivlen + esp->clen, iv);
390 aead_request_set_ad(req, assoclen);
392 memset(iv, 0, ivlen);
393 memcpy(iv + ivlen - min(ivlen, 8), (u8 *)&esp->seqno + 8 - min(ivlen, 8),
396 ESP_SKB_CB(skb)->tmp = tmp;
397 err = crypto_aead_encrypt(req);
408 if ((x->props.flags & XFRM_STATE_ESN))
409 esp_output_restore_header(skb);
413 esp_ssg_unref(x, tmp);
419 EXPORT_SYMBOL_GPL(esp6_output_tail);
421 static int esp6_output(struct xfrm_state *x, struct sk_buff *skb)
425 struct ip_esp_hdr *esph;
426 struct crypto_aead *aead;
431 esp.proto = *skb_mac_header(skb);
432 *skb_mac_header(skb) = IPPROTO_ESP;
434 /* skb is pure payload to encrypt */
437 alen = crypto_aead_authsize(aead);
441 struct xfrm_dst *dst = (struct xfrm_dst *)skb_dst(skb);
444 padto = min(x->tfcpad, esp6_get_mtu(x, dst->child_mtu_cached));
445 if (skb->len < padto)
446 esp.tfclen = padto - skb->len;
448 blksize = ALIGN(crypto_aead_blocksize(aead), 4);
449 esp.clen = ALIGN(skb->len + 2 + esp.tfclen, blksize);
450 esp.plen = esp.clen - skb->len - esp.tfclen;
451 esp.tailen = esp.tfclen + esp.plen + alen;
453 esp.nfrags = esp6_output_head(x, skb, &esp);
457 esph = ip_esp_hdr(skb);
458 esph->spi = x->id.spi;
460 esph->seq_no = htonl(XFRM_SKB_CB(skb)->seq.output.low);
461 esp.seqno = cpu_to_be64(XFRM_SKB_CB(skb)->seq.output.low +
462 ((u64)XFRM_SKB_CB(skb)->seq.output.hi << 32));
464 skb_push(skb, -skb_network_offset(skb));
466 return esp6_output_tail(x, skb, &esp);
469 int esp6_input_done2(struct sk_buff *skb, int err)
471 struct xfrm_state *x = xfrm_input_state(skb);
472 struct xfrm_offload *xo = xfrm_offload(skb);
473 struct crypto_aead *aead = x->data;
474 int alen = crypto_aead_authsize(aead);
475 int hlen = sizeof(struct ip_esp_hdr) + crypto_aead_ivsize(aead);
476 int elen = skb->len - hlen;
477 int hdr_len = skb_network_header_len(skb);
481 if (!xo || (xo && !(xo->flags & CRYPTO_DONE)))
482 kfree(ESP_SKB_CB(skb)->tmp);
487 if (skb_copy_bits(skb, skb->len - alen - 2, nexthdr, 2))
492 if (padlen + 2 + alen >= elen) {
493 net_dbg_ratelimited("ipsec esp packet is garbage padlen=%d, elen=%d\n",
494 padlen + 2, elen - alen);
498 /* ... check padding bits here. Silly. :-) */
500 pskb_trim(skb, skb->len - alen - padlen - 2);
501 __skb_pull(skb, hlen);
502 if (x->props.mode == XFRM_MODE_TUNNEL)
503 skb_reset_transport_header(skb);
505 skb_set_transport_header(skb, -hdr_len);
509 /* RFC4303: Drop dummy packets without any error */
510 if (err == IPPROTO_NONE)
516 EXPORT_SYMBOL_GPL(esp6_input_done2);
518 static void esp_input_done(struct crypto_async_request *base, int err)
520 struct sk_buff *skb = base->data;
522 xfrm_input_resume(skb, esp6_input_done2(skb, err));
525 static void esp_input_restore_header(struct sk_buff *skb)
527 esp_restore_header(skb, 0);
531 static void esp_input_set_header(struct sk_buff *skb, __be32 *seqhi)
533 struct xfrm_state *x = xfrm_input_state(skb);
534 struct ip_esp_hdr *esph = (struct ip_esp_hdr *)skb->data;
536 /* For ESN we move the header forward by 4 bytes to
537 * accomodate the high bits. We will move it back after
540 if ((x->props.flags & XFRM_STATE_ESN)) {
541 esph = (void *)skb_push(skb, 4);
543 esph->spi = esph->seq_no;
544 esph->seq_no = XFRM_SKB_CB(skb)->seq.input.hi;
548 static void esp_input_done_esn(struct crypto_async_request *base, int err)
550 struct sk_buff *skb = base->data;
552 esp_input_restore_header(skb);
553 esp_input_done(base, err);
556 static int esp6_input(struct xfrm_state *x, struct sk_buff *skb)
558 struct ip_esp_hdr *esph;
559 struct crypto_aead *aead = x->data;
560 struct aead_request *req;
561 struct sk_buff *trailer;
562 int ivlen = crypto_aead_ivsize(aead);
563 int elen = skb->len - sizeof(*esph) - ivlen;
571 struct scatterlist *sg;
573 if (!pskb_may_pull(skb, sizeof(*esph) + ivlen)) {
583 assoclen = sizeof(*esph);
586 if (x->props.flags & XFRM_STATE_ESN) {
587 seqhilen += sizeof(__be32);
588 assoclen += seqhilen;
591 if (!skb_cloned(skb)) {
592 if (!skb_is_nonlinear(skb)) {
596 } else if (!skb_has_frag_list(skb)) {
597 nfrags = skb_shinfo(skb)->nr_frags;
604 nfrags = skb_cow_data(skb, 0, &trailer);
612 tmp = esp_alloc_tmp(aead, nfrags, seqhilen);
616 ESP_SKB_CB(skb)->tmp = tmp;
617 seqhi = esp_tmp_seqhi(tmp);
618 iv = esp_tmp_iv(aead, tmp, seqhilen);
619 req = esp_tmp_req(aead, iv);
620 sg = esp_req_sg(aead, req);
622 esp_input_set_header(skb, seqhi);
624 sg_init_table(sg, nfrags);
625 skb_to_sgvec(skb, sg, 0, skb->len);
627 skb->ip_summed = CHECKSUM_NONE;
629 if ((x->props.flags & XFRM_STATE_ESN))
630 aead_request_set_callback(req, 0, esp_input_done_esn, skb);
632 aead_request_set_callback(req, 0, esp_input_done, skb);
634 aead_request_set_crypt(req, sg, sg, elen + ivlen, iv);
635 aead_request_set_ad(req, assoclen);
637 ret = crypto_aead_decrypt(req);
638 if (ret == -EINPROGRESS)
641 if ((x->props.flags & XFRM_STATE_ESN))
642 esp_input_restore_header(skb);
644 ret = esp6_input_done2(skb, ret);
650 static u32 esp6_get_mtu(struct xfrm_state *x, int mtu)
652 struct crypto_aead *aead = x->data;
653 u32 blksize = ALIGN(crypto_aead_blocksize(aead), 4);
654 unsigned int net_adj;
656 if (x->props.mode != XFRM_MODE_TUNNEL)
657 net_adj = sizeof(struct ipv6hdr);
661 return ((mtu - x->props.header_len - crypto_aead_authsize(aead) -
662 net_adj) & ~(blksize - 1)) + net_adj - 2;
665 static int esp6_err(struct sk_buff *skb, struct inet6_skb_parm *opt,
666 u8 type, u8 code, int offset, __be32 info)
668 struct net *net = dev_net(skb->dev);
669 const struct ipv6hdr *iph = (const struct ipv6hdr *)skb->data;
670 struct ip_esp_hdr *esph = (struct ip_esp_hdr *)(skb->data + offset);
671 struct xfrm_state *x;
673 if (type != ICMPV6_PKT_TOOBIG &&
674 type != NDISC_REDIRECT)
677 x = xfrm_state_lookup(net, skb->mark, (const xfrm_address_t *)&iph->daddr,
678 esph->spi, IPPROTO_ESP, AF_INET6);
682 if (type == NDISC_REDIRECT)
683 ip6_redirect(skb, net, skb->dev->ifindex, 0,
684 sock_net_uid(net, NULL));
686 ip6_update_pmtu(skb, net, info, 0, 0, sock_net_uid(net, NULL));
692 static void esp6_destroy(struct xfrm_state *x)
694 struct crypto_aead *aead = x->data;
699 crypto_free_aead(aead);
702 static int esp_init_aead(struct xfrm_state *x)
704 char aead_name[CRYPTO_MAX_ALG_NAME];
705 struct crypto_aead *aead;
710 if (snprintf(aead_name, CRYPTO_MAX_ALG_NAME, "%s(%s)",
711 x->geniv, x->aead->alg_name) >= CRYPTO_MAX_ALG_NAME)
714 if (x->xso.offload_handle)
715 mask |= CRYPTO_ALG_ASYNC;
717 aead = crypto_alloc_aead(aead_name, 0, mask);
724 err = crypto_aead_setkey(aead, x->aead->alg_key,
725 (x->aead->alg_key_len + 7) / 8);
729 err = crypto_aead_setauthsize(aead, x->aead->alg_icv_len / 8);
737 static int esp_init_authenc(struct xfrm_state *x)
739 struct crypto_aead *aead;
740 struct crypto_authenc_key_param *param;
744 char authenc_name[CRYPTO_MAX_ALG_NAME];
755 if ((x->props.flags & XFRM_STATE_ESN)) {
756 if (snprintf(authenc_name, CRYPTO_MAX_ALG_NAME,
757 "%s%sauthencesn(%s,%s)%s",
758 x->geniv ?: "", x->geniv ? "(" : "",
759 x->aalg ? x->aalg->alg_name : "digest_null",
761 x->geniv ? ")" : "") >= CRYPTO_MAX_ALG_NAME)
764 if (snprintf(authenc_name, CRYPTO_MAX_ALG_NAME,
765 "%s%sauthenc(%s,%s)%s",
766 x->geniv ?: "", x->geniv ? "(" : "",
767 x->aalg ? x->aalg->alg_name : "digest_null",
769 x->geniv ? ")" : "") >= CRYPTO_MAX_ALG_NAME)
773 if (x->xso.offload_handle)
774 mask |= CRYPTO_ALG_ASYNC;
776 aead = crypto_alloc_aead(authenc_name, 0, mask);
783 keylen = (x->aalg ? (x->aalg->alg_key_len + 7) / 8 : 0) +
784 (x->ealg->alg_key_len + 7) / 8 + RTA_SPACE(sizeof(*param));
786 key = kmalloc(keylen, GFP_KERNEL);
792 rta->rta_type = CRYPTO_AUTHENC_KEYA_PARAM;
793 rta->rta_len = RTA_LENGTH(sizeof(*param));
794 param = RTA_DATA(rta);
795 p += RTA_SPACE(sizeof(*param));
798 struct xfrm_algo_desc *aalg_desc;
800 memcpy(p, x->aalg->alg_key, (x->aalg->alg_key_len + 7) / 8);
801 p += (x->aalg->alg_key_len + 7) / 8;
803 aalg_desc = xfrm_aalg_get_byname(x->aalg->alg_name, 0);
807 if (aalg_desc->uinfo.auth.icv_fullbits / 8 !=
808 crypto_aead_authsize(aead)) {
809 pr_info("ESP: %s digestsize %u != %hu\n",
811 crypto_aead_authsize(aead),
812 aalg_desc->uinfo.auth.icv_fullbits / 8);
816 err = crypto_aead_setauthsize(
817 aead, x->aalg->alg_trunc_len / 8);
822 param->enckeylen = cpu_to_be32((x->ealg->alg_key_len + 7) / 8);
823 memcpy(p, x->ealg->alg_key, (x->ealg->alg_key_len + 7) / 8);
825 err = crypto_aead_setkey(aead, key, keylen);
834 static int esp6_init_state(struct xfrm_state *x)
836 struct crypto_aead *aead;
846 err = esp_init_aead(x);
848 err = esp_init_authenc(x);
855 x->props.header_len = sizeof(struct ip_esp_hdr) +
856 crypto_aead_ivsize(aead);
857 switch (x->props.mode) {
859 if (x->sel.family != AF_INET6)
860 x->props.header_len += IPV4_BEET_PHMAXLEN +
861 (sizeof(struct ipv6hdr) - sizeof(struct iphdr));
863 case XFRM_MODE_TRANSPORT:
865 case XFRM_MODE_TUNNEL:
866 x->props.header_len += sizeof(struct ipv6hdr);
872 align = ALIGN(crypto_aead_blocksize(aead), 4);
873 x->props.trailer_len = align + 1 + crypto_aead_authsize(aead);
879 static int esp6_rcv_cb(struct sk_buff *skb, int err)
884 static const struct xfrm_type esp6_type = {
885 .description = "ESP6",
886 .owner = THIS_MODULE,
887 .proto = IPPROTO_ESP,
888 .flags = XFRM_TYPE_REPLAY_PROT,
889 .init_state = esp6_init_state,
890 .destructor = esp6_destroy,
891 .get_mtu = esp6_get_mtu,
893 .output = esp6_output,
894 .hdr_offset = xfrm6_find_1stfragopt,
897 static struct xfrm6_protocol esp6_protocol = {
898 .handler = xfrm6_rcv,
899 .cb_handler = esp6_rcv_cb,
900 .err_handler = esp6_err,
904 static int __init esp6_init(void)
906 if (xfrm_register_type(&esp6_type, AF_INET6) < 0) {
907 pr_info("%s: can't add xfrm type\n", __func__);
910 if (xfrm6_protocol_register(&esp6_protocol, IPPROTO_ESP) < 0) {
911 pr_info("%s: can't add protocol\n", __func__);
912 xfrm_unregister_type(&esp6_type, AF_INET6);
919 static void __exit esp6_fini(void)
921 if (xfrm6_protocol_deregister(&esp6_protocol, IPPROTO_ESP) < 0)
922 pr_info("%s: can't remove protocol\n", __func__);
923 if (xfrm_unregister_type(&esp6_type, AF_INET6) < 0)
924 pr_info("%s: can't remove xfrm type\n", __func__);
927 module_init(esp6_init);
928 module_exit(esp6_fini);
930 MODULE_LICENSE("GPL");
931 MODULE_ALIAS_XFRM_TYPE(AF_INET6, XFRM_PROTO_ESP);