1 // SPDX-License-Identifier: GPL-2.0
3 * NETLINK Netlink attributes
5 * Authors: Thomas Graf <tgraf@suug.ch>
6 * Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>
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>
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.
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),
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),
47 static int validate_nla_bitfield32(const struct nlattr *nla,
48 const u32 *valid_flags_mask)
50 const struct nla_bitfield32 *bf = nla_data(nla);
52 if (!valid_flags_mask)
55 /*disallow invalid bit selector */
56 if (bf->selector & ~*valid_flags_mask)
59 /*disallow invalid bit values */
60 if (bf->value & ~*valid_flags_mask)
63 /*disallow valid bit values that are not selected*/
64 if (bf->value & ~bf->selector)
70 static int nla_validate_array(const struct nlattr *head, int len, int maxtype,
71 const struct nla_policy *policy,
72 struct netlink_ext_ack *extack)
74 const struct nlattr *entry;
77 nla_for_each_attr(entry, head, len, rem) {
80 if (nla_len(entry) == 0)
83 if (nla_len(entry) < NLA_HDRLEN) {
84 NL_SET_ERR_MSG_ATTR(extack, entry,
85 "Array element too short");
89 ret = nla_validate(nla_data(entry), nla_len(entry),
90 maxtype, policy, extack);
98 static int nla_validate_int_range(const struct nla_policy *pt,
99 const struct nlattr *nla,
100 struct netlink_ext_ack *extack)
102 bool validate_min, validate_max;
105 validate_min = pt->validation_type == NLA_VALIDATE_RANGE ||
106 pt->validation_type == NLA_VALIDATE_MIN;
107 validate_max = pt->validation_type == NLA_VALIDATE_RANGE ||
108 pt->validation_type == NLA_VALIDATE_MAX;
112 value = nla_get_u8(nla);
115 value = nla_get_u16(nla);
118 value = nla_get_u32(nla);
121 value = nla_get_s8(nla);
124 value = nla_get_s16(nla);
127 value = nla_get_s32(nla);
130 value = nla_get_s64(nla);
133 /* treat this one specially, since it may not fit into s64 */
134 if ((validate_min && nla_get_u64(nla) < pt->min) ||
135 (validate_max && nla_get_u64(nla) > pt->max)) {
136 NL_SET_ERR_MSG_ATTR(extack, nla,
137 "integer out of range");
146 if ((validate_min && value < pt->min) ||
147 (validate_max && value > pt->max)) {
148 NL_SET_ERR_MSG_ATTR(extack, nla,
149 "integer out of range");
156 static int validate_nla(const struct nlattr *nla, int maxtype,
157 const struct nla_policy *policy,
158 struct netlink_ext_ack *extack)
160 const struct nla_policy *pt;
161 int minlen = 0, attrlen = nla_len(nla), type = nla_type(nla);
164 if (type <= 0 || type > maxtype)
169 BUG_ON(pt->type > NLA_TYPE_MAX);
171 if ((nla_attr_len[pt->type] && attrlen != nla_attr_len[pt->type]) ||
172 (pt->type == NLA_EXACT_LEN_WARN && attrlen != pt->len)) {
173 pr_warn_ratelimited("netlink: '%s': attribute type %d has an invalid length.\n",
174 current->comm, type);
179 if (attrlen != pt->len)
184 if (extack && pt->validation_data) {
185 NL_SET_BAD_ATTR(extack, nla);
186 extack->_msg = pt->validation_data;
198 if (attrlen != sizeof(struct nla_bitfield32))
201 err = validate_nla_bitfield32(nla, pt->validation_data);
208 minlen = min_t(int, attrlen, pt->len + 1);
212 if (!minlen || memchr(nla_data(nla), '\0', minlen) == NULL) {
223 char *buf = nla_data(nla);
225 if (buf[attrlen - 1] == '\0')
228 if (attrlen > pt->len)
234 if (pt->len && attrlen > pt->len)
239 /* a nested attributes is allowed to be empty; if its not,
240 * it must have a size of at least NLA_HDRLEN.
244 if (attrlen < NLA_HDRLEN)
246 if (pt->validation_data) {
247 err = nla_validate(nla_data(nla), nla_len(nla), pt->len,
248 pt->validation_data, extack);
251 * return directly to preserve the inner
252 * error message/attribute pointer
258 case NLA_NESTED_ARRAY:
259 /* a nested array attribute is allowed to be empty; if its not,
260 * it must have a size of at least NLA_HDRLEN.
264 if (attrlen < NLA_HDRLEN)
266 if (pt->validation_data) {
269 err = nla_validate_array(nla_data(nla), nla_len(nla),
270 pt->len, pt->validation_data,
274 * return directly to preserve the inner
275 * error message/attribute pointer
284 else if (pt->type != NLA_UNSPEC)
285 minlen = nla_attr_minlen[pt->type];
287 if (attrlen < minlen)
291 /* further validation */
292 switch (pt->validation_type) {
293 case NLA_VALIDATE_NONE:
296 case NLA_VALIDATE_RANGE:
297 case NLA_VALIDATE_MIN:
298 case NLA_VALIDATE_MAX:
299 err = nla_validate_int_range(pt, nla, extack);
307 NL_SET_ERR_MSG_ATTR(extack, nla, "Attribute failed policy validation");
312 * nla_validate - Validate a stream of attributes
313 * @head: head of attribute stream
314 * @len: length of attribute stream
315 * @maxtype: maximum attribute type to be expected
316 * @policy: validation policy
317 * @extack: extended ACK report struct
319 * Validates all attributes in the specified attribute stream against the
320 * specified policy. Attributes with a type exceeding maxtype will be
321 * ignored. See documenation of struct nla_policy for more details.
323 * Returns 0 on success or a negative error code.
325 int nla_validate(const struct nlattr *head, int len, int maxtype,
326 const struct nla_policy *policy,
327 struct netlink_ext_ack *extack)
329 const struct nlattr *nla;
332 nla_for_each_attr(nla, head, len, rem) {
333 int err = validate_nla(nla, maxtype, policy, extack);
341 EXPORT_SYMBOL(nla_validate);
344 * nla_policy_len - Determin the max. length of a policy
345 * @policy: policy to use
346 * @n: number of policies
348 * Determines the max. length of the policy. It is currently used
349 * to allocated Netlink buffers roughly the size of the actual
352 * Returns 0 on success or a negative error code.
355 nla_policy_len(const struct nla_policy *p, int n)
359 for (i = 0; i < n; i++, p++) {
361 len += nla_total_size(p->len);
362 else if (nla_attr_len[p->type])
363 len += nla_total_size(nla_attr_len[p->type]);
364 else if (nla_attr_minlen[p->type])
365 len += nla_total_size(nla_attr_minlen[p->type]);
370 EXPORT_SYMBOL(nla_policy_len);
373 * nla_parse - Parse a stream of attributes into a tb buffer
374 * @tb: destination array with maxtype+1 elements
375 * @maxtype: maximum attribute type to be expected
376 * @head: head of attribute stream
377 * @len: length of attribute stream
378 * @policy: validation policy
380 * Parses a stream of attributes and stores a pointer to each attribute in
381 * the tb array accessible via the attribute type. Attributes with a type
382 * exceeding maxtype will be silently ignored for backwards compatibility
383 * reasons. policy may be set to NULL if no validation is required.
385 * Returns 0 on success or a negative error code.
387 int nla_parse(struct nlattr **tb, int maxtype, const struct nlattr *head,
388 int len, const struct nla_policy *policy,
389 struct netlink_ext_ack *extack)
391 const struct nlattr *nla;
394 memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));
396 nla_for_each_attr(nla, head, len, rem) {
397 u16 type = nla_type(nla);
399 if (type > 0 && type <= maxtype) {
401 int err = validate_nla(nla, maxtype, policy,
408 tb[type] = (struct nlattr *)nla;
412 if (unlikely(rem > 0))
413 pr_warn_ratelimited("netlink: %d bytes leftover after parsing attributes in process `%s'.\n",
418 EXPORT_SYMBOL(nla_parse);
421 * nla_find - Find a specific attribute in a stream of attributes
422 * @head: head of attribute stream
423 * @len: length of attribute stream
424 * @attrtype: type of attribute to look for
426 * Returns the first attribute in the stream matching the specified type.
428 struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype)
430 const struct nlattr *nla;
433 nla_for_each_attr(nla, head, len, rem)
434 if (nla_type(nla) == attrtype)
435 return (struct nlattr *)nla;
439 EXPORT_SYMBOL(nla_find);
442 * nla_strlcpy - Copy string attribute payload into a sized buffer
443 * @dst: where to copy the string to
444 * @nla: attribute to copy the string from
445 * @dstsize: size of destination buffer
447 * Copies at most dstsize - 1 bytes into the destination buffer.
448 * The result is always a valid NUL-terminated string. Unlike
449 * strlcpy the destination buffer is always padded out.
451 * Returns the length of the source buffer.
453 size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize)
455 size_t srclen = nla_len(nla);
456 char *src = nla_data(nla);
458 if (srclen > 0 && src[srclen - 1] == '\0')
462 size_t len = (srclen >= dstsize) ? dstsize - 1 : srclen;
464 memset(dst, 0, dstsize);
465 memcpy(dst, src, len);
470 EXPORT_SYMBOL(nla_strlcpy);
473 * nla_strdup - Copy string attribute payload into a newly allocated buffer
474 * @nla: attribute to copy the string from
475 * @flags: the type of memory to allocate (see kmalloc).
477 * Returns a pointer to the allocated buffer or NULL on error.
479 char *nla_strdup(const struct nlattr *nla, gfp_t flags)
481 size_t srclen = nla_len(nla);
482 char *src = nla_data(nla), *dst;
484 if (srclen > 0 && src[srclen - 1] == '\0')
487 dst = kmalloc(srclen + 1, flags);
489 memcpy(dst, src, srclen);
494 EXPORT_SYMBOL(nla_strdup);
497 * nla_memcpy - Copy a netlink attribute into another memory area
498 * @dest: where to copy to memcpy
499 * @src: netlink attribute to copy from
500 * @count: size of the destination area
502 * Note: The number of bytes copied is limited by the length of
503 * attribute's payload. memcpy
505 * Returns the number of bytes copied.
507 int nla_memcpy(void *dest, const struct nlattr *src, int count)
509 int minlen = min_t(int, count, nla_len(src));
511 memcpy(dest, nla_data(src), minlen);
513 memset(dest + minlen, 0, count - minlen);
517 EXPORT_SYMBOL(nla_memcpy);
520 * nla_memcmp - Compare an attribute with sized memory area
521 * @nla: netlink attribute
523 * @size: size of memory area
525 int nla_memcmp(const struct nlattr *nla, const void *data,
528 int d = nla_len(nla) - size;
531 d = memcmp(nla_data(nla), data, size);
535 EXPORT_SYMBOL(nla_memcmp);
538 * nla_strcmp - Compare a string attribute against a string
539 * @nla: netlink string attribute
540 * @str: another string
542 int nla_strcmp(const struct nlattr *nla, const char *str)
544 int len = strlen(str);
545 char *buf = nla_data(nla);
546 int attrlen = nla_len(nla);
549 if (attrlen > 0 && buf[attrlen - 1] == '\0')
554 d = memcmp(nla_data(nla), str, len);
558 EXPORT_SYMBOL(nla_strcmp);
562 * __nla_reserve - reserve room for attribute on the skb
563 * @skb: socket buffer to reserve room on
564 * @attrtype: attribute type
565 * @attrlen: length of attribute payload
567 * Adds a netlink attribute header to a socket buffer and reserves
568 * room for the payload but does not copy it.
570 * The caller is responsible to ensure that the skb provides enough
571 * tailroom for the attribute header and payload.
573 struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
577 nla = skb_put(skb, nla_total_size(attrlen));
578 nla->nla_type = attrtype;
579 nla->nla_len = nla_attr_size(attrlen);
581 memset((unsigned char *) nla + nla->nla_len, 0, nla_padlen(attrlen));
585 EXPORT_SYMBOL(__nla_reserve);
588 * __nla_reserve_64bit - reserve room for attribute on the skb and align it
589 * @skb: socket buffer to reserve room on
590 * @attrtype: attribute type
591 * @attrlen: length of attribute payload
592 * @padattr: attribute type for the padding
594 * Adds a netlink attribute header to a socket buffer and reserves
595 * room for the payload but does not copy it. It also ensure that this
596 * attribute will have a 64-bit aligned nla_data() area.
598 * The caller is responsible to ensure that the skb provides enough
599 * tailroom for the attribute header and payload.
601 struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype,
602 int attrlen, int padattr)
604 if (nla_need_padding_for_64bit(skb))
605 nla_align_64bit(skb, padattr);
607 return __nla_reserve(skb, attrtype, attrlen);
609 EXPORT_SYMBOL(__nla_reserve_64bit);
612 * __nla_reserve_nohdr - reserve room for attribute without header
613 * @skb: socket buffer to reserve room on
614 * @attrlen: length of attribute payload
616 * Reserves room for attribute payload without a header.
618 * The caller is responsible to ensure that the skb provides enough
619 * tailroom for the payload.
621 void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
623 return skb_put_zero(skb, NLA_ALIGN(attrlen));
625 EXPORT_SYMBOL(__nla_reserve_nohdr);
628 * nla_reserve - reserve room for attribute on the skb
629 * @skb: socket buffer to reserve room on
630 * @attrtype: attribute type
631 * @attrlen: length of attribute payload
633 * Adds a netlink attribute header to a socket buffer and reserves
634 * room for the payload but does not copy it.
636 * Returns NULL if the tailroom of the skb is insufficient to store
637 * the attribute header and payload.
639 struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
641 if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
644 return __nla_reserve(skb, attrtype, attrlen);
646 EXPORT_SYMBOL(nla_reserve);
649 * nla_reserve_64bit - reserve room for attribute on the skb and align it
650 * @skb: socket buffer to reserve room on
651 * @attrtype: attribute type
652 * @attrlen: length of attribute payload
653 * @padattr: attribute type for the padding
655 * Adds a netlink attribute header to a socket buffer and reserves
656 * room for the payload but does not copy it. It also ensure that this
657 * attribute will have a 64-bit aligned nla_data() area.
659 * Returns NULL if the tailroom of the skb is insufficient to store
660 * the attribute header and payload.
662 struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype, int attrlen,
667 if (nla_need_padding_for_64bit(skb))
668 len = nla_total_size_64bit(attrlen);
670 len = nla_total_size(attrlen);
671 if (unlikely(skb_tailroom(skb) < len))
674 return __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
676 EXPORT_SYMBOL(nla_reserve_64bit);
679 * nla_reserve_nohdr - reserve room for attribute without header
680 * @skb: socket buffer to reserve room on
681 * @attrlen: length of attribute payload
683 * Reserves room for attribute payload without a header.
685 * Returns NULL if the tailroom of the skb is insufficient to store
686 * the attribute payload.
688 void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
690 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
693 return __nla_reserve_nohdr(skb, attrlen);
695 EXPORT_SYMBOL(nla_reserve_nohdr);
698 * __nla_put - Add a netlink attribute to a socket buffer
699 * @skb: socket buffer to add attribute to
700 * @attrtype: attribute type
701 * @attrlen: length of attribute payload
702 * @data: head of attribute payload
704 * The caller is responsible to ensure that the skb provides enough
705 * tailroom for the attribute header and payload.
707 void __nla_put(struct sk_buff *skb, int attrtype, int attrlen,
712 nla = __nla_reserve(skb, attrtype, attrlen);
713 memcpy(nla_data(nla), data, attrlen);
715 EXPORT_SYMBOL(__nla_put);
718 * __nla_put_64bit - Add a netlink attribute to a socket buffer and align it
719 * @skb: socket buffer to add attribute to
720 * @attrtype: attribute type
721 * @attrlen: length of attribute payload
722 * @data: head of attribute payload
723 * @padattr: attribute type for the padding
725 * The caller is responsible to ensure that the skb provides enough
726 * tailroom for the attribute header and payload.
728 void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
729 const void *data, int padattr)
733 nla = __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
734 memcpy(nla_data(nla), data, attrlen);
736 EXPORT_SYMBOL(__nla_put_64bit);
739 * __nla_put_nohdr - Add a netlink attribute without header
740 * @skb: socket buffer to add attribute to
741 * @attrlen: length of attribute payload
742 * @data: head of attribute payload
744 * The caller is responsible to ensure that the skb provides enough
745 * tailroom for the attribute payload.
747 void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
751 start = __nla_reserve_nohdr(skb, attrlen);
752 memcpy(start, data, attrlen);
754 EXPORT_SYMBOL(__nla_put_nohdr);
757 * nla_put - Add a netlink attribute to a socket buffer
758 * @skb: socket buffer to add attribute to
759 * @attrtype: attribute type
760 * @attrlen: length of attribute payload
761 * @data: head of attribute payload
763 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
764 * the attribute header and payload.
766 int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data)
768 if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
771 __nla_put(skb, attrtype, attrlen, data);
774 EXPORT_SYMBOL(nla_put);
777 * nla_put_64bit - Add a netlink attribute to a socket buffer and align it
778 * @skb: socket buffer to add attribute to
779 * @attrtype: attribute type
780 * @attrlen: length of attribute payload
781 * @data: head of attribute payload
782 * @padattr: attribute type for the padding
784 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
785 * the attribute header and payload.
787 int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
788 const void *data, int padattr)
792 if (nla_need_padding_for_64bit(skb))
793 len = nla_total_size_64bit(attrlen);
795 len = nla_total_size(attrlen);
796 if (unlikely(skb_tailroom(skb) < len))
799 __nla_put_64bit(skb, attrtype, attrlen, data, padattr);
802 EXPORT_SYMBOL(nla_put_64bit);
805 * nla_put_nohdr - Add a netlink attribute without header
806 * @skb: socket buffer to add attribute to
807 * @attrlen: length of attribute payload
808 * @data: head of attribute payload
810 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
811 * the attribute payload.
813 int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
815 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
818 __nla_put_nohdr(skb, attrlen, data);
821 EXPORT_SYMBOL(nla_put_nohdr);
824 * nla_append - Add a netlink attribute without header or padding
825 * @skb: socket buffer to add attribute to
826 * @attrlen: length of attribute payload
827 * @data: head of attribute payload
829 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
830 * the attribute payload.
832 int nla_append(struct sk_buff *skb, int attrlen, const void *data)
834 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
837 skb_put_data(skb, data, attrlen);
840 EXPORT_SYMBOL(nla_append);