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,
73 unsigned int validate)
75 const struct nlattr *entry;
78 nla_for_each_attr(entry, head, len, rem) {
81 if (nla_len(entry) == 0)
84 if (nla_len(entry) < NLA_HDRLEN) {
85 NL_SET_ERR_MSG_ATTR(extack, entry,
86 "Array element too short");
90 ret = __nla_validate(nla_data(entry), nla_len(entry),
91 maxtype, policy, validate, extack);
99 static int nla_validate_int_range(const struct nla_policy *pt,
100 const struct nlattr *nla,
101 struct netlink_ext_ack *extack)
103 bool validate_min, validate_max;
106 validate_min = pt->validation_type == NLA_VALIDATE_RANGE ||
107 pt->validation_type == NLA_VALIDATE_MIN;
108 validate_max = pt->validation_type == NLA_VALIDATE_RANGE ||
109 pt->validation_type == NLA_VALIDATE_MAX;
113 value = nla_get_u8(nla);
116 value = nla_get_u16(nla);
119 value = nla_get_u32(nla);
122 value = nla_get_s8(nla);
125 value = nla_get_s16(nla);
128 value = nla_get_s32(nla);
131 value = nla_get_s64(nla);
134 /* treat this one specially, since it may not fit into s64 */
135 if ((validate_min && nla_get_u64(nla) < pt->min) ||
136 (validate_max && nla_get_u64(nla) > pt->max)) {
137 NL_SET_ERR_MSG_ATTR(extack, nla,
138 "integer out of range");
147 if ((validate_min && value < pt->min) ||
148 (validate_max && value > pt->max)) {
149 NL_SET_ERR_MSG_ATTR(extack, nla,
150 "integer out of range");
157 static int validate_nla(const struct nlattr *nla, int maxtype,
158 const struct nla_policy *policy, unsigned int validate,
159 struct netlink_ext_ack *extack)
161 u16 strict_start_type = policy[0].strict_start_type;
162 const struct nla_policy *pt;
163 int minlen = 0, attrlen = nla_len(nla), type = nla_type(nla);
166 if (strict_start_type && type >= strict_start_type)
167 validate |= NL_VALIDATE_STRICT;
169 if (type <= 0 || type > maxtype)
174 BUG_ON(pt->type > NLA_TYPE_MAX);
176 if ((nla_attr_len[pt->type] && attrlen != nla_attr_len[pt->type]) ||
177 (pt->type == NLA_EXACT_LEN_WARN && attrlen != pt->len)) {
178 pr_warn_ratelimited("netlink: '%s': attribute type %d has an invalid length.\n",
179 current->comm, type);
180 if (validate & NL_VALIDATE_STRICT_ATTRS) {
181 NL_SET_ERR_MSG_ATTR(extack, nla,
182 "invalid attribute length");
187 if (validate & NL_VALIDATE_NESTED) {
188 if ((pt->type == NLA_NESTED || pt->type == NLA_NESTED_ARRAY) &&
189 !(nla->nla_type & NLA_F_NESTED)) {
190 NL_SET_ERR_MSG_ATTR(extack, nla,
191 "NLA_F_NESTED is missing");
194 if (pt->type != NLA_NESTED && pt->type != NLA_NESTED_ARRAY &&
195 pt->type != NLA_UNSPEC && (nla->nla_type & NLA_F_NESTED)) {
196 NL_SET_ERR_MSG_ATTR(extack, nla,
197 "NLA_F_NESTED not expected");
204 if (attrlen != pt->len)
209 if (extack && pt->validation_data) {
210 NL_SET_BAD_ATTR(extack, nla);
211 extack->_msg = pt->validation_data;
223 if (attrlen != sizeof(struct nla_bitfield32))
226 err = validate_nla_bitfield32(nla, pt->validation_data);
233 minlen = min_t(int, attrlen, pt->len + 1);
237 if (!minlen || memchr(nla_data(nla), '\0', minlen) == NULL) {
248 char *buf = nla_data(nla);
250 if (buf[attrlen - 1] == '\0')
253 if (attrlen > pt->len)
259 if (pt->len && attrlen > pt->len)
264 /* a nested attributes is allowed to be empty; if its not,
265 * it must have a size of at least NLA_HDRLEN.
269 if (attrlen < NLA_HDRLEN)
271 if (pt->validation_data) {
272 err = __nla_validate(nla_data(nla), nla_len(nla), pt->len,
273 pt->validation_data, validate,
277 * return directly to preserve the inner
278 * error message/attribute pointer
284 case NLA_NESTED_ARRAY:
285 /* a nested array attribute is allowed to be empty; if its not,
286 * it must have a size of at least NLA_HDRLEN.
290 if (attrlen < NLA_HDRLEN)
292 if (pt->validation_data) {
295 err = nla_validate_array(nla_data(nla), nla_len(nla),
296 pt->len, pt->validation_data,
300 * return directly to preserve the inner
301 * error message/attribute pointer
309 if (validate & NL_VALIDATE_UNSPEC) {
310 NL_SET_ERR_MSG_ATTR(extack, nla,
311 "Unsupported attribute");
316 if (attrlen < pt->len)
324 minlen = nla_attr_minlen[pt->type];
326 if (attrlen < minlen)
330 /* further validation */
331 switch (pt->validation_type) {
332 case NLA_VALIDATE_NONE:
335 case NLA_VALIDATE_RANGE:
336 case NLA_VALIDATE_MIN:
337 case NLA_VALIDATE_MAX:
338 err = nla_validate_int_range(pt, nla, extack);
342 case NLA_VALIDATE_FUNCTION:
344 err = pt->validate(nla, extack);
353 NL_SET_ERR_MSG_ATTR(extack, nla, "Attribute failed policy validation");
357 static int __nla_validate_parse(const struct nlattr *head, int len, int maxtype,
358 const struct nla_policy *policy,
359 unsigned int validate,
360 struct netlink_ext_ack *extack,
363 const struct nlattr *nla;
367 memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));
369 nla_for_each_attr(nla, head, len, rem) {
370 u16 type = nla_type(nla);
372 if (type == 0 || type > maxtype) {
373 if (validate & NL_VALIDATE_MAXTYPE) {
374 NL_SET_ERR_MSG_ATTR(extack, nla,
375 "Unknown attribute type");
381 int err = validate_nla(nla, maxtype, policy,
389 tb[type] = (struct nlattr *)nla;
392 if (unlikely(rem > 0)) {
393 pr_warn_ratelimited("netlink: %d bytes leftover after parsing attributes in process `%s'.\n",
395 NL_SET_ERR_MSG(extack, "bytes leftover after parsing attributes");
396 if (validate & NL_VALIDATE_TRAILING)
404 * __nla_validate - Validate a stream of attributes
405 * @head: head of attribute stream
406 * @len: length of attribute stream
407 * @maxtype: maximum attribute type to be expected
408 * @policy: validation policy
409 * @validate: validation strictness
410 * @extack: extended ACK report struct
412 * Validates all attributes in the specified attribute stream against the
413 * specified policy. Validation depends on the validate flags passed, see
414 * &enum netlink_validation for more details on that.
415 * See documenation of struct nla_policy for more details.
417 * Returns 0 on success or a negative error code.
419 int __nla_validate(const struct nlattr *head, int len, int maxtype,
420 const struct nla_policy *policy, unsigned int validate,
421 struct netlink_ext_ack *extack)
423 return __nla_validate_parse(head, len, maxtype, policy, validate,
426 EXPORT_SYMBOL(__nla_validate);
429 * nla_policy_len - Determin the max. length of a policy
430 * @policy: policy to use
431 * @n: number of policies
433 * Determines the max. length of the policy. It is currently used
434 * to allocated Netlink buffers roughly the size of the actual
437 * Returns 0 on success or a negative error code.
440 nla_policy_len(const struct nla_policy *p, int n)
444 for (i = 0; i < n; i++, p++) {
446 len += nla_total_size(p->len);
447 else if (nla_attr_len[p->type])
448 len += nla_total_size(nla_attr_len[p->type]);
449 else if (nla_attr_minlen[p->type])
450 len += nla_total_size(nla_attr_minlen[p->type]);
455 EXPORT_SYMBOL(nla_policy_len);
458 * __nla_parse - Parse a stream of attributes into a tb buffer
459 * @tb: destination array with maxtype+1 elements
460 * @maxtype: maximum attribute type to be expected
461 * @head: head of attribute stream
462 * @len: length of attribute stream
463 * @policy: validation policy
464 * @validate: validation strictness
465 * @extack: extended ACK pointer
467 * Parses a stream of attributes and stores a pointer to each attribute in
468 * the tb array accessible via the attribute type.
469 * Validation is controlled by the @validate parameter.
471 * Returns 0 on success or a negative error code.
473 int __nla_parse(struct nlattr **tb, int maxtype,
474 const struct nlattr *head, int len,
475 const struct nla_policy *policy, unsigned int validate,
476 struct netlink_ext_ack *extack)
478 return __nla_validate_parse(head, len, maxtype, policy, validate,
481 EXPORT_SYMBOL(__nla_parse);
484 * nla_find - Find a specific attribute in a stream of attributes
485 * @head: head of attribute stream
486 * @len: length of attribute stream
487 * @attrtype: type of attribute to look for
489 * Returns the first attribute in the stream matching the specified type.
491 struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype)
493 const struct nlattr *nla;
496 nla_for_each_attr(nla, head, len, rem)
497 if (nla_type(nla) == attrtype)
498 return (struct nlattr *)nla;
502 EXPORT_SYMBOL(nla_find);
505 * nla_strlcpy - Copy string attribute payload into a sized buffer
506 * @dst: where to copy the string to
507 * @nla: attribute to copy the string from
508 * @dstsize: size of destination buffer
510 * Copies at most dstsize - 1 bytes into the destination buffer.
511 * The result is always a valid NUL-terminated string. Unlike
512 * strlcpy the destination buffer is always padded out.
514 * Returns the length of the source buffer.
516 size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize)
518 size_t srclen = nla_len(nla);
519 char *src = nla_data(nla);
521 if (srclen > 0 && src[srclen - 1] == '\0')
525 size_t len = (srclen >= dstsize) ? dstsize - 1 : srclen;
527 memset(dst, 0, dstsize);
528 memcpy(dst, src, len);
533 EXPORT_SYMBOL(nla_strlcpy);
536 * nla_strdup - Copy string attribute payload into a newly allocated buffer
537 * @nla: attribute to copy the string from
538 * @flags: the type of memory to allocate (see kmalloc).
540 * Returns a pointer to the allocated buffer or NULL on error.
542 char *nla_strdup(const struct nlattr *nla, gfp_t flags)
544 size_t srclen = nla_len(nla);
545 char *src = nla_data(nla), *dst;
547 if (srclen > 0 && src[srclen - 1] == '\0')
550 dst = kmalloc(srclen + 1, flags);
552 memcpy(dst, src, srclen);
557 EXPORT_SYMBOL(nla_strdup);
560 * nla_memcpy - Copy a netlink attribute into another memory area
561 * @dest: where to copy to memcpy
562 * @src: netlink attribute to copy from
563 * @count: size of the destination area
565 * Note: The number of bytes copied is limited by the length of
566 * attribute's payload. memcpy
568 * Returns the number of bytes copied.
570 int nla_memcpy(void *dest, const struct nlattr *src, int count)
572 int minlen = min_t(int, count, nla_len(src));
574 memcpy(dest, nla_data(src), minlen);
576 memset(dest + minlen, 0, count - minlen);
580 EXPORT_SYMBOL(nla_memcpy);
583 * nla_memcmp - Compare an attribute with sized memory area
584 * @nla: netlink attribute
586 * @size: size of memory area
588 int nla_memcmp(const struct nlattr *nla, const void *data,
591 int d = nla_len(nla) - size;
594 d = memcmp(nla_data(nla), data, size);
598 EXPORT_SYMBOL(nla_memcmp);
601 * nla_strcmp - Compare a string attribute against a string
602 * @nla: netlink string attribute
603 * @str: another string
605 int nla_strcmp(const struct nlattr *nla, const char *str)
607 int len = strlen(str);
608 char *buf = nla_data(nla);
609 int attrlen = nla_len(nla);
612 if (attrlen > 0 && buf[attrlen - 1] == '\0')
617 d = memcmp(nla_data(nla), str, len);
621 EXPORT_SYMBOL(nla_strcmp);
625 * __nla_reserve - reserve room for attribute on the skb
626 * @skb: socket buffer to reserve room on
627 * @attrtype: attribute type
628 * @attrlen: length of attribute payload
630 * Adds a netlink attribute header to a socket buffer and reserves
631 * room for the payload but does not copy it.
633 * The caller is responsible to ensure that the skb provides enough
634 * tailroom for the attribute header and payload.
636 struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
640 nla = skb_put(skb, nla_total_size(attrlen));
641 nla->nla_type = attrtype;
642 nla->nla_len = nla_attr_size(attrlen);
644 memset((unsigned char *) nla + nla->nla_len, 0, nla_padlen(attrlen));
648 EXPORT_SYMBOL(__nla_reserve);
651 * __nla_reserve_64bit - reserve room for attribute on the skb and align it
652 * @skb: socket buffer to reserve room on
653 * @attrtype: attribute type
654 * @attrlen: length of attribute payload
655 * @padattr: attribute type for the padding
657 * Adds a netlink attribute header to a socket buffer and reserves
658 * room for the payload but does not copy it. It also ensure that this
659 * attribute will have a 64-bit aligned nla_data() area.
661 * The caller is responsible to ensure that the skb provides enough
662 * tailroom for the attribute header and payload.
664 struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype,
665 int attrlen, int padattr)
667 if (nla_need_padding_for_64bit(skb))
668 nla_align_64bit(skb, padattr);
670 return __nla_reserve(skb, attrtype, attrlen);
672 EXPORT_SYMBOL(__nla_reserve_64bit);
675 * __nla_reserve_nohdr - reserve room for attribute without header
676 * @skb: socket buffer to reserve room on
677 * @attrlen: length of attribute payload
679 * Reserves room for attribute payload without a header.
681 * The caller is responsible to ensure that the skb provides enough
682 * tailroom for the payload.
684 void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
686 return skb_put_zero(skb, NLA_ALIGN(attrlen));
688 EXPORT_SYMBOL(__nla_reserve_nohdr);
691 * nla_reserve - reserve room for attribute on the skb
692 * @skb: socket buffer to reserve room on
693 * @attrtype: attribute type
694 * @attrlen: length of attribute payload
696 * Adds a netlink attribute header to a socket buffer and reserves
697 * room for the payload but does not copy it.
699 * Returns NULL if the tailroom of the skb is insufficient to store
700 * the attribute header and payload.
702 struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
704 if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
707 return __nla_reserve(skb, attrtype, attrlen);
709 EXPORT_SYMBOL(nla_reserve);
712 * nla_reserve_64bit - reserve room for attribute on the skb and align it
713 * @skb: socket buffer to reserve room on
714 * @attrtype: attribute type
715 * @attrlen: length of attribute payload
716 * @padattr: attribute type for the padding
718 * Adds a netlink attribute header to a socket buffer and reserves
719 * room for the payload but does not copy it. It also ensure that this
720 * attribute will have a 64-bit aligned nla_data() area.
722 * Returns NULL if the tailroom of the skb is insufficient to store
723 * the attribute header and payload.
725 struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype, int attrlen,
730 if (nla_need_padding_for_64bit(skb))
731 len = nla_total_size_64bit(attrlen);
733 len = nla_total_size(attrlen);
734 if (unlikely(skb_tailroom(skb) < len))
737 return __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
739 EXPORT_SYMBOL(nla_reserve_64bit);
742 * nla_reserve_nohdr - reserve room for attribute without header
743 * @skb: socket buffer to reserve room on
744 * @attrlen: length of attribute payload
746 * Reserves room for attribute payload without a header.
748 * Returns NULL if the tailroom of the skb is insufficient to store
749 * the attribute payload.
751 void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
753 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
756 return __nla_reserve_nohdr(skb, attrlen);
758 EXPORT_SYMBOL(nla_reserve_nohdr);
761 * __nla_put - Add a netlink attribute to a socket buffer
762 * @skb: socket buffer to add attribute to
763 * @attrtype: attribute type
764 * @attrlen: length of attribute payload
765 * @data: head of attribute payload
767 * The caller is responsible to ensure that the skb provides enough
768 * tailroom for the attribute header and payload.
770 void __nla_put(struct sk_buff *skb, int attrtype, int attrlen,
775 nla = __nla_reserve(skb, attrtype, attrlen);
776 memcpy(nla_data(nla), data, attrlen);
778 EXPORT_SYMBOL(__nla_put);
781 * __nla_put_64bit - Add a netlink attribute to a socket buffer and align it
782 * @skb: socket buffer to add attribute to
783 * @attrtype: attribute type
784 * @attrlen: length of attribute payload
785 * @data: head of attribute payload
786 * @padattr: attribute type for the padding
788 * The caller is responsible to ensure that the skb provides enough
789 * tailroom for the attribute header and payload.
791 void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
792 const void *data, int padattr)
796 nla = __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
797 memcpy(nla_data(nla), data, attrlen);
799 EXPORT_SYMBOL(__nla_put_64bit);
802 * __nla_put_nohdr - Add a netlink attribute without header
803 * @skb: socket buffer to add attribute to
804 * @attrlen: length of attribute payload
805 * @data: head of attribute payload
807 * The caller is responsible to ensure that the skb provides enough
808 * tailroom for the attribute payload.
810 void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
814 start = __nla_reserve_nohdr(skb, attrlen);
815 memcpy(start, data, attrlen);
817 EXPORT_SYMBOL(__nla_put_nohdr);
820 * nla_put - Add a netlink attribute to a socket buffer
821 * @skb: socket buffer to add attribute to
822 * @attrtype: attribute type
823 * @attrlen: length of attribute payload
824 * @data: head of attribute payload
826 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
827 * the attribute header and payload.
829 int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data)
831 if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
834 __nla_put(skb, attrtype, attrlen, data);
837 EXPORT_SYMBOL(nla_put);
840 * nla_put_64bit - Add a netlink attribute to a socket buffer and align it
841 * @skb: socket buffer to add attribute to
842 * @attrtype: attribute type
843 * @attrlen: length of attribute payload
844 * @data: head of attribute payload
845 * @padattr: attribute type for the padding
847 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
848 * the attribute header and payload.
850 int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
851 const void *data, int padattr)
855 if (nla_need_padding_for_64bit(skb))
856 len = nla_total_size_64bit(attrlen);
858 len = nla_total_size(attrlen);
859 if (unlikely(skb_tailroom(skb) < len))
862 __nla_put_64bit(skb, attrtype, attrlen, data, padattr);
865 EXPORT_SYMBOL(nla_put_64bit);
868 * nla_put_nohdr - Add a netlink attribute without header
869 * @skb: socket buffer to add attribute to
870 * @attrlen: length of attribute payload
871 * @data: head of attribute payload
873 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
874 * the attribute payload.
876 int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
878 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
881 __nla_put_nohdr(skb, attrlen, data);
884 EXPORT_SYMBOL(nla_put_nohdr);
887 * nla_append - Add a netlink attribute without header or padding
888 * @skb: socket buffer to add attribute to
889 * @attrlen: length of attribute payload
890 * @data: head of attribute payload
892 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
893 * the attribute payload.
895 int nla_append(struct sk_buff *skb, int attrlen, const void *data)
897 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
900 skb_put_data(skb, data, attrlen);
903 EXPORT_SYMBOL(nla_append);