]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/udev/udev-rules.c
projects / thirdparty / systemd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
udev-rules: add more info to errors about attr formats
[thirdparty/systemd.git] / src / udev / udev-rules.c
1 /* SPDX-License-Identifier: GPL-2.0+ */
2
3 #include <ctype.h>
4
5 #include "alloc-util.h"
6 #include "conf-files.h"
7 #include "def.h"
8 #include "device-util.h"
9 #include "dirent-util.h"
10 #include "escape.h"
11 #include "fd-util.h"
12 #include "fileio.h"
13 #include "format-util.h"
14 #include "fs-util.h"
15 #include "glob-util.h"
16 #include "libudev-util.h"
17 #include "list.h"
18 #include "mkdir.h"
19 #include "nulstr-util.h"
20 #include "parse-util.h"
21 #include "path-util.h"
22 #include "proc-cmdline.h"
23 #include "stat-util.h"
24 #include "strv.h"
25 #include "strxcpyx.h"
26 #include "sysctl-util.h"
27 #include "udev-builtin.h"
28 #include "udev-event.h"
29 #include "udev-rules.h"
30 #include "user-util.h"
31
32 #define RULES_DIRS (const char* const*) CONF_PATHS_STRV("udev/rules.d")
33
34
35 typedef enum {
36 OP_MATCH, /* == */
37 OP_NOMATCH, /* != */
38 OP_ADD, /* += */
39 OP_REMOVE, /* -= */
40 OP_ASSIGN, /* = */
41 OP_ASSIGN_FINAL, /* := */
42 _OP_TYPE_MAX,
43 _OP_TYPE_INVALID = -1
44 } UdevRuleOperatorType;
45
46 typedef enum {
47 MATCH_TYPE_EMPTY, /* empty string */
48 MATCH_TYPE_PLAIN, /* no special characters */
49 MATCH_TYPE_GLOB, /* shell globs ?,*,[] */
50 MATCH_TYPE_SUBSYSTEM, /* "subsystem", "bus", or "class" */
51 _MATCH_TYPE_MAX,
52 _MATCH_TYPE_INVALID = -1
53 } UdevRuleMatchType;
54
55 typedef enum {
56 SUBST_TYPE_PLAIN, /* no substitution */
57 SUBST_TYPE_FORMAT, /* % or $ */
58 SUBST_TYPE_SUBSYS, /* "[<SUBSYSTEM>/<KERNEL>]<attribute>" format */
59 _SUBST_TYPE_MAX,
60 _SUBST_TYPE_INVALID = -1
61 } UdevRuleSubstituteType;
62
63 typedef enum {
64 /* lvalues which take match or nomatch operator */
65 TK_M_ACTION, /* string, device_get_action() */
66 TK_M_DEVPATH, /* path, sd_device_get_devpath() */
67 TK_M_KERNEL, /* string, sd_device_get_sysname() */
68 TK_M_DEVLINK, /* strv, sd_device_get_devlink_first(), sd_device_get_devlink_next() */
69 TK_M_NAME, /* string, name of network interface */
70 TK_M_ENV, /* string, device property, takes key through attribute */
71 TK_M_TAG, /* strv, sd_device_get_tag_first(), sd_device_get_tag_next() */
72 TK_M_SUBSYSTEM, /* string, sd_device_get_subsystem() */
73 TK_M_DRIVER, /* string, sd_device_get_driver() */
74 TK_M_ATTR, /* string, takes filename through attribute, sd_device_get_sysattr_value(), util_resolve_subsys_kernel(), etc. */
75 TK_M_SYSCTL, /* string, takes kernel parameter through attribute */
76
77 /* matches parent paramters */
78 TK_M_PARENTS_KERNEL, /* string */
79 TK_M_PARENTS_SUBSYSTEM, /* string */
80 TK_M_PARENTS_DRIVER, /* string */
81 TK_M_PARENTS_ATTR, /* string */
82 TK_M_PARENTS_TAG, /* strv */
83
84 TK_M_TEST, /* path, optionally mode_t can be specified by attribute, test the existence of a file */
85 TK_M_PROGRAM, /* string, execute a program */
86 TK_M_IMPORT_FILE, /* path */
87 TK_M_IMPORT_PROGRAM, /* string, import properties from the result of program */
88 TK_M_IMPORT_BUILTIN, /* string, import properties from the result of built-in command */
89 TK_M_IMPORT_DB, /* string, import properties from database */
90 TK_M_IMPORT_CMDLINE, /* string, kernel command line */
91 TK_M_IMPORT_PARENT, /* string, parent property */
92 TK_M_RESULT, /* string, result of TK_M_PROGRAM */
93
94 #define _TK_M_MAX (TK_M_RESULT + 1)
95 #define _TK_A_MIN _TK_M_MAX
96
97 /* lvalues which take one of assign operators */
98 TK_A_OPTIONS_STRING_ESCAPE_NONE, /* no argument */
99 TK_A_OPTIONS_STRING_ESCAPE_REPLACE, /* no argument */
100 TK_A_OPTIONS_DB_PERSIST, /* no argument */
101 TK_A_OPTIONS_INOTIFY_WATCH, /* boolean */
102 TK_A_OPTIONS_DEVLINK_PRIORITY, /* int */
103 TK_A_OWNER, /* user name */
104 TK_A_GROUP, /* group name */
105 TK_A_MODE, /* mode string */
106 TK_A_OWNER_ID, /* uid_t */
107 TK_A_GROUP_ID, /* gid_t */
108 TK_A_MODE_ID, /* mode_t */
109 TK_A_TAG, /* string */
110 TK_A_OPTIONS_STATIC_NODE, /* device path, /dev/... */
111 TK_A_SECLABEL, /* string with attribute */
112 TK_A_ENV, /* string with attribute */
113 TK_A_NAME, /* ifname */
114 TK_A_DEVLINK, /* string */
115 TK_A_ATTR, /* string with attribute */
116 TK_A_SYSCTL, /* string with attribute */
117 TK_A_RUN_BUILTIN, /* string */
118 TK_A_RUN_PROGRAM, /* string */
119
120 _TK_TYPE_MAX,
121 _TK_TYPE_INVALID = -1,
122 } UdevRuleTokenType;
123
124 typedef enum {
125 LINE_HAS_NAME = 1 << 0, /* has NAME= */
126 LINE_HAS_DEVLINK = 1 << 1, /* has SYMLINK=, OWNER=, GROUP= or MODE= */
127 LINE_HAS_STATIC_NODE = 1 << 2, /* has OPTIONS=static_node */
128 LINE_HAS_GOTO = 1 << 3, /* has GOTO= */
129 LINE_HAS_LABEL = 1 << 4, /* has LABEL= */
130 LINE_UPDATE_SOMETHING = 1 << 5, /* has other TK_A_* or TK_M_IMPORT tokens */
131 } UdevRuleLineType;
132
133 typedef struct UdevRuleFile UdevRuleFile;
134 typedef struct UdevRuleLine UdevRuleLine;
135 typedef struct UdevRuleToken UdevRuleToken;
136
137 struct UdevRuleToken {
138 UdevRuleTokenType type:8;
139 UdevRuleOperatorType op:8;
140 UdevRuleMatchType match_type:8;
141 UdevRuleSubstituteType attr_subst_type:7;
142 bool attr_match_remove_trailing_whitespace:1;
143 const char *value;
144 void *data;
145 LIST_FIELDS(UdevRuleToken, tokens);
146 };
147
148 struct UdevRuleLine {
149 char *line;
150 unsigned line_number;
151 UdevRuleLineType type;
152
153 const char *label;
154 const char *goto_label;
155 UdevRuleLine *goto_line;
156
157 UdevRuleFile *rule_file;
158 UdevRuleToken *current_token;
159 LIST_HEAD(UdevRuleToken, tokens);
160 LIST_FIELDS(UdevRuleLine, rule_lines);
161 };
162
163 struct UdevRuleFile {
164 char *filename;
165 UdevRuleLine *current_line;
166 LIST_HEAD(UdevRuleLine, rule_lines);
167 LIST_FIELDS(UdevRuleFile, rule_files);
168 };
169
170 struct UdevRules {
171 usec_t dirs_ts_usec;
172 ResolveNameTiming resolve_name_timing;
173 Hashmap *known_users;
174 Hashmap *known_groups;
175 UdevRuleFile *current_file;
176 LIST_HEAD(UdevRuleFile, rule_files);
177 };
178
179
180 /*** Logging helpers ***/
181
182 #define log_rule_full(device, rules, level, error, fmt, ...) \
183 ({ \
184 UdevRules *_r = (rules); \
185 UdevRuleFile *_f = _r ? _r->current_file : NULL; \
186 UdevRuleLine *_l = _f ? _f->current_line : NULL; \
187 const char *_n = _f ? _f->filename : NULL; \
188 \
189 log_device_full(device, level, error, "%s:%u " fmt, \
190 strna(_n), _l ? _l->line_number : 0, \
191 ##__VA_ARGS__); \
192 })
193
194 #define log_rule_debug(device, rules, ...) log_rule_full(device, rules, LOG_DEBUG, 0, ##__VA_ARGS__)
195 #define log_rule_info(device, rules, ...) log_rule_full(device, rules, LOG_INFO, 0, ##__VA_ARGS__)
196 #define log_rule_notice(device, rules, ...) log_rule_full(device, rules, LOG_NOTICE, 0, ##__VA_ARGS__)
197 #define log_rule_warning(device, rules, ...) log_rule_full(device, rules, LOG_WARNING, 0, ##__VA_ARGS__)
198 #define log_rule_error(device, rules, ...) log_rule_full(device, rules, LOG_ERR, 0, ##__VA_ARGS__)
199
200 #define log_rule_debug_errno(device, rules, error, ...) log_rule_full(device, rules, LOG_DEBUG, error, ##__VA_ARGS__)
201 #define log_rule_info_errno(device, rules, error, ...) log_rule_full(device, rules, LOG_INFO, error, ##__VA_ARGS__)
202 #define log_rule_notice_errno(device, rules, error, ...) log_rule_full(device, rules, LOG_NOTICE, error, ##__VA_ARGS__)
203 #define log_rule_warning_errno(device, rules, error, ...) log_rule_full(device, rules, LOG_WARNING, error, ##__VA_ARGS__)
204 #define log_rule_error_errno(device, rules, error, ...) log_rule_full(device, rules, LOG_ERR, error, ##__VA_ARGS__)
205
206 #define log_token_full(rules, ...) log_rule_full(NULL, rules, ##__VA_ARGS__)
207
208 #define log_token_debug(rules, ...) log_token_full(rules, LOG_DEBUG, 0, ##__VA_ARGS__)
209 #define log_token_info(rules, ...) log_token_full(rules, LOG_INFO, 0, ##__VA_ARGS__)
210 #define log_token_notice(rules, ...) log_token_full(rules, LOG_NOTICE, 0, ##__VA_ARGS__)
211 #define log_token_warning(rules, ...) log_token_full(rules, LOG_WARNING, 0, ##__VA_ARGS__)
212 #define log_token_error(rules, ...) log_token_full(rules, LOG_ERR, 0, ##__VA_ARGS__)
213
214 #define log_token_debug_errno(rules, error, ...) log_token_full(rules, LOG_DEBUG, error, ##__VA_ARGS__)
215 #define log_token_info_errno(rules, error, ...) log_token_full(rules, LOG_INFO, error, ##__VA_ARGS__)
216 #define log_token_notice_errno(rules, error, ...) log_token_full(rules, LOG_NOTICE, error, ##__VA_ARGS__)
217 #define log_token_warning_errno(rules, error, ...) log_token_full(rules, LOG_WARNING, error, ##__VA_ARGS__)
218 #define log_token_error_errno(rules, error, ...) log_token_full(rules, LOG_ERR, error, ##__VA_ARGS__)
219
220 #define _log_token_invalid(rules, key, type) \
221 log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL), \
222 "Invalid %s for %s.", type, key)
223
224 #define log_token_invalid_op(rules, key) _log_token_invalid(rules, key, "operator")
225 #define log_token_invalid_attr(rules, key) _log_token_invalid(rules, key, "attribute")
226
227 #define log_token_invalid_attr_format(rules, key, attr, offset, hint) \
228 log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL), \
229 "Invalid attribute \"%s\" for %s (char %zu: %s), ignoring, but please fix it.", \
230 attr, key, offset, hint)
231 #define log_token_invalid_value(rules, key, value, offset, hint) \
232 log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL), \
233 "Invalid value \"%s\" for %s (char %zu: %s), ignoring, but please fix it.", \
234 value, key, offset, hint)
235
236 static void log_unknown_owner(sd_device *dev, UdevRules *rules, int error, const char *entity, const char *name) {
237 if (IN_SET(abs(error), ENOENT, ESRCH))
238 log_rule_error(dev, rules, "Unknown %s '%s', ignoring", entity, name);
239 else
240 log_rule_error_errno(dev, rules, error, "Failed to resolve %s '%s', ignoring: %m", entity, name);
241 }
242
243 /*** Other functions ***/
244
245 static void udev_rule_token_free(UdevRuleToken *token) {
246 free(token);
247 }
248
249 static void udev_rule_line_clear_tokens(UdevRuleLine *rule_line) {
250 UdevRuleToken *i, *next;
251
252 assert(rule_line);
253
254 LIST_FOREACH_SAFE(tokens, i, next, rule_line->tokens)
255 udev_rule_token_free(i);
256
257 rule_line->tokens = NULL;
258 }
259
260 static void udev_rule_line_free(UdevRuleLine *rule_line) {
261 if (!rule_line)
262 return;
263
264 udev_rule_line_clear_tokens(rule_line);
265
266 if (rule_line->rule_file) {
267 if (rule_line->rule_file->current_line == rule_line)
268 rule_line->rule_file->current_line = rule_line->rule_lines_prev;
269
270 LIST_REMOVE(rule_lines, rule_line->rule_file->rule_lines, rule_line);
271 }
272
273 free(rule_line->line);
274 free(rule_line);
275 }
276
277 DEFINE_TRIVIAL_CLEANUP_FUNC(UdevRuleLine*, udev_rule_line_free);
278
279 static void udev_rule_file_free(UdevRuleFile *rule_file) {
280 UdevRuleLine *i, *next;
281
282 if (!rule_file)
283 return;
284
285 LIST_FOREACH_SAFE(rule_lines, i, next, rule_file->rule_lines)
286 udev_rule_line_free(i);
287
288 free(rule_file->filename);
289 free(rule_file);
290 }
291
292 UdevRules *udev_rules_free(UdevRules *rules) {
293 UdevRuleFile *i, *next;
294
295 if (!rules)
296 return NULL;
297
298 LIST_FOREACH_SAFE(rule_files, i, next, rules->rule_files)
299 udev_rule_file_free(i);
300
301 hashmap_free_free_key(rules->known_users);
302 hashmap_free_free_key(rules->known_groups);
303 return mfree(rules);
304 }
305
306 static int rule_resolve_user(UdevRules *rules, const char *name, uid_t *ret) {
307 _cleanup_free_ char *n = NULL;
308 uid_t uid;
309 void *val;
310 int r;
311
312 assert(rules);
313 assert(name);
314
315 val = hashmap_get(rules->known_users, name);
316 if (val) {
317 *ret = PTR_TO_UID(val);
318 return 0;
319 }
320
321 r = get_user_creds(&name, &uid, NULL, NULL, NULL, USER_CREDS_ALLOW_MISSING);
322 if (r < 0) {
323 log_unknown_owner(NULL, rules, r, "user", name);
324 *ret = UID_INVALID;
325 return 0;
326 }
327
328 n = strdup(name);
329 if (!n)
330 return -ENOMEM;
331
332 r = hashmap_ensure_allocated(&rules->known_users, &string_hash_ops);
333 if (r < 0)
334 return r;
335
336 r = hashmap_put(rules->known_users, n, UID_TO_PTR(uid));
337 if (r < 0)
338 return r;
339
340 TAKE_PTR(n);
341 *ret = uid;
342 return 0;
343 }
344
345 static int rule_resolve_group(UdevRules *rules, const char *name, gid_t *ret) {
346 _cleanup_free_ char *n = NULL;
347 gid_t gid;
348 void *val;
349 int r;
350
351 assert(rules);
352 assert(name);
353
354 val = hashmap_get(rules->known_groups, name);
355 if (val) {
356 *ret = PTR_TO_GID(val);
357 return 0;
358 }
359
360 r = get_group_creds(&name, &gid, USER_CREDS_ALLOW_MISSING);
361 if (r < 0) {
362 log_unknown_owner(NULL, rules, r, "group", name);
363 *ret = GID_INVALID;
364 return 0;
365 }
366
367 n = strdup(name);
368 if (!n)
369 return -ENOMEM;
370
371 r = hashmap_ensure_allocated(&rules->known_groups, &string_hash_ops);
372 if (r < 0)
373 return r;
374
375 r = hashmap_put(rules->known_groups, n, GID_TO_PTR(gid));
376 if (r < 0)
377 return r;
378
379 TAKE_PTR(n);
380 *ret = gid;
381 return 0;
382 }
383
384 static UdevRuleSubstituteType rule_get_substitution_type(const char *str) {
385 assert(str);
386
387 if (str[0] == '[')
388 return SUBST_TYPE_SUBSYS;
389 if (strchr(str, '%') || strchr(str, '$'))
390 return SUBST_TYPE_FORMAT;
391 return SUBST_TYPE_PLAIN;
392 }
393
394 static void rule_line_append_token(UdevRuleLine *rule_line, UdevRuleToken *token) {
395 assert(rule_line);
396 assert(token);
397
398 if (rule_line->current_token)
399 LIST_APPEND(tokens, rule_line->current_token, token);
400 else
401 LIST_APPEND(tokens, rule_line->tokens, token);
402
403 rule_line->current_token = token;
404 }
405
406 static int rule_line_add_token(UdevRuleLine *rule_line, UdevRuleTokenType type, UdevRuleOperatorType op, char *value, void *data) {
407 UdevRuleToken *token;
408 UdevRuleMatchType match_type = _MATCH_TYPE_INVALID;
409 UdevRuleSubstituteType subst_type = _SUBST_TYPE_INVALID;
410 bool remove_trailing_whitespace = false;
411 size_t len;
412
413 assert(rule_line);
414 assert(type >= 0 && type < _TK_TYPE_MAX);
415 assert(op >= 0 && op < _OP_TYPE_MAX);
416
417 if (type < _TK_M_MAX) {
418 assert(value);
419 assert(IN_SET(op, OP_MATCH, OP_NOMATCH));
420
421 if (type == TK_M_SUBSYSTEM && STR_IN_SET(value, "subsystem", "bus", "class"))
422 match_type = MATCH_TYPE_SUBSYSTEM;
423 else if (isempty(value))
424 match_type = MATCH_TYPE_EMPTY;
425 else if (streq(value, "?*")) {
426 /* Convert KEY=="?*" -> KEY!="" */
427 match_type = MATCH_TYPE_EMPTY;
428 op = op == OP_MATCH ? OP_NOMATCH : OP_MATCH;
429 } else if (string_is_glob(value))
430 match_type = MATCH_TYPE_GLOB;
431 else
432 match_type = MATCH_TYPE_PLAIN;
433
434 if (type < TK_M_TEST || type == TK_M_RESULT) {
435 /* Convert value string to nulstr. */
436 len = strlen(value);
437 if (len > 1 && (value[len - 1] == '|' || strstr(value, "||"))) {
438 /* In this case, just replacing '|' -> '\0' does not work... */
439 _cleanup_free_ char *tmp = NULL;
440 char *i, *j;
441 bool v = true;
442
443 tmp = strdup(value);
444 if (!tmp)
445 return log_oom();
446
447 for (i = tmp, j = value; *i != '\0'; i++)
448 if (*i == '|')
449 v = true;
450 else {
451 if (v) {
452 *j++ = '\0';
453 v = false;
454 }
455 *j++ = *i;
456 }
457 j[0] = j[1] = '\0';
458 } else {
459 /* Simple conversion. */
460 char *i;
461
462 for (i = value; *i != '\0'; i++)
463 if (*i == '|')
464 *i = '\0';
465 }
466 }
467 }
468
469 if (IN_SET(type, TK_M_ATTR, TK_M_PARENTS_ATTR)) {
470 assert(value);
471 assert(data);
472
473 len = strlen(value);
474 if (len > 0 && !isspace(value[len - 1]))
475 remove_trailing_whitespace = true;
476
477 subst_type = rule_get_substitution_type((const char*) data);
478 }
479
480 token = new(UdevRuleToken, 1);
481 if (!token)
482 return -ENOMEM;
483
484 *token = (UdevRuleToken) {
485 .type = type,
486 .op = op,
487 .value = value,
488 .data = data,
489 .match_type = match_type,
490 .attr_subst_type = subst_type,
491 .attr_match_remove_trailing_whitespace = remove_trailing_whitespace,
492 };
493
494 rule_line_append_token(rule_line, token);
495
496 if (token->type == TK_A_NAME)
497 SET_FLAG(rule_line->type, LINE_HAS_NAME, true);
498
499 else if (IN_SET(token->type, TK_A_DEVLINK,
500 TK_A_OWNER, TK_A_GROUP, TK_A_MODE,
501 TK_A_OWNER_ID, TK_A_GROUP_ID, TK_A_MODE_ID))
502 SET_FLAG(rule_line->type, LINE_HAS_DEVLINK, true);
503
504 else if (token->type >= _TK_A_MIN ||
505 IN_SET(token->type,
506 TK_M_IMPORT_FILE, TK_M_IMPORT_PROGRAM, TK_M_IMPORT_BUILTIN,
507 TK_M_IMPORT_DB, TK_M_IMPORT_CMDLINE, TK_M_IMPORT_PARENT))
508 SET_FLAG(rule_line->type, LINE_UPDATE_SOMETHING, true);
509
510 return 0;
511 }
512
513 static void check_value_format_and_warn(UdevRules *rules, const char *key, const char *value, bool nonempty) {
514 size_t offset;
515 const char *hint;
516
517 if (nonempty && isempty(value))
518 log_token_invalid_value(rules, key, value, (size_t) 0, "empty value");
519 else if (udev_check_format(value, &offset, &hint) < 0)
520 log_token_invalid_value(rules, key, value, offset + 1, hint);
521 }
522
523 static int check_attr_format_and_warn(UdevRules *rules, const char *key, const char *value) {
524 size_t offset;
525 const char *hint;
526
527 if (isempty(value))
528 return log_token_invalid_attr(rules, key);
529 if (udev_check_format(value, &offset, &hint) < 0)
530 log_token_invalid_attr_format(rules, key, value, offset + 1, hint);
531 return 0;
532 }
533
534 static int parse_token(UdevRules *rules, const char *key, char *attr, UdevRuleOperatorType op, char *value) {
535 bool is_match = IN_SET(op, OP_MATCH, OP_NOMATCH);
536 UdevRuleLine *rule_line;
537 int r;
538
539 assert(rules);
540 assert(rules->current_file);
541 assert(rules->current_file->current_line);
542 assert(key);
543 assert(value);
544
545 rule_line = rules->current_file->current_line;
546
547 if (streq(key, "ACTION")) {
548 if (attr)
549 return log_token_invalid_attr(rules, key);
550 if (!is_match)
551 return log_token_invalid_op(rules, key);
552
553 r = rule_line_add_token(rule_line, TK_M_ACTION, op, value, NULL);
554 } else if (streq(key, "DEVPATH")) {
555 if (attr)
556 return log_token_invalid_attr(rules, key);
557 if (!is_match)
558 return log_token_invalid_op(rules, key);
559
560 r = rule_line_add_token(rule_line, TK_M_DEVPATH, op, value, NULL);
561 } else if (streq(key, "KERNEL")) {
562 if (attr)
563 return log_token_invalid_attr(rules, key);
564 if (!is_match)
565 return log_token_invalid_op(rules, key);
566
567 r = rule_line_add_token(rule_line, TK_M_KERNEL, op, value, NULL);
568 } else if (streq(key, "SYMLINK")) {
569 if (attr)
570 return log_token_invalid_attr(rules, key);
571 if (op == OP_REMOVE)
572 return log_token_invalid_op(rules, key);
573
574 if (!is_match) {
575 check_value_format_and_warn(rules, key, value, false);
576 r = rule_line_add_token(rule_line, TK_A_DEVLINK, op, value, NULL);
577 } else
578 r = rule_line_add_token(rule_line, TK_M_DEVLINK, op, value, NULL);
579 } else if (streq(key, "NAME")) {
580 if (attr)
581 return log_token_invalid_attr(rules, key);
582 if (op == OP_REMOVE)
583 return log_token_invalid_op(rules, key);
584 if (op == OP_ADD) {
585 log_token_warning(rules, "%s key takes '==', '!=', '=', or ':=' operator, assuming '=', but please fix it.", key);
586 op = OP_ASSIGN;
587 }
588
589 if (!is_match) {
590 if (streq(value, "%k"))
591 return log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL),
592 "Ignoring NAME=\"%%k\" is ignored, as it breaks kernel supplied names.");
593 if (isempty(value))
594 return log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL),
595 "Ignoring NAME=\"\", as udev will not delete any device nodes.");
596 check_value_format_and_warn(rules, key, value, false);
597
598 r = rule_line_add_token(rule_line, TK_A_NAME, op, value, NULL);
599 } else
600 r = rule_line_add_token(rule_line, TK_M_NAME, op, value, NULL);
601 } else if (streq(key, "ENV")) {
602 if (isempty(attr))
603 return log_token_invalid_attr(rules, key);
604 if (op == OP_REMOVE)
605 return log_token_invalid_op(rules, key);
606 if (op == OP_ASSIGN_FINAL) {
607 log_token_warning(rules, "%s key takes '==', '!=', '=', or '+=' operator, assuming '=', but please fix it.", key);
608 op = OP_ASSIGN;
609 }
610
611 if (!is_match) {
612 if (STR_IN_SET(attr,
613 "ACTION", "DEVLINKS", "DEVNAME", "DEVPATH", "DEVTYPE", "DRIVER",
614 "IFINDEX", "MAJOR", "MINOR", "SEQNUM", "SUBSYSTEM", "TAGS"))
615 return log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL),
616 "Invalid ENV attribute. '%s' cannot be set.", attr);
617
618 check_value_format_and_warn(rules, key, value, false);
619
620 r = rule_line_add_token(rule_line, TK_A_ENV, op, value, attr);
621 } else
622 r = rule_line_add_token(rule_line, TK_M_ENV, op, value, attr);
623 } else if (streq(key, "TAG")) {
624 if (attr)
625 return log_token_invalid_attr(rules, key);
626 if (op == OP_ASSIGN_FINAL) {
627 log_token_warning(rules, "%s key takes '==', '!=', '=', or '+=' operator, assuming '=', but please fix it.", key);
628 op = OP_ASSIGN;
629 }
630
631 if (!is_match) {
632 check_value_format_and_warn(rules, key, value, true);
633
634 r = rule_line_add_token(rule_line, TK_A_TAG, op, value, NULL);
635 } else
636 r = rule_line_add_token(rule_line, TK_M_TAG, op, value, NULL);
637 } else if (streq(key, "SUBSYSTEM")) {
638 if (attr)
639 return log_token_invalid_attr(rules, key);
640 if (!is_match)
641 return log_token_invalid_op(rules, key);
642
643 if (STR_IN_SET(value, "bus", "class"))
644 log_token_warning(rules, "'%s' must be specified as 'subsystem'; please fix it", value);
645
646 r = rule_line_add_token(rule_line, TK_M_SUBSYSTEM, op, value, NULL);
647 } else if (streq(key, "DRIVER")) {
648 if (attr)
649 return log_token_invalid_attr(rules, key);
650 if (!is_match)
651 return log_token_invalid_op(rules, key);
652
653 r = rule_line_add_token(rule_line, TK_M_DRIVER, op, value, NULL);
654 } else if (streq(key, "ATTR")) {
655 r = check_attr_format_and_warn(rules, key, attr);
656 if (r < 0)
657 return r;
658 if (op == OP_REMOVE)
659 return log_token_invalid_op(rules, key);
660 if (IN_SET(op, OP_ADD, OP_ASSIGN_FINAL)) {
661 log_token_warning(rules, "%s key takes '==', '!=', or '=' operator, assuming '=', but please fix it.", key);
662 op = OP_ASSIGN;
663 }
664
665 if (!is_match) {
666 check_value_format_and_warn(rules, key, value, false);
667 r = rule_line_add_token(rule_line, TK_A_ATTR, op, value, attr);
668 } else
669 r = rule_line_add_token(rule_line, TK_M_ATTR, op, value, attr);
670 } else if (streq(key, "SYSCTL")) {
671 r = check_attr_format_and_warn(rules, key, attr);
672 if (r < 0)
673 return r;
674 if (op == OP_REMOVE)
675 return log_token_invalid_op(rules, key);
676 if (IN_SET(op, OP_ADD, OP_ASSIGN_FINAL)) {
677 log_token_warning(rules, "%s key takes '==', '!=', or '=' operator, assuming '=', but please fix it.", key);
678 op = OP_ASSIGN;
679 }
680
681 if (!is_match) {
682 check_value_format_and_warn(rules, key, value, false);
683 r = rule_line_add_token(rule_line, TK_A_SYSCTL, op, value, attr);
684 } else
685 r = rule_line_add_token(rule_line, TK_M_SYSCTL, op, value, attr);
686 } else if (streq(key, "KERNELS")) {
687 if (attr)
688 return log_token_invalid_attr(rules, key);
689 if (!is_match)
690 return log_token_invalid_op(rules, key);
691
692 r = rule_line_add_token(rule_line, TK_M_PARENTS_KERNEL, op, value, NULL);
693 } else if (streq(key, "SUBSYSTEMS")) {
694 if (attr)
695 return log_token_invalid_attr(rules, key);
696 if (!is_match)
697 return log_token_invalid_op(rules, key);
698
699 r = rule_line_add_token(rule_line, TK_M_PARENTS_SUBSYSTEM, op, value, NULL);
700 } else if (streq(key, "DRIVERS")) {
701 if (attr)
702 return log_token_invalid_attr(rules, key);
703 if (!is_match)
704 return log_token_invalid_op(rules, key);
705
706 r = rule_line_add_token(rule_line, TK_M_PARENTS_DRIVER, op, value, NULL);
707 } else if (streq(key, "ATTRS")) {
708 r = check_attr_format_and_warn(rules, key, attr);
709 if (r < 0)
710 return r;
711 if (!is_match)
712 return log_token_invalid_op(rules, key);
713
714 if (startswith(attr, "device/"))
715 log_token_warning(rules, "'device' link may not be available in future kernels; please fix it.");
716 if (strstr(attr, "../"))
717 log_token_warning(rules, "Direct reference to parent sysfs directory, may break in future kernels; please fix it.");
718
719 r = rule_line_add_token(rule_line, TK_M_PARENTS_ATTR, op, value, attr);
720 } else if (streq(key, "TAGS")) {
721 if (attr)
722 return log_token_invalid_attr(rules, key);
723 if (!is_match)
724 return log_token_invalid_op(rules, key);
725
726 r = rule_line_add_token(rule_line, TK_M_PARENTS_TAG, op, value, NULL);
727 } else if (streq(key, "TEST")) {
728 mode_t mode = MODE_INVALID;
729
730 if (!isempty(attr)) {
731 r = parse_mode(attr, &mode);
732 if (r < 0)
733 return log_token_error_errno(rules, r, "Failed to parse mode '%s': %m", attr);
734 }
735 check_value_format_and_warn(rules, key, value, true);
736 if (!is_match)
737 return log_token_invalid_op(rules, key);
738
739 r = rule_line_add_token(rule_line, TK_M_TEST, op, value, MODE_TO_PTR(mode));
740 } else if (streq(key, "PROGRAM")) {
741 if (attr)
742 return log_token_invalid_attr(rules, key);
743 check_value_format_and_warn(rules, key, value, true);
744 if (op == OP_REMOVE)
745 return log_token_invalid_op(rules, key);
746 if (!is_match) {
747 if (op == OP_ASSIGN)
748 log_token_debug(rules, "Operator '=' is specified to %s key, assuming '=='.", key);
749 else
750 log_token_warning(rules, "%s key takes '==' or '!=' operator, assuming '==', but please fix it.", key);
751 op = OP_MATCH;
752 }
753
754 r = rule_line_add_token(rule_line, TK_M_PROGRAM, op, value, NULL);
755 } else if (streq(key, "IMPORT")) {
756 if (isempty(attr))
757 return log_token_invalid_attr(rules, key);
758 check_value_format_and_warn(rules, key, value, true);
759 if (op == OP_REMOVE)
760 return log_token_invalid_op(rules, key);
761 if (!is_match) {
762 if (op == OP_ASSIGN)
763 log_token_debug(rules, "Operator '=' is specified to %s key, assuming '=='.", key);
764 else
765 log_token_warning(rules, "%s key takes '==' or '!=' operator, assuming '==', but please fix it.", key);
766 op = OP_MATCH;
767 }
768
769 if (streq(attr, "file"))
770 r = rule_line_add_token(rule_line, TK_M_IMPORT_FILE, op, value, NULL);
771 else if (streq(attr, "program")) {
772 UdevBuiltinCommand cmd;
773
774 cmd = udev_builtin_lookup(value);
775 if (cmd >= 0) {
776 log_token_debug(rules,"Found builtin command '%s' for %s, replacing attribute", value, key);
777 r = rule_line_add_token(rule_line, TK_M_IMPORT_BUILTIN, op, value, UDEV_BUILTIN_CMD_TO_PTR(cmd));
778 } else
779 r = rule_line_add_token(rule_line, TK_M_IMPORT_PROGRAM, op, value, NULL);
780 } else if (streq(attr, "builtin")) {
781 UdevBuiltinCommand cmd;
782
783 cmd = udev_builtin_lookup(value);
784 if (cmd < 0)
785 return log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL),
786 "Unknown builtin command: %s", value);
787 r = rule_line_add_token(rule_line, TK_M_IMPORT_BUILTIN, op, value, UDEV_BUILTIN_CMD_TO_PTR(cmd));
788 } else if (streq(attr, "db"))
789 r = rule_line_add_token(rule_line, TK_M_IMPORT_DB, op, value, NULL);
790 else if (streq(attr, "cmdline"))
791 r = rule_line_add_token(rule_line, TK_M_IMPORT_CMDLINE, op, value, NULL);
792 else if (streq(attr, "parent"))
793 r = rule_line_add_token(rule_line, TK_M_IMPORT_PARENT, op, value, NULL);
794 else
795 return log_token_invalid_attr(rules, key);
796 } else if (streq(key, "RESULT")) {
797 if (attr)
798 return log_token_invalid_attr(rules, key);
799 if (!is_match)
800 return log_token_invalid_op(rules, key);
801
802 r = rule_line_add_token(rule_line, TK_M_RESULT, op, value, NULL);
803 } else if (streq(key, "OPTIONS")) {
804 char *tmp;
805
806 if (attr)
807 return log_token_invalid_attr(rules, key);
808 if (is_match || op == OP_REMOVE)
809 return log_token_invalid_op(rules, key);
810 if (op == OP_ADD) {
811 log_token_debug(rules, "Operator '+=' is specified to %s key, assuming '='.", key);
812 op = OP_ASSIGN;
813 }
814
815 if (streq(value, "string_escape=none"))
816 r = rule_line_add_token(rule_line, TK_A_OPTIONS_STRING_ESCAPE_NONE, op, NULL, NULL);
817 else if (streq(value, "string_escape=replace"))
818 r = rule_line_add_token(rule_line, TK_A_OPTIONS_STRING_ESCAPE_REPLACE, op, NULL, NULL);
819 else if (streq(value, "db_persist"))
820 r = rule_line_add_token(rule_line, TK_A_OPTIONS_DB_PERSIST, op, NULL, NULL);
821 else if (streq(value, "watch"))
822 r = rule_line_add_token(rule_line, TK_A_OPTIONS_INOTIFY_WATCH, op, NULL, INT_TO_PTR(1));
823 else if (streq(value, "nowatch"))
824 r = rule_line_add_token(rule_line, TK_A_OPTIONS_INOTIFY_WATCH, op, NULL, INT_TO_PTR(0));
825 else if ((tmp = startswith(value, "static_node=")))
826 r = rule_line_add_token(rule_line, TK_A_OPTIONS_STATIC_NODE, op, tmp, NULL);
827 else if ((tmp = startswith(value, "link_priority="))) {
828 int prio;
829
830 r = safe_atoi(tmp, &prio);
831 if (r < 0)
832 return log_token_error_errno(rules, r, "Failed to parse link priority '%s': %m", tmp);
833 r = rule_line_add_token(rule_line, TK_A_OPTIONS_DEVLINK_PRIORITY, op, NULL, INT_TO_PTR(prio));
834 } else {
835 log_token_warning(rules, "Invalid value for OPTIONS key, ignoring: '%s'", value);
836 return 0;
837 }
838 } else if (streq(key, "OWNER")) {
839 uid_t uid;
840
841 if (attr)
842 return log_token_invalid_attr(rules, key);
843 if (is_match || op == OP_REMOVE)
844 return log_token_invalid_op(rules, key);
845 if (op == OP_ADD) {
846 log_token_warning(rules, "%s key takes '=' or ':=' operator, assuming '=', but please fix it.", key);
847 op = OP_ASSIGN;
848 }
849
850 if (parse_uid(value, &uid) >= 0)
851 r = rule_line_add_token(rule_line, TK_A_OWNER_ID, op, NULL, UID_TO_PTR(uid));
852 else if (rules->resolve_name_timing == RESOLVE_NAME_EARLY &&
853 rule_get_substitution_type(value) == SUBST_TYPE_PLAIN) {
854 r = rule_resolve_user(rules, value, &uid);
855 if (r < 0)
856 return log_token_error_errno(rules, r, "Failed to resolve user name '%s': %m", value);
857
858 r = rule_line_add_token(rule_line, TK_A_OWNER_ID, op, NULL, UID_TO_PTR(uid));
859 } else if (rules->resolve_name_timing != RESOLVE_NAME_NEVER) {
860 check_value_format_and_warn(rules, key, value, true);
861 r = rule_line_add_token(rule_line, TK_A_OWNER, op, value, NULL);
862 } else {
863 log_token_debug(rules, "Resolving user name is disabled, ignoring %s=%s", key, value);
864 return 0;
865 }
866 } else if (streq(key, "GROUP")) {
867 gid_t gid;
868
869 if (attr)
870 return log_token_invalid_attr(rules, key);
871 if (is_match || op == OP_REMOVE)
872 return log_token_invalid_op(rules, key);
873 if (op == OP_ADD) {
874 log_token_warning(rules, "%s key takes '=' or ':=' operator, assuming '=', but please fix it.", key);
875 op = OP_ASSIGN;
876 }
877
878 if (parse_gid(value, &gid) >= 0)
879 r = rule_line_add_token(rule_line, TK_A_GROUP_ID, op, NULL, GID_TO_PTR(gid));
880 else if (rules->resolve_name_timing == RESOLVE_NAME_EARLY &&
881 rule_get_substitution_type(value) == SUBST_TYPE_PLAIN) {
882 r = rule_resolve_group(rules, value, &gid);
883 if (r < 0)
884 return log_token_error_errno(rules, r, "Failed to resolve group name '%s': %m", value);
885
886 r = rule_line_add_token(rule_line, TK_A_GROUP_ID, op, NULL, GID_TO_PTR(gid));
887 } else if (rules->resolve_name_timing != RESOLVE_NAME_NEVER) {
888 check_value_format_and_warn(rules, key, value, true);
889 r = rule_line_add_token(rule_line, TK_A_GROUP, op, value, NULL);
890 } else {
891 log_token_debug(rules, "Resolving group name is disabled, ignoring %s=%s", key, value);
892 return 0;
893 }
894 } else if (streq(key, "MODE")) {
895 mode_t mode;
896
897 if (attr)
898 return log_token_invalid_attr(rules, key);
899 if (is_match || op == OP_REMOVE)
900 return log_token_invalid_op(rules, key);
901 if (op == OP_ADD) {
902 log_token_warning(rules, "%s key takes '=' or ':=' operator, assuming '=', but please fix it.", key);
903 op = OP_ASSIGN;
904 }
905
906 if (parse_mode(value, &mode) >= 0)
907 r = rule_line_add_token(rule_line, TK_A_MODE_ID, op, NULL, MODE_TO_PTR(mode));
908 else {
909 check_value_format_and_warn(rules, key, value, true);
910 r = rule_line_add_token(rule_line, TK_A_MODE, op, value, NULL);
911 }
912 } else if (streq(key, "SECLABEL")) {
913 if (isempty(attr))
914 return log_token_invalid_attr(rules, key);
915 check_value_format_and_warn(rules, key, value, true);
916 if (is_match || op == OP_REMOVE)
917 return log_token_invalid_op(rules, key);
918 if (op == OP_ASSIGN_FINAL) {
919 log_token_warning(rules, "%s key takes '=' or '+=' operator, assuming '=', but please fix it.", key);
920 op = OP_ASSIGN;
921 }
922
923 r = rule_line_add_token(rule_line, TK_A_SECLABEL, op, value, NULL);
924 } else if (streq(key, "RUN")) {
925 if (is_match || op == OP_REMOVE)
926 return log_token_invalid_op(rules, key);
927 check_value_format_and_warn(rules, key, value, true);
928 if (!attr || streq(attr, "program"))
929 r = rule_line_add_token(rule_line, TK_A_RUN_PROGRAM, op, value, NULL);
930 else if (streq(attr, "builtin")) {
931 UdevBuiltinCommand cmd;
932
933 cmd = udev_builtin_lookup(value);
934 if (cmd < 0)
935 return log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL),
936 "Unknown builtin command '%s', ignoring", value);
937 r = rule_line_add_token(rule_line, TK_A_RUN_BUILTIN, op, value, UDEV_BUILTIN_CMD_TO_PTR(cmd));
938 } else
939 return log_token_invalid_attr(rules, key);
940 } else if (streq(key, "GOTO")) {
941 if (attr)
942 return log_token_invalid_attr(rules, key);
943 if (op != OP_ASSIGN)
944 return log_token_invalid_op(rules, key);
945 if (FLAGS_SET(rule_line->type, LINE_HAS_GOTO)) {
946 log_token_warning(rules, "Contains multiple GOTO key, ignoring GOTO=\"%s\".", value);
947 return 0;
948 }
949
950 rule_line->goto_label = value;
951 SET_FLAG(rule_line->type, LINE_HAS_GOTO, true);
952 return 1;
953 } else if (streq(key, "LABEL")) {
954 if (attr)
955 return log_token_invalid_attr(rules, key);
956 if (op != OP_ASSIGN)
957 return log_token_invalid_op(rules, key);
958
959 rule_line->label = value;
960 SET_FLAG(rule_line->type, LINE_HAS_LABEL, true);
961 return 1;
962 } else
963 return log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL), "Invalid key '%s'", key);
964 if (r < 0)
965 return log_oom();
966
967 return 1;
968 }
969
970 static UdevRuleOperatorType parse_operator(const char *op) {
971 assert(op);
972
973 if (startswith(op, "=="))
974 return OP_MATCH;
975 if (startswith(op, "!="))
976 return OP_NOMATCH;
977 if (startswith(op, "+="))
978 return OP_ADD;
979 if (startswith(op, "-="))
980 return OP_REMOVE;
981 if (startswith(op, "="))
982 return OP_ASSIGN;
983 if (startswith(op, ":="))
984 return OP_ASSIGN_FINAL;
985
986 return _OP_TYPE_INVALID;
987 }
988
989 static int parse_line(char **line, char **ret_key, char **ret_attr, UdevRuleOperatorType *ret_op, char **ret_value) {
990 char *key_begin, *key_end, *attr, *tmp, *value, *i, *j;
991 UdevRuleOperatorType op;
992
993 assert(line);
994 assert(*line);
995 assert(ret_key);
996 assert(ret_op);
997 assert(ret_value);
998
999 key_begin = skip_leading_chars(*line, WHITESPACE ",");
1000
1001 if (isempty(key_begin))
1002 return 0;
1003
1004 for (key_end = key_begin; ; key_end++) {
1005 if (key_end[0] == '\0')
1006 return -EINVAL;
1007 if (strchr(WHITESPACE "={", key_end[0]))
1008 break;
1009 if (strchr("+-!:", key_end[0]) && key_end[1] == '=')
1010 break;
1011 }
1012 if (key_end[0] == '{') {
1013 attr = key_end + 1;
1014 tmp = strchr(attr, '}');
1015 if (!tmp)
1016 return -EINVAL;
1017 *tmp++ = '\0';
1018 } else {
1019 attr = NULL;
1020 tmp = key_end;
1021 }
1022
1023 tmp = skip_leading_chars(tmp, NULL);
1024 op = parse_operator(tmp);
1025 if (op < 0)
1026 return -EINVAL;
1027
1028 key_end[0] = '\0';
1029
1030 tmp += op == OP_ASSIGN ? 1 : 2;
1031 value = skip_leading_chars(tmp, NULL);
1032
1033 /* value must be double quotated */
1034 if (value[0] != '"')
1035 return -EINVAL;
1036 value++;
1037
1038 /* unescape double quotation '\"' -> '"' */
1039 for (i = j = value; ; i++, j++) {
1040 if (*i == '"')
1041 break;
1042 if (*i == '\0')
1043 return -EINVAL;
1044 if (i[0] == '\\' && i[1] == '"')
1045 i++;
1046 *j = *i;
1047 }
1048 j[0] = '\0';
1049
1050 *line = i+1;
1051 *ret_key = key_begin;
1052 *ret_attr = attr;
1053 *ret_op = op;
1054 *ret_value = value;
1055 return 1;
1056 }
1057
1058 static void sort_tokens(UdevRuleLine *rule_line) {
1059 UdevRuleToken *head_old;
1060
1061 assert(rule_line);
1062
1063 head_old = TAKE_PTR(rule_line->tokens);
1064 rule_line->current_token = NULL;
1065
1066 while (!LIST_IS_EMPTY(head_old)) {
1067 UdevRuleToken *t, *min_token = NULL;
1068
1069 LIST_FOREACH(tokens, t, head_old)
1070 if (!min_token || min_token->type > t->type)
1071 min_token = t;
1072
1073 LIST_REMOVE(tokens, head_old, min_token);
1074 rule_line_append_token(rule_line, min_token);
1075 }
1076 }
1077
1078 static int rule_add_line(UdevRules *rules, const char *line_str, unsigned line_nr) {
1079 _cleanup_(udev_rule_line_freep) UdevRuleLine *rule_line = NULL;
1080 _cleanup_free_ char *line = NULL;
1081 UdevRuleFile *rule_file;
1082 char *p;
1083 int r;
1084
1085 assert(rules);
1086 assert(rules->current_file);
1087 assert(line_str);
1088
1089 rule_file = rules->current_file;
1090
1091 if (isempty(line_str))
1092 return 0;
1093
1094 line = strdup(line_str);
1095 if (!line)
1096 return log_oom();
1097
1098 rule_line = new(UdevRuleLine, 1);
1099 if (!rule_line)
1100 return log_oom();
1101
1102 *rule_line = (UdevRuleLine) {
1103 .line = TAKE_PTR(line),
1104 .line_number = line_nr,
1105 .rule_file = rule_file,
1106 };
1107
1108 if (rule_file->current_line)
1109 LIST_APPEND(rule_lines, rule_file->current_line, rule_line);
1110 else
1111 LIST_APPEND(rule_lines, rule_file->rule_lines, rule_line);
1112
1113 rule_file->current_line = rule_line;
1114
1115 for (p = rule_line->line; !isempty(p); ) {
1116 char *key, *attr, *value;
1117 UdevRuleOperatorType op;
1118
1119 r = parse_line(&p, &key, &attr, &op, &value);
1120 if (r < 0)
1121 return log_token_error_errno(rules, r, "Invalid key/value pair, ignoring.");
1122 if (r == 0)
1123 break;
1124
1125 r = parse_token(rules, key, attr, op, value);
1126 if (r < 0)
1127 return r;
1128 }
1129
1130 if (rule_line->type == 0) {
1131 log_token_warning(rules, "The line takes no effect, ignoring.");
1132 return 0;
1133 }
1134
1135 sort_tokens(rule_line);
1136 TAKE_PTR(rule_line);
1137 return 0;
1138 }
1139
1140 static void rule_resolve_goto(UdevRuleFile *rule_file) {
1141 UdevRuleLine *line, *line_next, *i;
1142
1143 assert(rule_file);
1144
1145 /* link GOTOs to LABEL rules in this file to be able to fast-forward */
1146 LIST_FOREACH_SAFE(rule_lines, line, line_next, rule_file->rule_lines) {
1147 if (!FLAGS_SET(line->type, LINE_HAS_GOTO))
1148 continue;
1149
1150 LIST_FOREACH_AFTER(rule_lines, i, line)
1151 if (streq_ptr(i->label, line->goto_label)) {
1152 line->goto_line = i;
1153 break;
1154 }
1155
1156 if (!line->goto_line) {
1157 log_error("%s:%u: GOTO=\"%s\" has no matching label, ignoring",
1158 rule_file->filename, line->line_number, line->goto_label);
1159
1160 SET_FLAG(line->type, LINE_HAS_GOTO, false);
1161 line->goto_label = NULL;
1162
1163 if ((line->type & ~LINE_HAS_LABEL) == 0) {
1164 log_notice("%s:%u: The line takes no effect any more, dropping",
1165 rule_file->filename, line->line_number);
1166 if (line->type == LINE_HAS_LABEL)
1167 udev_rule_line_clear_tokens(line);
1168 else
1169 udev_rule_line_free(line);
1170 }
1171 }
1172 }
1173 }
1174
1175 static int parse_file(UdevRules *rules, const char *filename) {
1176 _cleanup_free_ char *continuation = NULL, *name = NULL;
1177 _cleanup_fclose_ FILE *f = NULL;
1178 UdevRuleFile *rule_file;
1179 bool ignore_line = false;
1180 unsigned line_nr = 0;
1181 int r;
1182
1183 f = fopen(filename, "re");
1184 if (!f) {
1185 if (errno == ENOENT)
1186 return 0;
1187
1188 return -errno;
1189 }
1190
1191 if (null_or_empty_fd(fileno(f))) {
1192 log_debug("Skipping empty file: %s", filename);
1193 return 0;
1194 }
1195
1196 log_debug("Reading rules file: %s", filename);
1197
1198 name = strdup(filename);
1199 if (!name)
1200 return log_oom();
1201
1202 rule_file = new(UdevRuleFile, 1);
1203 if (!rule_file)
1204 return log_oom();
1205
1206 *rule_file = (UdevRuleFile) {
1207 .filename = TAKE_PTR(name),
1208 };
1209
1210 if (rules->current_file)
1211 LIST_APPEND(rule_files, rules->current_file, rule_file);
1212 else
1213 LIST_APPEND(rule_files, rules->rule_files, rule_file);
1214
1215 rules->current_file = rule_file;
1216
1217 for (;;) {
1218 _cleanup_free_ char *buf = NULL;
1219 size_t len;
1220 char *line;
1221
1222 r = read_line(f, UTIL_LINE_SIZE, &buf);
1223 if (r < 0)
1224 return r;
1225 if (r == 0)
1226 break;
1227
1228 line_nr++;
1229 line = skip_leading_chars(buf, NULL);
1230
1231 if (line[0] == '#')
1232 continue;
1233
1234 len = strlen(line);
1235
1236 if (continuation && !ignore_line) {
1237 if (strlen(continuation) + len >= UTIL_LINE_SIZE)
1238 ignore_line = true;
1239
1240 if (!strextend(&continuation, line, NULL))
1241 return log_oom();
1242
1243 if (!ignore_line) {
1244 line = continuation;
1245 len = strlen(line);
1246 }
1247 }
1248
1249 if (len > 0 && line[len - 1] == '\\') {
1250 if (ignore_line)
1251 continue;
1252
1253 line[len - 1] = '\0';
1254 if (!continuation) {
1255 continuation = strdup(line);
1256 if (!continuation)
1257 return log_oom();
1258 }
1259
1260 continue;
1261 }
1262
1263 if (ignore_line)
1264 log_error("%s:%u: Line is too long, ignored", filename, line_nr);
1265 else if (len > 0)
1266 (void) rule_add_line(rules, line, line_nr);
1267
1268 continuation = mfree(continuation);
1269 ignore_line = false;
1270 }
1271
1272 rule_resolve_goto(rule_file);
1273 return 0;
1274 }
1275
1276 int udev_rules_new(UdevRules **ret_rules, ResolveNameTiming resolve_name_timing) {
1277 _cleanup_(udev_rules_freep) UdevRules *rules = NULL;
1278 _cleanup_strv_free_ char **files = NULL;
1279 char **f;
1280 int r;
1281
1282 assert(resolve_name_timing >= 0 && resolve_name_timing < _RESOLVE_NAME_TIMING_MAX);
1283
1284 rules = new(UdevRules, 1);
1285 if (!rules)
1286 return -ENOMEM;
1287
1288 *rules = (UdevRules) {
1289 .resolve_name_timing = resolve_name_timing,
1290 };
1291
1292 (void) udev_rules_check_timestamp(rules);
1293
1294 r = conf_files_list_strv(&files, ".rules", NULL, 0, RULES_DIRS);
1295 if (r < 0)
1296 return log_error_errno(r, "Failed to enumerate rules files: %m");
1297
1298 STRV_FOREACH(f, files)
1299 (void) parse_file(rules, *f);
1300
1301 *ret_rules = TAKE_PTR(rules);
1302 return 0;
1303 }
1304
1305 bool udev_rules_check_timestamp(UdevRules *rules) {
1306 if (!rules)
1307 return false;
1308
1309 return paths_check_timestamp(RULES_DIRS, &rules->dirs_ts_usec, true);
1310 }
1311
1312 static bool token_match_string(UdevRuleToken *token, const char *str) {
1313 const char *i, *value;
1314 bool match = false;
1315
1316 assert(token);
1317 assert(token->value);
1318 assert(token->type < _TK_M_MAX);
1319
1320 str = strempty(str);
1321 value = token->value;
1322
1323 switch (token->match_type) {
1324 case MATCH_TYPE_EMPTY:
1325 match = isempty(str);
1326 break;
1327 case MATCH_TYPE_SUBSYSTEM:
1328 value = "subsystem\0class\0bus\0";
1329 _fallthrough_;
1330 case MATCH_TYPE_PLAIN:
1331 NULSTR_FOREACH(i, value)
1332 if (streq(i, str)) {
1333 match = true;
1334 break;
1335 }
1336 break;
1337 case MATCH_TYPE_GLOB:
1338 NULSTR_FOREACH(i, value)
1339 if ((fnmatch(i, str, 0) == 0)) {
1340 match = true;
1341 break;
1342 }
1343 break;
1344 default:
1345 assert_not_reached("Invalid match type");
1346 }
1347
1348 return token->op == (match ? OP_MATCH : OP_NOMATCH);
1349 }
1350
1351 static bool token_match_attr(UdevRuleToken *token, sd_device *dev, UdevEvent *event) {
1352 char nbuf[UTIL_NAME_SIZE], vbuf[UTIL_NAME_SIZE];
1353 const char *name, *value;
1354
1355 assert(token);
1356 assert(dev);
1357 assert(event);
1358
1359 name = (const char*) token->data;
1360
1361 switch (token->attr_subst_type) {
1362 case SUBST_TYPE_FORMAT:
1363 (void) udev_event_apply_format(event, name, nbuf, sizeof(nbuf), false);
1364 name = nbuf;
1365 _fallthrough_;
1366 case SUBST_TYPE_PLAIN:
1367 if (sd_device_get_sysattr_value(dev, name, &value) < 0)
1368 return false;
1369 break;
1370 case SUBST_TYPE_SUBSYS:
1371 if (util_resolve_subsys_kernel(name, vbuf, sizeof(vbuf), true) < 0)
1372 return false;
1373 value = vbuf;
1374 break;
1375 default:
1376 assert_not_reached("Invalid attribute substitution type");
1377 }
1378
1379 /* remove trailing whitespace, if not asked to match for it */
1380 if (token->attr_match_remove_trailing_whitespace) {
1381 if (value != vbuf) {
1382 strscpy(vbuf, sizeof(vbuf), value);
1383 value = vbuf;
1384 }
1385
1386 delete_trailing_chars(vbuf, NULL);
1387 }
1388
1389 return token_match_string(token, value);
1390 }
1391
1392 static int get_property_from_string(char *line, char **ret_key, char **ret_value) {
1393 char *key, *val;
1394 size_t len;
1395
1396 assert(line);
1397 assert(ret_key);
1398 assert(ret_value);
1399
1400 /* find key */
1401 key = skip_leading_chars(line, NULL);
1402
1403 /* comment or empty line */
1404 if (IN_SET(key[0], '#', '\0'))
1405 return 0;
1406
1407 /* split key/value */
1408 val = strchr(key, '=');
1409 if (!val)
1410 return -EINVAL;
1411 *val++ = '\0';
1412
1413 key = strstrip(key);
1414 if (isempty(key))
1415 return -EINVAL;
1416
1417 val = strstrip(val);
1418 if (isempty(val))
1419 return -EINVAL;
1420
1421 /* unquote */
1422 if (IN_SET(val[0], '"', '\'')) {
1423 len = strlen(val);
1424 if (len == 1 || val[len-1] != val[0])
1425 return -EINVAL;
1426 val[len-1] = '\0';
1427 val++;
1428 }
1429
1430 *ret_key = key;
1431 *ret_value = val;
1432 return 0;
1433 }
1434
1435 static int import_parent_into_properties(sd_device *dev, const char *filter) {
1436 const char *key, *val;
1437 sd_device *parent;
1438 int r;
1439
1440 assert(dev);
1441 assert(filter);
1442
1443 r = sd_device_get_parent(dev, &parent);
1444 if (r == -ENOENT)
1445 return 0;
1446 if (r < 0)
1447 return r;
1448
1449 FOREACH_DEVICE_PROPERTY(parent, key, val) {
1450 if (fnmatch(filter, key, 0) != 0)
1451 continue;
1452 r = device_add_property(dev, key, val);
1453 if (r < 0)
1454 return r;
1455 }
1456
1457 return 1;
1458 }
1459
1460 static int attr_subst_subdir(char attr[static UTIL_PATH_SIZE]) {
1461 _cleanup_closedir_ DIR *dir = NULL;
1462 struct dirent *dent;
1463 char buf[UTIL_PATH_SIZE], *p;
1464 const char *tail;
1465 size_t len, size;
1466
1467 tail = strstr(attr, "/*/");
1468 if (!tail)
1469 return 0;
1470
1471 len = tail - attr + 1; /* include slash at the end */
1472 tail += 2; /* include slash at the beginning */
1473
1474 p = buf;
1475 size = sizeof(buf);
1476 size -= strnpcpy(&p, size, attr, len);
1477
1478 dir = opendir(buf);
1479 if (!dir)
1480 return -errno;
1481
1482 FOREACH_DIRENT_ALL(dent, dir, break) {
1483 if (dent->d_name[0] == '.')
1484 continue;
1485
1486 strscpyl(p, size, dent->d_name, tail, NULL);
1487 if (faccessat(dirfd(dir), p, F_OK, 0) < 0)
1488 continue;
1489
1490 strcpy(attr, buf);
1491 return 0;
1492 }
1493
1494 return -ENOENT;
1495 }
1496
1497 static int udev_rule_apply_token_to_event(
1498 UdevRules *rules,
1499 sd_device *dev,
1500 UdevEvent *event,
1501 usec_t timeout_usec,
1502 Hashmap *properties_list) {
1503
1504 UdevRuleToken *token;
1505 char buf[UTIL_PATH_SIZE];
1506 const char *val;
1507 size_t count;
1508 bool match;
1509 int r;
1510
1511 assert(rules);
1512 assert(dev);
1513 assert(event);
1514
1515 /* This returns the following values:
1516 * 0 on the current token does not match the event,
1517 * 1 on the current token matches the event, and
1518 * negative errno on some critical errors. */
1519
1520 token = rules->current_file->current_line->current_token;
1521
1522 switch (token->type) {
1523 case TK_M_ACTION: {
1524 DeviceAction a;
1525
1526 r = device_get_action(dev, &a);
1527 if (r < 0)
1528 return log_rule_error_errno(dev, rules, r, "Failed to get uevent action type: %m");
1529
1530 return token_match_string(token, device_action_to_string(a));
1531 }
1532 case TK_M_DEVPATH:
1533 r = sd_device_get_devpath(dev, &val);
1534 if (r < 0)
1535 return log_rule_error_errno(dev, rules, r, "Failed to get devpath: %m");
1536
1537 return token_match_string(token, val);
1538 case TK_M_KERNEL:
1539 case TK_M_PARENTS_KERNEL:
1540 r = sd_device_get_sysname(dev, &val);
1541 if (r < 0)
1542 return log_rule_error_errno(dev, rules, r, "Failed to get sysname: %m");
1543
1544 return token_match_string(token, val);
1545 case TK_M_DEVLINK:
1546 FOREACH_DEVICE_DEVLINK(dev, val)
1547 if (token_match_string(token, strempty(startswith(val, "/dev/"))))
1548 return token->op == OP_MATCH;
1549 return token->op == OP_NOMATCH;
1550 case TK_M_NAME:
1551 return token_match_string(token, event->name);
1552 case TK_M_ENV:
1553 if (sd_device_get_property_value(dev, (const char*) token->data, &val) < 0)
1554 val = hashmap_get(properties_list, token->data);
1555
1556 return token_match_string(token, val);
1557 case TK_M_TAG:
1558 case TK_M_PARENTS_TAG:
1559 FOREACH_DEVICE_TAG(dev, val)
1560 if (token_match_string(token, val))
1561 return token->op == OP_MATCH;
1562 return token->op == OP_NOMATCH;
1563 case TK_M_SUBSYSTEM:
1564 case TK_M_PARENTS_SUBSYSTEM:
1565 r = sd_device_get_subsystem(dev, &val);
1566 if (r == -ENOENT)
1567 val = NULL;
1568 else if (r < 0)
1569 return log_rule_error_errno(dev, rules, r, "Failed to get subsystem: %m");
1570
1571 return token_match_string(token, val);
1572 case TK_M_DRIVER:
1573 case TK_M_PARENTS_DRIVER:
1574 r = sd_device_get_driver(dev, &val);
1575 if (r == -ENOENT)
1576 val = NULL;
1577 else if (r < 0)
1578 return log_rule_error_errno(dev, rules, r, "Failed to get driver: %m");
1579
1580 return token_match_string(token, val);
1581 case TK_M_ATTR:
1582 case TK_M_PARENTS_ATTR:
1583 return token_match_attr(token, dev, event);
1584 case TK_M_SYSCTL: {
1585 _cleanup_free_ char *value = NULL;
1586
1587 (void) udev_event_apply_format(event, (const char*) token->data, buf, sizeof(buf), false);
1588 r = sysctl_read(sysctl_normalize(buf), &value);
1589 if (r < 0 && r != -ENOENT)
1590 return log_rule_error_errno(dev, rules, r, "Failed to read sysctl '%s': %m", buf);
1591
1592 return token_match_string(token, strstrip(value));
1593 }
1594 case TK_M_TEST: {
1595 mode_t mode = PTR_TO_MODE(token->data);
1596 struct stat statbuf;
1597
1598 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1599 if (!path_is_absolute(buf) &&
1600 util_resolve_subsys_kernel(buf, buf, sizeof(buf), false) < 0) {
1601 char tmp[UTIL_PATH_SIZE];
1602
1603 r = sd_device_get_syspath(dev, &val);
1604 if (r < 0)
1605 return log_rule_error_errno(dev, rules, r, "Failed to get syspath: %m");
1606
1607 strscpy(tmp, sizeof(tmp), buf);
1608 strscpyl(buf, sizeof(buf), val, "/", tmp, NULL);
1609 }
1610
1611 r = attr_subst_subdir(buf);
1612 if (r == -ENOENT)
1613 return token->op == OP_NOMATCH;
1614 if (r < 0)
1615 return log_rule_error_errno(dev, rules, r, "Failed to test the existence of '%s': %m", buf);
1616
1617 if (stat(buf, &statbuf) < 0)
1618 return token->op == OP_NOMATCH;
1619
1620 if (mode == MODE_INVALID)
1621 return token->op == OP_MATCH;
1622
1623 match = (((statbuf.st_mode ^ mode) & 07777) == 0);
1624 return token->op == (match ? OP_MATCH : OP_NOMATCH);
1625 }
1626 case TK_M_PROGRAM: {
1627 char result[UTIL_LINE_SIZE];
1628
1629 event->program_result = mfree(event->program_result);
1630 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1631 log_rule_debug(dev, rules, "Running PROGRAM '%s'", buf);
1632
1633 r = udev_event_spawn(event, timeout_usec, true, buf, result, sizeof(result));
1634 if (r < 0)
1635 return log_rule_error_errno(dev, rules, r, "Failed to execute '%s': %m", buf);
1636 if (r > 0)
1637 return token->op == OP_NOMATCH;
1638
1639 delete_trailing_chars(result, "\n");
1640 count = util_replace_chars(result, UDEV_ALLOWED_CHARS_INPUT);
1641 if (count > 0)
1642 log_rule_debug(dev, rules, "Replaced %zu character(s) from result of '%s'",
1643 count, buf);
1644
1645 event->program_result = strdup(result);
1646 return token->op == OP_MATCH;
1647 }
1648 case TK_M_IMPORT_FILE: {
1649 _cleanup_fclose_ FILE *f = NULL;
1650
1651 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1652 log_rule_debug(dev, rules, "Importing properties from '%s'", buf);
1653
1654 f = fopen(buf, "re");
1655 if (!f) {
1656 if (errno != ENOENT)
1657 return log_rule_error_errno(dev, rules, errno,
1658 "Failed to open '%s': %m", buf);
1659 return token->op == OP_NOMATCH;
1660 }
1661
1662 for (;;) {
1663 _cleanup_free_ char *line = NULL;
1664 char *key, *value;
1665
1666 r = read_line(f, LONG_LINE_MAX, &line);
1667 if (r < 0) {
1668 log_rule_debug_errno(dev, rules, r,
1669 "Failed to read '%s', ignoring: %m", buf);
1670 return token->op == OP_NOMATCH;
1671 }
1672 if (r == 0)
1673 break;
1674
1675 r = get_property_from_string(line, &key, &value);
1676 if (r < 0) {
1677 log_rule_debug_errno(dev, rules, r,
1678 "Failed to parse key and value from '%s', ignoring: %m",
1679 line);
1680 continue;
1681 }
1682
1683 r = device_add_property(dev, key, value);
1684 if (r < 0)
1685 return log_rule_error_errno(dev, rules, r,
1686 "Failed to add property %s=%s: %m",
1687 key, value);
1688 }
1689
1690 return token->op == OP_MATCH;
1691 }
1692 case TK_M_IMPORT_PROGRAM: {
1693 char result[UTIL_LINE_SIZE], *line, *pos;
1694
1695 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1696 log_rule_debug(dev, rules, "Importing properties from results of '%s'", buf);
1697
1698 r = udev_event_spawn(event, timeout_usec, true, buf, result, sizeof result);
1699 if (r < 0)
1700 return log_rule_error_errno(dev, rules, r, "Failed to execute '%s': %m", buf);
1701 if (r > 0) {
1702 log_rule_debug(dev, rules, "Command \"%s\" returned %d (error), ignoring", buf, r);
1703 return token->op == OP_NOMATCH;
1704 }
1705
1706 for (line = result; !isempty(line); line = pos) {
1707 char *key, *value;
1708
1709 pos = strchr(line, '\n');
1710 if (pos)
1711 *pos++ = '\0';
1712
1713 r = get_property_from_string(line, &key, &value);
1714 if (r < 0) {
1715 log_rule_debug_errno(dev, rules, r,
1716 "Failed to parse key and value from '%s', ignoring: %m",
1717 line);
1718 continue;
1719 }
1720
1721 r = device_add_property(dev, key, value);
1722 if (r < 0)
1723 return log_rule_error_errno(dev, rules, r,
1724 "Failed to add property %s=%s: %m",
1725 key, value);
1726 }
1727
1728 return token->op == OP_MATCH;
1729 }
1730 case TK_M_IMPORT_BUILTIN: {
1731 UdevBuiltinCommand cmd = PTR_TO_UDEV_BUILTIN_CMD(token->data);
1732 unsigned mask = 1U << (int) cmd;
1733
1734 if (udev_builtin_run_once(cmd)) {
1735 /* check if we ran already */
1736 if (event->builtin_run & mask) {
1737 log_rule_debug(dev, rules, "Skipping builtin '%s' in IMPORT key",
1738 udev_builtin_name(cmd));
1739 /* return the result from earlier run */
1740 return token->op == (event->builtin_ret & mask ? OP_NOMATCH : OP_MATCH);
1741 }
1742 /* mark as ran */
1743 event->builtin_run |= mask;
1744 }
1745
1746 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1747 log_rule_debug(dev, rules, "Importing properties from results of builtin command '%s'", buf);
1748
1749 r = udev_builtin_run(dev, cmd, buf, false);
1750 if (r < 0) {
1751 /* remember failure */
1752 log_rule_debug_errno(dev, rules, r, "Failed to run builtin '%s': %m", buf);
1753 event->builtin_ret |= mask;
1754 }
1755 return token->op == (r >= 0 ? OP_MATCH : OP_NOMATCH);
1756 }
1757 case TK_M_IMPORT_DB: {
1758 if (!event->dev_db_clone)
1759 return token->op == OP_NOMATCH;
1760 r = sd_device_get_property_value(event->dev_db_clone, token->value, &val);
1761 if (r == -ENOENT)
1762 return token->op == OP_NOMATCH;
1763 if (r < 0)
1764 return log_rule_error_errno(dev, rules, r,
1765 "Failed to get property '%s' from database: %m",
1766 token->value);
1767
1768 r = device_add_property(dev, token->value, val);
1769 if (r < 0)
1770 return log_rule_error_errno(dev, rules, r, "Failed to add property '%s=%s': %m",
1771 token->value, val);
1772 return token->op == OP_MATCH;
1773 }
1774 case TK_M_IMPORT_CMDLINE: {
1775 _cleanup_free_ char *value = NULL;
1776
1777 r = proc_cmdline_get_key(token->value, PROC_CMDLINE_VALUE_OPTIONAL, &value);
1778 if (r < 0)
1779 return log_rule_error_errno(dev, rules, r,
1780 "Failed to read '%s' option from /proc/cmdline: %m",
1781 token->value);
1782 if (r == 0)
1783 return token->op == OP_NOMATCH;
1784
1785 r = device_add_property(dev, token->value, value ?: "1");
1786 if (r < 0)
1787 return log_rule_error_errno(dev, rules, r, "Failed to add property '%s=%s': %m",
1788 token->value, value ?: "1");
1789 return token->op == OP_MATCH;
1790 }
1791 case TK_M_IMPORT_PARENT: {
1792 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1793 r = import_parent_into_properties(dev, buf);
1794 if (r < 0)
1795 return log_rule_error_errno(dev, rules, r,
1796 "Failed to import properties '%s' from parent: %m",
1797 buf);
1798 return token->op == (r > 0 ? OP_MATCH : OP_NOMATCH);
1799 }
1800 case TK_M_RESULT:
1801 return token_match_string(token, event->program_result);
1802 case TK_A_OPTIONS_STRING_ESCAPE_NONE:
1803 event->esc = ESCAPE_NONE;
1804 break;
1805 case TK_A_OPTIONS_STRING_ESCAPE_REPLACE:
1806 event->esc = ESCAPE_REPLACE;
1807 break;
1808 case TK_A_OPTIONS_DB_PERSIST:
1809 device_set_db_persist(dev);
1810 break;
1811 case TK_A_OPTIONS_INOTIFY_WATCH:
1812 if (event->inotify_watch_final)
1813 break;
1814 if (token->op == OP_ASSIGN_FINAL)
1815 event->inotify_watch_final = true;
1816
1817 event->inotify_watch = token->data;
1818 break;
1819 case TK_A_OPTIONS_DEVLINK_PRIORITY:
1820 device_set_devlink_priority(dev, PTR_TO_INT(token->data));
1821 break;
1822 case TK_A_OWNER: {
1823 char owner[UTIL_NAME_SIZE];
1824 const char *ow = owner;
1825
1826 if (event->owner_final)
1827 break;
1828 if (token->op == OP_ASSIGN_FINAL)
1829 event->owner_final = true;
1830
1831 (void) udev_event_apply_format(event, token->value, owner, sizeof(owner), false);
1832 r = get_user_creds(&ow, &event->uid, NULL, NULL, NULL, USER_CREDS_ALLOW_MISSING);
1833 if (r < 0)
1834 log_unknown_owner(dev, rules, r, "user", owner);
1835 else
1836 log_rule_debug(dev, rules, "OWNER %s(%u)", owner, event->uid);
1837 break;
1838 }
1839 case TK_A_GROUP: {
1840 char group[UTIL_NAME_SIZE];
1841 const char *gr = group;
1842
1843 if (event->group_final)
1844 break;
1845 if (token->op == OP_ASSIGN_FINAL)
1846 event->group_final = true;
1847
1848 (void) udev_event_apply_format(event, token->value, group, sizeof(group), false);
1849 r = get_group_creds(&gr, &event->gid, USER_CREDS_ALLOW_MISSING);
1850 if (r < 0)
1851 log_unknown_owner(dev, rules, r, "group", group);
1852 else
1853 log_rule_debug(dev, rules, "GROUP %s(%u)", group, event->gid);
1854 break;
1855 }
1856 case TK_A_MODE: {
1857 char mode_str[UTIL_NAME_SIZE];
1858
1859 if (event->mode_final)
1860 break;
1861 if (token->op == OP_ASSIGN_FINAL)
1862 event->mode_final = true;
1863
1864 (void) udev_event_apply_format(event, token->value, mode_str, sizeof(mode_str), false);
1865 r = parse_mode(mode_str, &event->mode);
1866 if (r < 0)
1867 log_rule_error_errno(dev, rules, r, "Failed to parse mode '%s', ignoring: %m", mode_str);
1868 else
1869 log_rule_debug(dev, rules, "MODE %#o", event->mode);
1870 break;
1871 }
1872 case TK_A_OWNER_ID:
1873 if (event->owner_final)
1874 break;
1875 if (token->op == OP_ASSIGN_FINAL)
1876 event->owner_final = true;
1877 if (!token->data)
1878 break;
1879 event->uid = PTR_TO_UID(token->data);
1880 log_rule_debug(dev, rules, "OWNER %u", event->uid);
1881 break;
1882 case TK_A_GROUP_ID:
1883 if (event->group_final)
1884 break;
1885 if (token->op == OP_ASSIGN_FINAL)
1886 event->group_final = true;
1887 if (!token->data)
1888 break;
1889 event->gid = PTR_TO_GID(token->data);
1890 log_rule_debug(dev, rules, "GROUP %u", event->gid);
1891 break;
1892 case TK_A_MODE_ID:
1893 if (event->mode_final)
1894 break;
1895 if (token->op == OP_ASSIGN_FINAL)
1896 event->mode_final = true;
1897 if (!token->data)
1898 break;
1899 event->mode = PTR_TO_MODE(token->data);
1900 log_rule_debug(dev, rules, "MODE %#o", event->mode);
1901 break;
1902 case TK_A_SECLABEL: {
1903 _cleanup_free_ char *name = NULL, *label = NULL;
1904 char label_str[UTIL_LINE_SIZE] = {};
1905
1906 name = strdup((const char*) token->data);
1907 if (!name)
1908 return log_oom();
1909
1910 (void) udev_event_apply_format(event, token->value, label_str, sizeof(label_str), false);
1911 if (!isempty(label_str))
1912 label = strdup(label_str);
1913 else
1914 label = strdup(token->value);
1915 if (!label)
1916 return log_oom();
1917
1918 if (token->op == OP_ASSIGN)
1919 ordered_hashmap_clear_free_free(event->seclabel_list);
1920
1921 r = ordered_hashmap_ensure_allocated(&event->seclabel_list, NULL);
1922 if (r < 0)
1923 return log_oom();
1924
1925 r = ordered_hashmap_put(event->seclabel_list, name, label);
1926 if (r < 0)
1927 return log_oom();
1928 log_rule_debug(dev, rules, "SECLABEL{%s}='%s'", name, label);
1929 name = label = NULL;
1930 break;
1931 }
1932 case TK_A_ENV: {
1933 const char *name = (const char*) token->data;
1934 char value_new[UTIL_NAME_SIZE], *p = value_new;
1935 size_t l = sizeof(value_new);
1936
1937 if (isempty(token->value)) {
1938 if (token->op == OP_ADD)
1939 break;
1940 r = device_add_property(dev, name, NULL);
1941 if (r < 0)
1942 return log_rule_error_errno(dev, rules, r, "Failed to remove property '%s': %m", name);
1943 break;
1944 }
1945
1946 if (token->op == OP_ADD &&
1947 sd_device_get_property_value(dev, name, &val) >= 0)
1948 l = strpcpyl(&p, l, val, " ", NULL);
1949
1950 (void) udev_event_apply_format(event, token->value, p, l, false);
1951
1952 r = device_add_property(dev, name, value_new);
1953 if (r < 0)
1954 return log_rule_error_errno(dev, rules, r, "Failed to add property '%s=%s': %m", name, value_new);
1955 break;
1956 }
1957 case TK_A_TAG: {
1958 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1959 if (token->op == OP_ASSIGN)
1960 device_cleanup_tags(dev);
1961
1962 if (buf[strspn(buf, ALPHANUMERICAL "-_")] != '\0') {
1963 log_rule_error(dev, rules, "Invalid tag name '%s', ignoring", buf);
1964 break;
1965 }
1966 if (token->op == OP_REMOVE)
1967 device_remove_tag(dev, buf);
1968 else {
1969 r = device_add_tag(dev, buf);
1970 if (r < 0)
1971 return log_rule_error_errno(dev, rules, r, "Failed to add tag '%s': %m", buf);
1972 }
1973 break;
1974 }
1975 case TK_A_NAME: {
1976 if (event->name_final)
1977 break;
1978 if (token->op == OP_ASSIGN_FINAL)
1979 event->name_final = true;
1980
1981 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1982 if (IN_SET(event->esc, ESCAPE_UNSET, ESCAPE_REPLACE)) {
1983 count = util_replace_chars(buf, "/");
1984 if (count > 0)
1985 log_rule_debug(dev, rules, "Replaced %zu character(s) from result of NAME=\"%s\"",
1986 count, token->value);
1987 }
1988 if (sd_device_get_devnum(dev, NULL) >= 0 &&
1989 (sd_device_get_devname(dev, &val) < 0 ||
1990 !streq_ptr(buf, startswith(val, "/dev/")))) {
1991 log_rule_error(dev, rules,
1992 "Kernel device nodes cannot be renamed, ignoring NAME=\"%s\"; please fix it.",
1993 token->value);
1994 break;
1995 }
1996 if (free_and_strdup(&event->name, buf) < 0)
1997 return log_oom();
1998
1999 log_rule_debug(dev, rules, "NAME '%s'", event->name);
2000 break;
2001 }
2002 case TK_A_DEVLINK: {
2003 char *p;
2004
2005 if (event->devlink_final)
2006 break;
2007 if (sd_device_get_devnum(dev, NULL) < 0)
2008 break;
2009 if (token->op == OP_ASSIGN_FINAL)
2010 event->devlink_final = true;
2011 if (IN_SET(token->op, OP_ASSIGN, OP_ASSIGN_FINAL))
2012 device_cleanup_devlinks(dev);
2013
2014 /* allow multiple symlinks separated by spaces */
2015 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), event->esc != ESCAPE_NONE);
2016 if (event->esc == ESCAPE_UNSET)
2017 count = util_replace_chars(buf, "/ ");
2018 else if (event->esc == ESCAPE_REPLACE)
2019 count = util_replace_chars(buf, "/");
2020 else
2021 count = 0;
2022 if (count > 0)
2023 log_rule_debug(dev, rules, "Replaced %zu character(s) from result of LINK", count);
2024
2025 p = skip_leading_chars(buf, NULL);
2026 while (!isempty(p)) {
2027 char filename[UTIL_PATH_SIZE], *next;
2028
2029 next = strchr(p, ' ');
2030 if (next) {
2031 *next++ = '\0';
2032 next = skip_leading_chars(next, NULL);
2033 }
2034
2035 strscpyl(filename, sizeof(filename), "/dev/", p, NULL);
2036 r = device_add_devlink(dev, filename);
2037 if (r < 0)
2038 return log_rule_error_errno(dev, rules, r, "Failed to add devlink '%s': %m", filename);
2039
2040 log_rule_debug(dev, rules, "LINK '%s'", p);
2041 p = next;
2042 }
2043 break;
2044 }
2045 case TK_A_ATTR: {
2046 const char *key_name = (const char*) token->data;
2047 char value[UTIL_NAME_SIZE];
2048
2049 if (util_resolve_subsys_kernel(key_name, buf, sizeof(buf), false) < 0 &&
2050 sd_device_get_syspath(dev, &val) >= 0)
2051 strscpyl(buf, sizeof(buf), val, "/", key_name, NULL);
2052
2053 r = attr_subst_subdir(buf);
2054 if (r < 0) {
2055 log_rule_error_errno(dev, rules, r, "Could not find file matches '%s', ignoring: %m", buf);
2056 break;
2057 }
2058 (void) udev_event_apply_format(event, token->value, value, sizeof(value), false);
2059
2060 log_rule_debug(dev, rules, "ATTR '%s' writing '%s'", buf, value);
2061 r = write_string_file(buf, value, WRITE_STRING_FILE_VERIFY_ON_FAILURE | WRITE_STRING_FILE_DISABLE_BUFFER);
2062 if (r < 0)
2063 log_rule_error_errno(dev, rules, r, "Failed to write ATTR{%s}, ignoring: %m", buf);
2064 break;
2065 }
2066 case TK_A_SYSCTL: {
2067 char value[UTIL_NAME_SIZE];
2068
2069 (void) udev_event_apply_format(event, (const char*) token->data, buf, sizeof(buf), false);
2070 (void) udev_event_apply_format(event, token->value, value, sizeof(value), false);
2071 sysctl_normalize(buf);
2072 log_rule_debug(dev, rules, "SYSCTL '%s' writing '%s'", buf, value);
2073 r = sysctl_write(buf, value);
2074 if (r < 0)
2075 log_rule_error_errno(dev, rules, r, "Failed to write SYSCTL{%s}='%s', ignoring: %m", buf, value);
2076 break;
2077 }
2078 case TK_A_RUN_BUILTIN:
2079 case TK_A_RUN_PROGRAM: {
2080 _cleanup_free_ char *cmd = NULL;
2081
2082 if (event->run_final)
2083 break;
2084 if (token->op == OP_ASSIGN_FINAL)
2085 event->run_final = true;
2086
2087 if (IN_SET(token->op, OP_ASSIGN, OP_ASSIGN_FINAL))
2088 ordered_hashmap_clear_free_key(event->run_list);
2089
2090 r = ordered_hashmap_ensure_allocated(&event->run_list, NULL);
2091 if (r < 0)
2092 return log_oom();
2093
2094 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
2095
2096 cmd = strdup(buf);
2097 if (!cmd)
2098 return log_oom();
2099
2100 r = ordered_hashmap_put(event->run_list, cmd, token->data);
2101 if (r < 0)
2102 return log_oom();
2103
2104 TAKE_PTR(cmd);
2105
2106 log_rule_debug(dev, rules, "RUN '%s'", token->value);
2107 break;
2108 }
2109 case TK_A_OPTIONS_STATIC_NODE:
2110 /* do nothing for events. */
2111 break;
2112 default:
2113 assert_not_reached("Invalid token type");
2114 }
2115
2116 return true;
2117 }
2118
2119 static bool token_is_for_parents(UdevRuleToken *token) {
2120 return token->type >= TK_M_PARENTS_KERNEL && token->type <= TK_M_PARENTS_TAG;
2121 }
2122
2123 static int udev_rule_apply_parent_token_to_event(
2124 UdevRules *rules,
2125 UdevEvent *event) {
2126
2127 UdevRuleLine *line;
2128 UdevRuleToken *head;
2129 int r;
2130
2131 line = rules->current_file->current_line;
2132 head = rules->current_file->current_line->current_token;
2133 event->dev_parent = event->dev;
2134 for (;;) {
2135 LIST_FOREACH(tokens, line->current_token, head) {
2136 if (!token_is_for_parents(line->current_token))
2137 return true; /* All parent tokens match. */
2138 r = udev_rule_apply_token_to_event(rules, event->dev_parent, event, 0, NULL);
2139 if (r < 0)
2140 return r;
2141 if (r == 0)
2142 break;
2143 }
2144 if (!line->current_token)
2145 /* All parent tokens match. But no assign tokens in the line. Hmm... */
2146 return true;
2147
2148 if (sd_device_get_parent(event->dev_parent, &event->dev_parent) < 0) {
2149 event->dev_parent = NULL;
2150 return false;
2151 }
2152 }
2153 }
2154
2155 static int udev_rule_apply_line_to_event(
2156 UdevRules *rules,
2157 UdevEvent *event,
2158 usec_t timeout_usec,
2159 Hashmap *properties_list,
2160 UdevRuleLine **next_line) {
2161
2162 UdevRuleLine *line = rules->current_file->current_line;
2163 UdevRuleLineType mask = LINE_HAS_GOTO | LINE_UPDATE_SOMETHING;
2164 UdevRuleToken *token, *next_token;
2165 bool parents_done = false;
2166 DeviceAction action;
2167 int r;
2168
2169 r = device_get_action(event->dev, &action);
2170 if (r < 0)
2171 return r;
2172
2173 if (action != DEVICE_ACTION_REMOVE) {
2174 if (sd_device_get_devnum(event->dev, NULL) >= 0)
2175 mask |= LINE_HAS_DEVLINK;
2176
2177 if (sd_device_get_ifindex(event->dev, NULL) >= 0)
2178 mask |= LINE_HAS_NAME;
2179 }
2180
2181 if ((line->type & mask) == 0)
2182 return 0;
2183
2184 event->esc = ESCAPE_UNSET;
2185 LIST_FOREACH_SAFE(tokens, token, next_token, line->tokens) {
2186 line->current_token = token;
2187
2188 if (token_is_for_parents(token)) {
2189 if (parents_done)
2190 continue;
2191
2192 r = udev_rule_apply_parent_token_to_event(rules, event);
2193 if (r <= 0)
2194 return r;
2195
2196 parents_done = true;
2197 continue;
2198 }
2199
2200 r = udev_rule_apply_token_to_event(rules, event->dev, event, timeout_usec, properties_list);
2201 if (r <= 0)
2202 return r;
2203 }
2204
2205 if (line->goto_line)
2206 *next_line = line->goto_line;
2207
2208 return 0;
2209 }
2210
2211 int udev_rules_apply_to_event(
2212 UdevRules *rules,
2213 UdevEvent *event,
2214 usec_t timeout_usec,
2215 Hashmap *properties_list) {
2216
2217 UdevRuleFile *file;
2218 UdevRuleLine *next_line;
2219 int r;
2220
2221 assert(rules);
2222 assert(event);
2223
2224 LIST_FOREACH(rule_files, file, rules->rule_files) {
2225 rules->current_file = file;
2226 LIST_FOREACH_SAFE(rule_lines, file->current_line, next_line, file->rule_lines) {
2227 r = udev_rule_apply_line_to_event(rules, event, timeout_usec, properties_list, &next_line);
2228 if (r < 0)
2229 return r;
2230 }
2231 }
2232
2233 return 0;
2234 }
2235
2236 static int apply_static_dev_perms(const char *devnode, uid_t uid, gid_t gid, mode_t mode, char **tags) {
2237 char device_node[UTIL_PATH_SIZE], tags_dir[UTIL_PATH_SIZE], tag_symlink[UTIL_PATH_SIZE];
2238 _cleanup_free_ char *unescaped_filename = NULL;
2239 struct stat stats;
2240 char **t;
2241 int r;
2242
2243 assert(devnode);
2244
2245 if (uid == UID_INVALID && gid == GID_INVALID && mode == MODE_INVALID && !tags)
2246 return 0;
2247
2248 strscpyl(device_node, sizeof(device_node), "/dev/", devnode, NULL);
2249 if (stat(device_node, &stats) < 0) {
2250 if (errno != ENOENT)
2251 return log_error_errno(errno, "Failed to stat %s: %m", device_node);
2252 return 0;
2253 }
2254
2255 if (!S_ISBLK(stats.st_mode) && !S_ISCHR(stats.st_mode)) {
2256 log_warning("%s is neither block nor character device, ignoring.", device_node);
2257 return 0;
2258 }
2259
2260 if (!strv_isempty(tags)) {
2261 unescaped_filename = xescape(devnode, "/.");
2262 if (!unescaped_filename)
2263 return log_oom();
2264 }
2265
2266 /* export the tags to a directory as symlinks, allowing otherwise dead nodes to be tagged */
2267 STRV_FOREACH(t, tags) {
2268 strscpyl(tags_dir, sizeof(tags_dir), "/run/udev/static_node-tags/", *t, "/", NULL);
2269 r = mkdir_p(tags_dir, 0755);
2270 if (r < 0)
2271 return log_error_errno(r, "Failed to create %s: %m", tags_dir);
2272
2273 strscpyl(tag_symlink, sizeof(tag_symlink), tags_dir, unescaped_filename, NULL);
2274 r = symlink(device_node, tag_symlink);
2275 if (r < 0 && errno != EEXIST)
2276 return log_error_errno(errno, "Failed to create symlink %s -> %s: %m",
2277 tag_symlink, device_node);
2278 }
2279
2280 /* don't touch the permissions if only the tags were set */
2281 if (uid == UID_INVALID && gid == GID_INVALID && mode == MODE_INVALID)
2282 return 0;
2283
2284 if (mode == MODE_INVALID)
2285 mode = gid_is_valid(gid) ? 0660 : 0600;
2286 if (!uid_is_valid(uid))
2287 uid = 0;
2288 if (!gid_is_valid(gid))
2289 gid = 0;
2290
2291 r = chmod_and_chown(device_node, mode, uid, gid);
2292 if (r < 0)
2293 return log_error_errno(errno, "Failed to chown '%s' %u %u: %m",
2294 device_node, uid, gid);
2295 else
2296 log_debug("chown '%s' %u:%u", device_node, uid, gid);
2297
2298 (void) utimensat(AT_FDCWD, device_node, NULL, 0);
2299 return 0;
2300 }
2301
2302 static int udev_rule_line_apply_static_dev_perms(UdevRuleLine *rule_line) {
2303 UdevRuleToken *token;
2304 _cleanup_free_ char **tags = NULL;
2305 uid_t uid = UID_INVALID;
2306 gid_t gid = GID_INVALID;
2307 mode_t mode = MODE_INVALID;
2308 int r;
2309
2310 assert(rule_line);
2311
2312 if (!FLAGS_SET(rule_line->type, LINE_HAS_STATIC_NODE))
2313 return 0;
2314
2315 LIST_FOREACH(tokens, token, rule_line->tokens)
2316 if (token->type == TK_A_OWNER_ID)
2317 uid = PTR_TO_UID(token->data);
2318 else if (token->type == TK_A_GROUP_ID)
2319 gid = PTR_TO_GID(token->data);
2320 else if (token->type == TK_A_MODE_ID)
2321 mode = PTR_TO_MODE(token->data);
2322 else if (token->type == TK_A_TAG) {
2323 r = strv_extend(&tags, token->value);
2324 if (r < 0)
2325 return log_oom();
2326 } else if (token->type == TK_A_OPTIONS_STATIC_NODE) {
2327 r = apply_static_dev_perms(token->value, uid, gid, mode, tags);
2328 if (r < 0)
2329 return r;
2330 }
2331
2332 return 0;
2333 }
2334
2335 int udev_rules_apply_static_dev_perms(UdevRules *rules) {
2336 UdevRuleFile *file;
2337 UdevRuleLine *line;
2338 int r;
2339
2340 assert(rules);
2341
2342 LIST_FOREACH(rule_files, file, rules->rule_files)
2343 LIST_FOREACH(rule_lines, line, file->rule_lines) {
2344 r = udev_rule_line_apply_static_dev_perms(line);
2345 if (r < 0)
2346 return r;
2347 }
2348
2349 return 0;
2350 }
Unnamed repository; edit this file 'description' to name the repository.