nlattr.c 17.8 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
2 3 4 5 6 7 8
/*
 * NETLINK      Netlink attributes
 *
 * 		Authors:	Thomas Graf <tgraf@suug.ch>
 * 				Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>
 */

9
#include <linux/export.h>
10 11 12 13 14 15 16 17
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/jiffies.h>
#include <linux/skbuff.h>
#include <linux/string.h>
#include <linux/types.h>
#include <net/netlink.h>

18 19 20 21 22
/* For these data types, attribute length should be exactly the given
 * size. However, to maintain compatibility with broken commands, if the
 * attribute length does not match the expected size a warning is emitted
 * to the user that the command is sending invalid data and needs to be fixed.
 */
23
static const u8 nla_attr_len[NLA_TYPE_MAX+1] = {
24 25 26 27
	[NLA_U8]	= sizeof(u8),
	[NLA_U16]	= sizeof(u16),
	[NLA_U32]	= sizeof(u32),
	[NLA_U64]	= sizeof(u64),
28 29 30 31
	[NLA_S8]	= sizeof(s8),
	[NLA_S16]	= sizeof(s16),
	[NLA_S32]	= sizeof(s32),
	[NLA_S64]	= sizeof(s64),
32 33
};

34
static const u8 nla_attr_minlen[NLA_TYPE_MAX+1] = {
35 36 37 38
	[NLA_U8]	= sizeof(u8),
	[NLA_U16]	= sizeof(u16),
	[NLA_U32]	= sizeof(u32),
	[NLA_U64]	= sizeof(u64),
39 40
	[NLA_MSECS]	= sizeof(u64),
	[NLA_NESTED]	= NLA_HDRLEN,
41 42 43 44
	[NLA_S8]	= sizeof(s8),
	[NLA_S16]	= sizeof(s16),
	[NLA_S32]	= sizeof(s32),
	[NLA_S64]	= sizeof(s64),
45 46
};

47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
static int validate_nla_bitfield32(const struct nlattr *nla,
				   u32 *valid_flags_allowed)
{
	const struct nla_bitfield32 *bf = nla_data(nla);
	u32 *valid_flags_mask = valid_flags_allowed;

	if (!valid_flags_allowed)
		return -EINVAL;

	/*disallow invalid bit selector */
	if (bf->selector & ~*valid_flags_mask)
		return -EINVAL;

	/*disallow invalid bit values */
	if (bf->value & ~*valid_flags_mask)
		return -EINVAL;

	/*disallow valid bit values that are not selected*/
	if (bf->value & ~bf->selector)
		return -EINVAL;

	return 0;
}

71
static int validate_nla(const struct nlattr *nla, int maxtype,
72
			const struct nla_policy *policy)
73
{
74
	const struct nla_policy *pt;
75
	int minlen = 0, attrlen = nla_len(nla), type = nla_type(nla);
76

77
	if (type <= 0 || type > maxtype)
78 79
		return 0;

80
	pt = &policy[type];
81 82 83

	BUG_ON(pt->type > NLA_TYPE_MAX);

84 85 86
	if (nla_attr_len[pt->type] && attrlen != nla_attr_len[pt->type]) {
		pr_warn_ratelimited("netlink: '%s': attribute type %d has an invalid length.\n",
				    current->comm, type);
87 88
	}

89 90 91 92 93
	switch (pt->type) {
	case NLA_FLAG:
		if (attrlen > 0)
			return -ERANGE;
		break;
94

95 96 97 98 99 100
	case NLA_BITFIELD32:
		if (attrlen != sizeof(struct nla_bitfield32))
			return -ERANGE;

		return validate_nla_bitfield32(nla, pt->validation_data);

101 102 103 104 105
	case NLA_NUL_STRING:
		if (pt->len)
			minlen = min_t(int, attrlen, pt->len + 1);
		else
			minlen = attrlen;
106

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
		if (!minlen || memchr(nla_data(nla), '\0', minlen) == NULL)
			return -EINVAL;
		/* fall through */

	case NLA_STRING:
		if (attrlen < 1)
			return -ERANGE;

		if (pt->len) {
			char *buf = nla_data(nla);

			if (buf[attrlen - 1] == '\0')
				attrlen--;

			if (attrlen > pt->len)
				return -ERANGE;
		}
		break;

126 127 128 129 130
	case NLA_BINARY:
		if (pt->len && attrlen > pt->len)
			return -ERANGE;
		break;

131 132 133 134 135 136 137 138 139 140 141
	case NLA_NESTED_COMPAT:
		if (attrlen < pt->len)
			return -ERANGE;
		if (attrlen < NLA_ALIGN(pt->len))
			break;
		if (attrlen < NLA_ALIGN(pt->len) + NLA_HDRLEN)
			return -ERANGE;
		nla = nla_data(nla) + NLA_ALIGN(pt->len);
		if (attrlen < NLA_ALIGN(pt->len) + NLA_HDRLEN + nla_len(nla))
			return -ERANGE;
		break;
142 143 144 145 146 147
	case NLA_NESTED:
		/* a nested attributes is allowed to be empty; if its not,
		 * it must have a size of at least NLA_HDRLEN.
		 */
		if (attrlen == 0)
			break;
148 149 150 151 152 153 154 155 156
	default:
		if (pt->len)
			minlen = pt->len;
		else if (pt->type != NLA_UNSPEC)
			minlen = nla_attr_minlen[pt->type];

		if (attrlen < minlen)
			return -ERANGE;
	}
157 158 159 160 161 162 163 164 165 166

	return 0;
}

