blob: adc919b32bf92d2fa54ed0943b39b168ee66fcd8 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Thomas Grafbfa83a92005-11-10 02:25:51 +01002/*
3 * NETLINK Netlink attributes
4 *
5 * Authors: Thomas Graf <tgraf@suug.ch>
6 * Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>
7 */
8
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -05009#include <linux/export.h>
Thomas Grafbfa83a92005-11-10 02:25:51 +010010#include <linux/kernel.h>
11#include <linux/errno.h>
12#include <linux/jiffies.h>
Thomas Grafbfa83a92005-11-10 02:25:51 +010013#include <linux/skbuff.h>
14#include <linux/string.h>
15#include <linux/types.h>
16#include <net/netlink.h>
17
David Ahern6e237d02017-12-06 20:09:12 -080018/* 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 */
David Ahern28033ae2017-11-07 21:59:40 -080023static const u8 nla_attr_len[NLA_TYPE_MAX+1] = {
Thomas Grafbfa83a92005-11-10 02:25:51 +010024 [NLA_U8] = sizeof(u8),
25 [NLA_U16] = sizeof(u16),
26 [NLA_U32] = sizeof(u32),
27 [NLA_U64] = sizeof(u64),
Julian Anastasov9eca2eb2012-08-25 22:47:57 +000028 [NLA_S8] = sizeof(s8),
29 [NLA_S16] = sizeof(s16),
30 [NLA_S32] = sizeof(s32),
31 [NLA_S64] = sizeof(s64),
Thomas Grafbfa83a92005-11-10 02:25:51 +010032};
33
David Ahern28033ae2017-11-07 21:59:40 -080034static const u8 nla_attr_minlen[NLA_TYPE_MAX+1] = {
David Ahern6e237d02017-12-06 20:09:12 -080035 [NLA_U8] = sizeof(u8),
36 [NLA_U16] = sizeof(u16),
37 [NLA_U32] = sizeof(u32),
38 [NLA_U64] = sizeof(u64),
David Ahern28033ae2017-11-07 21:59:40 -080039 [NLA_MSECS] = sizeof(u64),
40 [NLA_NESTED] = NLA_HDRLEN,
David Ahern6e237d02017-12-06 20:09:12 -080041 [NLA_S8] = sizeof(s8),
42 [NLA_S16] = sizeof(s16),
43 [NLA_S32] = sizeof(s32),
44 [NLA_S64] = sizeof(s64),
David Ahern28033ae2017-11-07 21:59:40 -080045};
46
Jamal Hadi Salim64c83d82017-07-30 13:24:49 -040047static int validate_nla_bitfield32(const struct nlattr *nla,
Johannes Berg48fde902018-09-26 11:15:31 +020048 const u32 *valid_flags_mask)
Jamal Hadi Salim64c83d82017-07-30 13:24:49 -040049{
50 const struct nla_bitfield32 *bf = nla_data(nla);
Jamal Hadi Salim64c83d82017-07-30 13:24:49 -040051
Johannes Berg48fde902018-09-26 11:15:31 +020052 if (!valid_flags_mask)
Jamal Hadi Salim64c83d82017-07-30 13:24:49 -040053 return -EINVAL;
54
55 /*disallow invalid bit selector */
56 if (bf->selector & ~*valid_flags_mask)
57 return -EINVAL;
58
59 /*disallow invalid bit values */
60 if (bf->value & ~*valid_flags_mask)
61 return -EINVAL;
62
63 /*disallow valid bit values that are not selected*/
64 if (bf->value & ~bf->selector)
65 return -EINVAL;
66
67 return 0;
68}
69
Johannes Berg1501d132018-09-26 11:15:34 +020070static int nla_validate_array(const struct nlattr *head, int len, int maxtype,
71 const struct nla_policy *policy,
Johannes Berg8cb08172019-04-26 14:07:28 +020072 struct netlink_ext_ack *extack,
73 unsigned int validate)
Johannes Berg1501d132018-09-26 11:15:34 +020074{
75 const struct nlattr *entry;
76 int rem;
77
78 nla_for_each_attr(entry, head, len, rem) {
79 int ret;
80
81 if (nla_len(entry) == 0)
82 continue;
83
84 if (nla_len(entry) < NLA_HDRLEN) {
85 NL_SET_ERR_MSG_ATTR(extack, entry,
86 "Array element too short");
87 return -ERANGE;
88 }
89
Johannes Berg8cb08172019-04-26 14:07:28 +020090 ret = __nla_validate(nla_data(entry), nla_len(entry),
91 maxtype, policy, validate, extack);
Johannes Berg1501d132018-09-26 11:15:34 +020092 if (ret < 0)
93 return ret;
94 }
95
96 return 0;
97}
98
Johannes Berg3e48be02018-09-27 11:28:35 +020099static int nla_validate_int_range(const struct nla_policy *pt,
100 const struct nlattr *nla,
101 struct netlink_ext_ack *extack)
102{
103 bool validate_min, validate_max;
104 s64 value;
105
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;
110
111 switch (pt->type) {
112 case NLA_U8:
113 value = nla_get_u8(nla);
114 break;
115 case NLA_U16:
116 value = nla_get_u16(nla);
117 break;
118 case NLA_U32:
119 value = nla_get_u32(nla);
120 break;
121 case NLA_S8:
122 value = nla_get_s8(nla);
123 break;
124 case NLA_S16:
125 value = nla_get_s16(nla);
126 break;
127 case NLA_S32:
128 value = nla_get_s32(nla);
129 break;
130 case NLA_S64:
131 value = nla_get_s64(nla);
132 break;
133 case NLA_U64:
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");
139 return -ERANGE;
140 }
141 return 0;
142 default:
143 WARN_ON(1);
144 return -EINVAL;
145 }
146
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");
151 return -ERANGE;
152 }
153
154 return 0;
155}
156
Jan Engelhardt36546542010-11-16 09:52:32 -0800157static int validate_nla(const struct nlattr *nla, int maxtype,
Johannes Berg8cb08172019-04-26 14:07:28 +0200158 const struct nla_policy *policy, unsigned int validate,
Johannes Bergc29f1842018-09-26 11:15:32 +0200159 struct netlink_ext_ack *extack)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100160{
Johannes Berg56738f42019-04-26 14:07:30 +0200161 u16 strict_start_type = policy[0].strict_start_type;
Patrick McHardyef7c79e2007-06-05 12:38:30 -0700162 const struct nla_policy *pt;
Thomas Graf8f4c1f92007-09-12 14:44:36 +0200163 int minlen = 0, attrlen = nla_len(nla), type = nla_type(nla);
Johannes Bergc29f1842018-09-26 11:15:32 +0200164 int err = -ERANGE;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100165
Johannes Berg56738f42019-04-26 14:07:30 +0200166 if (strict_start_type && type >= strict_start_type)
167 validate |= NL_VALIDATE_STRICT;
168
Thomas Graf8f4c1f92007-09-12 14:44:36 +0200169 if (type <= 0 || type > maxtype)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100170 return 0;
171
Thomas Graf8f4c1f92007-09-12 14:44:36 +0200172 pt = &policy[type];
Thomas Grafbfa83a92005-11-10 02:25:51 +0100173
174 BUG_ON(pt->type > NLA_TYPE_MAX);
175
Johannes Bergb60b87f2018-09-17 11:57:29 +0200176 if ((nla_attr_len[pt->type] && attrlen != nla_attr_len[pt->type]) ||
177 (pt->type == NLA_EXACT_LEN_WARN && attrlen != pt->len)) {
David Ahern6e237d02017-12-06 20:09:12 -0800178 pr_warn_ratelimited("netlink: '%s': attribute type %d has an invalid length.\n",
179 current->comm, type);
Johannes Berg8cb08172019-04-26 14:07:28 +0200180 if (validate & NL_VALIDATE_STRICT_ATTRS) {
181 NL_SET_ERR_MSG_ATTR(extack, nla,
182 "invalid attribute length");
183 return -EINVAL;
184 }
David Ahern28033ae2017-11-07 21:59:40 -0800185 }
186
Thomas Grafa5531a52006-08-26 20:11:47 -0700187 switch (pt->type) {
Johannes Bergb60b87f2018-09-17 11:57:29 +0200188 case NLA_EXACT_LEN:
189 if (attrlen != pt->len)
Johannes Bergc29f1842018-09-26 11:15:32 +0200190 goto out_err;
Johannes Bergb60b87f2018-09-17 11:57:29 +0200191 break;
192
Johannes Berg568b7422018-09-17 11:57:28 +0200193 case NLA_REJECT:
Johannes Bergc29f1842018-09-26 11:15:32 +0200194 if (extack && pt->validation_data) {
195 NL_SET_BAD_ATTR(extack, nla);
196 extack->_msg = pt->validation_data;
197 return -EINVAL;
198 }
199 err = -EINVAL;
200 goto out_err;
Johannes Berg568b7422018-09-17 11:57:28 +0200201
Thomas Grafa5531a52006-08-26 20:11:47 -0700202 case NLA_FLAG:
203 if (attrlen > 0)
Johannes Bergc29f1842018-09-26 11:15:32 +0200204 goto out_err;
Thomas Grafa5531a52006-08-26 20:11:47 -0700205 break;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100206
Jamal Hadi Salim64c83d82017-07-30 13:24:49 -0400207 case NLA_BITFIELD32:
208 if (attrlen != sizeof(struct nla_bitfield32))
Johannes Bergc29f1842018-09-26 11:15:32 +0200209 goto out_err;
Jamal Hadi Salim64c83d82017-07-30 13:24:49 -0400210
Johannes Bergc29f1842018-09-26 11:15:32 +0200211 err = validate_nla_bitfield32(nla, pt->validation_data);
212 if (err)
213 goto out_err;
214 break;
Jamal Hadi Salim64c83d82017-07-30 13:24:49 -0400215
Thomas Grafa5531a52006-08-26 20:11:47 -0700216 case NLA_NUL_STRING:
217 if (pt->len)
218 minlen = min_t(int, attrlen, pt->len + 1);
219 else
220 minlen = attrlen;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100221
Johannes Bergc29f1842018-09-26 11:15:32 +0200222 if (!minlen || memchr(nla_data(nla), '\0', minlen) == NULL) {
223 err = -EINVAL;
224 goto out_err;
225 }
Thomas Grafa5531a52006-08-26 20:11:47 -0700226 /* fall through */
227
228 case NLA_STRING:
229 if (attrlen < 1)
Johannes Bergc29f1842018-09-26 11:15:32 +0200230 goto out_err;
Thomas Grafa5531a52006-08-26 20:11:47 -0700231
232 if (pt->len) {
233 char *buf = nla_data(nla);
234
235 if (buf[attrlen - 1] == '\0')
236 attrlen--;
237
238 if (attrlen > pt->len)
Johannes Bergc29f1842018-09-26 11:15:32 +0200239 goto out_err;
Thomas Grafa5531a52006-08-26 20:11:47 -0700240 }
241 break;
242
Johannes Bergd30045a2007-03-23 11:37:48 -0700243 case NLA_BINARY:
244 if (pt->len && attrlen > pt->len)
Johannes Bergc29f1842018-09-26 11:15:32 +0200245 goto out_err;
Johannes Bergd30045a2007-03-23 11:37:48 -0700246 break;
247
Patrick McHardyea5693c2008-11-28 03:05:19 -0800248 case NLA_NESTED:
249 /* a nested attributes is allowed to be empty; if its not,
250 * it must have a size of at least NLA_HDRLEN.
251 */
252 if (attrlen == 0)
253 break;
Johannes Berg9a659a32018-09-26 11:15:33 +0200254 if (attrlen < NLA_HDRLEN)
255 goto out_err;
256 if (pt->validation_data) {
Johannes Berg8cb08172019-04-26 14:07:28 +0200257 err = __nla_validate(nla_data(nla), nla_len(nla), pt->len,
258 pt->validation_data, validate,
259 extack);
Johannes Berg9a659a32018-09-26 11:15:33 +0200260 if (err < 0) {
261 /*
262 * return directly to preserve the inner
263 * error message/attribute pointer
264 */
265 return err;
266 }
267 }
268 break;
Johannes Berg1501d132018-09-26 11:15:34 +0200269 case NLA_NESTED_ARRAY:
270 /* a nested array attribute is allowed to be empty; if its not,
271 * it must have a size of at least NLA_HDRLEN.
272 */
273 if (attrlen == 0)
274 break;
275 if (attrlen < NLA_HDRLEN)
276 goto out_err;
277 if (pt->validation_data) {
278 int err;
279
280 err = nla_validate_array(nla_data(nla), nla_len(nla),
281 pt->len, pt->validation_data,
Johannes Berg8cb08172019-04-26 14:07:28 +0200282 extack, validate);
Johannes Berg1501d132018-09-26 11:15:34 +0200283 if (err < 0) {
284 /*
285 * return directly to preserve the inner
286 * error message/attribute pointer
287 */
288 return err;
289 }
290 }
291 break;
Johannes Berg6f455f52019-04-26 14:07:27 +0200292
293 case NLA_UNSPEC:
Johannes Berg8cb08172019-04-26 14:07:28 +0200294 if (validate & NL_VALIDATE_UNSPEC) {
295 NL_SET_ERR_MSG_ATTR(extack, nla,
296 "Unsupported attribute");
297 return -EINVAL;
298 }
299 /* fall through */
Johannes Berg6f455f52019-04-26 14:07:27 +0200300 case NLA_MIN_LEN:
301 if (attrlen < pt->len)
302 goto out_err;
303 break;
304
Thomas Grafa5531a52006-08-26 20:11:47 -0700305 default:
306 if (pt->len)
307 minlen = pt->len;
Johannes Berg6f455f52019-04-26 14:07:27 +0200308 else
Thomas Grafa5531a52006-08-26 20:11:47 -0700309 minlen = nla_attr_minlen[pt->type];
310
311 if (attrlen < minlen)
Johannes Bergc29f1842018-09-26 11:15:32 +0200312 goto out_err;
Thomas Grafa5531a52006-08-26 20:11:47 -0700313 }
Thomas Grafbfa83a92005-11-10 02:25:51 +0100314
Johannes Berg3e48be02018-09-27 11:28:35 +0200315 /* further validation */
316 switch (pt->validation_type) {
317 case NLA_VALIDATE_NONE:
318 /* nothing to do */
319 break;
320 case NLA_VALIDATE_RANGE:
321 case NLA_VALIDATE_MIN:
322 case NLA_VALIDATE_MAX:
323 err = nla_validate_int_range(pt, nla, extack);
324 if (err)
325 return err;
326 break;
Johannes Berg33188bd2018-09-27 11:28:36 +0200327 case NLA_VALIDATE_FUNCTION:
328 if (pt->validate) {
329 err = pt->validate(nla, extack);
330 if (err)
331 return err;
332 }
333 break;
Johannes Berg3e48be02018-09-27 11:28:35 +0200334 }
335
Thomas Grafbfa83a92005-11-10 02:25:51 +0100336 return 0;
Johannes Bergc29f1842018-09-26 11:15:32 +0200337out_err:
338 NL_SET_ERR_MSG_ATTR(extack, nla, "Attribute failed policy validation");
339 return err;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100340}
341
Johannes Berg8cb08172019-04-26 14:07:28 +0200342static int __nla_validate_parse(const struct nlattr *head, int len, int maxtype,
343 const struct nla_policy *policy,
344 unsigned int validate,
345 struct netlink_ext_ack *extack,
346 struct nlattr **tb)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100347{
Jan Engelhardt36546542010-11-16 09:52:32 -0800348 const struct nlattr *nla;
Johannes Bergfceb6432017-04-12 14:34:07 +0200349 int rem;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100350
Johannes Berg8cb08172019-04-26 14:07:28 +0200351 if (tb)
352 memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));
Johannes Bergfceb6432017-04-12 14:34:07 +0200353
Johannes Berg8cb08172019-04-26 14:07:28 +0200354 nla_for_each_attr(nla, head, len, rem) {
355 u16 type = nla_type(nla);
356
357 if (type == 0 || type > maxtype) {
358 if (validate & NL_VALIDATE_MAXTYPE) {
Michal Kubecekd54a16b2019-05-02 16:15:10 +0200359 NL_SET_ERR_MSG_ATTR(extack, nla,
360 "Unknown attribute type");
Johannes Berg8cb08172019-04-26 14:07:28 +0200361 return -EINVAL;
362 }
363 continue;
364 }
365 if (policy) {
366 int err = validate_nla(nla, maxtype, policy,
367 validate, extack);
368
369 if (err < 0)
370 return err;
371 }
372
373 if (tb)
374 tb[type] = (struct nlattr *)nla;
375 }
376
377 if (unlikely(rem > 0)) {
378 pr_warn_ratelimited("netlink: %d bytes leftover after parsing attributes in process `%s'.\n",
379 rem, current->comm);
380 NL_SET_ERR_MSG(extack, "bytes leftover after parsing attributes");
381 if (validate & NL_VALIDATE_TRAILING)
382 return -EINVAL;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100383 }
384
Johannes Bergfceb6432017-04-12 14:34:07 +0200385 return 0;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100386}
Johannes Berg8cb08172019-04-26 14:07:28 +0200387
388/**
389 * __nla_validate - Validate a stream of attributes
390 * @head: head of attribute stream
391 * @len: length of attribute stream
392 * @maxtype: maximum attribute type to be expected
393 * @policy: validation policy
394 * @validate: validation strictness
395 * @extack: extended ACK report struct
396 *
397 * Validates all attributes in the specified attribute stream against the
398 * specified policy. Validation depends on the validate flags passed, see
399 * &enum netlink_validation for more details on that.
400 * See documenation of struct nla_policy for more details.
401 *
402 * Returns 0 on success or a negative error code.
403 */
404int __nla_validate(const struct nlattr *head, int len, int maxtype,
405 const struct nla_policy *policy, unsigned int validate,
406 struct netlink_ext_ack *extack)
407{
408 return __nla_validate_parse(head, len, maxtype, policy, validate,
409 extack, NULL);
410}
411EXPORT_SYMBOL(__nla_validate);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100412
413/**
Holger Eitzenbergere487eb992009-03-25 18:26:30 +0100414 * nla_policy_len - Determin the max. length of a policy
415 * @policy: policy to use
416 * @n: number of policies
417 *
418 * Determines the max. length of the policy. It is currently used
419 * to allocated Netlink buffers roughly the size of the actual
420 * message.
421 *
422 * Returns 0 on success or a negative error code.
423 */
424int
425nla_policy_len(const struct nla_policy *p, int n)
426{
427 int i, len = 0;
428
Lars Ellenberge3fa3af2011-02-28 12:38:25 -0800429 for (i = 0; i < n; i++, p++) {
Holger Eitzenbergere487eb992009-03-25 18:26:30 +0100430 if (p->len)
431 len += nla_total_size(p->len);
David Ahern28033ae2017-11-07 21:59:40 -0800432 else if (nla_attr_len[p->type])
433 len += nla_total_size(nla_attr_len[p->type]);
Holger Eitzenbergere487eb992009-03-25 18:26:30 +0100434 else if (nla_attr_minlen[p->type])
435 len += nla_total_size(nla_attr_minlen[p->type]);
436 }
437
438 return len;
439}
Fabian Frederick6d6a1382014-06-04 16:11:57 -0700440EXPORT_SYMBOL(nla_policy_len);
Holger Eitzenbergere487eb992009-03-25 18:26:30 +0100441
442/**
Johannes Berg8cb08172019-04-26 14:07:28 +0200443 * __nla_parse - Parse a stream of attributes into a tb buffer
Thomas Grafbfa83a92005-11-10 02:25:51 +0100444 * @tb: destination array with maxtype+1 elements
445 * @maxtype: maximum attribute type to be expected
446 * @head: head of attribute stream
447 * @len: length of attribute stream
Julius Volz10b595a2008-06-27 20:02:14 -0700448 * @policy: validation policy
Johannes Berg8cb08172019-04-26 14:07:28 +0200449 * @validate: validation strictness
450 * @extack: extended ACK pointer
Thomas Grafbfa83a92005-11-10 02:25:51 +0100451 *
452 * Parses a stream of attributes and stores a pointer to each attribute in
Johannes Berg8cb08172019-04-26 14:07:28 +0200453 * the tb array accessible via the attribute type.
454 * Validation is controlled by the @validate parameter.
Thomas Grafbfa83a92005-11-10 02:25:51 +0100455 *
456 * Returns 0 on success or a negative error code.
457 */
Johannes Berg8cb08172019-04-26 14:07:28 +0200458int __nla_parse(struct nlattr **tb, int maxtype,
459 const struct nlattr *head, int len,
460 const struct nla_policy *policy, unsigned int validate,
461 struct netlink_ext_ack *extack)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100462{
Johannes Berg8cb08172019-04-26 14:07:28 +0200463 return __nla_validate_parse(head, len, maxtype, policy, validate,
464 extack, tb);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100465}
Johannes Berg8cb08172019-04-26 14:07:28 +0200466EXPORT_SYMBOL(__nla_parse);
David Aherna5f6cba2018-10-07 20:16:25 -0700467
Thomas Grafbfa83a92005-11-10 02:25:51 +0100468/**
469 * nla_find - Find a specific attribute in a stream of attributes
470 * @head: head of attribute stream
471 * @len: length of attribute stream
472 * @attrtype: type of attribute to look for
473 *
474 * Returns the first attribute in the stream matching the specified type.
475 */
Jan Engelhardt36546542010-11-16 09:52:32 -0800476struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100477{
Jan Engelhardt36546542010-11-16 09:52:32 -0800478 const struct nlattr *nla;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100479 int rem;
480
481 nla_for_each_attr(nla, head, len, rem)
Thomas Graf8f4c1f92007-09-12 14:44:36 +0200482 if (nla_type(nla) == attrtype)
Jan Engelhardt36546542010-11-16 09:52:32 -0800483 return (struct nlattr *)nla;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100484
485 return NULL;
486}
Fabian Frederick6d6a1382014-06-04 16:11:57 -0700487EXPORT_SYMBOL(nla_find);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100488
489/**
490 * nla_strlcpy - Copy string attribute payload into a sized buffer
491 * @dst: where to copy the string to
Julius Volz10b595a2008-06-27 20:02:14 -0700492 * @nla: attribute to copy the string from
Thomas Grafbfa83a92005-11-10 02:25:51 +0100493 * @dstsize: size of destination buffer
494 *
495 * Copies at most dstsize - 1 bytes into the destination buffer.
496 * The result is always a valid NUL-terminated string. Unlike
497 * strlcpy the destination buffer is always padded out.
498 *
499 * Returns the length of the source buffer.
500 */
501size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize)
502{
503 size_t srclen = nla_len(nla);
504 char *src = nla_data(nla);
505
506 if (srclen > 0 && src[srclen - 1] == '\0')
507 srclen--;
508
509 if (dstsize > 0) {
510 size_t len = (srclen >= dstsize) ? dstsize - 1 : srclen;
511
512 memset(dst, 0, dstsize);
513 memcpy(dst, src, len);
514 }
515
516 return srclen;
517}
Fabian Frederick6d6a1382014-06-04 16:11:57 -0700518EXPORT_SYMBOL(nla_strlcpy);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100519
520/**
Phil Sutter2cf0c8b2017-07-27 16:56:40 +0200521 * nla_strdup - Copy string attribute payload into a newly allocated buffer
522 * @nla: attribute to copy the string from
523 * @flags: the type of memory to allocate (see kmalloc).
524 *
525 * Returns a pointer to the allocated buffer or NULL on error.
526 */
527char *nla_strdup(const struct nlattr *nla, gfp_t flags)
528{
529 size_t srclen = nla_len(nla);
530 char *src = nla_data(nla), *dst;
531
532 if (srclen > 0 && src[srclen - 1] == '\0')
533 srclen--;
534
535 dst = kmalloc(srclen + 1, flags);
536 if (dst != NULL) {
537 memcpy(dst, src, srclen);
538 dst[srclen] = '\0';
539 }
540 return dst;
541}
542EXPORT_SYMBOL(nla_strdup);
543
544/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100545 * nla_memcpy - Copy a netlink attribute into another memory area
546 * @dest: where to copy to memcpy
547 * @src: netlink attribute to copy from
548 * @count: size of the destination area
549 *
550 * Note: The number of bytes copied is limited by the length of
551 * attribute's payload. memcpy
552 *
553 * Returns the number of bytes copied.
554 */
Patrick McHardyb057efd2008-10-28 11:59:11 -0700555int nla_memcpy(void *dest, const struct nlattr *src, int count)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100556{
557 int minlen = min_t(int, count, nla_len(src));
558
559 memcpy(dest, nla_data(src), minlen);
Jiri Benc5899f042015-03-29 16:05:28 +0200560 if (count > minlen)
561 memset(dest + minlen, 0, count - minlen);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100562
563 return minlen;
564}
Fabian Frederick6d6a1382014-06-04 16:11:57 -0700565EXPORT_SYMBOL(nla_memcpy);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100566
567/**
568 * nla_memcmp - Compare an attribute with sized memory area
569 * @nla: netlink attribute
570 * @data: memory area
571 * @size: size of memory area
572 */
573int nla_memcmp(const struct nlattr *nla, const void *data,
574 size_t size)
575{
576 int d = nla_len(nla) - size;
577
578 if (d == 0)
579 d = memcmp(nla_data(nla), data, size);
580
581 return d;
582}
Fabian Frederick6d6a1382014-06-04 16:11:57 -0700583EXPORT_SYMBOL(nla_memcmp);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100584
585/**
586 * nla_strcmp - Compare a string attribute against a string
587 * @nla: netlink string attribute
588 * @str: another string
589 */
590int nla_strcmp(const struct nlattr *nla, const char *str)
591{
Pablo Neira8b7b9322014-04-01 19:38:44 +0200592 int len = strlen(str);
593 char *buf = nla_data(nla);
594 int attrlen = nla_len(nla);
595 int d;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100596
Pablo Neira8b7b9322014-04-01 19:38:44 +0200597 if (attrlen > 0 && buf[attrlen - 1] == '\0')
598 attrlen--;
599
600 d = attrlen - len;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100601 if (d == 0)
602 d = memcmp(nla_data(nla), str, len);
603
604 return d;
605}
Fabian Frederick6d6a1382014-06-04 16:11:57 -0700606EXPORT_SYMBOL(nla_strcmp);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100607
Herbert Xu90800212009-03-11 23:18:32 +0800608#ifdef CONFIG_NET
Thomas Grafbfa83a92005-11-10 02:25:51 +0100609/**
610 * __nla_reserve - reserve room for attribute on the skb
611 * @skb: socket buffer to reserve room on
612 * @attrtype: attribute type
613 * @attrlen: length of attribute payload
614 *
615 * Adds a netlink attribute header to a socket buffer and reserves
616 * room for the payload but does not copy it.
617 *
618 * The caller is responsible to ensure that the skb provides enough
619 * tailroom for the attribute header and payload.
620 */
621struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
622{
623 struct nlattr *nla;
624
Johannes Berg4df864c2017-06-16 14:29:21 +0200625 nla = skb_put(skb, nla_total_size(attrlen));
Thomas Grafbfa83a92005-11-10 02:25:51 +0100626 nla->nla_type = attrtype;
627 nla->nla_len = nla_attr_size(attrlen);
628
629 memset((unsigned char *) nla + nla->nla_len, 0, nla_padlen(attrlen));
630
631 return nla;
632}
Herbert Xu90800212009-03-11 23:18:32 +0800633EXPORT_SYMBOL(__nla_reserve);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100634
635/**
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200636 * __nla_reserve_64bit - reserve room for attribute on the skb and align it
637 * @skb: socket buffer to reserve room on
638 * @attrtype: attribute type
639 * @attrlen: length of attribute payload
Nicolas Dichtel11a99572016-04-22 17:31:16 +0200640 * @padattr: attribute type for the padding
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200641 *
642 * Adds a netlink attribute header to a socket buffer and reserves
643 * room for the payload but does not copy it. It also ensure that this
Nicolas Dichtel11a99572016-04-22 17:31:16 +0200644 * attribute will have a 64-bit aligned nla_data() area.
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200645 *
646 * The caller is responsible to ensure that the skb provides enough
647 * tailroom for the attribute header and payload.
648 */
649struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype,
650 int attrlen, int padattr)
651{
652 if (nla_need_padding_for_64bit(skb))
653 nla_align_64bit(skb, padattr);
654
655 return __nla_reserve(skb, attrtype, attrlen);
656}
657EXPORT_SYMBOL(__nla_reserve_64bit);
658
659/**
Thomas Graffe4944e2006-08-04 23:03:05 -0700660 * __nla_reserve_nohdr - reserve room for attribute without header
661 * @skb: socket buffer to reserve room on
662 * @attrlen: length of attribute payload
663 *
664 * Reserves room for attribute payload without a header.
665 *
666 * The caller is responsible to ensure that the skb provides enough
667 * tailroom for the payload.
668 */
669void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
670{
yuan linyub952f4d2017-06-18 22:52:04 +0800671 return skb_put_zero(skb, NLA_ALIGN(attrlen));
Thomas Graffe4944e2006-08-04 23:03:05 -0700672}
Herbert Xu90800212009-03-11 23:18:32 +0800673EXPORT_SYMBOL(__nla_reserve_nohdr);
Thomas Graffe4944e2006-08-04 23:03:05 -0700674
675/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100676 * nla_reserve - reserve room for attribute on the skb
677 * @skb: socket buffer to reserve room on
678 * @attrtype: attribute type
679 * @attrlen: length of attribute payload
680 *
681 * Adds a netlink attribute header to a socket buffer and reserves
682 * room for the payload but does not copy it.
683 *
684 * Returns NULL if the tailroom of the skb is insufficient to store
685 * the attribute header and payload.
686 */
687struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen)
688{
689 if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
690 return NULL;
691
692 return __nla_reserve(skb, attrtype, attrlen);
693}
Herbert Xu90800212009-03-11 23:18:32 +0800694EXPORT_SYMBOL(nla_reserve);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100695
696/**
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200697 * nla_reserve_64bit - reserve room for attribute on the skb and align it
698 * @skb: socket buffer to reserve room on
699 * @attrtype: attribute type
700 * @attrlen: length of attribute payload
Nicolas Dichtel11a99572016-04-22 17:31:16 +0200701 * @padattr: attribute type for the padding
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200702 *
703 * Adds a netlink attribute header to a socket buffer and reserves
704 * room for the payload but does not copy it. It also ensure that this
Nicolas Dichtel11a99572016-04-22 17:31:16 +0200705 * attribute will have a 64-bit aligned nla_data() area.
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200706 *
707 * Returns NULL if the tailroom of the skb is insufficient to store
708 * the attribute header and payload.
709 */
710struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype, int attrlen,
711 int padattr)
712{
713 size_t len;
714
715 if (nla_need_padding_for_64bit(skb))
716 len = nla_total_size_64bit(attrlen);
717 else
718 len = nla_total_size(attrlen);
719 if (unlikely(skb_tailroom(skb) < len))
720 return NULL;
721
722 return __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
723}
724EXPORT_SYMBOL(nla_reserve_64bit);
725
726/**
Julius Volz10b595a2008-06-27 20:02:14 -0700727 * nla_reserve_nohdr - reserve room for attribute without header
Thomas Graffe4944e2006-08-04 23:03:05 -0700728 * @skb: socket buffer to reserve room on
Julius Volz10b595a2008-06-27 20:02:14 -0700729 * @attrlen: length of attribute payload
Thomas Graffe4944e2006-08-04 23:03:05 -0700730 *
731 * Reserves room for attribute payload without a header.
732 *
733 * Returns NULL if the tailroom of the skb is insufficient to store
734 * the attribute payload.
735 */
736void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen)
737{
738 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
739 return NULL;
740
741 return __nla_reserve_nohdr(skb, attrlen);
742}
Herbert Xu90800212009-03-11 23:18:32 +0800743EXPORT_SYMBOL(nla_reserve_nohdr);
Thomas Graffe4944e2006-08-04 23:03:05 -0700744
745/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100746 * __nla_put - Add a netlink attribute to a socket buffer
747 * @skb: socket buffer to add attribute to
748 * @attrtype: attribute type
749 * @attrlen: length of attribute payload
750 * @data: head of attribute payload
751 *
752 * The caller is responsible to ensure that the skb provides enough
753 * tailroom for the attribute header and payload.
754 */
755void __nla_put(struct sk_buff *skb, int attrtype, int attrlen,
756 const void *data)
757{
758 struct nlattr *nla;
759
760 nla = __nla_reserve(skb, attrtype, attrlen);
761 memcpy(nla_data(nla), data, attrlen);
762}
Herbert Xu90800212009-03-11 23:18:32 +0800763EXPORT_SYMBOL(__nla_put);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100764
Thomas Graffe4944e2006-08-04 23:03:05 -0700765/**
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200766 * __nla_put_64bit - Add a netlink attribute to a socket buffer and align it
767 * @skb: socket buffer to add attribute to
768 * @attrtype: attribute type
769 * @attrlen: length of attribute payload
770 * @data: head of attribute payload
Nicolas Dichtel11a99572016-04-22 17:31:16 +0200771 * @padattr: attribute type for the padding
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200772 *
773 * The caller is responsible to ensure that the skb provides enough
774 * tailroom for the attribute header and payload.
775 */
776void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
777 const void *data, int padattr)
778{
779 struct nlattr *nla;
780
781 nla = __nla_reserve_64bit(skb, attrtype, attrlen, padattr);
782 memcpy(nla_data(nla), data, attrlen);
783}
784EXPORT_SYMBOL(__nla_put_64bit);
785
786/**
Thomas Graffe4944e2006-08-04 23:03:05 -0700787 * __nla_put_nohdr - Add a netlink attribute without header
788 * @skb: socket buffer to add attribute to
789 * @attrlen: length of attribute payload
790 * @data: head of attribute payload
791 *
792 * The caller is responsible to ensure that the skb provides enough
793 * tailroom for the attribute payload.
794 */
795void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
796{
797 void *start;
798
799 start = __nla_reserve_nohdr(skb, attrlen);
800 memcpy(start, data, attrlen);
801}
Herbert Xu90800212009-03-11 23:18:32 +0800802EXPORT_SYMBOL(__nla_put_nohdr);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100803
804/**
805 * nla_put - Add a netlink attribute to a socket buffer
806 * @skb: socket buffer to add attribute to
807 * @attrtype: attribute type
808 * @attrlen: length of attribute payload
809 * @data: head of attribute payload
810 *
Thomas Grafbc3ed282008-06-03 16:36:54 -0700811 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
Thomas Grafbfa83a92005-11-10 02:25:51 +0100812 * the attribute header and payload.
813 */
814int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data)
815{
816 if (unlikely(skb_tailroom(skb) < nla_total_size(attrlen)))
Thomas Grafbc3ed282008-06-03 16:36:54 -0700817 return -EMSGSIZE;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100818
819 __nla_put(skb, attrtype, attrlen, data);
820 return 0;
821}
Herbert Xu90800212009-03-11 23:18:32 +0800822EXPORT_SYMBOL(nla_put);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100823
Thomas Graffe4944e2006-08-04 23:03:05 -0700824/**
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200825 * nla_put_64bit - Add a netlink attribute to a socket buffer and align it
826 * @skb: socket buffer to add attribute to
827 * @attrtype: attribute type
828 * @attrlen: length of attribute payload
829 * @data: head of attribute payload
Nicolas Dichtel11a99572016-04-22 17:31:16 +0200830 * @padattr: attribute type for the padding
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200831 *
832 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
833 * the attribute header and payload.
834 */
835int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
836 const void *data, int padattr)
837{
838 size_t len;
839
840 if (nla_need_padding_for_64bit(skb))
841 len = nla_total_size_64bit(attrlen);
842 else
843 len = nla_total_size(attrlen);
844 if (unlikely(skb_tailroom(skb) < len))
845 return -EMSGSIZE;
846
847 __nla_put_64bit(skb, attrtype, attrlen, data, padattr);
848 return 0;
849}
850EXPORT_SYMBOL(nla_put_64bit);
851
852/**
Thomas Graffe4944e2006-08-04 23:03:05 -0700853 * nla_put_nohdr - Add a netlink attribute without header
854 * @skb: socket buffer to add attribute to
855 * @attrlen: length of attribute payload
856 * @data: head of attribute payload
857 *
Thomas Grafbc3ed282008-06-03 16:36:54 -0700858 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
Thomas Graffe4944e2006-08-04 23:03:05 -0700859 * the attribute payload.
860 */
861int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data)
862{
863 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
Thomas Grafbc3ed282008-06-03 16:36:54 -0700864 return -EMSGSIZE;
Thomas Graffe4944e2006-08-04 23:03:05 -0700865
866 __nla_put_nohdr(skb, attrlen, data);
867 return 0;
868}
Herbert Xu90800212009-03-11 23:18:32 +0800869EXPORT_SYMBOL(nla_put_nohdr);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100870
Patrick McHardy01480e12008-01-22 22:10:59 -0800871/**
872 * nla_append - Add a netlink attribute without header or padding
873 * @skb: socket buffer to add attribute to
874 * @attrlen: length of attribute payload
875 * @data: head of attribute payload
876 *
Thomas Grafbc3ed282008-06-03 16:36:54 -0700877 * Returns -EMSGSIZE if the tailroom of the skb is insufficient to store
Patrick McHardy01480e12008-01-22 22:10:59 -0800878 * the attribute payload.
879 */
880int nla_append(struct sk_buff *skb, int attrlen, const void *data)
881{
882 if (unlikely(skb_tailroom(skb) < NLA_ALIGN(attrlen)))
Thomas Grafbc3ed282008-06-03 16:36:54 -0700883 return -EMSGSIZE;
Patrick McHardy01480e12008-01-22 22:10:59 -0800884
Johannes Berg59ae1d12017-06-16 14:29:20 +0200885 skb_put_data(skb, data, attrlen);
Patrick McHardy01480e12008-01-22 22:10:59 -0800886 return 0;
887}
Herbert Xu90800212009-03-11 23:18:32 +0800888EXPORT_SYMBOL(nla_append);
889#endif