net/netfilter/nft_bitwise.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Copyright (c) 2008-2009 Patrick McHardy <kaber@trash.net>
   4  *
   5  * Development of this code funded by Astaro AG (http://www.astaro.com/)
   6  */
   7
   8 #include <linux/kernel.h>
   9 #include <linux/init.h>
  10 #include <linux/module.h>
  11 #include <linux/netlink.h>
  12 #include <linux/netfilter.h>
  13 #include <linux/netfilter/nf_tables.h>
  14 #include <net/netfilter/nf_tables_core.h>
  15 #include <net/netfilter/nf_tables.h>
  16 #include <net/netfilter/nf_tables_offload.h>
  17
  18 struct nft_bitwise {
  19         u8                      sreg;
  20         u8                      dreg;
  21         enum nft_bitwise_ops    op:8;
  22         u8                      len;
  23         struct nft_data         mask;
  24         struct nft_data         xor;
  25         struct nft_data         data;
  26 };
  27
  28 static void nft_bitwise_eval_bool(u32 *dst, const u32 *src,
  29                                   const struct nft_bitwise *priv)
  30 {
  31         unsigned int i;
  32
  33         for (i = 0; i < DIV_ROUND_UP(priv->len, 4); i++)
  34                 dst[i] = (src[i] & priv->mask.data[i]) ^ priv->xor.data[i];
  35 }
  36
  37 static void nft_bitwise_eval_lshift(u32 *dst, const u32 *src,
  38                                     const struct nft_bitwise *priv)
  39 {
  40         u32 shift = priv->data.data[0];
  41         unsigned int i;
  42         u32 carry = 0;
  43
  44         for (i = DIV_ROUND_UP(priv->len, sizeof(u32)); i > 0; i--) {
  45                 dst[i - 1] = (src[i - 1] << shift) | carry;
  46                 carry = src[i - 1] >> (BITS_PER_TYPE(u32) - shift);
  47         }
  48 }
  49
  50 static void nft_bitwise_eval_rshift(u32 *dst, const u32 *src,
  51                                     const struct nft_bitwise *priv)
  52 {
  53         u32 shift = priv->data.data[0];
  54         unsigned int i;
  55         u32 carry = 0;
  56
  57         for (i = 0; i < DIV_ROUND_UP(priv->len, sizeof(u32)); i++) {
  58                 dst[i] = carry | (src[i] >> shift);
  59                 carry = src[i] << (BITS_PER_TYPE(u32) - shift);
  60         }
  61 }
  62
  63 void nft_bitwise_eval(const struct nft_expr *expr,
  64                       struct nft_regs *regs, const struct nft_pktinfo *pkt)
  65 {
  66         const struct nft_bitwise *priv = nft_expr_priv(expr);
  67         const u32 *src = &regs->data[priv->sreg];
  68         u32 *dst = &regs->data[priv->dreg];
  69
  70         switch (priv->op) {
  71         case NFT_BITWISE_BOOL:
  72                 nft_bitwise_eval_bool(dst, src, priv);
  73                 break;
  74         case NFT_BITWISE_LSHIFT:
  75                 nft_bitwise_eval_lshift(dst, src, priv);
  76                 break;
  77         case NFT_BITWISE_RSHIFT:
  78                 nft_bitwise_eval_rshift(dst, src, priv);
  79                 break;
  80         }
  81 }
  82
  83 static const struct nla_policy nft_bitwise_policy[NFTA_BITWISE_MAX + 1] = {
  84         [NFTA_BITWISE_SREG]     = { .type = NLA_U32 },
  85         [NFTA_BITWISE_DREG]     = { .type = NLA_U32 },
  86         [NFTA_BITWISE_LEN]      = { .type = NLA_U32 },
  87         [NFTA_BITWISE_MASK]     = { .type = NLA_NESTED },
  88         [NFTA_BITWISE_XOR]      = { .type = NLA_NESTED },
  89         [NFTA_BITWISE_OP]       = { .type = NLA_U32 },
  90         [NFTA_BITWISE_DATA]     = { .type = NLA_NESTED },
  91 };
  92
  93 static int nft_bitwise_init_bool(struct nft_bitwise *priv,
  94                                  const struct nlattr *const tb[])
  95 {
  96         struct nft_data_desc mask = {
  97                 .type   = NFT_DATA_VALUE,
  98                 .size   = sizeof(priv->mask),
  99                 .len    = priv->len,
 100         };
 101         struct nft_data_desc xor = {
 102                 .type   = NFT_DATA_VALUE,
 103                 .size   = sizeof(priv->xor),
 104                 .len    = priv->len,
 105         };
 106         int err;
 107
 108         if (tb[NFTA_BITWISE_DATA])
 109                 return -EINVAL;
 110
 111         if (!tb[NFTA_BITWISE_MASK] ||
 112             !tb[NFTA_BITWISE_XOR])
 113                 return -EINVAL;
 114
 115         err = nft_data_init(NULL, &priv->mask, &mask, tb[NFTA_BITWISE_MASK]);
 116         if (err < 0)
 117                 return err;
 118
 119         err = nft_data_init(NULL, &priv->xor, &xor, tb[NFTA_BITWISE_XOR]);
 120         if (err < 0)
 121                 goto err_xor_err;
 122
 123         return 0;
 124
 125 err_xor_err:
 126         nft_data_release(&priv->mask, mask.type);
 127
 128         return err;
 129 }
 130
 131 static int nft_bitwise_init_shift(struct nft_bitwise *priv,
 132                                   const struct nlattr *const tb[])
 133 {
 134         struct nft_data_desc desc = {
 135                 .type   = NFT_DATA_VALUE,
 136                 .size   = sizeof(priv->data),
 137                 .len    = sizeof(u32),
 138         };
 139         int err;
 140
 141         if (tb[NFTA_BITWISE_MASK] ||
 142             tb[NFTA_BITWISE_XOR])
 143                 return -EINVAL;
 144
 145         if (!tb[NFTA_BITWISE_DATA])
 146                 return -EINVAL;
 147
 148         err = nft_data_init(NULL, &priv->data, &desc, tb[NFTA_BITWISE_DATA]);
 149         if (err < 0)
 150                 return err;
 151
 152         if (priv->data.data[0] >= BITS_PER_TYPE(u32)) {
 153                 nft_data_release(&priv->data, desc.type);
 154                 return -EINVAL;
 155         }
 156
 157         return 0;
 158 }
 159
 160 static int nft_bitwise_init(const struct nft_ctx *ctx,
 161                             const struct nft_expr *expr,
 162                             const struct nlattr * const tb[])
 163 {
 164         struct nft_bitwise *priv = nft_expr_priv(expr);
 165         u32 len;
 166         int err;
 167
 168         err = nft_parse_u32_check(tb[NFTA_BITWISE_LEN], U8_MAX, &len);
 169         if (err < 0)
 170                 return err;
 171
 172         priv->len = len;
 173
 174         err = nft_parse_register_load(tb[NFTA_BITWISE_SREG], &priv->sreg,
 175                                       priv->len);
 176         if (err < 0)
 177                 return err;
 178
 179         err = nft_parse_register_store(ctx, tb[NFTA_BITWISE_DREG],
 180                                        &priv->dreg, NULL, NFT_DATA_VALUE,
 181                                        priv->len);
 182         if (err < 0)
 183                 return err;
 184
 185         if (tb[NFTA_BITWISE_OP]) {
 186                 priv->op = ntohl(nla_get_be32(tb[NFTA_BITWISE_OP]));
 187                 switch (priv->op) {
 188                 case NFT_BITWISE_BOOL:
 189                 case NFT_BITWISE_LSHIFT:
 190                 case NFT_BITWISE_RSHIFT:
 191                         break;
 192                 default:
 193                         return -EOPNOTSUPP;
 194                 }
 195         } else {
 196                 priv->op = NFT_BITWISE_BOOL;
 197         }
 198
 199         switch(priv->op) {
 200         case NFT_BITWISE_BOOL:
 201                 err = nft_bitwise_init_bool(priv, tb);
 202                 break;
 203         case NFT_BITWISE_LSHIFT:
 204         case NFT_BITWISE_RSHIFT:
 205                 err = nft_bitwise_init_shift(priv, tb);
 206                 break;
 207         }
 208
 209         return err;
 210 }
 211
 212 static int nft_bitwise_dump_bool(struct sk_buff *skb,
 213                                  const struct nft_bitwise *priv)
 214 {
 215         if (nft_data_dump(skb, NFTA_BITWISE_MASK, &priv->mask,
 216                           NFT_DATA_VALUE, priv->len) < 0)
 217                 return -1;
 218
 219         if (nft_data_dump(skb, NFTA_BITWISE_XOR, &priv->xor,
 220                           NFT_DATA_VALUE, priv->len) < 0)
 221                 return -1;
 222
 223         return 0;
 224 }
 225
 226 static int nft_bitwise_dump_shift(struct sk_buff *skb,
 227                                   const struct nft_bitwise *priv)
 228 {
 229         if (nft_data_dump(skb, NFTA_BITWISE_DATA, &priv->data,
 230                           NFT_DATA_VALUE, sizeof(u32)) < 0)
 231                 return -1;
 232         return 0;
 233 }
 234
 235 static int nft_bitwise_dump(struct sk_buff *skb, const struct nft_expr *expr)
 236 {
 237         const struct nft_bitwise *priv = nft_expr_priv(expr);
 238         int err = 0;
 239
 240         if (nft_dump_register(skb, NFTA_BITWISE_SREG, priv->sreg))
 241                 return -1;
 242         if (nft_dump_register(skb, NFTA_BITWISE_DREG, priv->dreg))
 243                 return -1;
 244         if (nla_put_be32(skb, NFTA_BITWISE_LEN, htonl(priv->len)))
 245                 return -1;
 246         if (nla_put_be32(skb, NFTA_BITWISE_OP, htonl(priv->op)))
 247                 return -1;
 248
 249         switch (priv->op) {
 250         case NFT_BITWISE_BOOL:
 251                 err = nft_bitwise_dump_bool(skb, priv);
 252                 break;
 253         case NFT_BITWISE_LSHIFT:
 254         case NFT_BITWISE_RSHIFT:
 255                 err = nft_bitwise_dump_shift(skb, priv);
 256                 break;
 257         }
 258
 259         return err;
 260 }
 261
 262 static struct nft_data zero;
 263
 264 static int nft_bitwise_offload(struct nft_offload_ctx *ctx,
 265                                struct nft_flow_rule *flow,
 266                                const struct nft_expr *expr)
 267 {
 268         const struct nft_bitwise *priv = nft_expr_priv(expr);
 269         struct nft_offload_reg *reg = &ctx->regs[priv->dreg];
 270
 271         if (priv->op != NFT_BITWISE_BOOL)
 272                 return -EOPNOTSUPP;
 273
 274         if (memcmp(&priv->xor, &zero, sizeof(priv->xor)) ||
 275             priv->sreg != priv->dreg || priv->len != reg->len)
 276                 return -EOPNOTSUPP;
 277
 278         memcpy(&reg->mask, &priv->mask, sizeof(priv->mask));
 279
 280         return 0;
 281 }
 282
 283 static const struct nft_expr_ops nft_bitwise_ops = {
 284         .type           = &nft_bitwise_type,
 285         .size           = NFT_EXPR_SIZE(sizeof(struct nft_bitwise)),
 286         .eval           = nft_bitwise_eval,
 287         .init           = nft_bitwise_init,
 288         .dump           = nft_bitwise_dump,
 289         .offload        = nft_bitwise_offload,
 290 };
 291
 292 static int
 293 nft_bitwise_extract_u32_data(const struct nlattr * const tb, u32 *out)
 294 {
 295         struct nft_data data;
 296         struct nft_data_desc desc = {
 297                 .type   = NFT_DATA_VALUE,
 298                 .size   = sizeof(data),
 299                 .len    = sizeof(u32),
 300         };
 301         int err;
 302
 303         err = nft_data_init(NULL, &data, &desc, tb);
 304         if (err < 0)
 305                 return err;
 306
 307         *out = data.data[0];
 308
 309         return 0;
 310 }
 311
 312 static int nft_bitwise_fast_init(const struct nft_ctx *ctx,
 313                                  const struct nft_expr *expr,
 314                                  const struct nlattr * const tb[])
 315 {
 316         struct nft_bitwise_fast_expr *priv = nft_expr_priv(expr);
 317         int err;
 318
 319         err = nft_parse_register_load(tb[NFTA_BITWISE_SREG], &priv->sreg,
 320                                       sizeof(u32));
 321         if (err < 0)
 322                 return err;
 323
 324         err = nft_parse_register_store(ctx, tb[NFTA_BITWISE_DREG], &priv->dreg,
 325                                        NULL, NFT_DATA_VALUE, sizeof(u32));
 326         if (err < 0)
 327                 return err;
 328
 329         if (tb[NFTA_BITWISE_DATA])
 330                 return -EINVAL;
 331
 332         if (!tb[NFTA_BITWISE_MASK] ||
 333             !tb[NFTA_BITWISE_XOR])
 334                 return -EINVAL;
 335
 336         err = nft_bitwise_extract_u32_data(tb[NFTA_BITWISE_MASK], &priv->mask);
 337         if (err < 0)
 338                 return err;
 339
 340         err = nft_bitwise_extract_u32_data(tb[NFTA_BITWISE_XOR], &priv->xor);
 341         if (err < 0)
 342                 return err;
 343
 344         return 0;
 345 }
 346
 347 static int
 348 nft_bitwise_fast_dump(struct sk_buff *skb, const struct nft_expr *expr)
 349 {
 350         const struct nft_bitwise_fast_expr *priv = nft_expr_priv(expr);
 351         struct nft_data data;
 352
 353         if (nft_dump_register(skb, NFTA_BITWISE_SREG, priv->sreg))
 354                 return -1;
 355         if (nft_dump_register(skb, NFTA_BITWISE_DREG, priv->dreg))
 356                 return -1;
 357         if (nla_put_be32(skb, NFTA_BITWISE_LEN, htonl(sizeof(u32))))
 358                 return -1;
 359         if (nla_put_be32(skb, NFTA_BITWISE_OP, htonl(NFT_BITWISE_BOOL)))
 360                 return -1;
 361
 362         data.data[0] = priv->mask;
 363         if (nft_data_dump(skb, NFTA_BITWISE_MASK, &data,
 364                           NFT_DATA_VALUE, sizeof(u32)) < 0)
 365                 return -1;
 366
 367         data.data[0] = priv->xor;
 368         if (nft_data_dump(skb, NFTA_BITWISE_XOR, &data,
 369                           NFT_DATA_VALUE, sizeof(u32)) < 0)
 370                 return -1;
 371
 372         return 0;
 373 }
 374
 375 static int nft_bitwise_fast_offload(struct nft_offload_ctx *ctx,
 376                                     struct nft_flow_rule *flow,
 377                                     const struct nft_expr *expr)
 378 {
 379         const struct nft_bitwise_fast_expr *priv = nft_expr_priv(expr);
 380         struct nft_offload_reg *reg = &ctx->regs[priv->dreg];
 381
 382         if (priv->xor || priv->sreg != priv->dreg || reg->len != sizeof(u32))
 383                 return -EOPNOTSUPP;
 384
 385         reg->mask.data[0] = priv->mask;
 386         return 0;
 387 }
 388
 389 const struct nft_expr_ops nft_bitwise_fast_ops = {
 390         .type           = &nft_bitwise_type,
 391         .size           = NFT_EXPR_SIZE(sizeof(struct nft_bitwise_fast_expr)),
 392         .eval           = NULL, /* inlined */
 393         .init           = nft_bitwise_fast_init,
 394         .dump           = nft_bitwise_fast_dump,
 395         .offload        = nft_bitwise_fast_offload,
 396 };
 397
 398 static const struct nft_expr_ops *
 399 nft_bitwise_select_ops(const struct nft_ctx *ctx,
 400                        const struct nlattr * const tb[])
 401 {
 402         int err;
 403         u32 len;
 404
 405         if (!tb[NFTA_BITWISE_LEN] ||
 406             !tb[NFTA_BITWISE_SREG] ||
 407             !tb[NFTA_BITWISE_DREG])
 408                 return ERR_PTR(-EINVAL);
 409
 410         err = nft_parse_u32_check(tb[NFTA_BITWISE_LEN], U8_MAX, &len);
 411         if (err < 0)
 412                 return ERR_PTR(err);
 413
 414         if (len != sizeof(u32))
 415                 return &nft_bitwise_ops;
 416
 417         if (tb[NFTA_BITWISE_OP] &&
 418             ntohl(nla_get_be32(tb[NFTA_BITWISE_OP])) != NFT_BITWISE_BOOL)
 419                 return &nft_bitwise_ops;
 420
 421         return &nft_bitwise_fast_ops;
 422 }
 423
 424 struct nft_expr_type nft_bitwise_type __read_mostly = {
 425         .name           = "bitwise",
 426         .select_ops     = nft_bitwise_select_ops,
 427         .policy         = nft_bitwise_policy,
 428         .maxattr        = NFTA_BITWISE_MAX,
 429         .owner          = THIS_MODULE,
 430 };