/**
 * nla_validate - Validate a stream of attributes
 * @head: head of attribute stream
 * @len: length of attribute stream
 * @maxtype: maximum attribute type to be expected
 * @policy: validation policy
167
 * @extack: extended ACK report struct
168 169 170 171 172 173 174
 *
 * Validates all attributes in the specified attribute stream against the
 * specified policy. Attributes with a type exceeding maxtype will be
 * ignored. See documenation of struct nla_policy for more details.
 *
 * Returns 0 on success or a negative error code.
 */
175
int nla_validate(const struct nlattr *head, int len, int maxtype,
176 177
		 const struct nla_policy *policy,
		 struct netlink_ext_ack *extack)
178
{
179
	const struct nlattr *nla;
180
	int rem;
181 182

	nla_for_each_attr(nla, head, len, rem) {
183 184 185 186 187 188 189
		int err = validate_nla(nla, maxtype, policy);

		if (err < 0) {
			if (extack)
				extack->bad_attr = nla;
			return err;
		}
190 191
	}

192
	return 0;
193
}
194
EXPORT_SYMBOL(nla_validate);
195

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
/**
 * nla_policy_len - Determin the max. length of a policy
 * @policy: policy to use
 * @n: number of policies
 *
 * Determines the max. length of the policy.  It is currently used
 * to allocated Netlink buffers roughly the size of the actual
 * message.
 *
 * Returns 0 on success or a negative error code.
 */
int
nla_policy_len(const struct nla_policy *p, int n)
{
	int i, len = 0;

212
	for (i = 0; i < n; i++, p++) {
213 214
		if (p->len)
			len += nla_total_size(p->len);
215 216
		else if (nla_attr_len[p->type])
			len += nla_total_size(nla_attr_len[p->type]);
217 218 219 220 221 222
		else if (nla_attr_minlen[p->type])
			len += nla_total_size(nla_attr_minlen[p->type]);
	}

	return len;
}
223
EXPORT_SYMBOL(nla_policy_len);
224

225 226 227 228 229 230
/**
 * nla_parse - Parse a stream of attributes into a tb buffer
 * @tb: destination array with maxtype+1 elements
 * @maxtype: maximum attribute type to be expected
 * @head: head of attribute stream
 * @len: length of attribute stream
231
 * @policy: validation policy
232 233
 *
 * Parses a stream of attributes and stores a pointer to each attribute in
234
 * the tb array accessible via the attribute type. Attributes with a type
235 236 237 238 239
 * exceeding maxtype will be silently ignored for backwards compatibility
 * reasons. policy may be set to NULL if no validation is required.
 *
 * Returns 0 on success or a negative error code.
 */
240
int nla_parse(struct nlattr **tb, int maxtype, const struct nlattr *head,
241 242
	      int len, const struct nla_policy *policy,
	      struct netlink_ext_ack *extack)
243
{
244
	const struct nlattr *nla;
245 246 247 248 249
	int rem, err;

	memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));

	nla_for_each_attr(nla, head, len, rem) {
250
		u16 type = nla_type(nla);
251 252 253 254

		if (type > 0 && type <= maxtype) {
			if (policy) {
				err = validate_nla(nla, maxtype, policy);
255 256 257
				if (err < 0) {
					if (extack)
						extack->bad_attr = nla;
258
					goto errout;
259
				}
260 261
			}

262
			tb[type] = (struct nlattr *)nla;
263 264 265 266
		}
	}

	if (unlikely(rem > 0))
