2 * Copyright (c) 2004-2018 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 #include <sys/param.h> /* for definition of NULL */
30 #include <sys/errno.h>
31 #include <sys/malloc.h>
32 #include <sys/socket.h>
34 #include <sys/systm.h>
35 #include <libkern/OSAtomic.h>
37 #include <machine/endian.h>
40 #include <net/if_var.h>
41 #include <net/route.h>
42 #include <net/kpi_protocol.h>
43 #include <net/net_api_stats.h>
45 #include <netinet/in_systm.h>
46 #include <netinet/in.h>
47 #include <netinet/in_var.h>
48 #include <netinet6/in6_var.h>
49 #include <netinet/ip.h>
50 #include <netinet/ip6.h>
51 #include <netinet/ip_var.h>
52 #include <netinet6/ip6_var.h>
53 #include <netinet/kpi_ipfilter_var.h>
58 * kipf_lock and kipf_ref protect the linkage of the list of IP filters
59 * An IP filter can be removed only when kipf_ref is zero
60 * If an IP filter cannot be removed because kipf_ref is not null, then
61 * the IP filter is marjed and kipf_delayed_remove is set so that when
62 * kipf_ref eventually goes down to zero, the IP filter is removed
64 decl_lck_mtx_data(static, kipf_lock_data
);
65 static lck_mtx_t
*kipf_lock
= &kipf_lock_data
;
66 static u_int32_t kipf_ref
= 0;
67 static u_int32_t kipf_delayed_remove
= 0;
68 u_int32_t kipf_count
= 0;
70 __private_extern__
struct ipfilter_list ipv4_filters
= TAILQ_HEAD_INITIALIZER(ipv4_filters
);
71 __private_extern__
struct ipfilter_list ipv6_filters
= TAILQ_HEAD_INITIALIZER(ipv6_filters
);
72 __private_extern__
struct ipfilter_list tbr_filters
= TAILQ_HEAD_INITIALIZER(tbr_filters
);
76 extern errno_t
ipf_addv4(const struct ipf_filter
*filter
,
77 ipfilter_t
*filter_ref
);
78 extern errno_t
ipf_addv6(const struct ipf_filter
*filter
,
79 ipfilter_t
*filter_ref
);
81 static errno_t
ipf_add(const struct ipf_filter
*filter
,
82 ipfilter_t
*filter_ref
, struct ipfilter_list
*head
, bool is_internal
);
84 __private_extern__
void
87 lck_mtx_lock(kipf_lock
);
89 lck_mtx_unlock(kipf_lock
);
92 __private_extern__
void
95 lck_mtx_lock(kipf_lock
);
98 panic("ipf_unref: kipf_ref == 0\n");
102 if (kipf_ref
== 0 && kipf_delayed_remove
!= 0) {
103 struct ipfilter
*filter
;
105 while ((filter
= TAILQ_FIRST(&tbr_filters
))) {
106 VERIFY(OSDecrementAtomic64(&net_api_stats
.nas_ipf_add_count
) > 0);
108 ipf_detach_func ipf_detach
= filter
->ipf_filter
.ipf_detach
;
109 void* cookie
= filter
->ipf_filter
.cookie
;
111 TAILQ_REMOVE(filter
->ipf_head
, filter
, ipf_link
);
112 TAILQ_REMOVE(&tbr_filters
, filter
, ipf_tbr
);
113 kipf_delayed_remove
--;
116 lck_mtx_unlock(kipf_lock
);
118 lck_mtx_lock(kipf_lock
);
119 /* In case some filter got to run while we released the lock */
126 lck_mtx_unlock(kipf_lock
);
131 const struct ipf_filter
*filter
,
132 ipfilter_t
*filter_ref
,
133 struct ipfilter_list
*head
,
136 struct ipfilter
*new_filter
;
137 if (filter
->name
== NULL
|| (filter
->ipf_input
== NULL
&& filter
->ipf_output
== NULL
)) {
141 MALLOC(new_filter
, struct ipfilter
*, sizeof(*new_filter
), M_IFADDR
, M_WAITOK
);
142 if (new_filter
== NULL
) {
146 lck_mtx_lock(kipf_lock
);
147 new_filter
->ipf_filter
= *filter
;
148 new_filter
->ipf_head
= head
;
150 TAILQ_INSERT_HEAD(head
, new_filter
, ipf_link
);
152 OSIncrementAtomic64(&net_api_stats
.nas_ipf_add_count
);
153 INC_ATOMIC_INT64_LIM(net_api_stats
.nas_ipf_add_total
);
155 INC_ATOMIC_INT64_LIM(net_api_stats
.nas_ipf_add_os_total
);
158 lck_mtx_unlock(kipf_lock
);
160 *filter_ref
= (ipfilter_t
)new_filter
;
162 /* This will force TCP to re-evaluate its use of TSO */
163 OSAddAtomic(1, &kipf_count
);
171 const struct ipf_filter
*filter
,
172 ipfilter_t
*filter_ref
)
174 return ipf_add(filter
, filter_ref
, &ipv4_filters
, true);
179 const struct ipf_filter
*filter
,
180 ipfilter_t
*filter_ref
)
182 return ipf_add(filter
, filter_ref
, &ipv4_filters
, false);
187 const struct ipf_filter
*filter
,
188 ipfilter_t
*filter_ref
)
190 return ipf_add(filter
, filter_ref
, &ipv6_filters
, true);
195 const struct ipf_filter
*filter
,
196 ipfilter_t
*filter_ref
)
198 return ipf_add(filter
, filter_ref
, &ipv6_filters
, false);
202 ipf_input_detached(void *cookie
, mbuf_t
*data
, int offset
, u_int8_t protocol
)
204 #pragma unused(cookie, data, offset, protocol)
207 printf("ipf_input_detached\n");
214 ipf_output_detached(void *cookie
, mbuf_t
*data
, ipf_pktopts_t options
)
216 #pragma unused(cookie, data, options)
219 printf("ipf_output_detached\n");
227 ipfilter_t filter_ref
)
229 struct ipfilter
*match
= (struct ipfilter
*)filter_ref
;
230 struct ipfilter_list
*head
;
232 if (match
== 0 || (match
->ipf_head
!= &ipv4_filters
&& match
->ipf_head
!= &ipv6_filters
)) {
236 head
= match
->ipf_head
;
238 lck_mtx_lock(kipf_lock
);
239 TAILQ_FOREACH(match
, head
, ipf_link
) {
240 if (match
== (struct ipfilter
*)filter_ref
) {
241 ipf_detach_func ipf_detach
= match
->ipf_filter
.ipf_detach
;
242 void* cookie
= match
->ipf_filter
.cookie
;
245 * Cannot detach when they are filters running
248 kipf_delayed_remove
++;
249 TAILQ_INSERT_TAIL(&tbr_filters
, match
, ipf_tbr
);
250 match
->ipf_filter
.ipf_input
= ipf_input_detached
;
251 match
->ipf_filter
.ipf_output
= ipf_output_detached
;
252 lck_mtx_unlock(kipf_lock
);
254 VERIFY(OSDecrementAtomic64(&net_api_stats
.nas_ipf_add_count
) > 0);
256 TAILQ_REMOVE(head
, match
, ipf_link
);
257 lck_mtx_unlock(kipf_lock
);
262 FREE(match
, M_IFADDR
);
264 /* This will force TCP to re-evaluate its use of TSO */
265 OSAddAtomic(-1, &kipf_count
);
271 lck_mtx_unlock(kipf_lock
);
281 ipfilter_t filter_ref
)
283 struct mbuf
*m
= (struct mbuf
*)data
;
284 struct m_tag
*mtag
= 0;
285 struct ip
*ip
= mtod(m
, struct ip
*);
290 protocol_family_t proto
;
291 struct in_ifaddr
*ia
= NULL
;
292 struct in_addr
*pkt_dst
= NULL
;
293 struct in6_ifaddr
*ia6
= NULL
;
294 struct sockaddr_in6 pkt_dst6
;
296 vers
= IP_VHL_V(ip
->ip_vhl
);
310 if (filter_ref
== 0 && m
->m_pkthdr
.rcvif
== 0) {
312 * Search for interface with the local address
316 pkt_dst
= &ip
->ip_dst
;
317 lck_rw_lock_shared(in_ifaddr_rwlock
);
318 TAILQ_FOREACH(ia
, INADDR_HASH(pkt_dst
->s_addr
), ia_hash
) {
319 if (IA_SIN(ia
)->sin_addr
.s_addr
== pkt_dst
->s_addr
) {
320 m
->m_pkthdr
.rcvif
= ia
->ia_ifp
;
324 lck_rw_done(in_ifaddr_rwlock
);
328 ip6
= mtod(m
, struct ip6_hdr
*);
329 pkt_dst6
.sin6_addr
= ip6
->ip6_dst
;
330 lck_rw_lock_shared(&in6_ifaddr_rwlock
);
331 for (ia6
= in6_ifaddrs
; ia6
!= NULL
; ia6
= ia6
->ia_next
) {
332 if (IN6_ARE_ADDR_EQUAL(&ia6
->ia_addr
.sin6_addr
, &pkt_dst6
.sin6_addr
)) {
333 m
->m_pkthdr
.rcvif
= ia6
->ia_ifp
;
337 lck_rw_done(&in6_ifaddr_rwlock
);
345 * If none found, fallback to loopback
347 if (m
->m_pkthdr
.rcvif
== NULL
) {
348 m
->m_pkthdr
.rcvif
= lo_ifp
;
351 m
->m_pkthdr
.csum_data
= 0;
352 m
->m_pkthdr
.csum_flags
= 0;
354 hlen
= IP_VHL_HL(ip
->ip_vhl
) << 2;
356 ip
->ip_sum
= in_cksum(m
, hlen
);
359 if (filter_ref
!= 0) {
360 mtag
= m_tag_create(KERNEL_MODULE_TAG_ID
, KERNEL_TAG_TYPE_IPFILT
,
361 sizeof(ipfilter_t
), M_NOWAIT
, m
);
366 *(ipfilter_t
*)(mtag
+ 1) = filter_ref
;
367 m_tag_prepend(m
, mtag
);
370 error
= proto_inject(proto
, data
);
377 ipf_injectv4_out(mbuf_t data
, ipfilter_t filter_ref
, ipf_pktopts_t options
)
381 struct mbuf
*m
= (struct mbuf
*)data
;
383 struct m_tag
*mtag
= NULL
;
384 struct ip_moptions
*imo
= NULL
;
385 struct ip_out_args ipoa
;
387 bzero(&ipoa
, sizeof(ipoa
));
388 ipoa
.ipoa_boundif
= IFSCOPE_NONE
;
389 ipoa
.ipoa_sotc
= SO_TC_UNSPEC
;
390 ipoa
.ipoa_netsvctype
= _NET_SERVICE_TYPE_UNSPEC
;
392 /* Make the IP header contiguous in the mbuf */
393 if ((size_t)m
->m_len
< sizeof(struct ip
)) {
394 m
= m_pullup(m
, sizeof(struct ip
));
399 ip
= (struct ip
*)m_mtod(m
);
401 if (filter_ref
!= 0) {
402 mtag
= m_tag_create(KERNEL_MODULE_TAG_ID
,
403 KERNEL_TAG_TYPE_IPFILT
, sizeof(ipfilter_t
), M_NOWAIT
, m
);
408 *(ipfilter_t
*)(mtag
+ 1) = filter_ref
;
409 m_tag_prepend(m
, mtag
);
412 if (options
!= NULL
&& (options
->ippo_flags
& IPPOF_MCAST_OPTS
) &&
413 (imo
= ip_allocmoptions(M_DONTWAIT
)) != NULL
) {
414 imo
->imo_multicast_ifp
= options
->ippo_mcast_ifnet
;
415 imo
->imo_multicast_ttl
= options
->ippo_mcast_ttl
;
416 imo
->imo_multicast_loop
= options
->ippo_mcast_loop
;
419 if (options
!= NULL
) {
420 if (options
->ippo_flags
& IPPOF_SELECT_SRCIF
) {
421 ipoa
.ipoa_flags
|= IPOAF_SELECT_SRCIF
;
423 if (options
->ippo_flags
& IPPOF_BOUND_IF
) {
424 ipoa
.ipoa_flags
|= IPOAF_BOUND_IF
;
425 ipoa
.ipoa_boundif
= options
->ippo_flags
>>
428 if (options
->ippo_flags
& IPPOF_NO_IFT_CELLULAR
) {
429 ipoa
.ipoa_flags
|= IPOAF_NO_CELLULAR
;
431 if (options
->ippo_flags
& IPPOF_BOUND_SRCADDR
) {
432 ipoa
.ipoa_flags
|= IPOAF_BOUND_SRCADDR
;
434 if (options
->ippo_flags
& IPPOF_NO_IFF_EXPENSIVE
) {
435 ipoa
.ipoa_flags
|= IPOAF_NO_EXPENSIVE
;
439 bzero(&ro
, sizeof(struct route
));
441 /* Put ip_len and ip_off in host byte order, ip_output expects that */
443 #if BYTE_ORDER != BIG_ENDIAN
448 /* Send; enforce source interface selection via IP_OUTARGS flag */
449 error
= ip_output(m
, NULL
, &ro
,
450 IP_ALLOWBROADCAST
| IP_RAWOUTPUT
| IP_OUTARGS
, imo
, &ipoa
);
452 /* Release the route */
464 ipf_injectv6_out(mbuf_t data
, ipfilter_t filter_ref
, ipf_pktopts_t options
)
468 struct mbuf
*m
= (struct mbuf
*)data
;
470 struct m_tag
*mtag
= NULL
;
471 struct ip6_moptions
*im6o
= NULL
;
472 struct ip6_out_args ip6oa
;
474 bzero(&ip6oa
, sizeof(ip6oa
));
475 ip6oa
.ip6oa_boundif
= IFSCOPE_NONE
;
476 ip6oa
.ip6oa_sotc
= SO_TC_UNSPEC
;
477 ip6oa
.ip6oa_netsvctype
= _NET_SERVICE_TYPE_UNSPEC
;
479 /* Make the IP header contiguous in the mbuf */
480 if ((size_t)m
->m_len
< sizeof(struct ip6_hdr
)) {
481 m
= m_pullup(m
, sizeof(struct ip6_hdr
));
486 ip6
= (struct ip6_hdr
*)m_mtod(m
);
488 if (filter_ref
!= 0) {
489 mtag
= m_tag_create(KERNEL_MODULE_TAG_ID
,
490 KERNEL_TAG_TYPE_IPFILT
, sizeof(ipfilter_t
), M_NOWAIT
, m
);
495 *(ipfilter_t
*)(mtag
+ 1) = filter_ref
;
496 m_tag_prepend(m
, mtag
);
499 if (options
!= NULL
&& (options
->ippo_flags
& IPPOF_MCAST_OPTS
) &&
500 (im6o
= ip6_allocmoptions(M_DONTWAIT
)) != NULL
) {
501 im6o
->im6o_multicast_ifp
= options
->ippo_mcast_ifnet
;
502 im6o
->im6o_multicast_hlim
= options
->ippo_mcast_ttl
;
503 im6o
->im6o_multicast_loop
= options
->ippo_mcast_loop
;
506 if (options
!= NULL
) {
507 if (options
->ippo_flags
& IPPOF_SELECT_SRCIF
) {
508 ip6oa
.ip6oa_flags
|= IP6OAF_SELECT_SRCIF
;
510 if (options
->ippo_flags
& IPPOF_BOUND_IF
) {
511 ip6oa
.ip6oa_flags
|= IP6OAF_BOUND_IF
;
512 ip6oa
.ip6oa_boundif
= options
->ippo_flags
>>
515 if (options
->ippo_flags
& IPPOF_NO_IFT_CELLULAR
) {
516 ip6oa
.ip6oa_flags
|= IP6OAF_NO_CELLULAR
;
518 if (options
->ippo_flags
& IPPOF_BOUND_SRCADDR
) {
519 ip6oa
.ip6oa_flags
|= IP6OAF_BOUND_SRCADDR
;
521 if (options
->ippo_flags
& IPPOF_NO_IFF_EXPENSIVE
) {
522 ip6oa
.ip6oa_flags
|= IP6OAF_NO_EXPENSIVE
;
526 bzero(&ro
, sizeof(struct route_in6
));
529 * Send mbuf and ifscope information. Check for correctness
530 * of ifscope information is done while searching for a route in
533 error
= ip6_output(m
, NULL
, &ro
, IPV6_OUTARGS
, im6o
, NULL
, &ip6oa
);
535 /* Release the route */
549 ipfilter_t filter_ref
,
550 ipf_pktopts_t options
)
552 struct mbuf
*m
= (struct mbuf
*)data
;
556 /* Make one byte of the header contiguous in the mbuf */
564 vers
= (*(u_int8_t
*)m_mtod(m
)) >> 4;
567 error
= ipf_injectv4_out(data
, filter_ref
, options
);
571 error
= ipf_injectv6_out(data
, filter_ref
, options
);
584 __private_extern__ ipfilter_t
585 ipf_get_inject_filter(struct mbuf
*m
)
587 ipfilter_t filter_ref
= 0;
590 mtag
= m_tag_locate(m
, KERNEL_MODULE_TAG_ID
, KERNEL_TAG_TYPE_IPFILT
, NULL
);
592 filter_ref
= *(ipfilter_t
*)(mtag
+ 1);
594 m_tag_delete(m
, mtag
);
599 __private_extern__
int
603 lck_grp_attr_t
*grp_attributes
= 0;
604 lck_attr_t
*lck_attributes
= 0;
605 lck_grp_t
*lck_grp
= 0;
607 grp_attributes
= lck_grp_attr_alloc_init();
608 if (grp_attributes
== 0) {
609 printf("ipf_init: lck_grp_attr_alloc_init failed\n");
614 lck_grp
= lck_grp_alloc_init("IP Filter", grp_attributes
);
616 printf("ipf_init: lck_grp_alloc_init failed\n");
621 lck_attributes
= lck_attr_alloc_init();
622 if (lck_attributes
== 0) {
623 printf("ipf_init: lck_attr_alloc_init failed\n");
628 lck_mtx_init(kipf_lock
, lck_grp
, lck_attributes
);
632 lck_grp_free(lck_grp
);
635 if (grp_attributes
) {
636 lck_grp_attr_free(grp_attributes
);
639 if (lck_attributes
) {
640 lck_attr_free(lck_attributes
);