libnftnl  1.0.6
payload.c
1 /*
2  * (C) 2012 by Pablo Neira Ayuso <pablo@netfilter.org>
3  *
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
6  * by the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This code has been sponsored by Sophos Astaro <http://www.sophos.com>
10  */
11 
12 #include "internal.h"
13 
14 #include <stdio.h>
15 #include <stdint.h>
16 #include <string.h>
17 #include <limits.h>
18 #include <arpa/inet.h>
19 #include <errno.h>
20 #include <libmnl/libmnl.h>
21 
22 #include <linux/netfilter/nf_tables.h>
23 
24 #include <libnftnl/expr.h>
25 #include <libnftnl/rule.h>
26 
28  enum nft_registers sreg;
29  enum nft_registers dreg;
30  enum nft_payload_bases base;
31  uint32_t offset;
32  uint32_t len;
33  uint32_t csum_type;
34  uint32_t csum_offset;
35 };
36 
37 static int
38 nftnl_expr_payload_set(struct nftnl_expr *e, uint16_t type,
39  const void *data, uint32_t data_len)
40 {
41  struct nftnl_expr_payload *payload = nftnl_expr_data(e);
42 
43  switch(type) {
44  case NFTNL_EXPR_PAYLOAD_SREG:
45  payload->sreg = *((uint32_t *)data);
46  break;
47  case NFTNL_EXPR_PAYLOAD_DREG:
48  payload->dreg = *((uint32_t *)data);
49  break;
50  case NFTNL_EXPR_PAYLOAD_BASE:
51  payload->base = *((uint32_t *)data);
52  break;
53  case NFTNL_EXPR_PAYLOAD_OFFSET:
54  payload->offset = *((unsigned int *)data);
55  break;
56  case NFTNL_EXPR_PAYLOAD_LEN:
57  payload->len = *((unsigned int *)data);
58  break;
59  case NFTNL_EXPR_PAYLOAD_CSUM_TYPE:
60  payload->csum_type = *((uint32_t *)data);
61  break;
62  case NFTNL_EXPR_PAYLOAD_CSUM_OFFSET:
63  payload->csum_offset = *((uint32_t *)data);
64  break;
65  default:
66  return -1;
67  }
68  return 0;
69 }
70 
71 static const void *
72 nftnl_expr_payload_get(const struct nftnl_expr *e, uint16_t type,
73  uint32_t *data_len)
74 {
75  struct nftnl_expr_payload *payload = nftnl_expr_data(e);
76 
77  switch(type) {
78  case NFTNL_EXPR_PAYLOAD_SREG:
79  *data_len = sizeof(payload->sreg);
80  return &payload->sreg;
81  case NFTNL_EXPR_PAYLOAD_DREG:
82  *data_len = sizeof(payload->dreg);
83  return &payload->dreg;
84  case NFTNL_EXPR_PAYLOAD_BASE:
85  *data_len = sizeof(payload->base);
86  return &payload->base;
87  case NFTNL_EXPR_PAYLOAD_OFFSET:
88  *data_len = sizeof(payload->offset);
89  return &payload->offset;
90  case NFTNL_EXPR_PAYLOAD_LEN:
91  *data_len = sizeof(payload->len);
92  return &payload->len;
93  case NFTNL_EXPR_PAYLOAD_CSUM_TYPE:
94  *data_len = sizeof(payload->csum_type);
95  return &payload->csum_type;
96  case NFTNL_EXPR_PAYLOAD_CSUM_OFFSET:
97  *data_len = sizeof(payload->csum_offset);
98  return &payload->csum_offset;
99  }
100  return NULL;
101 }
102 
103 static int nftnl_expr_payload_cb(const struct nlattr *attr, void *data)
104 {
105  const struct nlattr **tb = data;
106  int type = mnl_attr_get_type(attr);
107 
108  if (mnl_attr_type_valid(attr, NFTA_PAYLOAD_MAX) < 0)
109  return MNL_CB_OK;
110 
111  switch(type) {
112  case NFTA_PAYLOAD_SREG:
113  case NFTA_PAYLOAD_DREG:
114  case NFTA_PAYLOAD_BASE:
115  case NFTA_PAYLOAD_OFFSET:
116  case NFTA_PAYLOAD_LEN:
117  case NFTA_PAYLOAD_CSUM_TYPE:
118  case NFTA_PAYLOAD_CSUM_OFFSET:
119  if (mnl_attr_validate(attr, MNL_TYPE_U32) < 0)
120  abi_breakage();
121  break;
122  }
123 
124  tb[type] = attr;
125  return MNL_CB_OK;
126 }
127 
128 static void
129 nftnl_expr_payload_build(struct nlmsghdr *nlh, const struct nftnl_expr *e)
130 {
131  struct nftnl_expr_payload *payload = nftnl_expr_data(e);
132 
133  if (e->flags & (1 << NFTNL_EXPR_PAYLOAD_SREG))
134  mnl_attr_put_u32(nlh, NFTA_PAYLOAD_SREG, htonl(payload->sreg));
135  if (e->flags & (1 << NFTNL_EXPR_PAYLOAD_DREG))
136  mnl_attr_put_u32(nlh, NFTA_PAYLOAD_DREG, htonl(payload->dreg));
137  if (e->flags & (1 << NFTNL_EXPR_PAYLOAD_BASE))
138  mnl_attr_put_u32(nlh, NFTA_PAYLOAD_BASE, htonl(payload->base));
139  if (e->flags & (1 << NFTNL_EXPR_PAYLOAD_OFFSET))
140  mnl_attr_put_u32(nlh, NFTA_PAYLOAD_OFFSET, htonl(payload->offset));
141  if (e->flags & (1 << NFTNL_EXPR_PAYLOAD_LEN))
142  mnl_attr_put_u32(nlh, NFTA_PAYLOAD_LEN, htonl(payload->len));
143  if (e->flags & (1 << NFTNL_EXPR_PAYLOAD_CSUM_TYPE))
144  mnl_attr_put_u32(nlh, NFTA_PAYLOAD_CSUM_TYPE,
145  htonl(payload->csum_type));
146  if (e->flags & (1 << NFTNL_EXPR_PAYLOAD_CSUM_OFFSET))
147  mnl_attr_put_u32(nlh, NFTA_PAYLOAD_CSUM_OFFSET,
148  htonl(payload->csum_offset));
149 }
150 
151 static int
152 nftnl_expr_payload_parse(struct nftnl_expr *e, struct nlattr *attr)
153 {
154  struct nftnl_expr_payload *payload = nftnl_expr_data(e);
155  struct nlattr *tb[NFTA_PAYLOAD_MAX+1] = {};
156 
157  if (mnl_attr_parse_nested(attr, nftnl_expr_payload_cb, tb) < 0)
158  return -1;
159 
160  if (tb[NFTA_PAYLOAD_SREG]) {
161  payload->sreg = ntohl(mnl_attr_get_u32(tb[NFTA_PAYLOAD_SREG]));
162  e->flags |= (1 << NFT_EXPR_PAYLOAD_SREG);
163  }
164  if (tb[NFTA_PAYLOAD_DREG]) {
165  payload->dreg = ntohl(mnl_attr_get_u32(tb[NFTA_PAYLOAD_DREG]));
166  e->flags |= (1 << NFTNL_EXPR_PAYLOAD_DREG);
167  }
168  if (tb[NFTA_PAYLOAD_BASE]) {
169  payload->base = ntohl(mnl_attr_get_u32(tb[NFTA_PAYLOAD_BASE]));
170  e->flags |= (1 << NFTNL_EXPR_PAYLOAD_BASE);
171  }
172  if (tb[NFTA_PAYLOAD_OFFSET]) {
173  payload->offset = ntohl(mnl_attr_get_u32(tb[NFTA_PAYLOAD_OFFSET]));
174  e->flags |= (1 << NFTNL_EXPR_PAYLOAD_OFFSET);
175  }
176  if (tb[NFTA_PAYLOAD_LEN]) {
177  payload->len = ntohl(mnl_attr_get_u32(tb[NFTA_PAYLOAD_LEN]));
178  e->flags |= (1 << NFTNL_EXPR_PAYLOAD_LEN);
179  }
180  if (tb[NFTA_PAYLOAD_CSUM_TYPE]) {
181  payload->csum_type = ntohl(mnl_attr_get_u32(tb[NFTA_PAYLOAD_CSUM_TYPE]));
182  e->flags |= (1 << NFTNL_EXPR_PAYLOAD_CSUM_TYPE);
183  }
184  if (tb[NFTA_PAYLOAD_CSUM_OFFSET]) {
185  payload->csum_offset = ntohl(mnl_attr_get_u32(tb[NFTA_PAYLOAD_CSUM_OFFSET]));
186  e->flags |= (1 << NFTNL_EXPR_PAYLOAD_CSUM_OFFSET);
187  }
188  return 0;
189 }
190 
191 static char *base2str_array[NFT_PAYLOAD_TRANSPORT_HEADER+1] = {
192  [NFT_PAYLOAD_LL_HEADER] = "link",
193  [NFT_PAYLOAD_NETWORK_HEADER] = "network",
194  [NFT_PAYLOAD_TRANSPORT_HEADER] = "transport",
195 };
196 
197 static const char *base2str(enum nft_payload_bases base)
198 {
199  if (base > NFT_PAYLOAD_TRANSPORT_HEADER)
200  return "unknown";
201 
202  return base2str_array[base];
203 }
204 
205 static inline int nftnl_str2base(const char *base)
206 {
207  if (strcmp(base, "link") == 0)
208  return NFT_PAYLOAD_LL_HEADER;
209  else if (strcmp(base, "network") == 0)
210  return NFT_PAYLOAD_NETWORK_HEADER;
211  else if (strcmp(base, "transport") == 0)
212  return NFT_PAYLOAD_TRANSPORT_HEADER;
213  else {
214  errno = EINVAL;
215  return -1;
216  }
217 }
218 
219 static int
220 nftnl_expr_payload_json_parse(struct nftnl_expr *e, json_t *root,
221  struct nftnl_parse_err *err)
222 {
223 #ifdef JSON_PARSING
224  const char *base_str;
225  uint32_t reg, uval32;
226  int base;
227 
228  if (nftnl_jansson_parse_reg(root, "dreg", NFTNL_TYPE_U32, &reg, err) == 0)
229  nftnl_expr_set_u32(e, NFTNL_EXPR_PAYLOAD_DREG, reg);
230 
231  base_str = nftnl_jansson_parse_str(root, "base", err);
232  if (base_str != NULL) {
233  base = nftnl_str2base(base_str);
234  if (base < 0)
235  return -1;
236 
237  nftnl_expr_set_u32(e, NFTNL_EXPR_PAYLOAD_BASE, base);
238  }
239 
240  if (nftnl_jansson_parse_val(root, "offset", NFTNL_TYPE_U32, &uval32,
241  err) == 0)
242  nftnl_expr_set_u32(e, NFTNL_EXPR_PAYLOAD_OFFSET, uval32);
243 
244  if (nftnl_jansson_parse_val(root, "len", NFTNL_TYPE_U32, &uval32, err) == 0)
245  nftnl_expr_set_u32(e, NFTNL_EXPR_PAYLOAD_LEN, uval32);
246 
247  return 0;
248 #else
249  errno = EOPNOTSUPP;
250  return -1;
251 #endif
252 }
253 
254 static int
255 nftnl_expr_payload_xml_parse(struct nftnl_expr *e, mxml_node_t *tree,
256  struct nftnl_parse_err *err)
257 {
258 #ifdef XML_PARSING
259  const char *base_str;
260  int32_t base;
261  uint32_t dreg, offset, len;
262 
263  if (nftnl_mxml_reg_parse(tree, "dreg", &dreg, MXML_DESCEND_FIRST,
264  NFTNL_XML_MAND, err) == 0)
265  nftnl_expr_set_u32(e, NFTNL_EXPR_PAYLOAD_DREG, dreg);
266 
267  base_str = nftnl_mxml_str_parse(tree, "base", MXML_DESCEND_FIRST,
268  NFTNL_XML_MAND, err);
269  if (base_str != NULL) {
270  base = nftnl_str2base(base_str);
271  if (base < 0)
272  return -1;
273 
274  nftnl_expr_set_u32(e, NFTNL_EXPR_PAYLOAD_BASE, base);
275  }
276 
277  if (nftnl_mxml_num_parse(tree, "offset", MXML_DESCEND_FIRST, BASE_DEC,
278  &offset, NFTNL_TYPE_U32, NFTNL_XML_MAND, err) == 0)
279  nftnl_expr_set_u32(e, NFTNL_EXPR_PAYLOAD_OFFSET, offset);
280 
281 
282  if (nftnl_mxml_num_parse(tree, "len", MXML_DESCEND_FIRST, BASE_DEC,
283  &len, NFTNL_TYPE_U32, NFTNL_XML_MAND, err) == 0)
284  nftnl_expr_set_u32(e, NFTNL_EXPR_PAYLOAD_LEN, len);
285 
286  return 0;
287 #else
288  errno = EOPNOTSUPP;
289  return -1;
290 #endif
291 }
292 
293 static int nftnl_expr_payload_export(char *buf, size_t size, uint32_t flags,
294  const struct nftnl_expr *e, int type)
295 {
296  struct nftnl_expr_payload *payload = nftnl_expr_data(e);
297  NFTNL_BUF_INIT(b, buf, size);
298 
299  if (e->flags & (1 << NFTNL_EXPR_PAYLOAD_DREG))
300  nftnl_buf_u32(&b, type, payload->dreg, DREG);
301  if (e->flags & (1 << NFTNL_EXPR_PAYLOAD_OFFSET))
302  nftnl_buf_u32(&b, type, payload->offset, OFFSET);
303  if (e->flags & (1 << NFTNL_EXPR_PAYLOAD_LEN))
304  nftnl_buf_u32(&b, type, payload->len, LEN);
305  if (e->flags & (1 << NFTNL_EXPR_PAYLOAD_BASE))
306  nftnl_buf_str(&b, type, base2str(payload->base), BASE);
307 
308  return nftnl_buf_done(&b);
309 }
310 
311 static int
312 nftnl_expr_payload_snprintf(char *buf, size_t len, uint32_t type,
313  uint32_t flags, const struct nftnl_expr *e)
314 {
315  struct nftnl_expr_payload *payload = nftnl_expr_data(e);
316 
317  switch (type) {
318  case NFTNL_OUTPUT_DEFAULT:
319  if (payload->sreg)
320  return snprintf(buf, len, "write reg %u => %ub @ %s header + %u csum_type %u csum_off %u ",
321  payload->sreg,
322  payload->len, base2str(payload->base),
323  payload->offset, payload->csum_type,
324  payload->csum_offset);
325  else
326  return snprintf(buf, len, "load %ub @ %s header + %u => reg %u ",
327  payload->len, base2str(payload->base),
328  payload->offset, payload->dreg);
329  case NFTNL_OUTPUT_XML:
330  case NFTNL_OUTPUT_JSON:
331  return nftnl_expr_payload_export(buf, len, flags, e, type);
332  default:
333  break;
334  }
335  return -1;
336 }
337 
338 struct expr_ops expr_ops_payload = {
339  .name = "payload",
340  .alloc_len = sizeof(struct nftnl_expr_payload),
341  .max_attr = NFTA_PAYLOAD_MAX,
342  .set = nftnl_expr_payload_set,
343  .get = nftnl_expr_payload_get,
344  .parse = nftnl_expr_payload_parse,
345  .build = nftnl_expr_payload_build,
346  .snprintf = nftnl_expr_payload_snprintf,
347  .xml_parse = nftnl_expr_payload_xml_parse,
348  .json_parse = nftnl_expr_payload_json_parse,
349 };