267 268
		pr_warn_ratelimited("netlink: %d bytes leftover after parsing attributes in process `%s'.\n",
				    rem, current->comm);
269 270 271 272 273

	err = 0;
errout:
	return err;
}
274
EXPORT_SYMBOL(nla_parse);
275 276 277 278 279 280 281 282 283

/**
 * nla_find - Find a specific attribute in a stream of attributes
 * @head: head of attribute stream
 * @len: length of attribute stream
 * @attrtype: type of attribute to look for
 *
 * Returns the first attribute in the stream matching the specified type.
 */
284
struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype)
285
{
286
	const struct nlattr *nla;
287 288 289
	int rem;

	nla_for_each_attr(nla, head, len, rem)
290
		if (nla_type(nla) == attrtype)
291
			return (struct nlattr *)nla;
292 293 294

	return NULL;
}
295
EXPORT_SYMBOL(nla_find);
296 297 298 299

/**
 * nla_strlcpy - Copy string attribute payload into a sized buffer
 * @dst: where to copy the string to
300
 * @nla: attribute to copy the string from
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
 * @dstsize: size of destination buffer
 *
 * Copies at most dstsize - 1 bytes into the destination buffer.
 * The result is always a valid NUL-terminated string. Unlike
 * strlcpy the destination buffer is always padded out.
 *
 * Returns the length of the source buffer.
 */
size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize)
{
	size_t srclen = nla_len(nla);
	char *src = nla_data(nla);

	if (srclen > 0 && src[srclen - 1] == '\0')
		srclen--;

	if (dstsize > 0) {
		size_t len = (srclen >= dstsize) ? dstsize - 1 : srclen;

		memset(dst, 0, dstsize);
		memcpy(dst, src, len);
	}

	return srclen;
}
326
EXPORT_SYMBOL(nla_strlcpy);
327

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
/**
 * nla_strdup - Copy string attribute payload into a newly allocated buffer
 * @nla: attribute to copy the string from
 * @flags: the type of memory to allocate (see kmalloc).
 *
 * Returns a pointer to the allocated buffer or NULL on error.
 */
char *nla_strdup(const struct nlattr *nla, gfp_t flags)
{
	size_t srclen = nla_len(nla);
	char *src = nla_data(nla), *dst;

	if (srclen > 0 && src[srclen - 1] == '\0')
		srclen--;

	dst = kmalloc(srclen + 1, flags);
	if (dst != NULL) {
		memcpy(dst, src, srclen);
		dst[srclen] = '\0';
	}
	return dst;
}
EXPORT_SYMBOL(nla_strdup);

352 353 354 355 356 357 358 359 360 361 362
/**
 * nla_memcpy - Copy a netlink attribute into another memory area
 * @dest: where to copy to memcpy
 * @src: netlink attribute to copy from
 * @count: size of the destination area
 *
 * Note: The number of bytes copied is limited by the length of
 *       attribute's payload. memcpy
 *
 * Returns the number of bytes copied.
 */
363
int nla_memcpy(void *dest, const struct nlattr *src, int count)
364 365 366 367
{
	int minlen = min_t(int, count, nla_len(src));

	memcpy(dest, nla_data(src), minlen);
368 369
	if (count > minlen)
		memset(dest + minlen, 0, count - minlen);
370 371 372

	return minlen;
}
373
EXPORT_SYMBOL(nla_memcpy);
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390

/**
 * nla_memcmp - Compare an attribute with sized memory area
 * @nla: netlink attribute
 * @data: memory area
 * @size: size of memory area
 */
int nla_memcmp(const struct nlattr *nla, const void *data,
			     size_t size)
{
	int d = nla_len(nla) - size;

	if (d == 0)
		d = memcmp(nla_data(nla), data, size);

	return d;
}
391
EXPORT_SYMBOL(nla_memcmp);
392 393 394 395 396 397 398 399

/**
 * nla_strcmp - Compare a string attribute against a string
 * @nla: netlink string attribute
 * @str: another string
 */
int nla_strcmp(const struct nlattr *nla, const char *str)
{
400 401 402 403
	int len = strlen(str);
	char *buf = nla_data(nla);
	int attrlen = nla_len(nla);
	int d;
404

405 406 407 408
	if (attrlen > 0 && buf[attrlen - 1] == '\0')
		attrlen--;

	d = attrlen - len;
409 410 411 412 413
	if (d == 0)
		d = memcmp(nla_data(nla), str, len);

	return d;
}
414
EXPORT_SYMBOL(nla_strcmp);
415

