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