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 u32 *valid_flags_allowed)
50 const struct nla_bitfield32 *bf = nla_data(nla);
51 u32 *valid_flags_mask = valid_flags_allowed;
53 if (!valid_flags_allowed)
56 /*disallow invalid bit selector */
57 if (bf->selector & ~*valid_flags_mask)
60 /*disallow invalid bit values */
61 if (bf->value & ~*valid_flags_mask)
64 /*disallow valid bit values that are not selected*/
65 if (bf->value & ~bf->selector)
71 static int validate_nla(const struct nlattr *nla, int maxtype,
72 const struct nla_policy *policy)
74 const struct nla_policy *pt;
75 int minlen = 0, attrlen = nla_len(nla), type = nla_type(nla);
77 if (type <= 0 || type > maxtype)
82 BUG_ON(pt->type > NLA_TYPE_MAX);
84 if (nla_attr_len[pt->type] && attrlen != nla_attr_len[pt->type]) {
85 pr_warn_ratelimited("netlink: '%s': attribute type %d has an invalid length.\n",
96 if (attrlen != sizeof(struct nla_bitfield32))
99 return validate_nla_bitfield32(nla, pt->validation_data);
103 minlen = min_t(int, attrlen, pt->len + 1);
107 if (!minlen || memchr(nla_data(nla), '\0', minlen) == NULL)
116 char *buf = nla_data(nla);
118 if (buf[attrlen - 1] == '\0')
121 if (attrlen > pt->len)
127 if (pt->len && attrlen > pt->len)
131 case NLA_NESTED_COMPAT:
132 if (attrlen < pt->len)
134 if (attrlen < NLA_ALIGN(pt->len))
136 if (attrlen < NLA_ALIGN(pt->len) + NLA_HDRLEN)
138 nla = nla_data(nla) + NLA_ALIGN(pt->len);
139 if (attrlen < NLA_ALIGN(pt->len) + NLA_HDRLEN + nla_len(nla))
143 /* a nested attributes is allowed to be empty; if its not,
144 * it must have a size of at least NLA_HDRLEN.
151 else if (pt->type != NLA_UNSPEC)
152 minlen = nla_attr_minlen[pt->type];
154 if (attrlen < minlen)
162 * nla_validate - Validate a stream of attributes
163 * @head: head of attribute stream
164 * @len: length of attribute stream
165 * @maxtype: maximum attribute type to be expected
166 * @policy: validation policy
167 * @extack: extended ACK report struct
169 * Validates all attributes in the specified attribute stream against the
170 * specified policy. Attributes with a type exceeding maxtype will be
171 * ignored. See documenation of struct nla_policy for more details.
173 * Returns 0 on success or a negative error code.
175 int nla_validate(const struct nlattr *head, int len, int maxtype,
176 const struct nla_policy *policy,
177 struct netlink_ext_ack *extack)
179 const struct nlattr *nla;
182 nla_for_each_attr(nla, head, len, rem) {
183 int err = validate_nla(nla, maxtype, policy);
187 extack->bad_attr = nla;
194 EXPORT_SYMBOL(nla_validate);
197 * nla_policy_len - Determin the max. length of a policy
198 * @policy: policy to use
199 * @n: number of policies
201 * Determines the max. length of the policy. It is currently used
202 * to allocated Netlink buffers roughly the size of the actual
205 * Returns 0 on success or a negative error code.
208 nla_policy_len(const struct nla_policy *p, int n)
212 for (i = 0; i < n; i++, p++) {
214 len += nla_total_size(p->len);
215 else if (nla_attr_len[p->type])
216 len += nla_total_size(nla_attr_len[p->type]);
217 else if (nla_attr_minlen[p->type])
218 len += nla_total_size(nla_attr_minlen[p->type]);
223 EXPORT_SYMBOL(nla_policy_len);
226 * nla_parse - Parse a stream of attributes into a tb buffer
227 * @tb: destination array with maxtype+1 elements
228 * @maxtype: maximum attribute type to be expected
229 * @head: head of attribute stream
230 * @len: length of attribute stream
231 * @policy: validation policy
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 * exceeding maxtype will be silently ignored for backwards compatibility
236 * reasons. policy may be set to NULL if no validation is required.
238 * Returns 0 on success or a negative error code.
240 int nla_parse(struct nlattr **tb, int maxtype, const struct nlattr *head,
241 int len, const struct nla_policy *policy,
242 struct netlink_ext_ack *extack)
244 const struct nlattr *nla;
247 memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));
249 nla_for_each_attr(nla, head, len, rem) {
250 u16 type = nla_type(nla);
252 if (type > 0 && type <= maxtype) {
254 err = validate_nla(nla, maxtype, policy);
256 NL_SET_ERR_MSG_ATTR(extack, nla,
257 "Attribute failed policy validation");
262 tb[type] = (struct nlattr *)nla;
266 if (unlikely(rem > 0))
267 pr_warn_ratelimited("netlink: %d bytes leftover after parsing attributes in process `%s'.\n",
274 EXPORT_SYMBOL(nla_parse);
277 * nla_find - Find a specific attribute in a stream of attributes
278 * @head: head of attribute stream
279 * @len: length of attribute stream
280 * @attrtype: type of attribute to look for
282 * Returns the first attribute in the stream matching the specified type.
284 struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype)
286 const struct nlattr *nla;
289 nla_for_each_attr(nla, head, len, rem)
290 if (nla_type(nla) == attrtype)
291 return (struct nlattr *)nla;
295 EXPORT_SYMBOL(nla_find);
298 * nla_strlcpy - Copy string attribute payload into a sized buffer
299 * @dst: where to copy the string to
300 * @nla: attribute to copy the string from
301 * @dstsize: size of destination buffer
303 * Copies at most dstsize - 1 bytes into the destination buffer.
304 * The result is always a valid NUL-terminated string. Unlike
305 * strlcpy the destination buffer is always padded out.
307 * Returns the length of the source buffer.
309 size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize)
311 size_t srclen = nla_len(nla);
312 char *src = nla_data(nla);
314 if (srclen > 0 && src[srclen - 1] == '\0')
318 size_t len = (srclen >= dstsize) ? dstsize - 1 : srclen;
320 memset(dst, 0, dstsize);
321 memcpy(dst, src, len);
326 EXPORT_SYMBOL(nla_strlcpy);
329 * nla_strdup - Copy string attribute payload into a newly allocated buffer
330 * @nla: attribute to copy the string from
331 * @flags: the type of memory to allocate (see kmalloc).
333 * Returns a pointer to the allocated buffer or NULL on error.
335 char *nla_strdup(const struct nlattr *nla, gfp_t flags)
337 size_t srclen = nla_len(nla);
338 char *src = nla_data(nla), *dst;
340 if (srclen > 0 && src[srclen - 1] == '\0')
343 dst = kmalloc(srclen + 1, flags);
345 memcpy(dst, src, srclen);
350 EXPORT_SYMBOL(nla_strdup);
353 * nla_memcpy - Copy a netlink attribute into another memory area
354 * @dest: where to copy to memcpy
355 * @src: netlink attribute to copy from
356 * @count: size of the destination area
358 * Note: The number of bytes copied is limited by the length of
359 * attribute's payload. memcpy
361 * Returns the number of bytes copied.
363 int nla_memcpy(void *dest, const struct nlattr *src, int count)
365 int minlen = min_t(int, count, nla_len(src));
367 memcpy(dest, nla_data(src), minlen);
369 memset(dest + minlen, 0, count - minlen);
373 EXPORT_SYMBOL(nla_memcpy);
376 * nla_memcmp - Compare an attribute with sized memory area
377 * @nla: netlink attribute
379 * @size: size of memory area
381 int nla_memcmp(const struct nlattr *nla, const void *data,
384 int d = nla_len(nla) - size;
387 d = memcmp(nla_data(nla), data, size);
391 EXPORT_SYMBOL(nla_memcmp);
394 * nla_strcmp - Compare a string attribute against a string
395 * @nla: netlink string attribute
396 * @str: another string
398 int nla_strcmp(const struct nlattr *nla, const char *str)
400 int len = strlen(str);
401 char *buf = nla_data(nla);
402 int attrlen = nla_len(nla);
405 while (attrlen > 0 && buf[attrlen - 1] == '\0')
410 d = memcmp(nla_data(nla), str, len);
414 EXPORT_SYMBOL(nla_strcmp);
418 * __nla_reserve - reserve room for attribute on the skb
419 * @skb: socket buffer to reserve room on
420 * @attrtype: attribute type
421 * @attrlen: length of attribute payload
423 * Adds a netlink attribute header to a socket buffer and reserves
424 * room for the payload but does not copy it.
426 * The caller is responsible to ensure that the skb provides enough
427 * tailroom for the attribute header and payload.
429 struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
433 nla = skb_put(skb, nla_total_size(attrlen));
434 nla->nla_type = attrtype;
435 nla->nla_len = nla_attr_size(attrlen);
437 memset((unsigned char *) nla + nla->nla_len, 0, nla_padlen(attrlen));
441 EXPORT_SYMBOL(__nla_reserve);
444 * __nla_reserve_64bit - reserve room for attribute on the skb and align it
445 * @skb: socket buffer to reserve room on
446 * @attrtype: attribute type
447 * @attrlen: length of attribute payload
448 * @padattr: attribute type for the padding
450 * Adds a netlink attribute header to a socket buffer and reserves
451 * 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.
454 * The caller is responsible to ensure that the skb provides enough
455 * tailroom for the attribute header and payload.
457 struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype,
458 int attrlen, int padattr)
460 if (nla_need_padding_for_64bit(skb))
461 nla_align_64bit(skb, padattr);
463 return __nla_reserve(skb, attrtype, attrlen);
465 EXPORT_SYMBOL(__nla_reserve_64bit);
468 * __nla_reserve_nohdr - reserve room for attribute without header
469 * @skb: socket buffer to reserve room on
470 * @attrlen: length of attribute payload
472 * Reserves room for attribute payload without a header.
474 * The caller is responsible to ensure that the skb provides enough
475 * tailroom for the payload.
477 void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
479 return skb_put_zero(skb, NLA_ALIGN(attrlen));
481 EXPORT_SYMBOL(__nla_reserve_nohdr);
484 * nla_reserve - reserve room for attribute on the skb
485 * @skb: socket buffer to reserve room on
486 * @attrtype: attribute type
487 * @attrlen: length of attribute payload
489 * Adds a netlink attribute header to a socket buffer and reserves
490 * room for the payload but does not copy it.
492 * Returns NULL if the tailroom of the skb is insufficient to store
493 * the attribute header and payload.
495 struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
497 if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
500 return __nla_reserve(skb, attrtype, attrlen);
502 EXPORT_SYMBOL(nla_reserve);
505 * nla_reserve_64bit - reserve room for attribute on the skb and align it
506 * @skb: socket buffer to reserve room on
507 * @attrtype: attribute type
508 * @attrlen: length of attribute payload
509 * @padattr: attribute type for the padding
511 * Adds a netlink attribute header to a socket buffer and reserves
512 * 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.
515 * Returns NULL if the tailroom of the skb is insufficient to store
516 * the attribute header and payload.
518 struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype, int attrlen,
523 if (nla_need_padding_for_64bit(skb))
524 len = nla_total_size_64bit(attrlen);
526 len = nla_total_size(attrlen);
527 if (unlikely(skb_tailroom(skb) < len))
530 return __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
532 EXPORT_SYMBOL(nla_reserve_64bit);
535 * nla_reserve_nohdr - reserve room for attribute without header
536 * @skb: socket buffer to reserve room on
537 * @attrlen: length of attribute payload
539 * Reserves room for attribute payload without a header.
541 * Returns NULL if the tailroom of the skb is insufficient to store
542 * the attribute payload.
544 void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
546 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
549 return __nla_reserve_nohdr(skb, attrlen);
551 EXPORT_SYMBOL(nla_reserve_nohdr);
554 * __nla_put - Add a netlink attribute to a socket buffer
555 * @skb: socket buffer to add attribute to
556 * @attrtype: attribute type
557 * @attrlen: length of attribute payload
558 * @data: head of attribute payload
560 * The caller is responsible to ensure that the skb provides enough
561 * tailroom for the attribute header and payload.
563 void __nla_put(struct sk_buff *skb, int attrtype, int attrlen,
568 nla = __nla_reserve(skb, attrtype, attrlen);
569 memcpy(nla_data(nla), data, attrlen);
571 EXPORT_SYMBOL(__nla_put);
574 * __nla_put_64bit - Add a netlink attribute to a socket buffer and align it
575 * @skb: socket buffer to add attribute to
576 * @attrtype: attribute type
577 * @attrlen: length of attribute payload
578 * @data: head of attribute payload
579 * @padattr: attribute type for the padding
581 * The caller is responsible to ensure that the skb provides enough
582 * tailroom for the attribute header and payload.
584 void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
585 const void *data, int padattr)
589 nla = __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
590 memcpy(nla_data(nla), data, attrlen);
592 EXPORT_SYMBOL(__nla_put_64bit);
595 * __nla_put_nohdr - Add a netlink attribute without header
596 * @skb: socket buffer to add attribute to
597 * @attrlen: length of attribute payload
598 * @data: head of attribute payload
600 * The caller is responsible to ensure that the skb provides enough
601 * tailroom for the attribute payload.
603 void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
607 start = __nla_reserve_nohdr(skb, attrlen);
608 memcpy(start, data, attrlen);
610 EXPORT_SYMBOL(__nla_put_nohdr);
613 * nla_put - Add a netlink attribute to a socket buffer
614 * @skb: socket buffer to add attribute to
615 * @attrtype: attribute type
616 * @attrlen: length of attribute payload
617 * @data: head of attribute payload
619 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
620 * the attribute header and payload.
622 int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data)
624 if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
627 __nla_put(skb, attrtype, attrlen, data);
630 EXPORT_SYMBOL(nla_put);
633 * nla_put_64bit - Add a netlink attribute to a socket buffer and align it
634 * @skb: socket buffer to add attribute to
635 * @attrtype: attribute type
636 * @attrlen: length of attribute payload
637 * @data: head of attribute payload
638 * @padattr: attribute type for the padding
640 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
641 * the attribute header and payload.
643 int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
644 const void *data, int padattr)
648 if (nla_need_padding_for_64bit(skb))
649 len = nla_total_size_64bit(attrlen);
651 len = nla_total_size(attrlen);
652 if (unlikely(skb_tailroom(skb) < len))
655 __nla_put_64bit(skb, attrtype, attrlen, data, padattr);
658 EXPORT_SYMBOL(nla_put_64bit);
661 * nla_put_nohdr - Add a netlink attribute without header
662 * @skb: socket buffer to add attribute to
663 * @attrlen: length of attribute payload
664 * @data: head of attribute payload
666 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
667 * the attribute payload.
669 int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
671 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
674 __nla_put_nohdr(skb, attrlen, data);
677 EXPORT_SYMBOL(nla_put_nohdr);
680 * nla_append - Add a netlink attribute without header or padding
681 * @skb: socket buffer to add attribute to
682 * @attrlen: length of attribute payload
683 * @data: head of attribute payload
685 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
686 * the attribute payload.
688 int nla_append(struct sk_buff *skb, int attrlen, const void *data)
690 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
693 skb_put_data(skb, data, attrlen);
696 EXPORT_SYMBOL(nla_append);