]> 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 #13994 from keszybz/bpf-refactor
[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 paramters */
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 if (op == OP_ASSIGN)
755 log_token_debug(rules, "Operator '=' is specified to %s key, assuming '=='.", key);
756 else
757 log_token_warning(rules, "%s key takes '==' or '!=' operator, assuming '==', but please fix it.", key);
758 op = OP_MATCH;
759 }
760
761 r = rule_line_add_token(rule_line, TK_M_PROGRAM, op, value, NULL);
762 } else if (streq(key, "IMPORT")) {
763 if (isempty(attr))
764 return log_token_invalid_attr(rules, key);
765 check_value_format_and_warn(rules, key, value, true);
766 if (op == OP_REMOVE)
767 return log_token_invalid_op(rules, key);
768 if (!is_match) {
769 if (op == OP_ASSIGN)
770 log_token_debug(rules, "Operator '=' is specified to %s key, assuming '=='.", key);
771 else
772 log_token_warning(rules, "%s key takes '==' or '!=' operator, assuming '==', but please fix it.", key);
773 op = OP_MATCH;
774 }
775
776 if (streq(attr, "file"))
777 r = rule_line_add_token(rule_line, TK_M_IMPORT_FILE, op, value, NULL);
778 else if (streq(attr, "program")) {
779 UdevBuiltinCommand cmd;
780
781 cmd = udev_builtin_lookup(value);
782 if (cmd >= 0) {
783 log_token_debug(rules,"Found builtin command '%s' for %s, replacing attribute", value, key);
784 r = rule_line_add_token(rule_line, TK_M_IMPORT_BUILTIN, op, value, UDEV_BUILTIN_CMD_TO_PTR(cmd));
785 } else
786 r = rule_line_add_token(rule_line, TK_M_IMPORT_PROGRAM, op, value, NULL);
787 } else if (streq(attr, "builtin")) {
788 UdevBuiltinCommand cmd;
789
790 cmd = udev_builtin_lookup(value);
791 if (cmd < 0)
792 return log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL),
793 "Unknown builtin command: %s", value);
794 r = rule_line_add_token(rule_line, TK_M_IMPORT_BUILTIN, op, value, UDEV_BUILTIN_CMD_TO_PTR(cmd));
795 } else if (streq(attr, "db"))
796 r = rule_line_add_token(rule_line, TK_M_IMPORT_DB, op, value, NULL);
797 else if (streq(attr, "cmdline"))
798 r = rule_line_add_token(rule_line, TK_M_IMPORT_CMDLINE, op, value, NULL);
799 else if (streq(attr, "parent"))
800 r = rule_line_add_token(rule_line, TK_M_IMPORT_PARENT, op, value, NULL);
801 else
802 return log_token_invalid_attr(rules, key);
803 } else if (streq(key, "RESULT")) {
804 if (attr)
805 return log_token_invalid_attr(rules, key);
806 if (!is_match)
807 return log_token_invalid_op(rules, key);
808
809 r = rule_line_add_token(rule_line, TK_M_RESULT, op, value, NULL);
810 } else if (streq(key, "OPTIONS")) {
811 char *tmp;
812
813 if (attr)
814 return log_token_invalid_attr(rules, key);
815 if (is_match || op == OP_REMOVE)
816 return log_token_invalid_op(rules, key);
817 if (op == OP_ADD) {
818 log_token_debug(rules, "Operator '+=' is specified to %s key, assuming '='.", key);
819 op = OP_ASSIGN;
820 }
821
822 if (streq(value, "string_escape=none"))
823 r = rule_line_add_token(rule_line, TK_A_OPTIONS_STRING_ESCAPE_NONE, op, NULL, NULL);
824 else if (streq(value, "string_escape=replace"))
825 r = rule_line_add_token(rule_line, TK_A_OPTIONS_STRING_ESCAPE_REPLACE, op, NULL, NULL);
826 else if (streq(value, "db_persist"))
827 r = rule_line_add_token(rule_line, TK_A_OPTIONS_DB_PERSIST, op, NULL, NULL);
828 else if (streq(value, "watch"))
829 r = rule_line_add_token(rule_line, TK_A_OPTIONS_INOTIFY_WATCH, op, NULL, INT_TO_PTR(1));
830 else if (streq(value, "nowatch"))
831 r = rule_line_add_token(rule_line, TK_A_OPTIONS_INOTIFY_WATCH, op, NULL, INT_TO_PTR(0));
832 else if ((tmp = startswith(value, "static_node=")))
833 r = rule_line_add_token(rule_line, TK_A_OPTIONS_STATIC_NODE, op, tmp, NULL);
834 else if ((tmp = startswith(value, "link_priority="))) {
835 int prio;
836
837 r = safe_atoi(tmp, &prio);
838 if (r < 0)
839 return log_token_error_errno(rules, r, "Failed to parse link priority '%s': %m", tmp);
840 r = rule_line_add_token(rule_line, TK_A_OPTIONS_DEVLINK_PRIORITY, op, NULL, INT_TO_PTR(prio));
841 } else {
842 log_token_warning(rules, "Invalid value for OPTIONS key, ignoring: '%s'", value);
843 return 0;
844 }
845 } else if (streq(key, "OWNER")) {
846 uid_t uid;
847
848 if (attr)
849 return log_token_invalid_attr(rules, key);
850 if (is_match || op == OP_REMOVE)
851 return log_token_invalid_op(rules, key);
852 if (op == OP_ADD) {
853 log_token_warning(rules, "%s key takes '=' or ':=' operator, assuming '=', but please fix it.", key);
854 op = OP_ASSIGN;
855 }
856
857 if (parse_uid(value, &uid) >= 0)
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_EARLY &&
860 rule_get_substitution_type(value) == SUBST_TYPE_PLAIN) {
861 r = rule_resolve_user(rules, value, &uid);
862 if (r < 0)
863 return log_token_error_errno(rules, r, "Failed to resolve user name '%s': %m", value);
864
865 r = rule_line_add_token(rule_line, TK_A_OWNER_ID, op, NULL, UID_TO_PTR(uid));
866 } else if (rules->resolve_name_timing != RESOLVE_NAME_NEVER) {
867 check_value_format_and_warn(rules, key, value, true);
868 r = rule_line_add_token(rule_line, TK_A_OWNER, op, value, NULL);
869 } else {
870 log_token_debug(rules, "Resolving user name is disabled, ignoring %s=%s", key, value);
871 return 0;
872 }
873 } else if (streq(key, "GROUP")) {
874 gid_t gid;
875
876 if (attr)
877 return log_token_invalid_attr(rules, key);
878 if (is_match || op == OP_REMOVE)
879 return log_token_invalid_op(rules, key);
880 if (op == OP_ADD) {
881 log_token_warning(rules, "%s key takes '=' or ':=' operator, assuming '=', but please fix it.", key);
882 op = OP_ASSIGN;
883 }
884
885 if (parse_gid(value, &gid) >= 0)
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_EARLY &&
888 rule_get_substitution_type(value) == SUBST_TYPE_PLAIN) {
889 r = rule_resolve_group(rules, value, &gid);
890 if (r < 0)
891 return log_token_error_errno(rules, r, "Failed to resolve group name '%s': %m", value);
892
893 r = rule_line_add_token(rule_line, TK_A_GROUP_ID, op, NULL, GID_TO_PTR(gid));
894 } else if (rules->resolve_name_timing != RESOLVE_NAME_NEVER) {
895 check_value_format_and_warn(rules, key, value, true);
896 r = rule_line_add_token(rule_line, TK_A_GROUP, op, value, NULL);
897 } else {
898 log_token_debug(rules, "Resolving group name is disabled, ignoring %s=%s", key, value);
899 return 0;
900 }
901 } else if (streq(key, "MODE")) {
902 mode_t mode;
903
904 if (attr)
905 return log_token_invalid_attr(rules, key);
906 if (is_match || op == OP_REMOVE)
907 return log_token_invalid_op(rules, key);
908 if (op == OP_ADD) {
909 log_token_warning(rules, "%s key takes '=' or ':=' operator, assuming '=', but please fix it.", key);
910 op = OP_ASSIGN;
911 }
912
913 if (parse_mode(value, &mode) >= 0)
914 r = rule_line_add_token(rule_line, TK_A_MODE_ID, op, NULL, MODE_TO_PTR(mode));
915 else {
916 check_value_format_and_warn(rules, key, value, true);
917 r = rule_line_add_token(rule_line, TK_A_MODE, op, value, NULL);
918 }
919 } else if (streq(key, "SECLABEL")) {
920 if (isempty(attr))
921 return log_token_invalid_attr(rules, key);
922 check_value_format_and_warn(rules, key, value, true);
923 if (is_match || op == OP_REMOVE)
924 return log_token_invalid_op(rules, key);
925 if (op == OP_ASSIGN_FINAL) {
926 log_token_warning(rules, "%s key takes '=' or '+=' operator, assuming '=', but please fix it.", key);
927 op = OP_ASSIGN;
928 }
929
930 r = rule_line_add_token(rule_line, TK_A_SECLABEL, op, value, NULL);
931 } else if (streq(key, "RUN")) {
932 if (is_match || op == OP_REMOVE)
933 return log_token_invalid_op(rules, key);
934 check_value_format_and_warn(rules, key, value, true);
935 if (!attr || streq(attr, "program"))
936 r = rule_line_add_token(rule_line, TK_A_RUN_PROGRAM, op, value, NULL);
937 else if (streq(attr, "builtin")) {
938 UdevBuiltinCommand cmd;
939
940 cmd = udev_builtin_lookup(value);
941 if (cmd < 0)
942 return log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL),
943 "Unknown builtin command '%s', ignoring", value);
944 r = rule_line_add_token(rule_line, TK_A_RUN_BUILTIN, op, value, UDEV_BUILTIN_CMD_TO_PTR(cmd));
945 } else
946 return log_token_invalid_attr(rules, key);
947 } else if (streq(key, "GOTO")) {
948 if (attr)
949 return log_token_invalid_attr(rules, key);
950 if (op != OP_ASSIGN)
951 return log_token_invalid_op(rules, key);
952 if (FLAGS_SET(rule_line->type, LINE_HAS_GOTO)) {
953 log_token_warning(rules, "Contains multiple GOTO key, ignoring GOTO=\"%s\".", value);
954 return 0;
955 }
956
957 rule_line->goto_label = value;
958 SET_FLAG(rule_line->type, LINE_HAS_GOTO, true);
959 return 1;
960 } else if (streq(key, "LABEL")) {
961 if (attr)
962 return log_token_invalid_attr(rules, key);
963 if (op != OP_ASSIGN)
964 return log_token_invalid_op(rules, key);
965
966 rule_line->label = value;
967 SET_FLAG(rule_line->type, LINE_HAS_LABEL, true);
968 return 1;
969 } else
970 return log_token_error_errno(rules, SYNTHETIC_ERRNO(EINVAL), "Invalid key '%s'", key);
971 if (r < 0)
972 return log_oom();
973
974 return 1;
975 }
976
977 static UdevRuleOperatorType parse_operator(const char *op) {
978 assert(op);
979
980 if (startswith(op, "=="))
981 return OP_MATCH;
982 if (startswith(op, "!="))
983 return OP_NOMATCH;
984 if (startswith(op, "+="))
985 return OP_ADD;
986 if (startswith(op, "-="))
987 return OP_REMOVE;
988 if (startswith(op, "="))
989 return OP_ASSIGN;
990 if (startswith(op, ":="))
991 return OP_ASSIGN_FINAL;
992
993 return _OP_TYPE_INVALID;
994 }
995
996 static int parse_line(char **line, char **ret_key, char **ret_attr, UdevRuleOperatorType *ret_op, char **ret_value) {
997 char *key_begin, *key_end, *attr, *tmp, *value, *i, *j;
998 UdevRuleOperatorType op;
999
1000 assert(line);
1001 assert(*line);
1002 assert(ret_key);
1003 assert(ret_op);
1004 assert(ret_value);
1005
1006 key_begin = skip_leading_chars(*line, WHITESPACE ",");
1007
1008 if (isempty(key_begin))
1009 return 0;
1010
1011 for (key_end = key_begin; ; key_end++) {
1012 if (key_end[0] == '\0')
1013 return -EINVAL;
1014 if (strchr(WHITESPACE "={", key_end[0]))
1015 break;
1016 if (strchr("+-!:", key_end[0]) && key_end[1] == '=')
1017 break;
1018 }
1019 if (key_end[0] == '{') {
1020 attr = key_end + 1;
1021 tmp = strchr(attr, '}');
1022 if (!tmp)
1023 return -EINVAL;
1024 *tmp++ = '\0';
1025 } else {
1026 attr = NULL;
1027 tmp = key_end;
1028 }
1029
1030 tmp = skip_leading_chars(tmp, NULL);
1031 op = parse_operator(tmp);
1032 if (op < 0)
1033 return -EINVAL;
1034
1035 key_end[0] = '\0';
1036
1037 tmp += op == OP_ASSIGN ? 1 : 2;
1038 value = skip_leading_chars(tmp, NULL);
1039
1040 /* value must be double quotated */
1041 if (value[0] != '"')
1042 return -EINVAL;
1043 value++;
1044
1045 /* unescape double quotation '\"' -> '"' */
1046 for (i = j = value; ; i++, j++) {
1047 if (*i == '"')
1048 break;
1049 if (*i == '\0')
1050 return -EINVAL;
1051 if (i[0] == '\\' && i[1] == '"')
1052 i++;
1053 *j = *i;
1054 }
1055 j[0] = '\0';
1056
1057 *line = i+1;
1058 *ret_key = key_begin;
1059 *ret_attr = attr;
1060 *ret_op = op;
1061 *ret_value = value;
1062 return 1;
1063 }
1064
1065 static void sort_tokens(UdevRuleLine *rule_line) {
1066 UdevRuleToken *head_old;
1067
1068 assert(rule_line);
1069
1070 head_old = TAKE_PTR(rule_line->tokens);
1071 rule_line->current_token = NULL;
1072
1073 while (!LIST_IS_EMPTY(head_old)) {
1074 UdevRuleToken *t, *min_token = NULL;
1075
1076 LIST_FOREACH(tokens, t, head_old)
1077 if (!min_token || min_token->type > t->type)
1078 min_token = t;
1079
1080 LIST_REMOVE(tokens, head_old, min_token);
1081 rule_line_append_token(rule_line, min_token);
1082 }
1083 }
1084
1085 static int rule_add_line(UdevRules *rules, const char *line_str, unsigned line_nr) {
1086 _cleanup_(udev_rule_line_freep) UdevRuleLine *rule_line = NULL;
1087 _cleanup_free_ char *line = NULL;
1088 UdevRuleFile *rule_file;
1089 char *p;
1090 int r;
1091
1092 assert(rules);
1093 assert(rules->current_file);
1094 assert(line_str);
1095
1096 rule_file = rules->current_file;
1097
1098 if (isempty(line_str))
1099 return 0;
1100
1101 line = strdup(line_str);
1102 if (!line)
1103 return log_oom();
1104
1105 rule_line = new(UdevRuleLine, 1);
1106 if (!rule_line)
1107 return log_oom();
1108
1109 *rule_line = (UdevRuleLine) {
1110 .line = TAKE_PTR(line),
1111 .line_number = line_nr,
1112 .rule_file = rule_file,
1113 };
1114
1115 if (rule_file->current_line)
1116 LIST_APPEND(rule_lines, rule_file->current_line, rule_line);
1117 else
1118 LIST_APPEND(rule_lines, rule_file->rule_lines, rule_line);
1119
1120 rule_file->current_line = rule_line;
1121
1122 for (p = rule_line->line; !isempty(p); ) {
1123 char *key, *attr, *value;
1124 UdevRuleOperatorType op;
1125
1126 r = parse_line(&p, &key, &attr, &op, &value);
1127 if (r < 0)
1128 return log_token_error_errno(rules, r, "Invalid key/value pair, ignoring.");
1129 if (r == 0)
1130 break;
1131
1132 r = parse_token(rules, key, attr, op, value);
1133 if (r < 0)
1134 return r;
1135 }
1136
1137 if (rule_line->type == 0) {
1138 log_token_warning(rules, "The line takes no effect, ignoring.");
1139 return 0;
1140 }
1141
1142 sort_tokens(rule_line);
1143 TAKE_PTR(rule_line);
1144 return 0;
1145 }
1146
1147 static void rule_resolve_goto(UdevRuleFile *rule_file) {
1148 UdevRuleLine *line, *line_next, *i;
1149
1150 assert(rule_file);
1151
1152 /* link GOTOs to LABEL rules in this file to be able to fast-forward */
1153 LIST_FOREACH_SAFE(rule_lines, line, line_next, rule_file->rule_lines) {
1154 if (!FLAGS_SET(line->type, LINE_HAS_GOTO))
1155 continue;
1156
1157 LIST_FOREACH_AFTER(rule_lines, i, line)
1158 if (streq_ptr(i->label, line->goto_label)) {
1159 line->goto_line = i;
1160 break;
1161 }
1162
1163 if (!line->goto_line) {
1164 log_error("%s:%u: GOTO=\"%s\" has no matching label, ignoring",
1165 rule_file->filename, line->line_number, line->goto_label);
1166
1167 SET_FLAG(line->type, LINE_HAS_GOTO, false);
1168 line->goto_label = NULL;
1169
1170 if ((line->type & ~LINE_HAS_LABEL) == 0) {
1171 log_notice("%s:%u: The line takes no effect any more, dropping",
1172 rule_file->filename, line->line_number);
1173 if (line->type == LINE_HAS_LABEL)
1174 udev_rule_line_clear_tokens(line);
1175 else
1176 udev_rule_line_free(line);
1177 }
1178 }
1179 }
1180 }
1181
1182 static int parse_file(UdevRules *rules, const char *filename) {
1183 _cleanup_free_ char *continuation = NULL, *name = NULL;
1184 _cleanup_fclose_ FILE *f = NULL;
1185 UdevRuleFile *rule_file;
1186 bool ignore_line = false;
1187 unsigned line_nr = 0;
1188 int r;
1189
1190 f = fopen(filename, "re");
1191 if (!f) {
1192 if (errno == ENOENT)
1193 return 0;
1194
1195 return -errno;
1196 }
1197
1198 (void) fd_warn_permissions(filename, fileno(f));
1199
1200 if (null_or_empty_fd(fileno(f))) {
1201 log_debug("Skipping empty file: %s", filename);
1202 return 0;
1203 }
1204
1205 log_debug("Reading rules file: %s", filename);
1206
1207 name = strdup(filename);
1208 if (!name)
1209 return log_oom();
1210
1211 rule_file = new(UdevRuleFile, 1);
1212 if (!rule_file)
1213 return log_oom();
1214
1215 *rule_file = (UdevRuleFile) {
1216 .filename = TAKE_PTR(name),
1217 };
1218
1219 if (rules->current_file)
1220 LIST_APPEND(rule_files, rules->current_file, rule_file);
1221 else
1222 LIST_APPEND(rule_files, rules->rule_files, rule_file);
1223
1224 rules->current_file = rule_file;
1225
1226 for (;;) {
1227 _cleanup_free_ char *buf = NULL;
1228 size_t len;
1229 char *line;
1230
1231 r = read_line(f, UTIL_LINE_SIZE, &buf);
1232 if (r < 0)
1233 return r;
1234 if (r == 0)
1235 break;
1236
1237 line_nr++;
1238 line = skip_leading_chars(buf, NULL);
1239
1240 if (line[0] == '#')
1241 continue;
1242
1243 len = strlen(line);
1244
1245 if (continuation && !ignore_line) {
1246 if (strlen(continuation) + len >= UTIL_LINE_SIZE)
1247 ignore_line = true;
1248
1249 if (!strextend(&continuation, line, NULL))
1250 return log_oom();
1251
1252 if (!ignore_line) {
1253 line = continuation;
1254 len = strlen(line);
1255 }
1256 }
1257
1258 if (len > 0 && line[len - 1] == '\\') {
1259 if (ignore_line)
1260 continue;
1261
1262 line[len - 1] = '\0';
1263 if (!continuation) {
1264 continuation = strdup(line);
1265 if (!continuation)
1266 return log_oom();
1267 }
1268
1269 continue;
1270 }
1271
1272 if (ignore_line)
1273 log_error("%s:%u: Line is too long, ignored", filename, line_nr);
1274 else if (len > 0)
1275 (void) rule_add_line(rules, line, line_nr);
1276
1277 continuation = mfree(continuation);
1278 ignore_line = false;
1279 }
1280
1281 rule_resolve_goto(rule_file);
1282 return 0;
1283 }
1284
1285 int udev_rules_new(UdevRules **ret_rules, ResolveNameTiming resolve_name_timing) {
1286 _cleanup_(udev_rules_freep) UdevRules *rules = NULL;
1287 _cleanup_strv_free_ char **files = NULL;
1288 char **f;
1289 int r;
1290
1291 assert(resolve_name_timing >= 0 && resolve_name_timing < _RESOLVE_NAME_TIMING_MAX);
1292
1293 rules = new(UdevRules, 1);
1294 if (!rules)
1295 return -ENOMEM;
1296
1297 *rules = (UdevRules) {
1298 .resolve_name_timing = resolve_name_timing,
1299 };
1300
1301 (void) udev_rules_check_timestamp(rules);
1302
1303 r = conf_files_list_strv(&files, ".rules", NULL, 0, RULES_DIRS);
1304 if (r < 0)
1305 return log_error_errno(r, "Failed to enumerate rules files: %m");
1306
1307 STRV_FOREACH(f, files)
1308 (void) parse_file(rules, *f);
1309
1310 *ret_rules = TAKE_PTR(rules);
1311 return 0;
1312 }
1313
1314 bool udev_rules_check_timestamp(UdevRules *rules) {
1315 if (!rules)
1316 return false;
1317
1318 return paths_check_timestamp(RULES_DIRS, &rules->dirs_ts_usec, true);
1319 }
1320
1321 static bool token_match_string(UdevRuleToken *token, const char *str) {
1322 const char *i, *value;
1323 bool match = false;
1324
1325 assert(token);
1326 assert(token->value);
1327 assert(token->type < _TK_M_MAX);
1328
1329 str = strempty(str);
1330 value = token->value;
1331
1332 switch (token->match_type) {
1333 case MATCH_TYPE_EMPTY:
1334 match = isempty(str);
1335 break;
1336 case MATCH_TYPE_SUBSYSTEM:
1337 NULSTR_FOREACH(i, "subsystem\0class\0bus\0")
1338 if (streq(i, str)) {
1339 match = true;
1340 break;
1341 }
1342 break;
1343 case MATCH_TYPE_PLAIN_WITH_EMPTY:
1344 if (isempty(str)) {
1345 match = true;
1346 break;
1347 }
1348 _fallthrough_;
1349 case MATCH_TYPE_PLAIN:
1350 NULSTR_FOREACH(i, value)
1351 if (streq(i, str)) {
1352 match = true;
1353 break;
1354 }
1355 break;
1356 case MATCH_TYPE_GLOB_WITH_EMPTY:
1357 if (isempty(str)) {
1358 match = true;
1359 break;
1360 }
1361 _fallthrough_;
1362 case MATCH_TYPE_GLOB:
1363 NULSTR_FOREACH(i, value)
1364 if ((fnmatch(i, str, 0) == 0)) {
1365 match = true;
1366 break;
1367 }
1368 break;
1369 default:
1370 assert_not_reached("Invalid match type");
1371 }
1372
1373 return token->op == (match ? OP_MATCH : OP_NOMATCH);
1374 }
1375
1376 static bool token_match_attr(UdevRuleToken *token, sd_device *dev, UdevEvent *event) {
1377 char nbuf[UTIL_NAME_SIZE], vbuf[UTIL_NAME_SIZE];
1378 const char *name, *value;
1379
1380 assert(token);
1381 assert(dev);
1382 assert(event);
1383
1384 name = (const char*) token->data;
1385
1386 switch (token->attr_subst_type) {
1387 case SUBST_TYPE_FORMAT:
1388 (void) udev_event_apply_format(event, name, nbuf, sizeof(nbuf), false);
1389 name = nbuf;
1390 _fallthrough_;
1391 case SUBST_TYPE_PLAIN:
1392 if (sd_device_get_sysattr_value(dev, name, &value) < 0)
1393 return false;
1394 break;
1395 case SUBST_TYPE_SUBSYS:
1396 if (util_resolve_subsys_kernel(name, vbuf, sizeof(vbuf), true) < 0)
1397 return false;
1398 value = vbuf;
1399 break;
1400 default:
1401 assert_not_reached("Invalid attribute substitution type");
1402 }
1403
1404 /* remove trailing whitespace, if not asked to match for it */
1405 if (token->attr_match_remove_trailing_whitespace) {
1406 if (value != vbuf) {
1407 strscpy(vbuf, sizeof(vbuf), value);
1408 value = vbuf;
1409 }
1410
1411 delete_trailing_chars(vbuf, NULL);
1412 }
1413
1414 return token_match_string(token, value);
1415 }
1416
1417 static int get_property_from_string(char *line, char **ret_key, char **ret_value) {
1418 char *key, *val;
1419 size_t len;
1420
1421 assert(line);
1422 assert(ret_key);
1423 assert(ret_value);
1424
1425 /* find key */
1426 key = skip_leading_chars(line, NULL);
1427
1428 /* comment or empty line */
1429 if (IN_SET(key[0], '#', '\0')) {
1430 *ret_key = *ret_value = NULL;
1431 return 0;
1432 }
1433
1434 /* split key/value */
1435 val = strchr(key, '=');
1436 if (!val)
1437 return -EINVAL;
1438 *val++ = '\0';
1439
1440 key = strstrip(key);
1441 if (isempty(key))
1442 return -EINVAL;
1443
1444 val = strstrip(val);
1445 if (isempty(val))
1446 return -EINVAL;
1447
1448 /* unquote */
1449 if (IN_SET(val[0], '"', '\'')) {
1450 len = strlen(val);
1451 if (len == 1 || val[len-1] != val[0])
1452 return -EINVAL;
1453 val[len-1] = '\0';
1454 val++;
1455 }
1456
1457 *ret_key = key;
1458 *ret_value = val;
1459 return 1;
1460 }
1461
1462 static int import_parent_into_properties(sd_device *dev, const char *filter) {
1463 const char *key, *val;
1464 sd_device *parent;
1465 int r;
1466
1467 assert(dev);
1468 assert(filter);
1469
1470 r = sd_device_get_parent(dev, &parent);
1471 if (r == -ENOENT)
1472 return 0;
1473 if (r < 0)
1474 return r;
1475
1476 FOREACH_DEVICE_PROPERTY(parent, key, val) {
1477 if (fnmatch(filter, key, 0) != 0)
1478 continue;
1479 r = device_add_property(dev, key, val);
1480 if (r < 0)
1481 return r;
1482 }
1483
1484 return 1;
1485 }
1486
1487 static int attr_subst_subdir(char attr[static UTIL_PATH_SIZE]) {
1488 _cleanup_closedir_ DIR *dir = NULL;
1489 struct dirent *dent;
1490 char buf[UTIL_PATH_SIZE], *p;
1491 const char *tail;
1492 size_t len, size;
1493
1494 assert(attr);
1495
1496 tail = strstr(attr, "/*/");
1497 if (!tail)
1498 return 0;
1499
1500 len = tail - attr + 1; /* include slash at the end */
1501 tail += 2; /* include slash at the beginning */
1502
1503 p = buf;
1504 size = sizeof(buf);
1505 size -= strnpcpy(&p, size, attr, len);
1506
1507 dir = opendir(buf);
1508 if (!dir)
1509 return -errno;
1510
1511 FOREACH_DIRENT_ALL(dent, dir, break) {
1512 if (dent->d_name[0] == '.')
1513 continue;
1514
1515 strscpyl(p, size, dent->d_name, tail, NULL);
1516 if (faccessat(dirfd(dir), p, F_OK, 0) < 0)
1517 continue;
1518
1519 strcpy(attr, buf);
1520 return 0;
1521 }
1522
1523 return -ENOENT;
1524 }
1525
1526 static int udev_rule_apply_token_to_event(
1527 UdevRules *rules,
1528 sd_device *dev,
1529 UdevEvent *event,
1530 usec_t timeout_usec,
1531 Hashmap *properties_list) {
1532
1533 UdevRuleToken *token;
1534 char buf[UTIL_PATH_SIZE];
1535 const char *val;
1536 size_t count;
1537 bool match;
1538 int r;
1539
1540 assert(rules);
1541 assert(dev);
1542 assert(event);
1543
1544 /* This returns the following values:
1545 * 0 on the current token does not match the event,
1546 * 1 on the current token matches the event, and
1547 * negative errno on some critical errors. */
1548
1549 token = rules->current_file->current_line->current_token;
1550
1551 switch (token->type) {
1552 case TK_M_ACTION: {
1553 DeviceAction a;
1554
1555 r = device_get_action(dev, &a);
1556 if (r < 0)
1557 return log_rule_error_errno(dev, rules, r, "Failed to get uevent action type: %m");
1558
1559 return token_match_string(token, device_action_to_string(a));
1560 }
1561 case TK_M_DEVPATH:
1562 r = sd_device_get_devpath(dev, &val);
1563 if (r < 0)
1564 return log_rule_error_errno(dev, rules, r, "Failed to get devpath: %m");
1565
1566 return token_match_string(token, val);
1567 case TK_M_KERNEL:
1568 case TK_M_PARENTS_KERNEL:
1569 r = sd_device_get_sysname(dev, &val);
1570 if (r < 0)
1571 return log_rule_error_errno(dev, rules, r, "Failed to get sysname: %m");
1572
1573 return token_match_string(token, val);
1574 case TK_M_DEVLINK:
1575 FOREACH_DEVICE_DEVLINK(dev, val)
1576 if (token_match_string(token, strempty(startswith(val, "/dev/"))))
1577 return token->op == OP_MATCH;
1578 return token->op == OP_NOMATCH;
1579 case TK_M_NAME:
1580 return token_match_string(token, event->name);
1581 case TK_M_ENV:
1582 if (sd_device_get_property_value(dev, (const char*) token->data, &val) < 0)
1583 val = hashmap_get(properties_list, token->data);
1584
1585 return token_match_string(token, val);
1586 case TK_M_CONST: {
1587 const char *k = token->data;
1588
1589 if (streq(k, "arch"))
1590 val = architecture_to_string(uname_architecture());
1591 else if (streq(k, "virt"))
1592 val = virtualization_to_string(detect_virtualization());
1593 else
1594 assert_not_reached("Invalid CONST key");
1595 return token_match_string(token, val);
1596 }
1597 case TK_M_TAG:
1598 case TK_M_PARENTS_TAG:
1599 FOREACH_DEVICE_TAG(dev, val)
1600 if (token_match_string(token, val))
1601 return token->op == OP_MATCH;
1602 return token->op == OP_NOMATCH;
1603 case TK_M_SUBSYSTEM:
1604 case TK_M_PARENTS_SUBSYSTEM:
1605 r = sd_device_get_subsystem(dev, &val);
1606 if (r == -ENOENT)
1607 val = NULL;
1608 else if (r < 0)
1609 return log_rule_error_errno(dev, rules, r, "Failed to get subsystem: %m");
1610
1611 return token_match_string(token, val);
1612 case TK_M_DRIVER:
1613 case TK_M_PARENTS_DRIVER:
1614 r = sd_device_get_driver(dev, &val);
1615 if (r == -ENOENT)
1616 val = NULL;
1617 else if (r < 0)
1618 return log_rule_error_errno(dev, rules, r, "Failed to get driver: %m");
1619
1620 return token_match_string(token, val);
1621 case TK_M_ATTR:
1622 case TK_M_PARENTS_ATTR:
1623 return token_match_attr(token, dev, event);
1624 case TK_M_SYSCTL: {
1625 _cleanup_free_ char *value = NULL;
1626
1627 (void) udev_event_apply_format(event, (const char*) token->data, buf, sizeof(buf), false);
1628 r = sysctl_read(sysctl_normalize(buf), &value);
1629 if (r < 0 && r != -ENOENT)
1630 return log_rule_error_errno(dev, rules, r, "Failed to read sysctl '%s': %m", buf);
1631
1632 return token_match_string(token, strstrip(value));
1633 }
1634 case TK_M_TEST: {
1635 mode_t mode = PTR_TO_MODE(token->data);
1636 struct stat statbuf;
1637
1638 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1639 if (!path_is_absolute(buf) &&
1640 util_resolve_subsys_kernel(buf, buf, sizeof(buf), false) < 0) {
1641 char tmp[UTIL_PATH_SIZE];
1642
1643 r = sd_device_get_syspath(dev, &val);
1644 if (r < 0)
1645 return log_rule_error_errno(dev, rules, r, "Failed to get syspath: %m");
1646
1647 strscpy(tmp, sizeof(tmp), buf);
1648 strscpyl(buf, sizeof(buf), val, "/", tmp, NULL);
1649 }
1650
1651 r = attr_subst_subdir(buf);
1652 if (r == -ENOENT)
1653 return token->op == OP_NOMATCH;
1654 if (r < 0)
1655 return log_rule_error_errno(dev, rules, r, "Failed to test the existence of '%s': %m", buf);
1656
1657 if (stat(buf, &statbuf) < 0)
1658 return token->op == OP_NOMATCH;
1659
1660 if (mode == MODE_INVALID)
1661 return token->op == OP_MATCH;
1662
1663 match = (((statbuf.st_mode ^ mode) & 07777) == 0);
1664 return token->op == (match ? OP_MATCH : OP_NOMATCH);
1665 }
1666 case TK_M_PROGRAM: {
1667 char result[UTIL_LINE_SIZE];
1668
1669 event->program_result = mfree(event->program_result);
1670 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1671 log_rule_debug(dev, rules, "Running PROGRAM '%s'", buf);
1672
1673 r = udev_event_spawn(event, timeout_usec, true, buf, result, sizeof(result));
1674 if (r < 0)
1675 return log_rule_error_errno(dev, rules, r, "Failed to execute '%s': %m", buf);
1676 if (r > 0)
1677 return token->op == OP_NOMATCH;
1678
1679 delete_trailing_chars(result, "\n");
1680 count = util_replace_chars(result, UDEV_ALLOWED_CHARS_INPUT);
1681 if (count > 0)
1682 log_rule_debug(dev, rules, "Replaced %zu character(s) from result of '%s'",
1683 count, buf);
1684
1685 event->program_result = strdup(result);
1686 return token->op == OP_MATCH;
1687 }
1688 case TK_M_IMPORT_FILE: {
1689 _cleanup_fclose_ FILE *f = NULL;
1690
1691 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1692 log_rule_debug(dev, rules, "Importing properties from '%s'", buf);
1693
1694 f = fopen(buf, "re");
1695 if (!f) {
1696 if (errno != ENOENT)
1697 return log_rule_error_errno(dev, rules, errno,
1698 "Failed to open '%s': %m", buf);
1699 return token->op == OP_NOMATCH;
1700 }
1701
1702 for (;;) {
1703 _cleanup_free_ char *line = NULL;
1704 char *key, *value;
1705
1706 r = read_line(f, LONG_LINE_MAX, &line);
1707 if (r < 0) {
1708 log_rule_debug_errno(dev, rules, r,
1709 "Failed to read '%s', ignoring: %m", buf);
1710 return token->op == OP_NOMATCH;
1711 }
1712 if (r == 0)
1713 break;
1714
1715 r = get_property_from_string(line, &key, &value);
1716 if (r < 0) {
1717 log_rule_debug_errno(dev, rules, r,
1718 "Failed to parse key and value from '%s', ignoring: %m",
1719 line);
1720 continue;
1721 }
1722 if (r == 0)
1723 continue;
1724
1725 r = device_add_property(dev, key, value);
1726 if (r < 0)
1727 return log_rule_error_errno(dev, rules, r,
1728 "Failed to add property %s=%s: %m",
1729 key, value);
1730 }
1731
1732 return token->op == OP_MATCH;
1733 }
1734 case TK_M_IMPORT_PROGRAM: {
1735 char result[UTIL_LINE_SIZE], *line, *pos;
1736
1737 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1738 log_rule_debug(dev, rules, "Importing properties from results of '%s'", buf);
1739
1740 r = udev_event_spawn(event, timeout_usec, true, buf, result, sizeof result);
1741 if (r < 0)
1742 return log_rule_error_errno(dev, rules, r, "Failed to execute '%s': %m", buf);
1743 if (r > 0) {
1744 log_rule_debug(dev, rules, "Command \"%s\" returned %d (error), ignoring", buf, r);
1745 return token->op == OP_NOMATCH;
1746 }
1747
1748 for (line = result; !isempty(line); line = pos) {
1749 char *key, *value;
1750
1751 pos = strchr(line, '\n');
1752 if (pos)
1753 *pos++ = '\0';
1754
1755 r = get_property_from_string(line, &key, &value);
1756 if (r < 0) {
1757 log_rule_debug_errno(dev, rules, r,
1758 "Failed to parse key and value from '%s', ignoring: %m",
1759 line);
1760 continue;
1761 }
1762 if (r == 0)
1763 continue;
1764
1765 r = device_add_property(dev, key, value);
1766 if (r < 0)
1767 return log_rule_error_errno(dev, rules, r,
1768 "Failed to add property %s=%s: %m",
1769 key, value);
1770 }
1771
1772 return token->op == OP_MATCH;
1773 }
1774 case TK_M_IMPORT_BUILTIN: {
1775 UdevBuiltinCommand cmd = PTR_TO_UDEV_BUILTIN_CMD(token->data);
1776 unsigned mask = 1U << (int) cmd;
1777
1778 if (udev_builtin_run_once(cmd)) {
1779 /* check if we ran already */
1780 if (event->builtin_run & mask) {
1781 log_rule_debug(dev, rules, "Skipping builtin '%s' in IMPORT key",
1782 udev_builtin_name(cmd));
1783 /* return the result from earlier run */
1784 return token->op == (event->builtin_ret & mask ? OP_NOMATCH : OP_MATCH);
1785 }
1786 /* mark as ran */
1787 event->builtin_run |= mask;
1788 }
1789
1790 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1791 log_rule_debug(dev, rules, "Importing properties from results of builtin command '%s'", buf);
1792
1793 r = udev_builtin_run(dev, cmd, buf, false);
1794 if (r < 0) {
1795 /* remember failure */
1796 log_rule_debug_errno(dev, rules, r, "Failed to run builtin '%s': %m", buf);
1797 event->builtin_ret |= mask;
1798 }
1799 return token->op == (r >= 0 ? OP_MATCH : OP_NOMATCH);
1800 }
1801 case TK_M_IMPORT_DB: {
1802 if (!event->dev_db_clone)
1803 return token->op == OP_NOMATCH;
1804 r = sd_device_get_property_value(event->dev_db_clone, token->value, &val);
1805 if (r == -ENOENT)
1806 return token->op == OP_NOMATCH;
1807 if (r < 0)
1808 return log_rule_error_errno(dev, rules, r,
1809 "Failed to get property '%s' from database: %m",
1810 token->value);
1811
1812 r = device_add_property(dev, token->value, val);
1813 if (r < 0)
1814 return log_rule_error_errno(dev, rules, r, "Failed to add property '%s=%s': %m",
1815 token->value, val);
1816 return token->op == OP_MATCH;
1817 }
1818 case TK_M_IMPORT_CMDLINE: {
1819 _cleanup_free_ char *value = NULL;
1820
1821 r = proc_cmdline_get_key(token->value, PROC_CMDLINE_VALUE_OPTIONAL, &value);
1822 if (r < 0)
1823 return log_rule_error_errno(dev, rules, r,
1824 "Failed to read '%s' option from /proc/cmdline: %m",
1825 token->value);
1826 if (r == 0)
1827 return token->op == OP_NOMATCH;
1828
1829 r = device_add_property(dev, token->value, value ?: "1");
1830 if (r < 0)
1831 return log_rule_error_errno(dev, rules, r, "Failed to add property '%s=%s': %m",
1832 token->value, value ?: "1");
1833 return token->op == OP_MATCH;
1834 }
1835 case TK_M_IMPORT_PARENT: {
1836 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
1837 r = import_parent_into_properties(dev, buf);
1838 if (r < 0)
1839 return log_rule_error_errno(dev, rules, r,
1840 "Failed to import properties '%s' from parent: %m",
1841 buf);
1842 return token->op == (r > 0 ? OP_MATCH : OP_NOMATCH);
1843 }
1844 case TK_M_RESULT:
1845 return token_match_string(token, event->program_result);
1846 case TK_A_OPTIONS_STRING_ESCAPE_NONE:
1847 event->esc = ESCAPE_NONE;
1848 break;
1849 case TK_A_OPTIONS_STRING_ESCAPE_REPLACE:
1850 event->esc = ESCAPE_REPLACE;
1851 break;
1852 case TK_A_OPTIONS_DB_PERSIST:
1853 device_set_db_persist(dev);
1854 break;
1855 case TK_A_OPTIONS_INOTIFY_WATCH:
1856 if (event->inotify_watch_final)
1857 break;
1858 if (token->op == OP_ASSIGN_FINAL)
1859 event->inotify_watch_final = true;
1860
1861 event->inotify_watch = token->data;
1862 break;
1863 case TK_A_OPTIONS_DEVLINK_PRIORITY:
1864 device_set_devlink_priority(dev, PTR_TO_INT(token->data));
1865 break;
1866 case TK_A_OWNER: {
1867 char owner[UTIL_NAME_SIZE];
1868 const char *ow = owner;
1869
1870 if (event->owner_final)
1871 break;
1872 if (token->op == OP_ASSIGN_FINAL)
1873 event->owner_final = true;
1874
1875 (void) udev_event_apply_format(event, token->value, owner, sizeof(owner), false);
1876 r = get_user_creds(&ow, &event->uid, NULL, NULL, NULL, USER_CREDS_ALLOW_MISSING);
1877 if (r < 0)
1878 log_unknown_owner(dev, rules, r, "user", owner);
1879 else
1880 log_rule_debug(dev, rules, "OWNER %s(%u)", owner, event->uid);
1881 break;
1882 }
1883 case TK_A_GROUP: {
1884 char group[UTIL_NAME_SIZE];
1885 const char *gr = group;
1886
1887 if (event->group_final)
1888 break;
1889 if (token->op == OP_ASSIGN_FINAL)
1890 event->group_final = true;
1891
1892 (void) udev_event_apply_format(event, token->value, group, sizeof(group), false);
1893 r = get_group_creds(&gr, &event->gid, USER_CREDS_ALLOW_MISSING);
1894 if (r < 0)
1895 log_unknown_owner(dev, rules, r, "group", group);
1896 else
1897 log_rule_debug(dev, rules, "GROUP %s(%u)", group, event->gid);
1898 break;
1899 }
1900 case TK_A_MODE: {
1901 char mode_str[UTIL_NAME_SIZE];
1902
1903 if (event->mode_final)
1904 break;
1905 if (token->op == OP_ASSIGN_FINAL)
1906 event->mode_final = true;
1907
1908 (void) udev_event_apply_format(event, token->value, mode_str, sizeof(mode_str), false);
1909 r = parse_mode(mode_str, &event->mode);
1910 if (r < 0)
1911 log_rule_error_errno(dev, rules, r, "Failed to parse mode '%s', ignoring: %m", mode_str);
1912 else
1913 log_rule_debug(dev, rules, "MODE %#o", event->mode);
1914 break;
1915 }
1916 case TK_A_OWNER_ID:
1917 if (event->owner_final)
1918 break;
1919 if (token->op == OP_ASSIGN_FINAL)
1920 event->owner_final = true;
1921 if (!token->data)
1922 break;
1923 event->uid = PTR_TO_UID(token->data);
1924 log_rule_debug(dev, rules, "OWNER %u", event->uid);
1925 break;
1926 case TK_A_GROUP_ID:
1927 if (event->group_final)
1928 break;
1929 if (token->op == OP_ASSIGN_FINAL)
1930 event->group_final = true;
1931 if (!token->data)
1932 break;
1933 event->gid = PTR_TO_GID(token->data);
1934 log_rule_debug(dev, rules, "GROUP %u", event->gid);
1935 break;
1936 case TK_A_MODE_ID:
1937 if (event->mode_final)
1938 break;
1939 if (token->op == OP_ASSIGN_FINAL)
1940 event->mode_final = true;
1941 if (!token->data)
1942 break;
1943 event->mode = PTR_TO_MODE(token->data);
1944 log_rule_debug(dev, rules, "MODE %#o", event->mode);
1945 break;
1946 case TK_A_SECLABEL: {
1947 _cleanup_free_ char *name = NULL, *label = NULL;
1948 char label_str[UTIL_LINE_SIZE] = {};
1949
1950 name = strdup((const char*) token->data);
1951 if (!name)
1952 return log_oom();
1953
1954 (void) udev_event_apply_format(event, token->value, label_str, sizeof(label_str), false);
1955 if (!isempty(label_str))
1956 label = strdup(label_str);
1957 else
1958 label = strdup(token->value);
1959 if (!label)
1960 return log_oom();
1961
1962 if (token->op == OP_ASSIGN)
1963 ordered_hashmap_clear_free_free(event->seclabel_list);
1964
1965 r = ordered_hashmap_ensure_allocated(&event->seclabel_list, NULL);
1966 if (r < 0)
1967 return log_oom();
1968
1969 r = ordered_hashmap_put(event->seclabel_list, name, label);
1970 if (r < 0)
1971 return log_oom();
1972 log_rule_debug(dev, rules, "SECLABEL{%s}='%s'", name, label);
1973 name = label = NULL;
1974 break;
1975 }
1976 case TK_A_ENV: {
1977 const char *name = (const char*) token->data;
1978 char value_new[UTIL_NAME_SIZE], *p = value_new;
1979 size_t l = sizeof(value_new);
1980
1981 if (isempty(token->value)) {
1982 if (token->op == OP_ADD)
1983 break;
1984 r = device_add_property(dev, name, NULL);
1985 if (r < 0)
1986 return log_rule_error_errno(dev, rules, r, "Failed to remove property '%s': %m", name);
1987 break;
1988 }
1989
1990 if (token->op == OP_ADD &&
1991 sd_device_get_property_value(dev, name, &val) >= 0)
1992 l = strpcpyl(&p, l, val, " ", NULL);
1993
1994 (void) udev_event_apply_format(event, token->value, p, l, false);
1995
1996 r = device_add_property(dev, name, value_new);
1997 if (r < 0)
1998 return log_rule_error_errno(dev, rules, r, "Failed to add property '%s=%s': %m", name, value_new);
1999 break;
2000 }
2001 case TK_A_TAG: {
2002 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
2003 if (token->op == OP_ASSIGN)
2004 device_cleanup_tags(dev);
2005
2006 if (buf[strspn(buf, ALPHANUMERICAL "-_")] != '\0') {
2007 log_rule_error(dev, rules, "Invalid tag name '%s', ignoring", buf);
2008 break;
2009 }
2010 if (token->op == OP_REMOVE)
2011 device_remove_tag(dev, buf);
2012 else {
2013 r = device_add_tag(dev, buf);
2014 if (r < 0)
2015 return log_rule_error_errno(dev, rules, r, "Failed to add tag '%s': %m", buf);
2016 }
2017 break;
2018 }
2019 case TK_A_NAME: {
2020 if (event->name_final)
2021 break;
2022 if (token->op == OP_ASSIGN_FINAL)
2023 event->name_final = true;
2024
2025 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
2026 if (IN_SET(event->esc, ESCAPE_UNSET, ESCAPE_REPLACE)) {
2027 count = util_replace_chars(buf, "/");
2028 if (count > 0)
2029 log_rule_debug(dev, rules, "Replaced %zu character(s) from result of NAME=\"%s\"",
2030 count, token->value);
2031 }
2032 if (sd_device_get_devnum(dev, NULL) >= 0 &&
2033 (sd_device_get_devname(dev, &val) < 0 ||
2034 !streq_ptr(buf, startswith(val, "/dev/")))) {
2035 log_rule_error(dev, rules,
2036 "Kernel device nodes cannot be renamed, ignoring NAME=\"%s\"; please fix it.",
2037 token->value);
2038 break;
2039 }
2040 if (free_and_strdup(&event->name, buf) < 0)
2041 return log_oom();
2042
2043 log_rule_debug(dev, rules, "NAME '%s'", event->name);
2044 break;
2045 }
2046 case TK_A_DEVLINK: {
2047 char *p;
2048
2049 if (event->devlink_final)
2050 break;
2051 if (sd_device_get_devnum(dev, NULL) < 0)
2052 break;
2053 if (token->op == OP_ASSIGN_FINAL)
2054 event->devlink_final = true;
2055 if (IN_SET(token->op, OP_ASSIGN, OP_ASSIGN_FINAL))
2056 device_cleanup_devlinks(dev);
2057
2058 /* allow multiple symlinks separated by spaces */
2059 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), event->esc != ESCAPE_NONE);
2060 if (event->esc == ESCAPE_UNSET)
2061 count = util_replace_chars(buf, "/ ");
2062 else if (event->esc == ESCAPE_REPLACE)
2063 count = util_replace_chars(buf, "/");
2064 else
2065 count = 0;
2066 if (count > 0)
2067 log_rule_debug(dev, rules, "Replaced %zu character(s) from result of LINK", count);
2068
2069 p = skip_leading_chars(buf, NULL);
2070 while (!isempty(p)) {
2071 char filename[UTIL_PATH_SIZE], *next;
2072
2073 next = strchr(p, ' ');
2074 if (next) {
2075 *next++ = '\0';
2076 next = skip_leading_chars(next, NULL);
2077 }
2078
2079 strscpyl(filename, sizeof(filename), "/dev/", p, NULL);
2080 r = device_add_devlink(dev, filename);
2081 if (r < 0)
2082 return log_rule_error_errno(dev, rules, r, "Failed to add devlink '%s': %m", filename);
2083
2084 log_rule_debug(dev, rules, "LINK '%s'", p);
2085 p = next;
2086 }
2087 break;
2088 }
2089 case TK_A_ATTR: {
2090 const char *key_name = (const char*) token->data;
2091 char value[UTIL_NAME_SIZE];
2092
2093 if (util_resolve_subsys_kernel(key_name, buf, sizeof(buf), false) < 0 &&
2094 sd_device_get_syspath(dev, &val) >= 0)
2095 strscpyl(buf, sizeof(buf), val, "/", key_name, NULL);
2096
2097 r = attr_subst_subdir(buf);
2098 if (r < 0) {
2099 log_rule_error_errno(dev, rules, r, "Could not find file matches '%s', ignoring: %m", buf);
2100 break;
2101 }
2102 (void) udev_event_apply_format(event, token->value, value, sizeof(value), false);
2103
2104 log_rule_debug(dev, rules, "ATTR '%s' writing '%s'", buf, value);
2105 r = write_string_file(buf, value, WRITE_STRING_FILE_VERIFY_ON_FAILURE | WRITE_STRING_FILE_DISABLE_BUFFER | WRITE_STRING_FILE_AVOID_NEWLINE);
2106 if (r < 0)
2107 log_rule_error_errno(dev, rules, r, "Failed to write ATTR{%s}, ignoring: %m", buf);
2108 break;
2109 }
2110 case TK_A_SYSCTL: {
2111 char value[UTIL_NAME_SIZE];
2112
2113 (void) udev_event_apply_format(event, (const char*) token->data, buf, sizeof(buf), false);
2114 (void) udev_event_apply_format(event, token->value, value, sizeof(value), false);
2115 sysctl_normalize(buf);
2116 log_rule_debug(dev, rules, "SYSCTL '%s' writing '%s'", buf, value);
2117 r = sysctl_write(buf, value);
2118 if (r < 0)
2119 log_rule_error_errno(dev, rules, r, "Failed to write SYSCTL{%s}='%s', ignoring: %m", buf, value);
2120 break;
2121 }
2122 case TK_A_RUN_BUILTIN:
2123 case TK_A_RUN_PROGRAM: {
2124 _cleanup_free_ char *cmd = NULL;
2125
2126 if (event->run_final)
2127 break;
2128 if (token->op == OP_ASSIGN_FINAL)
2129 event->run_final = true;
2130
2131 if (IN_SET(token->op, OP_ASSIGN, OP_ASSIGN_FINAL))
2132 ordered_hashmap_clear_free_key(event->run_list);
2133
2134 r = ordered_hashmap_ensure_allocated(&event->run_list, NULL);
2135 if (r < 0)
2136 return log_oom();
2137
2138 (void) udev_event_apply_format(event, token->value, buf, sizeof(buf), false);
2139
2140 cmd = strdup(buf);
2141 if (!cmd)
2142 return log_oom();
2143
2144 r = ordered_hashmap_put(event->run_list, cmd, token->data);
2145 if (r < 0)
2146 return log_oom();
2147
2148 TAKE_PTR(cmd);
2149
2150 log_rule_debug(dev, rules, "RUN '%s'", token->value);
2151 break;
2152 }
2153 case TK_A_OPTIONS_STATIC_NODE:
2154 /* do nothing for events. */
2155 break;
2156 default:
2157 assert_not_reached("Invalid token type");
2158 }
2159
2160 return true;
2161 }
2162
2163 static bool token_is_for_parents(UdevRuleToken *token) {
2164 return token->type >= TK_M_PARENTS_KERNEL && token->type <= TK_M_PARENTS_TAG;
2165 }
2166
2167 static int udev_rule_apply_parent_token_to_event(
2168 UdevRules *rules,
2169 UdevEvent *event) {
2170
2171 UdevRuleLine *line;
2172 UdevRuleToken *head;
2173 int r;
2174
2175 line = rules->current_file->current_line;
2176 head = rules->current_file->current_line->current_token;
2177 event->dev_parent = event->dev;
2178 for (;;) {
2179 LIST_FOREACH(tokens, line->current_token, head) {
2180 if (!token_is_for_parents(line->current_token))
2181 return true; /* All parent tokens match. */
2182 r = udev_rule_apply_token_to_event(rules, event->dev_parent, event, 0, NULL);
2183 if (r < 0)
2184 return r;
2185 if (r == 0)
2186 break;
2187 }
2188 if (!line->current_token)
2189 /* All parent tokens match. But no assign tokens in the line. Hmm... */
2190 return true;
2191
2192 if (sd_device_get_parent(event->dev_parent, &event->dev_parent) < 0) {
2193 event->dev_parent = NULL;
2194 return false;
2195 }
2196 }
2197 }
2198
2199 static int udev_rule_apply_line_to_event(
2200 UdevRules *rules,
2201 UdevEvent *event,
2202 usec_t timeout_usec,
2203 Hashmap *properties_list,
2204 UdevRuleLine **next_line) {
2205
2206 UdevRuleLine *line = rules->current_file->current_line;
2207 UdevRuleLineType mask = LINE_HAS_GOTO | LINE_UPDATE_SOMETHING;
2208 UdevRuleToken *token, *next_token;
2209 bool parents_done = false;
2210 DeviceAction action;
2211 int r;
2212
2213 r = device_get_action(event->dev, &action);
2214 if (r < 0)
2215 return r;
2216
2217 if (action != DEVICE_ACTION_REMOVE) {
2218 if (sd_device_get_devnum(event->dev, NULL) >= 0)
2219 mask |= LINE_HAS_DEVLINK;
2220
2221 if (sd_device_get_ifindex(event->dev, NULL) >= 0)
2222 mask |= LINE_HAS_NAME;
2223 }
2224
2225 if ((line->type & mask) == 0)
2226 return 0;
2227
2228 event->esc = ESCAPE_UNSET;
2229 LIST_FOREACH_SAFE(tokens, token, next_token, line->tokens) {
2230 line->current_token = token;
2231
2232 if (token_is_for_parents(token)) {
2233 if (parents_done)
2234 continue;
2235
2236 r = udev_rule_apply_parent_token_to_event(rules, event);
2237 if (r <= 0)
2238 return r;
2239
2240 parents_done = true;
2241 continue;
2242 }
2243
2244 r = udev_rule_apply_token_to_event(rules, event->dev, event, timeout_usec, properties_list);
2245 if (r <= 0)
2246 return r;
2247 }
2248
2249 if (line->goto_line)
2250 *next_line = line->goto_line;
2251
2252 return 0;
2253 }
2254
2255 int udev_rules_apply_to_event(
2256 UdevRules *rules,
2257 UdevEvent *event,
2258 usec_t timeout_usec,
2259 Hashmap *properties_list) {
2260
2261 UdevRuleFile *file;
2262 UdevRuleLine *next_line;
2263 int r;
2264
2265 assert(rules);
2266 assert(event);
2267
2268 LIST_FOREACH(rule_files, file, rules->rule_files) {
2269 rules->current_file = file;
2270 LIST_FOREACH_SAFE(rule_lines, file->current_line, next_line, file->rule_lines) {
2271 r = udev_rule_apply_line_to_event(rules, event, timeout_usec, properties_list, &next_line);
2272 if (r < 0)
2273 return r;
2274 }
2275 }
2276
2277 return 0;
2278 }
2279
2280 static int apply_static_dev_perms(const char *devnode, uid_t uid, gid_t gid, mode_t mode, char **tags) {
2281 char device_node[UTIL_PATH_SIZE], tags_dir[UTIL_PATH_SIZE], tag_symlink[UTIL_PATH_SIZE];
2282 _cleanup_free_ char *unescaped_filename = NULL;
2283 struct stat stats;
2284 char **t;
2285 int r;
2286
2287 assert(devnode);
2288
2289 if (uid == UID_INVALID && gid == GID_INVALID && mode == MODE_INVALID && !tags)
2290 return 0;
2291
2292 strscpyl(device_node, sizeof(device_node), "/dev/", devnode, NULL);
2293 if (stat(device_node, &stats) < 0) {
2294 if (errno != ENOENT)
2295 return log_error_errno(errno, "Failed to stat %s: %m", device_node);
2296 return 0;
2297 }
2298
2299 if (!S_ISBLK(stats.st_mode) && !S_ISCHR(stats.st_mode)) {
2300 log_warning("%s is neither block nor character device, ignoring.", device_node);
2301 return 0;
2302 }
2303
2304 if (!strv_isempty(tags)) {
2305 unescaped_filename = xescape(devnode, "/.");
2306 if (!unescaped_filename)
2307 return log_oom();
2308 }
2309
2310 /* export the tags to a directory as symlinks, allowing otherwise dead nodes to be tagged */
2311 STRV_FOREACH(t, tags) {
2312 strscpyl(tags_dir, sizeof(tags_dir), "/run/udev/static_node-tags/", *t, "/", NULL);
2313 r = mkdir_p(tags_dir, 0755);
2314 if (r < 0)
2315 return log_error_errno(r, "Failed to create %s: %m", tags_dir);
2316
2317 strscpyl(tag_symlink, sizeof(tag_symlink), tags_dir, unescaped_filename, NULL);
2318 r = symlink(device_node, tag_symlink);
2319 if (r < 0 && errno != EEXIST)
2320 return log_error_errno(errno, "Failed to create symlink %s -> %s: %m",
2321 tag_symlink, device_node);
2322 }
2323
2324 /* don't touch the permissions if only the tags were set */
2325 if (uid == UID_INVALID && gid == GID_INVALID && mode == MODE_INVALID)
2326 return 0;
2327
2328 if (mode == MODE_INVALID)
2329 mode = gid_is_valid(gid) ? 0660 : 0600;
2330 if (!uid_is_valid(uid))
2331 uid = 0;
2332 if (!gid_is_valid(gid))
2333 gid = 0;
2334
2335 r = chmod_and_chown(device_node, mode, uid, gid);
2336 if (r == -ENOENT)
2337 return 0;
2338 if (r < 0)
2339 return log_error_errno(r, "Failed to chown '%s' %u %u: %m", device_node, uid, gid);
2340 else
2341 log_debug("chown '%s' %u:%u with mode %#o", device_node, uid, gid, mode);
2342
2343 (void) utimensat(AT_FDCWD, device_node, NULL, 0);
2344 return 0;
2345 }
2346
2347 static int udev_rule_line_apply_static_dev_perms(UdevRuleLine *rule_line) {
2348 UdevRuleToken *token;
2349 _cleanup_strv_free_ char **tags = NULL;
2350 uid_t uid = UID_INVALID;
2351 gid_t gid = GID_INVALID;
2352 mode_t mode = MODE_INVALID;
2353 int r;
2354
2355 assert(rule_line);
2356
2357 if (!FLAGS_SET(rule_line->type, LINE_HAS_STATIC_NODE))
2358 return 0;
2359
2360 LIST_FOREACH(tokens, token, rule_line->tokens)
2361 if (token->type == TK_A_OWNER_ID)
2362 uid = PTR_TO_UID(token->data);
2363 else if (token->type == TK_A_GROUP_ID)
2364 gid = PTR_TO_GID(token->data);
2365 else if (token->type == TK_A_MODE_ID)
2366 mode = PTR_TO_MODE(token->data);
2367 else if (token->type == TK_A_TAG) {
2368 r = strv_extend(&tags, token->value);
2369 if (r < 0)
2370 return log_oom();
2371 } else if (token->type == TK_A_OPTIONS_STATIC_NODE) {
2372 r = apply_static_dev_perms(token->value, uid, gid, mode, tags);
2373 if (r < 0)
2374 return r;
2375 }
2376
2377 return 0;
2378 }
2379
2380 int udev_rules_apply_static_dev_perms(UdevRules *rules) {
2381 UdevRuleFile *file;
2382 UdevRuleLine *line;
2383 int r;
2384
2385 assert(rules);
2386
2387 LIST_FOREACH(rule_files, file, rules->rule_files)
2388 LIST_FOREACH(rule_lines, line, file->rule_lines) {
2389 r = udev_rule_line_apply_static_dev_perms(line);
2390 if (r < 0)
2391 return r;
2392 }
2393
2394 return 0;
2395 }
Unnamed repository; edit this file 'description' to name the repository.