2 * Copyright (c) 2008 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 /* $FreeBSD: src/sys/netinet6/esp_output.c,v 1.1.2.3 2002/04/28 05:40:26 suz Exp $ */
30 /* $KAME: esp_output.c,v 1.44 2001/07/26 06:53:15 jinmei Exp $ */
33 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
44 * 3. Neither the name of the project nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
48 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 * RFC1827/2406 Encapsulated Security Payload.
67 #include <sys/param.h>
68 #include <sys/systm.h>
69 #include <sys/malloc.h>
71 #include <sys/domain.h>
72 #include <sys/protosw.h>
73 #include <sys/socket.h>
74 #include <sys/socketvar.h>
75 #include <sys/errno.h>
77 #include <sys/kernel.h>
78 #include <sys/syslog.h>
81 #include <net/route.h>
83 #include <netinet/in.h>
84 #include <netinet/in_systm.h>
85 #include <netinet/ip.h>
86 #include <netinet/in_var.h>
87 #include <netinet/udp.h> /* for nat traversal */
90 #include <netinet/ip6.h>
91 #include <netinet6/ip6_var.h>
92 #include <netinet/icmp6.h>
95 #include <netinet6/ipsec.h>
97 #include <netinet6/ipsec6.h>
99 #include <netinet6/ah.h>
101 #include <netinet6/ah6.h>
103 #include <netinet6/esp.h>
105 #include <netinet6/esp6.h>
107 #include <netkey/key.h>
108 #include <netkey/keydb.h>
110 #include <net/net_osdep.h>
112 #include <sys/kdebug.h>
113 #define DBG_LAYER_BEG NETDBG_CODE(DBG_NETIPSEC, 1)
114 #define DBG_LAYER_END NETDBG_CODE(DBG_NETIPSEC, 3)
115 #define DBG_FNC_ESPOUT NETDBG_CODE(DBG_NETIPSEC, (4 << 8))
116 #define DBG_FNC_ENCRYPT NETDBG_CODE(DBG_NETIPSEC, (5 << 8))
118 static int esp_output(struct mbuf
*, u_char
*, struct mbuf
*,
119 int, struct secasvar
*sav
);
121 extern int esp_udp_encap_port
;
122 extern u_int32_t natt_now
;
124 extern lck_mtx_t
*sadb_mutex
;
127 * compute ESP header size.
131 struct ipsecrequest
*isr
;
136 panic("esp_hdrsiz: NULL was passed.\n");
140 lck_mtx_lock(sadb_mutex
);
142 struct secasvar
*sav
;
143 const struct esp_algorithm
*algo
;
144 const struct ah_algorithm
*aalgo
;
150 /*%%%% this needs to change - no sav in ipsecrequest any more */
153 if (isr
->saidx
.proto
!= IPPROTO_ESP
)
154 panic("unsupported mode passed to esp_hdrsiz");
158 if (sav
->state
!= SADB_SASTATE_MATURE
159 && sav
->state
!= SADB_SASTATE_DYING
)
162 /* we need transport mode ESP. */
163 algo
= esp_algorithm_lookup(sav
->alg_enc
);
171 maxpad
= algo
->padbound
;
174 maxpad
+= 1; /* maximum 'extendsiz' is padbound + 1, see esp_output */
176 if (sav
->flags
& SADB_X_EXT_OLD
) {
178 hdrsiz
= sizeof(struct esp
) + ivlen
+ maxpad
;
181 aalgo
= ah_algorithm_lookup(sav
->alg_auth
);
182 if (aalgo
&& sav
->replay
&& sav
->key_auth
)
183 authlen
= (aalgo
->sumsiz
)(sav
);
186 hdrsiz
= sizeof(struct newesp
) + ivlen
+ maxpad
+ authlen
;
190 * If the security association indicates that NATT is required,
191 * add the size of the NATT encapsulation header:
193 if ((sav
->flags
& SADB_X_EXT_NATT
) != 0) hdrsiz
+= sizeof(struct udphdr
) + 4;
195 lck_mtx_unlock(sadb_mutex
);
199 lck_mtx_unlock(sadb_mutex
);
203 * sizeof(struct newesp) > sizeof(struct esp). (8)
204 * esp_max_ivlen() = max ivlen for CBC mode
205 * 17 = (maximum padding length without random padding length)
206 * + (Pad Length field) + (Next Header field).
207 * 64 = maximum ICV we support.
208 * sizeof(struct udphdr) in case NAT traversal is used
210 return sizeof(struct newesp
) + esp_max_ivlen() + 17 + AH_MAXSUMSIZE
+ sizeof(struct udphdr
);
214 * Modify the packet so that the payload is encrypted.
215 * The mbuf (m) must start with IPv4 or IPv6 header.
216 * On failure, free the given mbuf and return NULL.
221 * IP ......... payload
222 * during the encryption:
223 * m nexthdrp mprev md
225 * IP ............... esp iv payload pad padlen nxthdr
226 * <--><-><------><--------------->
227 * esplen plen extendsiz
231 * <-----------------> espoff
234 esp_output(m
, nexthdrp
, md
, af
, sav
)
239 struct secasvar
*sav
;
244 struct esptail
*esptail
;
245 const struct esp_algorithm
*algo
;
248 size_t plen
; /*payload length to be encrypted*/
254 struct ipsecstat
*stat
;
255 struct udphdr
*udp
= NULL
;
256 int udp_encapsulate
= (sav
->flags
& SADB_X_EXT_NATT
&& af
== AF_INET
&&
257 (esp_udp_encap_port
& 0xFFFF) != 0);
259 KERNEL_DEBUG(DBG_FNC_ESPOUT
| DBG_FUNC_START
, sav
->ivlen
,0,0,0,0);
274 ipseclog((LOG_ERR
, "esp_output: unsupported af %d\n", af
));
275 KERNEL_DEBUG(DBG_FNC_ESPOUT
| DBG_FUNC_END
, 1,0,0,0,0);
276 return 0; /* no change at all */
279 /* some sanity check */
280 if ((sav
->flags
& SADB_X_EXT_OLD
) == 0 && !sav
->replay
) {
287 ip
= mtod(m
, struct ip
*);
288 ipseclog((LOG_DEBUG
, "esp4_output: internal error: "
289 "sav->replay is null: %x->%x, SPI=%u\n",
290 (u_int32_t
)ntohl(ip
->ip_src
.s_addr
),
291 (u_int32_t
)ntohl(ip
->ip_dst
.s_addr
),
292 (u_int32_t
)ntohl(sav
->spi
)));
293 IPSEC_STAT_INCREMENT(ipsecstat
.out_inval
);
299 ipseclog((LOG_DEBUG
, "esp6_output: internal error: "
300 "sav->replay is null: SPI=%u\n",
301 (u_int32_t
)ntohl(sav
->spi
)));
302 IPSEC_STAT_INCREMENT(ipsec6stat
.out_inval
);
306 panic("esp_output: should not reach here");
309 KERNEL_DEBUG(DBG_FNC_ESPOUT
| DBG_FUNC_END
, 2,0,0,0,0);
313 algo
= esp_algorithm_lookup(sav
->alg_enc
);
315 ipseclog((LOG_ERR
, "esp_output: unsupported algorithm: "
316 "SPI=%u\n", (u_int32_t
)ntohl(sav
->spi
)));
318 KERNEL_DEBUG(DBG_FNC_ESPOUT
| DBG_FUNC_END
, 3,0,0,0,0);
325 panic("invalid ivlen");
331 * XXX inserts ESP header right after IPv4 header. should
332 * chase the header chain.
333 * XXX sequential number
336 struct ip
*ip
= NULL
;
339 struct ip6_hdr
*ip6
= NULL
;
341 size_t esplen
; /* sizeof(struct esp/newesp) */
342 size_t esphlen
; /* sizeof(struct esp/newesp) + ivlen */
343 size_t hlen
= 0; /* ip header len */
345 if (sav
->flags
& SADB_X_EXT_OLD
) {
347 esplen
= sizeof(struct esp
);
350 if (sav
->flags
& SADB_X_EXT_DERIV
)
351 esplen
= sizeof(struct esp
);
353 esplen
= sizeof(struct newesp
);
355 esphlen
= esplen
+ ivlen
;
357 for (mprev
= m
; mprev
&& mprev
->m_next
!= md
; mprev
= mprev
->m_next
)
359 if (mprev
== NULL
|| mprev
->m_next
!= md
) {
360 ipseclog((LOG_DEBUG
, "esp%d_output: md is not in chain\n",
363 KERNEL_DEBUG(DBG_FNC_ESPOUT
| DBG_FUNC_END
, 4,0,0,0,0);
368 for (n
= md
; n
; n
= n
->m_next
)
374 ip
= mtod(m
, struct ip
*);
376 hlen
= IP_VHL_HL(ip
->ip_vhl
) << 2;
378 hlen
= ip
->ip_hl
<< 2;
384 ip6
= mtod(m
, struct ip6_hdr
*);
390 /* make the packet over-writable */
391 mprev
->m_next
= NULL
;
392 if ((md
= ipsec_copypkt(md
)) == NULL
) {
400 * Translate UDP source port back to its original value.
401 * SADB_X_EXT_NATT_MULTIPLEUSERS is only set for transort mode.
403 if ((sav
->flags
& SADB_X_EXT_NATT_MULTIPLEUSERS
) != 0) {
404 /* if not UDP - drop it */
405 if (ip
->ip_p
!= IPPROTO_UDP
) {
406 IPSEC_STAT_INCREMENT(ipsecstat
.out_inval
);
412 udp
= mtod(md
, struct udphdr
*);
414 /* if src port not set in sav - find it */
415 if (sav
->natt_encapsulated_src_port
== 0)
416 if (key_natt_get_translated_port(sav
) == 0) {
421 if (sav
->remote_ike_port
== htons(udp
->uh_dport
)) {
422 /* translate UDP port */
423 udp
->uh_dport
= sav
->natt_encapsulated_src_port
;
424 udp
->uh_sum
= 0; /* don't need checksum with ESP auth */
426 /* drop the packet - can't translate the port */
427 IPSEC_STAT_INCREMENT(ipsecstat
.out_inval
);
435 espoff
= m
->m_pkthdr
.len
- plen
;
437 if (udp_encapsulate
) {
438 esphlen
+= sizeof(struct udphdr
);
439 espoff
+= sizeof(struct udphdr
);
443 * grow the mbuf to accomodate ESP header.
444 * before: IP ... payload
445 * after: IP ... [UDP] ESP IV payload
447 if (M_LEADINGSPACE(md
) < esphlen
|| (md
->m_flags
& M_EXT
) != 0) {
448 MGET(n
, M_DONTWAIT
, MT_DATA
);
457 m
->m_pkthdr
.len
+= esphlen
;
458 if (udp_encapsulate
) {
459 udp
= mtod(n
, struct udphdr
*);
460 esp
= (struct esp
*)((caddr_t
)udp
+ sizeof(struct udphdr
));
462 esp
= mtod(n
, struct esp
*);
465 md
->m_len
+= esphlen
;
466 md
->m_data
-= esphlen
;
467 m
->m_pkthdr
.len
+= esphlen
;
468 esp
= mtod(md
, struct esp
*);
469 if (udp_encapsulate
) {
470 udp
= mtod(md
, struct udphdr
*);
471 esp
= (struct esp
*)((caddr_t
)udp
+ sizeof(struct udphdr
));
473 esp
= mtod(md
, struct esp
*);
480 if (esphlen
< (IP_MAXPACKET
- ntohs(ip
->ip_len
)))
481 ip
->ip_len
= htons(ntohs(ip
->ip_len
) + esphlen
);
484 "IPv4 ESP output: size exceeds limit\n"));
485 IPSEC_STAT_INCREMENT(ipsecstat
.out_inval
);
494 /* total packet length will be computed in ip6_output() */
500 /* initialize esp header. */
502 if ((sav
->flags
& SADB_X_EXT_OLD
) == 0) {
504 nesp
= (struct newesp
*)esp
;
505 if (sav
->replay
->count
== ~0) {
506 if ((sav
->flags
& SADB_X_EXT_CYCSEQ
) == 0) {
507 /* XXX Is it noisy ? */
508 ipseclog((LOG_WARNING
,
509 "replay counter overflowed. %s\n",
510 ipsec_logsastr(sav
)));
511 IPSEC_STAT_INCREMENT(stat
->out_inval
);
513 KERNEL_DEBUG(DBG_FNC_ESPOUT
| DBG_FUNC_END
, 5,0,0,0,0);
517 lck_mtx_lock(sadb_mutex
);
518 sav
->replay
->count
++;
519 lck_mtx_unlock(sadb_mutex
);
521 * XXX sequence number must not be cycled, if the SA is
522 * installed by IKE daemon.
524 nesp
->esp_seq
= htonl(sav
->replay
->count
);
529 * find the last mbuf. make some room for ESP trailer.
532 struct ip
*ip
= NULL
;
540 padbound
= algo
->padbound
;
543 /* ESP packet, including nxthdr field, must be length of 4n */
547 extendsiz
= padbound
- (plen
% padbound
);
549 extendsiz
= padbound
+ 1;
555 randpadmax
= ip4_esp_randpad
;
560 randpadmax
= ip6_esp_randpad
;
567 if (randpadmax
< 0 || plen
+ extendsiz
>= randpadmax
)
573 randpadmax
= (randpadmax
/ padbound
) * padbound
;
574 pad
= (randpadmax
- plen
+ extendsiz
) / padbound
;
577 pad
= (random() % pad
) * padbound
;
582 * make sure we do not pad too much.
583 * MLEN limitation comes from the trailer attachment
585 * 256 limitation comes from sequential padding.
586 * also, the 1-octet length field in ESP trailer imposes
587 * limitation (but is less strict than sequential padding
588 * as length field do not count the last 2 octets).
590 if (extendsiz
+ pad
<= MLEN
&& extendsiz
+ pad
< 256)
595 if (extendsiz
> MLEN
|| extendsiz
>= 256)
596 panic("extendsiz too big in esp_output");
604 * if M_EXT, the external mbuf data may be shared among
605 * two consequtive TCP packets, and it may be unsafe to use the
608 if (!(n
->m_flags
& M_EXT
) && extendsiz
< M_TRAILINGSPACE(n
)) {
609 extend
= mtod(n
, u_char
*) + n
->m_len
;
610 n
->m_len
+= extendsiz
;
611 m
->m_pkthdr
.len
+= extendsiz
;
615 MGET(nn
, M_DONTWAIT
, MT_DATA
);
617 ipseclog((LOG_DEBUG
, "esp%d_output: can't alloc mbuf",
623 extend
= mtod(nn
, u_char
*);
624 nn
->m_len
= extendsiz
;
628 m
->m_pkthdr
.len
+= extendsiz
;
630 switch (sav
->flags
& SADB_X_EXT_PMASK
) {
631 case SADB_X_EXT_PRAND
:
632 key_randomfill(extend
, extendsiz
);
634 case SADB_X_EXT_PZERO
:
635 bzero(extend
, extendsiz
);
637 case SADB_X_EXT_PSEQ
:
638 for (i
= 0; i
< extendsiz
; i
++)
639 extend
[i
] = (i
+ 1) & 0xff;
644 if (udp_encapsulate
) {
645 *nexthdrp
= IPPROTO_UDP
;
647 /* Fill out the UDP header */
648 udp
->uh_sport
= ntohs((u_short
)esp_udp_encap_port
);
649 udp
->uh_dport
= ntohs(sav
->remote_ike_port
);
650 // udp->uh_len set later, after all length tweaks are complete
653 /* Update last sent so we know if we need to send keepalive */
654 sav
->natt_last_activity
= natt_now
;
656 *nexthdrp
= IPPROTO_ESP
;
659 /* initialize esp trailer. */
660 esptail
= (struct esptail
*)
661 (mtod(n
, u_int8_t
*) + n
->m_len
- sizeof(struct esptail
));
662 esptail
->esp_nxt
= nxt
;
663 esptail
->esp_padlen
= extendsiz
- 2;
665 /* modify IP header (for ESP header part only) */
669 ip
= mtod(m
, struct ip
*);
670 if (extendsiz
< (IP_MAXPACKET
- ntohs(ip
->ip_len
)))
671 ip
->ip_len
= htons(ntohs(ip
->ip_len
) + extendsiz
);
674 "IPv4 ESP output: size exceeds limit\n"));
675 IPSEC_STAT_INCREMENT(ipsecstat
.out_inval
);
684 /* total packet length will be computed in ip6_output() */
691 * pre-compute and cache intermediate key
693 error
= esp_schedule(algo
, sav
);
696 IPSEC_STAT_INCREMENT(stat
->out_inval
);
701 * encrypt the packet, based on security association
702 * and the algorithm specified.
705 panic("internal error: no encrypt function");
706 KERNEL_DEBUG(DBG_FNC_ENCRYPT
| DBG_FUNC_START
, 0,0,0,0,0);
707 if ((*algo
->encrypt
)(m
, espoff
, plen
+ extendsiz
, sav
, algo
, ivlen
)) {
708 /* m is already freed */
709 ipseclog((LOG_ERR
, "packet encryption failure\n"));
710 IPSEC_STAT_INCREMENT(stat
->out_inval
);
712 KERNEL_DEBUG(DBG_FNC_ENCRYPT
| DBG_FUNC_END
, 1,error
,0,0,0);
715 KERNEL_DEBUG(DBG_FNC_ENCRYPT
| DBG_FUNC_END
, 2,0,0,0,0);
718 * calculate ICV if required.
724 if (sav
->key_auth
== SADB_AALG_NONE
)
728 const struct ah_algorithm
*aalgo
;
729 u_char authbuf
[AH_MAXSUMSIZE
];
736 aalgo
= ah_algorithm_lookup(sav
->alg_auth
);
739 siz
= ((aalgo
->sumsiz
)(sav
) + 3) & ~(4 - 1);
740 if (AH_MAXSUMSIZE
< siz
)
741 panic("assertion failed for AH_MAXSUMSIZE");
743 if (esp_auth(m
, espoff
, m
->m_pkthdr
.len
- espoff
, sav
, authbuf
)) {
744 ipseclog((LOG_ERR
, "ESP checksum generation failure\n"));
747 IPSEC_STAT_INCREMENT(stat
->out_inval
);
755 if (!(n
->m_flags
& M_EXT
) && siz
< M_TRAILINGSPACE(n
)) { /* XXX */
757 m
->m_pkthdr
.len
+= siz
;
758 p
= mtod(n
, u_char
*) + n
->m_len
- siz
;
762 MGET(nn
, M_DONTWAIT
, MT_DATA
);
764 ipseclog((LOG_DEBUG
, "can't alloc mbuf in esp%d_output",
774 m
->m_pkthdr
.len
+= siz
;
775 p
= mtod(nn
, u_char
*);
777 bcopy(authbuf
, p
, siz
);
779 /* modify IP header (for ESP header part only) */
783 ip
= mtod(m
, struct ip
*);
784 if (siz
< (IP_MAXPACKET
- ntohs(ip
->ip_len
)))
785 ip
->ip_len
= htons(ntohs(ip
->ip_len
) + siz
);
788 "IPv4 ESP output: size exceeds limit\n"));
789 IPSEC_STAT_INCREMENT(ipsecstat
.out_inval
);
798 /* total packet length will be computed in ip6_output() */
804 if (udp_encapsulate
) {
806 ip
= mtod(m
, struct ip
*);
807 udp
->uh_ulen
= htons(ntohs(ip
->ip_len
) - (IP_VHL_HL(ip
->ip_vhl
) << 2));
812 lck_mtx_lock(sadb_mutex
);
815 "NULL mbuf after encryption in esp%d_output", afnumber
));
818 stat
->out_esphist
[sav
->alg_enc
]++;
819 lck_mtx_unlock(sadb_mutex
);
820 key_sa_recordxfer(sav
, m
);
821 KERNEL_DEBUG(DBG_FNC_ESPOUT
| DBG_FUNC_END
, 6,0,0,0,0);
826 KERNEL_DEBUG(DBG_FNC_ESPOUT
| DBG_FUNC_END
, 7,error
,0,0,0);
829 panic("something bad in esp_output");
837 struct secasvar
*sav
;
840 if (m
->m_len
< sizeof(struct ip
)) {
841 ipseclog((LOG_DEBUG
, "esp4_output: first mbuf too short\n"));
845 ip
= mtod(m
, struct ip
*);
846 /* XXX assumes that m->m_next points to payload */
847 return esp_output(m
, &ip
->ip_p
, m
->m_next
, AF_INET
, sav
);
853 esp6_output(m
, nexthdrp
, md
, sav
)
857 struct secasvar
*sav
;
859 if (m
->m_len
< sizeof(struct ip6_hdr
)) {
860 ipseclog((LOG_DEBUG
, "esp6_output: first mbuf too short\n"));
864 return esp_output(m
, nexthdrp
, md
, AF_INET6
, sav
);