blob: 98c221dbf05962975ac65fff2bd19d8b5f082c7b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Description: EBTables 802.1Q match extension kernelspace module.
3 * Authors: Nick Fedchik <nick@fedchik.org.ua>
4 * Bart De Schuymer <bdschuym@pandora.be>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
Jeff Kirshere664eab2013-12-06 09:13:42 -080017 * along with this program; if not, see <http://www.gnu.org/licenses/>.
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 */
19
20#include <linux/if_ether.h>
21#include <linux/if_vlan.h>
22#include <linux/module.h>
23#include <linux/moduleparam.h>
Jan Engelhardt18219d32008-10-08 11:35:13 +020024#include <linux/netfilter/x_tables.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/netfilter_bridge/ebtables.h>
26#include <linux/netfilter_bridge/ebt_vlan.h>
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#define MODULE_VERS "0.6"
29
Linus Torvalds1da177e2005-04-16 15:20:36 -070030MODULE_AUTHOR("Nick Fedchik <nick@fedchik.org.ua>");
Jan Engelhardtf776c4c2008-01-31 04:00:30 -080031MODULE_DESCRIPTION("Ebtables: 802.1Q VLAN tag match");
Linus Torvalds1da177e2005-04-16 15:20:36 -070032MODULE_LICENSE("GPL");
33
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#define GET_BITMASK(_BIT_MASK_) info->bitmask & _BIT_MASK_
Jan Engelhardt8cc784e2008-10-08 11:35:13 +020035#define EXIT_ON_MISMATCH(_MATCH_,_MASK_) {if (!((info->_MATCH_ == _MATCH_)^!!(info->invflags & _MASK_))) return false; }
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Jan Engelhardt8cc784e2008-10-08 11:35:13 +020037static bool
Jan Engelhardt62fc8052009-07-07 20:42:08 +020038ebt_vlan_mt(const struct sk_buff *skb, struct xt_action_param *par)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039{
Jan Engelhardtf7108a22008-10-08 11:35:18 +020040 const struct ebt_vlan_info *info = par->matchinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42 unsigned short TCI; /* Whole TCI, given from parsed frame */
43 unsigned short id; /* VLAN ID, given from frame TCI */
44 unsigned char prio; /* user_priority, given from frame TCI */
45 /* VLAN encapsulated Type/Length field, given from orig frame */
Al Viro47c183fa2006-11-14 21:11:51 -080046 __be16 encap;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Jiri Pirkodf8a39d2015-01-13 17:13:44 +010048 if (skb_vlan_tag_present(skb)) {
49 TCI = skb_vlan_tag_get(skb);
Jesse Gross13937912010-10-20 13:56:01 +000050 encap = skb->protocol;
51 } else {
52 const struct vlan_hdr *fp;
53 struct vlan_hdr _frame;
54
55 fp = skb_header_pointer(skb, 0, sizeof(_frame), &_frame);
56 if (fp == NULL)
57 return false;
58
59 TCI = ntohs(fp->h_vlan_TCI);
60 encap = fp->h_vlan_encapsulated_proto;
61 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63 /* Tag Control Information (TCI) consists of the following elements:
64 * - User_priority. The user_priority field is three bits in length,
65 * interpreted as a binary number.
66 * - Canonical Format Indicator (CFI). The Canonical Format Indicator
67 * (CFI) is a single bit flag value. Currently ignored.
68 * - VLAN Identifier (VID). The VID is encoded as
Ian Morris7f495ad2015-10-26 09:10:41 +000069 * an unsigned binary number.
70 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 id = TCI & VLAN_VID_MASK;
72 prio = (TCI >> 13) & 0x7;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74 /* Checking VLAN Identifier (VID) */
75 if (GET_BITMASK(EBT_VLAN_ID))
76 EXIT_ON_MISMATCH(id, EBT_VLAN_ID);
77
78 /* Checking user_priority */
79 if (GET_BITMASK(EBT_VLAN_PRIO))
80 EXIT_ON_MISMATCH(prio, EBT_VLAN_PRIO);
81
82 /* Checking Encapsulated Proto (Length/Type) field */
83 if (GET_BITMASK(EBT_VLAN_ENCAP))
84 EXIT_ON_MISMATCH(encap, EBT_VLAN_ENCAP);
85
Jan Engelhardt8cc784e2008-10-08 11:35:13 +020086 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087}
88
Jan Engelhardtb0f38452010-03-19 17:16:42 +010089static int ebt_vlan_mt_check(const struct xt_mtchk_param *par)
Linus Torvalds1da177e2005-04-16 15:20:36 -070090{
Jan Engelhardt9b4fce72008-10-08 11:35:18 +020091 struct ebt_vlan_info *info = par->matchinfo;
92 const struct ebt_entry *e = par->entryinfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 /* Is it 802.1Q frame checked? */
95 if (e->ethproto != htons(ETH_P_8021Q)) {
Jan Engelhardtff67e4e2010-03-19 21:08:16 +010096 pr_debug("passed entry proto %2.4X is not 802.1Q (8100)\n",
97 ntohs(e->ethproto));
Jan Engelhardtbd414ee2010-03-23 16:35:56 +010098 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 }
100
101 /* Check for bitmask range
Ian Morris7f495ad2015-10-26 09:10:41 +0000102 * True if even one bit is out of mask
103 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 if (info->bitmask & ~EBT_VLAN_MASK) {
Jan Engelhardtff67e4e2010-03-19 21:08:16 +0100105 pr_debug("bitmask %2X is out of mask (%2X)\n",
106 info->bitmask, EBT_VLAN_MASK);
Jan Engelhardtbd414ee2010-03-23 16:35:56 +0100107 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 }
109
110 /* Check for inversion flags range */
111 if (info->invflags & ~EBT_VLAN_MASK) {
Jan Engelhardtff67e4e2010-03-19 21:08:16 +0100112 pr_debug("inversion flags %2X is out of mask (%2X)\n",
113 info->invflags, EBT_VLAN_MASK);
Jan Engelhardtbd414ee2010-03-23 16:35:56 +0100114 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 }
116
117 /* Reserved VLAN ID (VID) values
118 * -----------------------------
YOSHIFUJI Hideaki9d6f2292007-02-09 23:24:35 +0900119 * 0 - The null VLAN ID.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 * 1 - The default Port VID (PVID)
YOSHIFUJI Hideaki9d6f2292007-02-09 23:24:35 +0900121 * 0x0FFF - Reserved for implementation use.
Ian Morris7f495ad2015-10-26 09:10:41 +0000122 * if_vlan.h: VLAN_N_VID 4096.
123 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 if (GET_BITMASK(EBT_VLAN_ID)) {
125 if (!!info->id) { /* if id!=0 => check vid range */
Jesse Grossb7381272010-10-20 13:56:02 +0000126 if (info->id > VLAN_N_VID) {
Jan Engelhardtff67e4e2010-03-19 21:08:16 +0100127 pr_debug("id %d is out of range (1-4096)\n",
128 info->id);
Jan Engelhardtbd414ee2010-03-23 16:35:56 +0100129 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 }
131 /* Note: This is valid VLAN-tagged frame point.
YOSHIFUJI Hideaki9d6f2292007-02-09 23:24:35 +0900132 * Any value of user_priority are acceptable,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 * but should be ignored according to 802.1Q Std.
Ian Morris7f495ad2015-10-26 09:10:41 +0000134 * So we just drop the prio flag.
135 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 info->bitmask &= ~EBT_VLAN_PRIO;
137 }
138 /* Else, id=0 (null VLAN ID) => user_priority range (any?) */
139 }
140
141 if (GET_BITMASK(EBT_VLAN_PRIO)) {
142 if ((unsigned char) info->prio > 7) {
Jan Engelhardtff67e4e2010-03-19 21:08:16 +0100143 pr_debug("prio %d is out of range (0-7)\n",
144 info->prio);
Jan Engelhardtbd414ee2010-03-23 16:35:56 +0100145 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 }
147 }
148 /* Check for encapsulated proto range - it is possible to be
149 * any value for u_short range.
Ian Morris7f495ad2015-10-26 09:10:41 +0000150 * if_ether.h: ETH_ZLEN 60 - Min. octets in frame sans FCS
151 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 if (GET_BITMASK(EBT_VLAN_ENCAP)) {
153 if ((unsigned short) ntohs(info->encap) < ETH_ZLEN) {
Jan Engelhardtff67e4e2010-03-19 21:08:16 +0100154 pr_debug("encap frame length %d is less than "
155 "minimal\n", ntohs(info->encap));
Jan Engelhardtbd414ee2010-03-23 16:35:56 +0100156 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 }
158 }
159
Jan Engelhardtbd414ee2010-03-23 16:35:56 +0100160 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
Jan Engelhardt043ef462008-10-08 11:35:15 +0200163static struct xt_match ebt_vlan_mt_reg __read_mostly = {
164 .name = "vlan",
Jan Engelhardt001a18d2008-10-08 11:35:14 +0200165 .revision = 0,
166 .family = NFPROTO_BRIDGE,
Jan Engelhardt2d06d4a2008-10-08 11:35:15 +0200167 .match = ebt_vlan_mt,
168 .checkentry = ebt_vlan_mt_check,
Florian Westphalfc0e3df2010-02-15 18:16:26 +0100169 .matchsize = sizeof(struct ebt_vlan_info),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 .me = THIS_MODULE,
171};
172
Andrew Morton65b4b4e2006-03-28 16:37:06 -0800173static int __init ebt_vlan_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174{
Jan Engelhardtff67e4e2010-03-19 21:08:16 +0100175 pr_debug("ebtables 802.1Q extension module v" MODULE_VERS "\n");
Jan Engelhardt043ef462008-10-08 11:35:15 +0200176 return xt_register_match(&ebt_vlan_mt_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177}
178
Andrew Morton65b4b4e2006-03-28 16:37:06 -0800179static void __exit ebt_vlan_fini(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180{
Jan Engelhardt043ef462008-10-08 11:35:15 +0200181 xt_unregister_match(&ebt_vlan_mt_reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182}
183
Andrew Morton65b4b4e2006-03-28 16:37:06 -0800184module_init(ebt_vlan_init);
185module_exit(ebt_vlan_fini);