416
#ifdef CONFIG_NET
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
/**
 * __nla_reserve - reserve room for attribute on the skb
 * @skb: socket buffer to reserve room on
 * @attrtype: attribute type
 * @attrlen: length of attribute payload
 *
 * Adds a netlink attribute header to a socket buffer and reserves
 * room for the payload but does not copy it.
 *
 * The caller is responsible to ensure that the skb provides enough
 * tailroom for the attribute header and payload.
 */
struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
{
	struct nlattr *nla;

433
	nla = skb_put(skb, nla_total_size(attrlen));
434 435 436 437 438 439 440
	nla->nla_type = attrtype;
	nla->nla_len = nla_attr_size(attrlen);

	memset((unsigned char *) nla + nla->nla_len, 0, nla_padlen(attrlen));

	return nla;
}
441
EXPORT_SYMBOL(__nla_reserve);
442

443 444 445 446 447
/**
 * __nla_reserve_64bit - reserve room for attribute on the skb and align it
 * @skb: socket buffer to reserve room on
 * @attrtype: attribute type
 * @attrlen: length of attribute payload
448
 * @padattr: attribute type for the padding
449 450 451
 *
 * Adds a netlink attribute header to a socket buffer and reserves
 * room for the payload but does not copy it. It also ensure that this
452
 * attribute will have a 64-bit aligned nla_data() area.
453 454 455 456 457 458 459 460 461 462 463 464 465 466
 *
 * The caller is responsible to ensure that the skb provides enough
 * tailroom for the attribute header and payload.
 */
struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype,
				   int attrlen, int padattr)
{
	if (nla_need_padding_for_64bit(skb))
		nla_align_64bit(skb, padattr);

	return __nla_reserve(skb, attrtype, attrlen);
}
EXPORT_SYMBOL(__nla_reserve_64bit);

467 468 469 470 471 472 473 474 475 476 477 478
/**
 * __nla_reserve_nohdr - reserve room for attribute without header
 * @skb: socket buffer to reserve room on
 * @attrlen: length of attribute payload
 *
 * Reserves room for attribute payload without a header.
 *
 * The caller is responsible to ensure that the skb provides enough
 * tailroom for the payload.
 */
void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
{
479
	return skb_put_zero(skb, NLA_ALIGN(attrlen));
480
}
481
EXPORT_SYMBOL(__nla_reserve_nohdr);
482

483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
/**
 * nla_reserve - reserve room for attribute on the skb
 * @skb: socket buffer to reserve room on
 * @attrtype: attribute type
 * @attrlen: length of attribute payload
 *
 * Adds a netlink attribute header to a socket buffer and reserves
 * room for the payload but does not copy it.
 *
 * Returns NULL if the tailroom of the skb is insufficient to store
 * the attribute header and payload.
 */
struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
{
	if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
		return NULL;

	return __nla_reserve(skb, attrtype, attrlen);
}
502
EXPORT_SYMBOL(nla_reserve);
503

504 505 506 507 508
/**
 * nla_reserve_64bit - reserve room for attribute on the skb and align it
 * @skb: socket buffer to reserve room on
 * @attrtype: attribute type
 * @attrlen: length of attribute payload
509
 * @padattr: attribute type for the padding
510 511 512
 *
 * Adds a netlink attribute header to a socket buffer and reserves
 * room for the payload but does not copy it. It also ensure that this
513
 * attribute will have a 64-bit aligned nla_data() area.
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
 *
 * Returns NULL if the tailroom of the skb is insufficient to store
 * the attribute header and payload.
 */
struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype, int attrlen,
				 int padattr)
{
	size_t len;

	if (nla_need_padding_for_64bit(skb))
		len = nla_total_size_64bit(attrlen);
	else
		len = nla_total_size(attrlen);
	if (unlikely(skb_tailroom(skb) < len))
		return NULL;

	return __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
}
EXPORT_SYMBOL(nla_reserve_64bit);

534
/**
535
 * nla_reserve_nohdr - reserve room for attribute without header
536
 * @skb: socket buffer to reserve room on
537
 * @attrlen: length of attribute payload
538 539 540 541 542 543 544 545 546 547 548 549 550
 *
 * Reserves room for attribute payload without a header.
 *
 * Returns NULL if the tailroom of the skb is insufficient to store
 * the attribute payload.
 */
