2 * Linux Socket Filter - Kernel level socket filtering
5 * Jay Schulist <jschlst@samba.org>
7 * Based on the design of:
8 * - The Berkeley Packet Filter
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version
13 * 2 of the License, or (at your option) any later version.
15 * Andi Kleen - Fix a few bad bugs and races.
16 * Kris Katterjohn - Added many additional checks in sk_chk_filter()
19 #include <linux/module.h>
20 #include <linux/types.h>
22 #include <linux/fcntl.h>
23 #include <linux/socket.h>
25 #include <linux/inet.h>
26 #include <linux/netdevice.h>
27 #include <linux/if_packet.h>
28 #include <linux/gfp.h>
30 #include <net/protocol.h>
31 #include <net/netlink.h>
32 #include <linux/skbuff.h>
34 #include <linux/errno.h>
35 #include <linux/timer.h>
36 #include <asm/system.h>
37 #include <asm/uaccess.h>
38 #include <asm/unaligned.h>
39 #include <linux/filter.h>
41 /* No hurry in this branch */
42 static void *__load_pointer(struct sk_buff *skb, int k)
47 ptr = skb_network_header(skb) + k - SKF_NET_OFF;
48 else if (k >= SKF_LL_OFF)
49 ptr = skb_mac_header(skb) + k - SKF_LL_OFF;
51 if (ptr >= skb->head && ptr < skb_tail_pointer(skb))
56 static inline void *load_pointer(struct sk_buff *skb, int k,
57 unsigned int size, void *buffer)
60 return skb_header_pointer(skb, k, size, buffer);
64 return __load_pointer(skb, k);
69 * sk_filter - run a packet through a socket filter
70 * @sk: sock associated with &sk_buff
71 * @skb: buffer to filter
73 * Run the filter code and then cut skb->data to correct size returned by
74 * sk_run_filter. If pkt_len is 0 we toss packet. If skb->len is smaller
75 * than pkt_len we keep whole skb->data. This is the socket level
76 * wrapper to sk_run_filter. It returns 0 if the packet should
77 * be accepted or -EPERM if the packet should be tossed.
80 int sk_filter(struct sock *sk, struct sk_buff *skb)
83 struct sk_filter *filter;
85 err = security_sock_rcv_skb(sk, skb);
90 filter = rcu_dereference_bh(sk->sk_filter);
92 unsigned int pkt_len = sk_run_filter(skb, filter->insns,
94 err = pkt_len ? pskb_trim(skb, pkt_len) : -EPERM;
100 EXPORT_SYMBOL(sk_filter);
103 * sk_run_filter - run a filter on a socket
104 * @skb: buffer to run the filter on
105 * @filter: filter to apply
106 * @flen: length of filter
108 * Decode and apply filter instructions to the skb->data.
109 * Return length to keep, 0 for none. skb is the data we are
110 * filtering, filter is the array of filter instructions, and
111 * len is the number of filter blocks in the array.
113 unsigned int sk_run_filter(struct sk_buff *skb, struct sock_filter *filter, int flen)
116 u32 A = 0; /* Accumulator */
117 u32 X = 0; /* Index Register */
118 u32 mem[BPF_MEMWORDS]; /* Scratch Memory Store */
119 unsigned long memvalid = 0;
124 BUILD_BUG_ON(BPF_MEMWORDS > BITS_PER_LONG);
126 * Process array of filter instructions.
128 for (pc = 0; pc < flen; pc++) {
129 const struct sock_filter *fentry = &filter[pc];
132 switch (fentry->code) {
133 case BPF_S_ALU_ADD_X:
136 case BPF_S_ALU_ADD_K:
139 case BPF_S_ALU_SUB_X:
142 case BPF_S_ALU_SUB_K:
145 case BPF_S_ALU_MUL_X:
148 case BPF_S_ALU_MUL_K:
151 case BPF_S_ALU_DIV_X:
156 case BPF_S_ALU_DIV_K:
159 case BPF_S_ALU_AND_X:
162 case BPF_S_ALU_AND_K:
171 case BPF_S_ALU_LSH_X:
174 case BPF_S_ALU_LSH_K:
177 case BPF_S_ALU_RSH_X:
180 case BPF_S_ALU_RSH_K:
189 case BPF_S_JMP_JGT_K:
190 pc += (A > f_k) ? fentry->jt : fentry->jf;
192 case BPF_S_JMP_JGE_K:
193 pc += (A >= f_k) ? fentry->jt : fentry->jf;
195 case BPF_S_JMP_JEQ_K:
196 pc += (A == f_k) ? fentry->jt : fentry->jf;
198 case BPF_S_JMP_JSET_K:
199 pc += (A & f_k) ? fentry->jt : fentry->jf;
201 case BPF_S_JMP_JGT_X:
202 pc += (A > X) ? fentry->jt : fentry->jf;
204 case BPF_S_JMP_JGE_X:
205 pc += (A >= X) ? fentry->jt : fentry->jf;
207 case BPF_S_JMP_JEQ_X:
208 pc += (A == X) ? fentry->jt : fentry->jf;
210 case BPF_S_JMP_JSET_X:
211 pc += (A & X) ? fentry->jt : fentry->jf;
216 ptr = load_pointer(skb, k, 4, &tmp);
218 A = get_unaligned_be32(ptr);
225 ptr = load_pointer(skb, k, 2, &tmp);
227 A = get_unaligned_be16(ptr);
234 ptr = load_pointer(skb, k, 1, &tmp);
243 case BPF_S_LDX_W_LEN:
255 case BPF_S_LDX_B_MSH:
256 ptr = load_pointer(skb, f_k, 1, &tmp);
258 X = (*(u8 *)ptr & 0xf) << 2;
269 A = (memvalid & (1UL << f_k)) ?
273 X = (memvalid & (1UL << f_k)) ?
287 memvalid |= 1UL << f_k;
291 memvalid |= 1UL << f_k;
295 WARN_RATELIMIT(1, "Unknown code:%u jt:%u tf:%u k:%u\n",
296 fentry->code, fentry->jt,
297 fentry->jf, fentry->k);
302 * Handle ancillary data, which are impossible
303 * (or very difficult) to get parsing packet contents.
305 switch (k-SKF_AD_OFF) {
306 case SKF_AD_PROTOCOL:
307 A = ntohs(skb->protocol);
315 A = skb->dev->ifindex;
321 A = skb->queue_mapping;
328 case SKF_AD_NLATTR: {
331 if (skb_is_nonlinear(skb))
333 if (A > skb->len - sizeof(struct nlattr))
336 nla = nla_find((struct nlattr *)&skb->data[A],
339 A = (void *)nla - (void *)skb->data;
344 case SKF_AD_NLATTR_NEST: {
347 if (skb_is_nonlinear(skb))
349 if (A > skb->len - sizeof(struct nlattr))
352 nla = (struct nlattr *)&skb->data[A];
353 if (nla->nla_len > A - skb->len)
356 nla = nla_find_nested(nla, X);
358 A = (void *)nla - (void *)skb->data;
370 EXPORT_SYMBOL(sk_run_filter);
373 * sk_chk_filter - verify socket filter code
374 * @filter: filter to verify
375 * @flen: length of filter
377 * Check the user's filter code. If we let some ugly
378 * filter code slip through kaboom! The filter must contain
379 * no references or jumps that are out of range, no illegal
380 * instructions, and must end with a RET instruction.
382 * All jumps are forward as they are not signed.
384 * Returns 0 if the rule set is legal or -EINVAL if not.
386 int sk_chk_filter(struct sock_filter *filter, int flen)
388 struct sock_filter *ftest;
391 if (flen == 0 || flen > BPF_MAXINSNS)
394 /* check the filter code now */
395 for (pc = 0; pc < flen; pc++) {
398 /* Only allow valid instructions */
399 switch (ftest->code) {
400 case BPF_ALU|BPF_ADD|BPF_K:
401 ftest->code = BPF_S_ALU_ADD_K;
403 case BPF_ALU|BPF_ADD|BPF_X:
404 ftest->code = BPF_S_ALU_ADD_X;
406 case BPF_ALU|BPF_SUB|BPF_K:
407 ftest->code = BPF_S_ALU_SUB_K;
409 case BPF_ALU|BPF_SUB|BPF_X:
410 ftest->code = BPF_S_ALU_SUB_X;
412 case BPF_ALU|BPF_MUL|BPF_K:
413 ftest->code = BPF_S_ALU_MUL_K;
415 case BPF_ALU|BPF_MUL|BPF_X:
416 ftest->code = BPF_S_ALU_MUL_X;
418 case BPF_ALU|BPF_DIV|BPF_X:
419 ftest->code = BPF_S_ALU_DIV_X;
421 case BPF_ALU|BPF_AND|BPF_K:
422 ftest->code = BPF_S_ALU_AND_K;
424 case BPF_ALU|BPF_AND|BPF_X:
425 ftest->code = BPF_S_ALU_AND_X;
427 case BPF_ALU|BPF_OR|BPF_K:
428 ftest->code = BPF_S_ALU_OR_K;
430 case BPF_ALU|BPF_OR|BPF_X:
431 ftest->code = BPF_S_ALU_OR_X;
433 case BPF_ALU|BPF_LSH|BPF_K:
434 ftest->code = BPF_S_ALU_LSH_K;
436 case BPF_ALU|BPF_LSH|BPF_X:
437 ftest->code = BPF_S_ALU_LSH_X;
439 case BPF_ALU|BPF_RSH|BPF_K:
440 ftest->code = BPF_S_ALU_RSH_K;
442 case BPF_ALU|BPF_RSH|BPF_X:
443 ftest->code = BPF_S_ALU_RSH_X;
445 case BPF_ALU|BPF_NEG:
446 ftest->code = BPF_S_ALU_NEG;
448 case BPF_LD|BPF_W|BPF_ABS:
449 ftest->code = BPF_S_LD_W_ABS;
451 case BPF_LD|BPF_H|BPF_ABS:
452 ftest->code = BPF_S_LD_H_ABS;
454 case BPF_LD|BPF_B|BPF_ABS:
455 ftest->code = BPF_S_LD_B_ABS;
457 case BPF_LD|BPF_W|BPF_LEN:
458 ftest->code = BPF_S_LD_W_LEN;
460 case BPF_LD|BPF_W|BPF_IND:
461 ftest->code = BPF_S_LD_W_IND;
463 case BPF_LD|BPF_H|BPF_IND:
464 ftest->code = BPF_S_LD_H_IND;
466 case BPF_LD|BPF_B|BPF_IND:
467 ftest->code = BPF_S_LD_B_IND;
470 ftest->code = BPF_S_LD_IMM;
472 case BPF_LDX|BPF_W|BPF_LEN:
473 ftest->code = BPF_S_LDX_W_LEN;
475 case BPF_LDX|BPF_B|BPF_MSH:
476 ftest->code = BPF_S_LDX_B_MSH;
478 case BPF_LDX|BPF_IMM:
479 ftest->code = BPF_S_LDX_IMM;
481 case BPF_MISC|BPF_TAX:
482 ftest->code = BPF_S_MISC_TAX;
484 case BPF_MISC|BPF_TXA:
485 ftest->code = BPF_S_MISC_TXA;
488 ftest->code = BPF_S_RET_K;
491 ftest->code = BPF_S_RET_A;
494 /* Some instructions need special checks */
496 /* check for division by zero */
497 case BPF_ALU|BPF_DIV|BPF_K:
500 ftest->code = BPF_S_ALU_DIV_K;
503 /* check for invalid memory addresses */
505 if (ftest->k >= BPF_MEMWORDS)
507 ftest->code = BPF_S_LD_MEM;
509 case BPF_LDX|BPF_MEM:
510 if (ftest->k >= BPF_MEMWORDS)
512 ftest->code = BPF_S_LDX_MEM;
515 if (ftest->k >= BPF_MEMWORDS)
517 ftest->code = BPF_S_ST;
520 if (ftest->k >= BPF_MEMWORDS)
522 ftest->code = BPF_S_STX;
527 * Note, the large ftest->k might cause loops.
528 * Compare this with conditional jumps below,
529 * where offsets are limited. --ANK (981016)
531 if (ftest->k >= (unsigned)(flen-pc-1))
533 ftest->code = BPF_S_JMP_JA;
536 case BPF_JMP|BPF_JEQ|BPF_K:
537 ftest->code = BPF_S_JMP_JEQ_K;
539 case BPF_JMP|BPF_JEQ|BPF_X:
540 ftest->code = BPF_S_JMP_JEQ_X;
542 case BPF_JMP|BPF_JGE|BPF_K:
543 ftest->code = BPF_S_JMP_JGE_K;
545 case BPF_JMP|BPF_JGE|BPF_X:
546 ftest->code = BPF_S_JMP_JGE_X;
548 case BPF_JMP|BPF_JGT|BPF_K:
549 ftest->code = BPF_S_JMP_JGT_K;
551 case BPF_JMP|BPF_JGT|BPF_X:
552 ftest->code = BPF_S_JMP_JGT_X;
554 case BPF_JMP|BPF_JSET|BPF_K:
555 ftest->code = BPF_S_JMP_JSET_K;
557 case BPF_JMP|BPF_JSET|BPF_X:
558 ftest->code = BPF_S_JMP_JSET_X;
565 /* for conditionals both must be safe */
566 switch (ftest->code) {
567 case BPF_S_JMP_JEQ_K:
568 case BPF_S_JMP_JEQ_X:
569 case BPF_S_JMP_JGE_K:
570 case BPF_S_JMP_JGE_X:
571 case BPF_S_JMP_JGT_K:
572 case BPF_S_JMP_JGT_X:
573 case BPF_S_JMP_JSET_X:
574 case BPF_S_JMP_JSET_K:
575 if (pc + ftest->jt + 1 >= flen ||
576 pc + ftest->jf + 1 >= flen)
581 /* last instruction must be a RET code */
582 switch (filter[flen - 1].code) {
591 EXPORT_SYMBOL(sk_chk_filter);
594 * sk_filter_release_rcu - Release a socket filter by rcu_head
595 * @rcu: rcu_head that contains the sk_filter to free
597 void sk_filter_release_rcu(struct rcu_head *rcu)
599 struct sk_filter *fp = container_of(rcu, struct sk_filter, rcu);
603 EXPORT_SYMBOL(sk_filter_release_rcu);
606 * sk_attach_filter - attach a socket filter
607 * @fprog: the filter program
608 * @sk: the socket to use
610 * Attach the user's filter code. We first run some sanity checks on
611 * it to make sure it does not explode on us later. If an error
612 * occurs or there is insufficient memory for the filter a negative
613 * errno code is returned. On success the return is zero.
615 int sk_attach_filter(struct sock_fprog *fprog, struct sock *sk)
617 struct sk_filter *fp, *old_fp;
618 unsigned int fsize = sizeof(struct sock_filter) * fprog->len;
621 /* Make sure new filter is there and in the right amounts. */
622 if (fprog->filter == NULL)
625 fp = sock_kmalloc(sk, fsize+sizeof(*fp), GFP_KERNEL);
628 if (copy_from_user(fp->insns, fprog->filter, fsize)) {
629 sock_kfree_s(sk, fp, fsize+sizeof(*fp));
633 atomic_set(&fp->refcnt, 1);
634 fp->len = fprog->len;
636 err = sk_chk_filter(fp->insns, fp->len);
638 sk_filter_uncharge(sk, fp);
643 old_fp = rcu_dereference_bh(sk->sk_filter);
644 rcu_assign_pointer(sk->sk_filter, fp);
645 rcu_read_unlock_bh();
648 sk_filter_uncharge(sk, old_fp);
651 EXPORT_SYMBOL_GPL(sk_attach_filter);
653 int sk_detach_filter(struct sock *sk)
656 struct sk_filter *filter;
659 filter = rcu_dereference_bh(sk->sk_filter);
661 rcu_assign_pointer(sk->sk_filter, NULL);
662 sk_filter_uncharge(sk, filter);
665 rcu_read_unlock_bh();
668 EXPORT_SYMBOL_GPL(sk_detach_filter);