lib/nlattr.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * NETLINK      Netlink attributes
   4  *
   5  *              Authors:        Thomas Graf <tgraf@suug.ch>
   6  *                              Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>
   7  */
   8
   9 #include <linux/export.h>
  10 #include <linux/kernel.h>
  11 #include <linux/errno.h>
  12 #include <linux/jiffies.h>
  13 #include <linux/skbuff.h>
  14 #include <linux/string.h>
  15 #include <linux/types.h>
  16 #include <net/netlink.h>
  17
  18 /* For these data types, attribute length should be exactly the given
  19  * size. However, to maintain compatibility with broken commands, if the
  20  * attribute length does not match the expected size a warning is emitted
  21  * to the user that the command is sending invalid data and needs to be fixed.
  22  */
  23 static const u8 nla_attr_len[NLA_TYPE_MAX+1] = {
  24         [NLA_U8]        = sizeof(u8),
  25         [NLA_U16]       = sizeof(u16),
  26         [NLA_U32]       = sizeof(u32),
  27         [NLA_U64]       = sizeof(u64),
  28         [NLA_S8]        = sizeof(s8),
  29         [NLA_S16]       = sizeof(s16),
  30         [NLA_S32]       = sizeof(s32),
  31         [NLA_S64]       = sizeof(s64),
  32 };
  33
  34 static const u8 nla_attr_minlen[NLA_TYPE_MAX+1] = {
  35         [NLA_U8]        = sizeof(u8),
  36         [NLA_U16]       = sizeof(u16),
  37         [NLA_U32]       = sizeof(u32),
  38         [NLA_U64]       = sizeof(u64),
  39         [NLA_MSECS]     = sizeof(u64),
  40         [NLA_NESTED]    = NLA_HDRLEN,
  41         [NLA_S8]        = sizeof(s8),
  42         [NLA_S16]       = sizeof(s16),
  43         [NLA_S32]       = sizeof(s32),
  44         [NLA_S64]       = sizeof(s64),
  45 };
  46
  47 /*
  48  * Nested policies might refer back to the original
  49  * policy in some cases, and userspace could try to
  50  * abuse that and recurse by nesting in the right
  51  * ways. Limit recursion to avoid this problem.
  52  */
  53 #define MAX_POLICY_RECURSION_DEPTH      10
  54
  55 static int __nla_validate_parse(const struct nlattr *head, int len, int maxtype,
  56                                 const struct nla_policy *policy,
  57                                 unsigned int validate,
  58                                 struct netlink_ext_ack *extack,
  59                                 struct nlattr **tb, unsigned int depth);
  60
  61 static int validate_nla_bitfield32(const struct nlattr *nla,
  62                                    const u32 valid_flags_mask)
  63 {
  64         const struct nla_bitfield32 *bf = nla_data(nla);
  65
  66         if (!valid_flags_mask)
  67                 return -EINVAL;
  68
  69         /*disallow invalid bit selector */
  70         if (bf->selector & ~valid_flags_mask)
  71                 return -EINVAL;
  72
  73         /*disallow invalid bit values */
  74         if (bf->value & ~valid_flags_mask)
  75                 return -EINVAL;
  76
  77         /*disallow valid bit values that are not selected*/
  78         if (bf->value & ~bf->selector)
  79                 return -EINVAL;
  80
  81         return 0;
  82 }
  83
  84 static int nla_validate_array(const struct nlattr *head, int len, int maxtype,
  85                               const struct nla_policy *policy,
  86                               struct netlink_ext_ack *extack,
  87                               unsigned int validate, unsigned int depth)
  88 {
  89         const struct nlattr *entry;
  90         int rem;
  91
  92         nla_for_each_attr(entry, head, len, rem) {
  93                 int ret;
  94
  95                 if (nla_len(entry) == 0)
  96                         continue;
  97
  98                 if (nla_len(entry) < NLA_HDRLEN) {
  99                         NL_SET_ERR_MSG_ATTR(extack, entry,
 100                                             "Array element too short");
 101                         return -ERANGE;
 102                 }
 103
 104                 ret = __nla_validate_parse(nla_data(entry), nla_len(entry),
 105                                            maxtype, policy, validate, extack,
 106                                            NULL, depth + 1);
 107                 if (ret < 0)
 108                         return ret;
 109         }
 110
 111         return 0;
 112 }
 113
 114 void nla_get_range_unsigned(const struct nla_policy *pt,
 115                             struct netlink_range_validation *range)
 116 {
 117         WARN_ON_ONCE(pt->validation_type != NLA_VALIDATE_RANGE_PTR &&
 118                      (pt->min < 0 || pt->max < 0));
 119
 120         range->min = 0;
 121
 122         switch (pt->type) {
 123         case NLA_U8:
 124                 range->max = U8_MAX;
 125                 break;
 126         case NLA_U16:
 127         case NLA_BINARY:
 128                 range->max = U16_MAX;
 129                 break;
 130         case NLA_U32:
 131                 range->max = U32_MAX;
 132                 break;
 133         case NLA_U64:
 134         case NLA_MSECS:
 135                 range->max = U64_MAX;
 136                 break;
 137         default:
 138                 WARN_ON_ONCE(1);
 139                 return;
 140         }
 141
 142         switch (pt->validation_type) {
 143         case NLA_VALIDATE_RANGE:
 144         case NLA_VALIDATE_RANGE_WARN_TOO_LONG:
 145                 range->min = pt->min;
 146                 range->max = pt->max;
 147                 break;
 148         case NLA_VALIDATE_RANGE_PTR:
 149                 *range = *pt->range;
 150                 break;
 151         case NLA_VALIDATE_MIN:
 152                 range->min = pt->min;
 153                 break;
 154         case NLA_VALIDATE_MAX:
 155                 range->max = pt->max;
 156                 break;
 157         default:
 158                 break;
 159         }
 160 }
 161
 162 static int nla_validate_range_unsigned(const struct nla_policy *pt,
 163                                        const struct nlattr *nla,
 164                                        struct netlink_ext_ack *extack,
 165                                        unsigned int validate)
 166 {
 167         struct netlink_range_validation range;
 168         u64 value;
 169
 170         switch (pt->type) {
 171         case NLA_U8:
 172                 value = nla_get_u8(nla);
 173                 break;
 174         case NLA_U16:
 175                 value = nla_get_u16(nla);
 176                 break;
 177         case NLA_U32:
 178                 value = nla_get_u32(nla);
 179                 break;
 180         case NLA_U64:
 181         case NLA_MSECS:
 182                 value = nla_get_u64(nla);
 183                 break;
 184         case NLA_BINARY:
 185                 value = nla_len(nla);
 186                 break;
 187         default:
 188                 return -EINVAL;
 189         }
 190
 191         nla_get_range_unsigned(pt, &range);
 192
 193         if (pt->validation_type == NLA_VALIDATE_RANGE_WARN_TOO_LONG &&
 194             pt->type == NLA_BINARY && value > range.max) {
 195                 pr_warn_ratelimited("netlink: '%s': attribute type %d has an invalid length.\n",
 196                                     current->comm, pt->type);
 197                 if (validate & NL_VALIDATE_STRICT_ATTRS) {
 198                         NL_SET_ERR_MSG_ATTR(extack, nla,
 199                                             "invalid attribute length");
 200                         return -EINVAL;
 201                 }
 202
 203                 /* this assumes min <= max (don't validate against min) */
 204                 return 0;
 205         }
 206
 207         if (value < range.min || value > range.max) {
 208                 bool binary = pt->type == NLA_BINARY;
 209
 210                 if (binary)
 211                         NL_SET_ERR_MSG_ATTR(extack, nla,
 212                                             "binary attribute size out of range");
 213                 else
 214                         NL_SET_ERR_MSG_ATTR(extack, nla,
 215                                             "integer out of range");
 216
 217                 return -ERANGE;
 218         }
 219
 220         return 0;
 221 }
 222
 223 void nla_get_range_signed(const struct nla_policy *pt,
 224                           struct netlink_range_validation_signed *range)
 225 {
 226         switch (pt->type) {
 227         case NLA_S8:
 228                 range->min = S8_MIN;
 229                 range->max = S8_MAX;
 230                 break;
 231         case NLA_S16:
 232                 range->min = S16_MIN;
 233                 range->max = S16_MAX;
 234                 break;
 235         case NLA_S32:
 236                 range->min = S32_MIN;
 237                 range->max = S32_MAX;
 238                 break;
 239         case NLA_S64:
 240                 range->min = S64_MIN;
 241                 range->max = S64_MAX;
 242                 break;
 243         default:
 244                 WARN_ON_ONCE(1);
 245                 return;
 246         }
 247
 248         switch (pt->validation_type) {
 249         case NLA_VALIDATE_RANGE:
 250                 range->min = pt->min;
 251                 range->max = pt->max;
 252                 break;
 253         case NLA_VALIDATE_RANGE_PTR:
 254                 *range = *pt->range_signed;
 255                 break;
 256         case NLA_VALIDATE_MIN:
 257                 range->min = pt->min;
 258                 break;
 259         case NLA_VALIDATE_MAX:
 260                 range->max = pt->max;
 261                 break;
 262         default:
 263                 break;
 264         }
 265 }
 266
 267 static int nla_validate_int_range_signed(const struct nla_policy *pt,
 268                                          const struct nlattr *nla,
 269                                          struct netlink_ext_ack *extack)
 270 {
 271         struct netlink_range_validation_signed range;
 272         s64 value;
 273
 274         switch (pt->type) {
 275         case NLA_S8:
 276                 value = nla_get_s8(nla);
 277                 break;
 278         case NLA_S16:
 279                 value = nla_get_s16(nla);
 280                 break;
 281         case NLA_S32:
 282                 value = nla_get_s32(nla);
 283                 break;
 284         case NLA_S64:
 285                 value = nla_get_s64(nla);
 286                 break;
 287         default:
 288                 return -EINVAL;
 289         }
 290
 291         nla_get_range_signed(pt, &range);
 292
 293         if (value < range.min || value > range.max) {
 294                 NL_SET_ERR_MSG_ATTR(extack, nla,
 295                                     "integer out of range");
 296                 return -ERANGE;
 297         }
 298
 299         return 0;
 300 }
 301
 302 static int nla_validate_int_range(const struct nla_policy *pt,
 303                                   const struct nlattr *nla,
 304                                   struct netlink_ext_ack *extack,
 305                                   unsigned int validate)
 306 {
 307         switch (pt->type) {
 308         case NLA_U8:
 309         case NLA_U16:
 310         case NLA_U32:
 311         case NLA_U64:
 312         case NLA_MSECS:
 313         case NLA_BINARY:
 314                 return nla_validate_range_unsigned(pt, nla, extack, validate);
 315         case NLA_S8:
 316         case NLA_S16:
 317         case NLA_S32:
 318         case NLA_S64:
 319                 return nla_validate_int_range_signed(pt, nla, extack);
 320         default:
 321                 WARN_ON(1);
 322                 return -EINVAL;
 323         }
 324 }
 325
 326 static int nla_validate_mask(const struct nla_policy *pt,
 327                              const struct nlattr *nla,
 328                              struct netlink_ext_ack *extack)
 329 {
 330         u64 value;
 331
 332         switch (pt->type) {
 333         case NLA_U8:
 334                 value = nla_get_u8(nla);
 335                 break;
 336         case NLA_U16:
 337                 value = nla_get_u16(nla);
 338                 break;
 339         case NLA_U32:
 340                 value = nla_get_u32(nla);
 341                 break;
 342         case NLA_U64:
 343                 value = nla_get_u64(nla);
 344                 break;
 345         default:
 346                 return -EINVAL;
 347         }
 348
 349         if (value & ~(u64)pt->mask) {
 350                 NL_SET_ERR_MSG_ATTR(extack, nla, "reserved bit set");
 351                 return -EINVAL;
 352         }
 353
 354         return 0;
 355 }
 356
 357 static int validate_nla(const struct nlattr *nla, int maxtype,
 358                         const struct nla_policy *policy, unsigned int validate,
 359                         struct netlink_ext_ack *extack, unsigned int depth)
 360 {
 361         u16 strict_start_type = policy[0].strict_start_type;
 362         const struct nla_policy *pt;
 363         int minlen = 0, attrlen = nla_len(nla), type = nla_type(nla);
 364         int err = -ERANGE;
 365
 366         if (strict_start_type && type >= strict_start_type)
 367                 validate |= NL_VALIDATE_STRICT;
 368
 369         if (type <= 0 || type > maxtype)
 370                 return 0;
 371
 372         pt = &policy[type];
 373
 374         BUG_ON(pt->type > NLA_TYPE_MAX);
 375
 376         if (nla_attr_len[pt->type] && attrlen != nla_attr_len[pt->type]) {
 377                 pr_warn_ratelimited("netlink: '%s': attribute type %d has an invalid length.\n",
 378                                     current->comm, type);
 379                 if (validate & NL_VALIDATE_STRICT_ATTRS) {
 380                         NL_SET_ERR_MSG_ATTR(extack, nla,
 381                                             "invalid attribute length");
 382                         return -EINVAL;
 383                 }
 384         }
 385
 386         if (validate & NL_VALIDATE_NESTED) {
 387                 if ((pt->type == NLA_NESTED || pt->type == NLA_NESTED_ARRAY) &&
 388                     !(nla->nla_type & NLA_F_NESTED)) {
 389                         NL_SET_ERR_MSG_ATTR(extack, nla,
 390                                             "NLA_F_NESTED is missing");
 391                         return -EINVAL;
 392                 }
 393                 if (pt->type != NLA_NESTED && pt->type != NLA_NESTED_ARRAY &&
 394                     pt->type != NLA_UNSPEC && (nla->nla_type & NLA_F_NESTED)) {
 395                         NL_SET_ERR_MSG_ATTR(extack, nla,
 396                                             "NLA_F_NESTED not expected");
 397                         return -EINVAL;
 398                 }
 399         }
 400
 401         switch (pt->type) {
 402         case NLA_REJECT:
 403                 if (extack && pt->reject_message) {
 404                         NL_SET_BAD_ATTR(extack, nla);
 405                         extack->_msg = pt->reject_message;
 406                         return -EINVAL;
 407                 }
 408                 err = -EINVAL;
 409                 goto out_err;
 410
 411         case NLA_FLAG:
 412                 if (attrlen > 0)
 413                         goto out_err;
 414                 break;
 415
 416         case NLA_BITFIELD32:
 417                 if (attrlen != sizeof(struct nla_bitfield32))
 418                         goto out_err;
 419
 420                 err = validate_nla_bitfield32(nla, pt->bitfield32_valid);
 421                 if (err)
 422                         goto out_err;
 423                 break;
 424
 425         case NLA_NUL_STRING:
 426                 if (pt->len)
 427                         minlen = min_t(int, attrlen, pt->len + 1);
 428                 else
 429                         minlen = attrlen;
 430
 431                 if (!minlen || memchr(nla_data(nla), '\0', minlen) == NULL) {
 432                         err = -EINVAL;
 433                         goto out_err;
 434                 }
 435                 /* fall through */
 436
 437         case NLA_STRING:
 438                 if (attrlen < 1)
 439                         goto out_err;
 440
 441                 if (pt->len) {
 442                         char *buf = nla_data(nla);
 443
 444                         if (buf[attrlen - 1] == '\0')
 445                                 attrlen--;
 446
 447                         if (attrlen > pt->len)
 448                                 goto out_err;
 449                 }
 450                 break;
 451
 452         case NLA_BINARY:
 453                 if (pt->len && attrlen > pt->len)
 454                         goto out_err;
 455                 break;
 456
 457         case NLA_NESTED:
 458                 /* a nested attributes is allowed to be empty; if its not,
 459                  * it must have a size of at least NLA_HDRLEN.
 460                  */
 461                 if (attrlen == 0)
 462                         break;
 463                 if (attrlen < NLA_HDRLEN)
 464                         goto out_err;
 465                 if (pt->nested_policy) {
 466                         err = __nla_validate_parse(nla_data(nla), nla_len(nla),
 467                                                    pt->len, pt->nested_policy,
 468                                                    validate, extack, NULL,
 469                                                    depth + 1);
 470                         if (err < 0) {
 471                                 /*
 472                                  * return directly to preserve the inner
 473                                  * error message/attribute pointer
 474                                  */
 475                                 return err;
 476                         }
 477                 }
 478                 break;
 479         case NLA_NESTED_ARRAY:
 480                 /* a nested array attribute is allowed to be empty; if its not,
 481                  * it must have a size of at least NLA_HDRLEN.
 482                  */
 483                 if (attrlen == 0)
 484                         break;
 485                 if (attrlen < NLA_HDRLEN)
 486                         goto out_err;
 487                 if (pt->nested_policy) {
 488                         int err;
 489
 490                         err = nla_validate_array(nla_data(nla), nla_len(nla),
 491                                                  pt->len, pt->nested_policy,
 492                                                  extack, validate, depth);
 493                         if (err < 0) {
 494                                 /*
 495                                  * return directly to preserve the inner
 496                                  * error message/attribute pointer
 497                                  */
 498                                 return err;
 499                         }
 500                 }
 501                 break;
 502
 503         case NLA_UNSPEC:
 504                 if (validate & NL_VALIDATE_UNSPEC) {
 505                         NL_SET_ERR_MSG_ATTR(extack, nla,
 506                                             "Unsupported attribute");
 507                         return -EINVAL;
 508                 }
 509                 if (attrlen < pt->len)
 510                         goto out_err;
 511                 break;
 512
 513         default:
 514                 if (pt->len)
 515                         minlen = pt->len;
 516                 else
 517                         minlen = nla_attr_minlen[pt->type];
 518
 519                 if (attrlen < minlen)
 520                         goto out_err;
 521         }
 522
 523         /* further validation */
 524         switch (pt->validation_type) {
 525         case NLA_VALIDATE_NONE:
 526                 /* nothing to do */
 527                 break;
 528         case NLA_VALIDATE_RANGE_PTR:
 529         case NLA_VALIDATE_RANGE:
 530         case NLA_VALIDATE_RANGE_WARN_TOO_LONG:
 531         case NLA_VALIDATE_MIN:
 532         case NLA_VALIDATE_MAX:
 533                 err = nla_validate_int_range(pt, nla, extack, validate);
 534                 if (err)
 535                         return err;
 536                 break;
 537         case NLA_VALIDATE_MASK:
 538                 err = nla_validate_mask(pt, nla, extack);
 539                 if (err)
 540                         return err;
 541                 break;
 542         case NLA_VALIDATE_FUNCTION:
 543                 if (pt->validate) {
 544                         err = pt->validate(nla, extack);
 545                         if (err)
 546                                 return err;
 547                 }
 548                 break;
 549         }
 550
 551         return 0;
 552 out_err:
 553         NL_SET_ERR_MSG_ATTR(extack, nla, "Attribute failed policy validation");
 554         return err;
 555 }
 556
 557 static int __nla_validate_parse(const struct nlattr *head, int len, int maxtype,
 558                                 const struct nla_policy *policy,
 559                                 unsigned int validate,
 560                                 struct netlink_ext_ack *extack,
 561                                 struct nlattr **tb, unsigned int depth)
 562 {
 563         const struct nlattr *nla;
 564         int rem;
 565
 566         if (depth >= MAX_POLICY_RECURSION_DEPTH) {
 567                 NL_SET_ERR_MSG(extack,
 568                                "allowed policy recursion depth exceeded");
 569                 return -EINVAL;
 570         }
 571
 572         if (tb)
 573                 memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));
 574
 575         nla_for_each_attr(nla, head, len, rem) {
 576                 u16 type = nla_type(nla);
 577
 578                 if (type == 0 || type > maxtype) {
 579                         if (validate & NL_VALIDATE_MAXTYPE) {
 580                                 NL_SET_ERR_MSG_ATTR(extack, nla,
 581                                                     "Unknown attribute type");
 582                                 return -EINVAL;
 583                         }
 584                         continue;
 585                 }
 586                 if (policy) {
 587                         int err = validate_nla(nla, maxtype, policy,
 588                                                validate, extack, depth);
 589
 590                         if (err < 0)
 591                                 return err;
 592                 }
 593
 594                 if (tb)
 595                         tb[type] = (struct nlattr *)nla;
 596         }
 597
 598         if (unlikely(rem > 0)) {
 599                 pr_warn_ratelimited("netlink: %d bytes leftover after parsing attributes in process `%s'.\n",
 600                                     rem, current->comm);
 601                 NL_SET_ERR_MSG(extack, "bytes leftover after parsing attributes");
 602                 if (validate & NL_VALIDATE_TRAILING)
 603                         return -EINVAL;
 604         }
 605
 606         return 0;
 607 }
 608
 609 /**
 610  * __nla_validate - Validate a stream of attributes
 611  * @head: head of attribute stream
 612  * @len: length of attribute stream
 613  * @maxtype: maximum attribute type to be expected
 614  * @policy: validation policy
 615  * @validate: validation strictness
 616  * @extack: extended ACK report struct
 617  *
 618  * Validates all attributes in the specified attribute stream against the
 619  * specified policy. Validation depends on the validate flags passed, see
 620  * &enum netlink_validation for more details on that.
 621  * See documenation of struct nla_policy for more details.
 622  *
 623  * Returns 0 on success or a negative error code.
 624  */
 625 int __nla_validate(const struct nlattr *head, int len, int maxtype,
 626                    const struct nla_policy *policy, unsigned int validate,
 627                    struct netlink_ext_ack *extack)
 628 {
 629         return __nla_validate_parse(head, len, maxtype, policy, validate,
 630                                     extack, NULL, 0);
 631 }
 632 EXPORT_SYMBOL(__nla_validate);
 633
 634 /**
 635  * nla_policy_len - Determin the max. length of a policy
 636  * @policy: policy to use
 637  * @n: number of policies
 638  *
 639  * Determines the max. length of the policy.  It is currently used
 640  * to allocated Netlink buffers roughly the size of the actual
 641  * message.
 642  *
 643  * Returns 0 on success or a negative error code.
 644  */
 645 int
 646 nla_policy_len(const struct nla_policy *p, int n)
 647 {
 648         int i, len = 0;
 649
 650         for (i = 0; i < n; i++, p++) {
 651                 if (p->len)
 652                         len += nla_total_size(p->len);
 653                 else if (nla_attr_len[p->type])
 654                         len += nla_total_size(nla_attr_len[p->type]);
 655                 else if (nla_attr_minlen[p->type])
 656                         len += nla_total_size(nla_attr_minlen[p->type]);
 657         }
 658
 659         return len;
 660 }
 661 EXPORT_SYMBOL(nla_policy_len);
 662
 663 /**
 664  * __nla_parse - Parse a stream of attributes into a tb buffer
 665  * @tb: destination array with maxtype+1 elements
 666  * @maxtype: maximum attribute type to be expected
 667  * @head: head of attribute stream
 668  * @len: length of attribute stream
 669  * @policy: validation policy
 670  * @validate: validation strictness
 671  * @extack: extended ACK pointer
 672  *
 673  * Parses a stream of attributes and stores a pointer to each attribute in
 674  * the tb array accessible via the attribute type.
 675  * Validation is controlled by the @validate parameter.
 676  *
 677  * Returns 0 on success or a negative error code.
 678  */
 679 int __nla_parse(struct nlattr **tb, int maxtype,
 680                 const struct nlattr *head, int len,
 681                 const struct nla_policy *policy, unsigned int validate,
 682                 struct netlink_ext_ack *extack)
 683 {
 684         return __nla_validate_parse(head, len, maxtype, policy, validate,
 685                                     extack, tb, 0);
 686 }
 687 EXPORT_SYMBOL(__nla_parse);
 688
 689 /**
 690  * nla_find - Find a specific attribute in a stream of attributes
 691  * @head: head of attribute stream
 692  * @len: length of attribute stream
 693  * @attrtype: type of attribute to look for
 694  *
 695  * Returns the first attribute in the stream matching the specified type.
 696  */
 697 struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype)
 698 {
 699         const struct nlattr *nla;
 700         int rem;
 701
 702         nla_for_each_attr(nla, head, len, rem)
 703                 if (nla_type(nla) == attrtype)
 704                         return (struct nlattr *)nla;
 705
 706         return NULL;
 707 }
 708 EXPORT_SYMBOL(nla_find);
 709
 710 /**
 711  * nla_strlcpy - Copy string attribute payload into a sized buffer
 712  * @dst: where to copy the string to
 713  * @nla: attribute to copy the string from
 714  * @dstsize: size of destination buffer
 715  *
 716  * Copies at most dstsize - 1 bytes into the destination buffer.
 717  * The result is always a valid NUL-terminated string. Unlike
 718  * strlcpy the destination buffer is always padded out.
 719  *
 720  * Returns the length of the source buffer.
 721  */
 722 size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize)
 723 {
 724         size_t srclen = nla_len(nla);
 725         char *src = nla_data(nla);
 726
 727         if (srclen > 0 && src[srclen - 1] == '\0')
 728                 srclen--;
 729
 730         if (dstsize > 0) {
 731                 size_t len = (srclen >= dstsize) ? dstsize - 1 : srclen;
 732
 733                 memset(dst, 0, dstsize);
 734                 memcpy(dst, src, len);
 735         }
 736
 737         return srclen;
 738 }
 739 EXPORT_SYMBOL(nla_strlcpy);
 740
 741 /**
 742  * nla_strdup - Copy string attribute payload into a newly allocated buffer
 743  * @nla: attribute to copy the string from
 744  * @flags: the type of memory to allocate (see kmalloc).
 745  *
 746  * Returns a pointer to the allocated buffer or NULL on error.
 747  */
 748 char *nla_strdup(const struct nlattr *nla, gfp_t flags)
 749 {
 750         size_t srclen = nla_len(nla);
 751         char *src = nla_data(nla), *dst;
 752
 753         if (srclen > 0 && src[srclen - 1] == '\0')
 754                 srclen--;
 755
 756         dst = kmalloc(srclen + 1, flags);
 757         if (dst != NULL) {
 758                 memcpy(dst, src, srclen);
 759                 dst[srclen] = '\0';
 760         }
 761         return dst;
 762 }
 763 EXPORT_SYMBOL(nla_strdup);
 764
 765 /**
 766  * nla_memcpy - Copy a netlink attribute into another memory area
 767  * @dest: where to copy to memcpy
 768  * @src: netlink attribute to copy from
 769  * @count: size of the destination area
 770  *
 771  * Note: The number of bytes copied is limited by the length of
 772  *       attribute's payload. memcpy
 773  *
 774  * Returns the number of bytes copied.
 775  */
 776 int nla_memcpy(void *dest, const struct nlattr *src, int count)
 777 {
 778         int minlen = min_t(int, count, nla_len(src));
 779
 780         memcpy(dest, nla_data(src), minlen);
 781         if (count > minlen)
 782                 memset(dest + minlen, 0, count - minlen);
 783
 784         return minlen;
 785 }
 786 EXPORT_SYMBOL(nla_memcpy);
 787
 788 /**
 789  * nla_memcmp - Compare an attribute with sized memory area
 790  * @nla: netlink attribute
 791  * @data: memory area
 792  * @size: size of memory area
 793  */
 794 int nla_memcmp(const struct nlattr *nla, const void *data,
 795                              size_t size)
 796 {
 797         int d = nla_len(nla) - size;
 798
 799         if (d == 0)
 800                 d = memcmp(nla_data(nla), data, size);
 801
 802         return d;
 803 }
 804 EXPORT_SYMBOL(nla_memcmp);
 805
 806 /**
 807  * nla_strcmp - Compare a string attribute against a string
 808  * @nla: netlink string attribute
 809  * @str: another string
 810  */
 811 int nla_strcmp(const struct nlattr *nla, const char *str)
 812 {
 813         int len = strlen(str);
 814         char *buf = nla_data(nla);
 815         int attrlen = nla_len(nla);
 816         int d;
 817
 818         if (attrlen > 0 && buf[attrlen - 1] == '\0')
 819                 attrlen--;
 820
 821         d = attrlen - len;
 822         if (d == 0)
 823                 d = memcmp(nla_data(nla), str, len);
 824
 825         return d;
 826 }
 827 EXPORT_SYMBOL(nla_strcmp);
 828
 829 #ifdef CONFIG_NET
 830 /**
 831  * __nla_reserve - reserve room for attribute on the skb
 832  * @skb: socket buffer to reserve room on
 833  * @attrtype: attribute type
 834  * @attrlen: length of attribute payload
 835  *
 836  * Adds a netlink attribute header to a socket buffer and reserves
 837  * room for the payload but does not copy it.
 838  *
 839  * The caller is responsible to ensure that the skb provides enough
 840  * tailroom for the attribute header and payload.
 841  */
 842 struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
 843 {
 844         struct nlattr *nla;
 845
 846         nla = skb_put(skb, nla_total_size(attrlen));
 847         nla->nla_type = attrtype;
 848         nla->nla_len = nla_attr_size(attrlen);
 849
 850         memset((unsigned char *) nla + nla->nla_len, 0, nla_padlen(attrlen));
 851
 852         return nla;
 853 }
 854 EXPORT_SYMBOL(__nla_reserve);
 855
 856 /**
 857  * __nla_reserve_64bit - reserve room for attribute on the skb and align it
 858  * @skb: socket buffer to reserve room on
 859  * @attrtype: attribute type
 860  * @attrlen: length of attribute payload
 861  * @padattr: attribute type for the padding
 862  *
 863  * Adds a netlink attribute header to a socket buffer and reserves
 864  * room for the payload but does not copy it. It also ensure that this
 865  * attribute will have a 64-bit aligned nla_data() area.
 866  *
 867  * The caller is responsible to ensure that the skb provides enough
 868  * tailroom for the attribute header and payload.
 869  */
 870 struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype,
 871                                    int attrlen, int padattr)
 872 {
 873         nla_align_64bit(skb, padattr);
 874
 875         return __nla_reserve(skb, attrtype, attrlen);
 876 }
 877 EXPORT_SYMBOL(__nla_reserve_64bit);
 878
 879 /**
 880  * __nla_reserve_nohdr - reserve room for attribute without header
 881  * @skb: socket buffer to reserve room on
 882  * @attrlen: length of attribute payload
 883  *
 884  * Reserves room for attribute payload without a header.
 885  *
 886  * The caller is responsible to ensure that the skb provides enough
 887  * tailroom for the payload.
 888  */
 889 void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
 890 {
 891         return skb_put_zero(skb, NLA_ALIGN(attrlen));
 892 }
 893 EXPORT_SYMBOL(__nla_reserve_nohdr);
 894
 895 /**
 896  * nla_reserve - reserve room for attribute on the skb
 897  * @skb: socket buffer to reserve room on
 898  * @attrtype: attribute type
 899  * @attrlen: length of attribute payload
 900  *
 901  * Adds a netlink attribute header to a socket buffer and reserves
 902  * room for the payload but does not copy it.
 903  *
 904  * Returns NULL if the tailroom of the skb is insufficient to store
 905  * the attribute header and payload.
 906  */
 907 struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
 908 {
 909         if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
 910                 return NULL;
 911
 912         return __nla_reserve(skb, attrtype, attrlen);
 913 }
 914 EXPORT_SYMBOL(nla_reserve);
 915
 916 /**
 917  * nla_reserve_64bit - reserve room for attribute on the skb and align it
 918  * @skb: socket buffer to reserve room on
 919  * @attrtype: attribute type
 920  * @attrlen: length of attribute payload
 921  * @padattr: attribute type for the padding
 922  *
 923  * Adds a netlink attribute header to a socket buffer and reserves
 924  * room for the payload but does not copy it. It also ensure that this
 925  * attribute will have a 64-bit aligned nla_data() area.
 926  *
 927  * Returns NULL if the tailroom of the skb is insufficient to store
 928  * the attribute header and payload.
 929  */
 930 struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype, int attrlen,
 931                                  int padattr)
 932 {
 933         size_t len;
 934
 935         if (nla_need_padding_for_64bit(skb))
 936                 len = nla_total_size_64bit(attrlen);
 937         else
 938                 len = nla_total_size(attrlen);
 939         if (unlikely(skb_tailroom(skb) < len))
 940                 return NULL;
 941
 942         return __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
 943 }
 944 EXPORT_SYMBOL(nla_reserve_64bit);
 945
 946 /**
 947  * nla_reserve_nohdr - reserve room for attribute without header
 948  * @skb: socket buffer to reserve room on
 949  * @attrlen: length of attribute payload
 950  *
 951  * Reserves room for attribute payload without a header.
 952  *
 953  * Returns NULL if the tailroom of the skb is insufficient to store
 954  * the attribute payload.
 955  */
 956 void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
 957 {
 958         if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
 959                 return NULL;
 960
 961         return __nla_reserve_nohdr(skb, attrlen);
 962 }
 963 EXPORT_SYMBOL(nla_reserve_nohdr);
 964
 965 /**
 966  * __nla_put - Add a netlink attribute to a socket buffer
 967  * @skb: socket buffer to add attribute to
 968  * @attrtype: attribute type
 969  * @attrlen: length of attribute payload
 970  * @data: head of attribute payload
 971  *
 972  * The caller is responsible to ensure that the skb provides enough
 973  * tailroom for the attribute header and payload.
 974  */
 975 void __nla_put(struct sk_buff *skb, int attrtype, int attrlen,
 976                              const void *data)
 977 {
 978         struct nlattr *nla;
 979
 980         nla = __nla_reserve(skb, attrtype, attrlen);
 981         memcpy(nla_data(nla), data, attrlen);
 982 }
 983 EXPORT_SYMBOL(__nla_put);
 984
 985 /**
 986  * __nla_put_64bit - Add a netlink attribute to a socket buffer and align it
 987  * @skb: socket buffer to add attribute to
 988  * @attrtype: attribute type
 989  * @attrlen: length of attribute payload
 990  * @data: head of attribute payload
 991  * @padattr: attribute type for the padding
 992  *
 993  * The caller is responsible to ensure that the skb provides enough
 994  * tailroom for the attribute header and payload.
 995  */
 996 void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
 997                      const void *data, int padattr)
 998 {
 999         struct nlattr *nla;
1000
1001         nla = __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
1002         memcpy(nla_data(nla), data, attrlen);
1003 }
1004 EXPORT_SYMBOL(__nla_put_64bit);
1005
1006 /**
1007  * __nla_put_nohdr - Add a netlink attribute without header
1008  * @skb: socket buffer to add attribute to
1009  * @attrlen: length of attribute payload
1010  * @data: head of attribute payload
1011  *
1012  * The caller is responsible to ensure that the skb provides enough
1013  * tailroom for the attribute payload.
1014  */
1015 void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
1016 {
1017         void *start;
1018
1019         start = __nla_reserve_nohdr(skb, attrlen);
1020         memcpy(start, data, attrlen);
1021 }
1022 EXPORT_SYMBOL(__nla_put_nohdr);
1023
1024 /**
1025  * nla_put - Add a netlink attribute to a socket buffer
1026  * @skb: socket buffer to add attribute to
1027  * @attrtype: attribute type
1028  * @attrlen: length of attribute payload
1029  * @data: head of attribute payload
1030  *
1031  * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
1032  * the attribute header and payload.
1033  */
1034 int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data)
1035 {
1036         if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
1037                 return -EMSGSIZE;
1038
1039         __nla_put(skb, attrtype, attrlen, data);
1040         return 0;
1041 }
1042 EXPORT_SYMBOL(nla_put);
1043
1044 /**
1045  * nla_put_64bit - Add a netlink attribute to a socket buffer and align it
1046  * @skb: socket buffer to add attribute to
1047  * @attrtype: attribute type
1048  * @attrlen: length of attribute payload
1049  * @data: head of attribute payload
1050  * @padattr: attribute type for the padding
1051  *
1052  * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
1053  * the attribute header and payload.
1054  */
1055 int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
1056                   const void *data, int padattr)
1057 {
1058         size_t len;
1059
1060         if (nla_need_padding_for_64bit(skb))
1061                 len = nla_total_size_64bit(attrlen);
1062         else
1063                 len = nla_total_size(attrlen);
1064         if (unlikely(skb_tailroom(skb) < len))
1065                 return -EMSGSIZE;
1066
1067         __nla_put_64bit(skb, attrtype, attrlen, data, padattr);
1068         return 0;
1069 }
1070 EXPORT_SYMBOL(nla_put_64bit);
1071
1072 /**
1073  * nla_put_nohdr - Add a netlink attribute without header
1074  * @skb: socket buffer to add attribute to
1075  * @attrlen: length of attribute payload
1076  * @data: head of attribute payload
1077  *
1078  * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
1079  * the attribute payload.
1080  */
1081 int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
1082 {
1083         if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
1084                 return -EMSGSIZE;
1085
1086         __nla_put_nohdr(skb, attrlen, data);
1087         return 0;
1088 }
1089 EXPORT_SYMBOL(nla_put_nohdr);
1090
1091 /**
1092  * nla_append - Add a netlink attribute without header or padding
1093  * @skb: socket buffer to add attribute to
1094  * @attrlen: length of attribute payload
1095  * @data: head of attribute payload
1096  *
1097  * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
1098  * the attribute payload.
1099  */
1100 int nla_append(struct sk_buff *skb, int attrlen, const void *data)
1101 {
1102         if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
1103                 return -EMSGSIZE;
1104
1105         skb_put_data(skb, data, attrlen);
1106         return 0;
1107 }
1108 EXPORT_SYMBOL(nla_append);
1109 #endif