void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
{
	if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
		return NULL;

	return __nla_reserve_nohdr(skb, attrlen);
}
551
EXPORT_SYMBOL(nla_reserve_nohdr);
552

553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
/**
 * __nla_put - Add a netlink attribute to a socket buffer
 * @skb: socket buffer to add attribute to
 * @attrtype: attribute type
 * @attrlen: length of attribute payload
 * @data: head of attribute payload
 *
 * The caller is responsible to ensure that the skb provides enough
 * tailroom for the attribute header and payload.
 */
void __nla_put(struct sk_buff *skb, int attrtype, int attrlen,
			     const void *data)
{
	struct nlattr *nla;

	nla = __nla_reserve(skb, attrtype, attrlen);
	memcpy(nla_data(nla), data, attrlen);
}
571
EXPORT_SYMBOL(__nla_put);
572

573 574 575 576 577 578
/**
 * __nla_put_64bit - Add a netlink attribute to a socket buffer and align it
 * @skb: socket buffer to add attribute to
 * @attrtype: attribute type
 * @attrlen: length of attribute payload
 * @data: head of attribute payload
579
 * @padattr: attribute type for the padding
580 581 582 583 584 585 586 587 588 589 590 591 592 593
 *
 * The caller is responsible to ensure that the skb provides enough
 * tailroom for the attribute header and payload.
 */
void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
		     const void *data, int padattr)
{
	struct nlattr *nla;

	nla = __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
	memcpy(nla_data(nla), data, attrlen);
}
EXPORT_SYMBOL(__nla_put_64bit);

594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
/**
 * __nla_put_nohdr - Add a netlink attribute without header
 * @skb: socket buffer to add attribute to
 * @attrlen: length of attribute payload
 * @data: head of attribute payload
 *
 * The caller is responsible to ensure that the skb provides enough
 * tailroom for the attribute payload.
 */
void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
{
	void *start;

	start = __nla_reserve_nohdr(skb, attrlen);
	memcpy(start, data, attrlen);
}
610
EXPORT_SYMBOL(__nla_put_nohdr);
611 612 613 614 615 616 617 618

/**
 * nla_put - Add a netlink attribute to a socket buffer
 * @skb: socket buffer to add attribute to
 * @attrtype: attribute type
 * @attrlen: length of attribute payload
 * @data: head of attribute payload
 *
619
 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
620 621 622 623 624
 * the attribute header and payload.
 */
int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data)
{
	if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
625
		return -EMSGSIZE;
626 627 628 629

	__nla_put(skb, attrtype, attrlen, data);
	return 0;
}
630
EXPORT_SYMBOL(nla_put);
631

632 633 634 635 636 637
/**
 * nla_put_64bit - Add a netlink attribute to a socket buffer and align it
 * @skb: socket buffer to add attribute to
 * @attrtype: attribute type
 * @attrlen: length of attribute payload
 * @data: head of attribute payload
638
 * @padattr: attribute type for the padding
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
 *
 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
 * the attribute header and payload.
 */
int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
		  const void *data, int padattr)
{
	size_t len;

	if (nla_need_padding_for_64bit(skb))
		len = nla_total_size_64bit(attrlen);
	else
		len = nla_total_size(attrlen);
	if (unlikely(skb_tailroom(skb) < len))
		return -EMSGSIZE;

	__nla_put_64bit(skb, attrtype, attrlen, data, padattr);
	return 0;
}
EXPORT_SYMBOL(nla_put_64bit);

660 661 662 663 664 665
/**
 * nla_put_nohdr - Add a netlink attribute without header
 * @skb: socket buffer to add attribute to
 * @attrlen: length of attribute payload
 * @data: head of attribute payload
 *
666
 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
667 668 669 670 671
 * the attribute payload.
 */
int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
{
	if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
672
		return -EMSGSIZE;
673 674 675 676

	__nla_put_nohdr(skb, attrlen, data);
	return 0;
}
677
EXPORT_SYMBOL(nla_put_nohdr);
678

679 680 681 682 683 684
/**
 * nla_append - Add a netlink attribute without header or padding
 * @skb: socket buffer to add attribute to
 * @attrlen: length of attribute payload
 * @data: head of attribute payload
 *
685
 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
686 687 688 689 690
 * the attribute payload.
 */
int nla_append(struct sk_buff *skb, int attrlen, const void *data)
{
	if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
691
		return -EMSGSIZE;
692

693
	skb_put_data(skb, data, attrlen);
694 695
	return 0;
}
696 697
EXPORT_SYMBOL(nla_append);
#endif