2 * Copyright (C) 2003,2004 Greg Kroah-Hartman <greg@kroah.com>
3 * Copyright (C) 2003-2006 Kay Sievers <kay.sievers@vrfy.org>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
30 #include "udev_rules.h"
31 #include "udev_selinux.h"
34 void udev_rules_iter_init(struct udev_rules *rules)
36 dbg("bufsize=%zi\n", rules->bufsize);
40 struct udev_rule *udev_rules_iter_next(struct udev_rules *rules)
42 static struct udev_rule *rule;
47 dbg("current=%zi\n", rules->current);
48 if (rules->current >= rules->bufsize) {
49 dbg("no more rules\n");
54 rule = (struct udev_rule *) (rules->buf + rules->current);
55 rules->current += sizeof(struct udev_rule) + rule->bufsize;
60 struct udev_rule *udev_rules_iter_label(struct udev_rules *rules, const char *label)
62 static struct udev_rule *rule;
65 dbg("current=%zi\n", rules->current);
66 if (rules->current >= rules->bufsize) {
67 dbg("no more rules\n");
70 rule = (struct udev_rule *) (rules->buf + rules->current);
72 if (strcmp(&rule->buf[rule->label.val_off], label) != 0) {
73 dbg("moving forward, looking for label '%s'\n", label);
74 rules->current += sizeof(struct udev_rule) + rule->bufsize;
78 dbg("found label '%s'\n", label);
82 static int get_key(char **line, char **key, enum key_operation *operation, char **value)
88 if (linepos == NULL && linepos[0] == '\0')
92 while (isspace(linepos[0]) || linepos[0] == ',')
96 if (linepos[0] == '\0')
102 if (linepos[0] == '\0')
104 if (isspace(linepos[0]))
106 if (linepos[0] == '=')
108 if ((linepos[0] == '+') || (linepos[0] == '!') || (linepos[0] == ':'))
109 if (linepos[1] == '=')
113 /* remember end of key */
116 /* skip whitespace after key */
117 while (isspace(linepos[0]))
119 if (linepos[0] == '\0')
122 /* get operation type */
123 if (linepos[0] == '=' && linepos[1] == '=') {
124 *operation = KEY_OP_MATCH;
126 dbg("operator=match\n");
127 } else if (linepos[0] == '!' && linepos[1] == '=') {
128 *operation = KEY_OP_NOMATCH;
130 dbg("operator=nomatch\n");
131 } else if (linepos[0] == '+' && linepos[1] == '=') {
132 *operation = KEY_OP_ADD;
134 dbg("operator=add\n");
135 } else if (linepos[0] == '=') {
136 *operation = KEY_OP_ASSIGN;
138 dbg("operator=assign\n");
139 } else if (linepos[0] == ':' && linepos[1] == '=') {
140 *operation = KEY_OP_ASSIGN_FINAL;
142 dbg("operator=assign_final\n");
148 dbg("key='%s'\n", *key);
150 /* skip whitespace after operator */
151 while (isspace(linepos[0]))
153 if (linepos[0] == '\0')
157 if (linepos[0] == '"')
163 temp = strchr(linepos, '"');
168 dbg("value='%s'\n", *value);
170 /* move line to next key */
176 /* extract possible KEY{attr} */
177 static char *get_key_attribute(char *str)
182 attr = strchr(str, '{');
185 pos = strchr(attr, '}');
187 err("missing closing brace for format\n");
191 dbg("attribute='%s'\n", attr);
198 static int add_rule_key(struct udev_rule *rule, struct key *key,
199 enum key_operation operation, const char *value)
201 size_t val_len = strnlen(value, PATH_SIZE);
203 key->operation = operation;
205 key->val_off = rule->bufsize;
206 strlcpy(rule->buf + rule->bufsize, value, val_len+1);
207 rule->bufsize += val_len+1;
212 static int add_rule_key_pair(struct udev_rule *rule, struct key_pairs *pairs,
213 enum key_operation operation, const char *key, const char *value)
215 size_t key_len = strnlen(key, PATH_SIZE);
217 if (pairs->count >= PAIRS_MAX) {
218 err("skip, too many keys of the same type in a single rule\n");
222 add_rule_key(rule, &pairs->keys[pairs->count].key, operation, value);
224 /* add the key-name of the pair */
225 pairs->keys[pairs->count].key_name_off = rule->bufsize;
226 strlcpy(rule->buf + rule->bufsize, key, key_len+1);
227 rule->bufsize += key_len+1;
234 static int add_to_rules(struct udev_rules *rules, char *line, const char *filename, unsigned int lineno)
236 char buf[sizeof(struct udev_rule) + LINE_SIZE];
237 struct udev_rule *rule;
246 memset(buf, 0x00, sizeof(buf));
247 rule = (struct udev_rule *) buf;
248 rule->event_timeout = -1;
252 /* get all the keys */
256 enum key_operation operation = KEY_OP_UNSET;
258 retval = get_key(&linepos, &key, &operation, &value);
262 if (strcasecmp(key, "ACTION") == 0) {
263 if (operation != KEY_OP_MATCH &&
264 operation != KEY_OP_NOMATCH) {
265 err("invalid ACTION operation\n");
268 add_rule_key(rule, &rule->action, operation, value);
273 if (strcasecmp(key, "DEVPATH") == 0) {
274 if (operation != KEY_OP_MATCH &&
275 operation != KEY_OP_NOMATCH) {
276 err("invalid DEVPATH operation\n");
279 add_rule_key(rule, &rule->devpath, operation, value);
284 if (strcasecmp(key, "KERNEL") == 0) {
285 if (operation != KEY_OP_MATCH &&
286 operation != KEY_OP_NOMATCH) {
287 err("invalid KERNEL operation\n");
290 add_rule_key(rule, &rule->kernel, operation, value);
295 if (strcasecmp(key, "SUBSYSTEM") == 0) {
296 if (operation != KEY_OP_MATCH &&
297 operation != KEY_OP_NOMATCH) {
298 err("invalid SUBSYSTEM operation\n");
301 /* bus, class, subsystem events should all be the same */
302 if (strcmp(value, "subsystem") == 0 ||
303 strcmp(value, "bus") == 0 ||
304 strcmp(value, "class") == 0) {
305 if (strcmp(value, "bus") == 0 || strcmp(value, "class") == 0)
306 err("'%s' must be specified as 'subsystem' \n"
307 "please fix it in %s:%u", value, filename, lineno);
308 add_rule_key(rule, &rule->subsystem, operation, "subsystem|class|bus");
310 add_rule_key(rule, &rule->subsystem, operation, value);
315 if (strcasecmp(key, "DRIVER") == 0) {
316 if (operation != KEY_OP_MATCH &&
317 operation != KEY_OP_NOMATCH) {
318 err("invalid DRIVER operation\n");
321 add_rule_key(rule, &rule->driver, operation, value);
326 if (strncasecmp(key, "ATTR{", sizeof("ATTR{")-1) == 0) {
327 attr = get_key_attribute(key + sizeof("ATTR")-1);
329 err("error parsing ATTR attribute\n");
332 if (add_rule_key_pair(rule, &rule->attr, operation, attr, value) != 0)
338 if (strcasecmp(key, "KERNELS") == 0 ||
339 strcasecmp(key, "ID") == 0) {
340 if (operation != KEY_OP_MATCH &&
341 operation != KEY_OP_NOMATCH) {
342 err("invalid KERNELS operation\n");
345 add_rule_key(rule, &rule->kernels, operation, value);
350 if (strcasecmp(key, "SUBSYSTEMS") == 0 ||
351 strcasecmp(key, "BUS") == 0) {
352 if (operation != KEY_OP_MATCH &&
353 operation != KEY_OP_NOMATCH) {
354 err("invalid SUBSYSTEMS operation\n");
357 add_rule_key(rule, &rule->subsystems, operation, value);
362 if (strcasecmp(key, "DRIVERS") == 0) {
363 if (operation != KEY_OP_MATCH &&
364 operation != KEY_OP_NOMATCH) {
365 err("invalid DRIVERS operation\n");
368 add_rule_key(rule, &rule->drivers, operation, value);
373 if (strncasecmp(key, "ATTRS{", sizeof("ATTRS{")-1) == 0 ||
374 strncasecmp(key, "SYSFS{", sizeof("SYSFS{")-1) == 0) {
375 if (operation != KEY_OP_MATCH &&
376 operation != KEY_OP_NOMATCH) {
377 err("invalid ATTRS operation\n");
380 attr = get_key_attribute(key + sizeof("ATTRS")-1);
382 err("error parsing ATTRS attribute\n");
385 if (strncmp(attr, "device/", 7) == 0)
386 err("the 'device' link is deprecated and will be removed from a future kernel, \n"
387 "please fix it in %s:%u", filename, lineno);
388 else if (strstr(attr, "../") != NULL)
389 err("do not reference parent sysfs directories directly, that may break with a future kernel, \n"
390 "please fix it in %s:%u", filename, lineno);
391 if (add_rule_key_pair(rule, &rule->attrs, operation, attr, value) != 0)
397 if (strncasecmp(key, "ENV{", sizeof("ENV{")-1) == 0) {
398 attr = get_key_attribute(key + sizeof("ENV")-1);
400 err("error parsing ENV attribute\n");
403 if (strncmp(attr, "PHYSDEV", 7) == 0)
405 if (add_rule_key_pair(rule, &rule->env, operation, attr, value) != 0)
411 if (strcasecmp(key, "PROGRAM") == 0) {
412 add_rule_key(rule, &rule->program, operation, value);
417 if (strcasecmp(key, "RESULT") == 0) {
418 if (operation != KEY_OP_MATCH &&
419 operation != KEY_OP_NOMATCH) {
420 err("invalid RESULT operation\n");
423 add_rule_key(rule, &rule->result, operation, value);
428 if (strncasecmp(key, "IMPORT", sizeof("IMPORT")-1) == 0) {
429 attr = get_key_attribute(key + sizeof("IMPORT")-1);
430 if (attr != NULL && strstr(attr, "program")) {
431 dbg("IMPORT will be executed\n");
432 rule->import_type = IMPORT_PROGRAM;
433 } else if (attr != NULL && strstr(attr, "file")) {
434 dbg("IMPORT will be included as file\n");
435 rule->import_type = IMPORT_FILE;
436 } else if (attr != NULL && strstr(attr, "parent")) {
437 dbg("IMPORT will include the parent values\n");
438 rule->import_type = IMPORT_PARENT;
440 /* figure it out if it is executable */
441 char file[PATH_SIZE];
445 strlcpy(file, value, sizeof(file));
446 pos = strchr(file, ' ');
450 /* allow programs in /lib/udev called without the path */
451 if (strchr(file, '/') == NULL) {
452 strlcpy(file, "/lib/udev/", sizeof(file));
453 strlcat(file, value, sizeof(file));
454 pos = strchr(file, ' ');
459 dbg("IMPORT auto mode for '%s'\n", file);
460 if (!lstat(file, &statbuf) && (statbuf.st_mode & S_IXUSR)) {
461 dbg("IMPORT is executable, will be executed (autotype)\n");
462 rule->import_type = IMPORT_PROGRAM;
464 dbg("IMPORT is not executable, will be included as file (autotype)\n");
465 rule->import_type = IMPORT_FILE;
468 add_rule_key(rule, &rule->import, operation, value);
473 if (strncasecmp(key, "TEST", sizeof("TEST")-1) == 0) {
474 if (operation != KEY_OP_MATCH &&
475 operation != KEY_OP_NOMATCH) {
476 err("invalid TEST operation\n");
479 attr = get_key_attribute(key + sizeof("TEST")-1);
481 rule->test_mode_mask = strtol(attr, NULL, 8);
482 add_rule_key(rule, &rule->test, operation, value);
487 if (strncasecmp(key, "RUN", sizeof("RUN")-1) == 0) {
488 attr = get_key_attribute(key + sizeof("RUN")-1);
490 if (strstr(attr, "ignore_error"))
491 rule->run_ignore_error = 1;
493 add_rule_key(rule, &rule->run, operation, value);
498 if (strcasecmp(key, "WAIT_FOR") == 0 || strcasecmp(key, "WAIT_FOR_SYSFS") == 0) {
499 add_rule_key(rule, &rule->wait_for, operation, value);
504 if (strcasecmp(key, "LABEL") == 0) {
505 add_rule_key(rule, &rule->label, operation, value);
510 if (strcasecmp(key, "GOTO") == 0) {
511 add_rule_key(rule, &rule->goto_label, operation, value);
516 if (strncasecmp(key, "NAME", sizeof("NAME")-1) == 0) {
517 attr = get_key_attribute(key + sizeof("NAME")-1);
519 if (strstr(attr, "all_partitions") != NULL) {
520 dbg("creation of partition nodes requested\n");
521 rule->partitions = DEFAULT_PARTITIONS_COUNT;
523 if (strstr(attr, "ignore_remove") != NULL) {
524 dbg("remove event should be ignored\n");
525 rule->ignore_remove = 1;
528 if (value[0] == '\0')
529 dbg("name empty, node creation supressed\n");
530 add_rule_key(rule, &rule->name, operation, value);
534 if (strcasecmp(key, "SYMLINK") == 0) {
535 if (operation == KEY_OP_MATCH ||
536 operation == KEY_OP_NOMATCH)
537 add_rule_key(rule, &rule->symlink_match, operation, value);
539 add_rule_key(rule, &rule->symlink, operation, value);
544 if (strcasecmp(key, "OWNER") == 0) {
546 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
548 strtoul(value, &endptr, 10);
549 if (endptr[0] != '\0') {
551 uid_t uid = lookup_user(value);
552 dbg("replacing username='%s' by id=%i\n", value, uid);
553 sprintf(owner, "%u", (unsigned int) uid);
554 add_rule_key(rule, &rule->owner, operation, owner);
559 add_rule_key(rule, &rule->owner, operation, value);
563 if (strcasecmp(key, "GROUP") == 0) {
565 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
567 strtoul(value, &endptr, 10);
568 if (endptr[0] != '\0') {
570 gid_t gid = lookup_group(value);
571 dbg("replacing groupname='%s' by id=%i\n", value, gid);
572 sprintf(group, "%u", (unsigned int) gid);
573 add_rule_key(rule, &rule->group, operation, group);
578 add_rule_key(rule, &rule->group, operation, value);
582 if (strcasecmp(key, "MODE") == 0) {
583 add_rule_key(rule, &rule->mode, operation, value);
588 if (strcasecmp(key, "OPTIONS") == 0) {
591 if (strstr(value, "last_rule") != NULL) {
592 dbg("last rule to be applied\n");
595 if (strstr(value, "ignore_device") != NULL) {
596 dbg("device should be ignored\n");
597 rule->ignore_device = 1;
599 if (strstr(value, "ignore_remove") != NULL) {
600 dbg("remove event should be ignored\n");
601 rule->ignore_remove = 1;
603 pos = strstr(value, "link_priority=");
605 rule->link_priority = atoi(&pos[strlen("link_priority=")]);
606 dbg("link priority=%i\n", rule->link_priority);
608 pos = strstr(value, "event_timeout=");
610 rule->event_timeout = atoi(&pos[strlen("event_timeout=")]);
611 dbg("event timout=%i\n", rule->event_timeout);
613 pos = strstr(value, "string_escape=");
615 pos = &pos[strlen("string_escape=")];
616 if (strncmp(pos, "none", strlen("none")) == 0)
617 rule->string_escape = ESCAPE_NONE;
618 else if (strncmp(pos, "replace", strlen("replace")) == 0)
619 rule->string_escape = ESCAPE_REPLACE;
621 if (strstr(value, "all_partitions") != NULL) {
622 dbg("creation of partition nodes requested\n");
623 rule->partitions = DEFAULT_PARTITIONS_COUNT;
629 err("unknown key '%s' in %s:%u\n", key, filename, lineno);
632 if (physdev && rule->wait_for.operation == KEY_OP_UNSET)
633 err("PHYSDEV* values are deprecated and will be removed from a future kernel, \n"
634 "please fix it in %s:%u", filename, lineno);
636 /* skip line if not any valid key was found */
640 /* grow buffer and add rule */
641 rule_size = sizeof(struct udev_rule) + rule->bufsize;
642 padding = (sizeof(size_t) - rule_size % sizeof(size_t)) % sizeof(size_t);
643 dbg("add %zi padding bytes\n", padding);
644 rule_size += padding;
645 rule->bufsize += padding;
647 rules->buf = realloc(rules->buf, rules->bufsize + rule_size);
649 err("realloc failed\n");
652 dbg("adding rule to offset %zi\n", rules->bufsize);
653 memcpy(rules->buf + rules->bufsize, rule, rule_size);
654 rules->bufsize += rule_size;
659 err("invalid rule '%s:%u'\n", filename, lineno);
663 static int parse_file(struct udev_rules *rules, const char *filename)
665 char line[LINE_SIZE];
674 if (file_map(filename, &buf, &bufsize) != 0) {
675 err("can't open '%s' as rules file: %s\n", filename, strerror(errno));
678 info("reading '%s' as rules file\n", filename);
680 /* loop through the whole file */
683 while (cur < bufsize) {
686 count = buf_get_line(buf, bufsize, cur);
691 /* eat the whitespace */
692 while ((count > 0) && isspace(bufline[0])) {
699 /* see if this is a comment */
700 if (bufline[0] == COMMENT_CHARACTER)
703 if (count >= sizeof(line)) {
704 err("line too long, rule skipped '%s:%u'\n", filename, lineno);
708 /* skip backslash and newline from multiline rules */
709 for (i = j = 0; i < count; i++) {
710 if (bufline[i] == '\\' && bufline[i+1] == '\n')
713 line[j++] = bufline[i];
717 dbg("read '%s'\n", line);
718 add_to_rules(rules, line, filename, lineno);
721 file_unmap(buf, bufsize);
725 int udev_rules_init(struct udev_rules *rules, int resolve_names)
728 char filename[PATH_MAX];
729 LIST_HEAD(name_list);
731 struct name_entry *name_loop, *name_tmp;
732 struct name_entry *dyn_loop, *dyn_tmp;
735 memset(rules, 0x00, sizeof(struct udev_rules));
736 rules->resolve_names = resolve_names;
738 /* read main config from single file or all files in a directory */
739 if (stat(udev_rules_dir, &statbuf) != 0)
741 if ((statbuf.st_mode & S_IFMT) != S_IFDIR) {
742 dbg("parse single rules file '%s'\n", udev_rules_dir);
743 name_list_add(&name_list, udev_rules_dir, 1);
745 dbg("parse rules directory '%s'\n", udev_rules_dir);
746 retval = add_matching_files(&name_list, udev_rules_dir, RULESFILE_SUFFIX);
749 /* read dynamic rules directory */
750 strlcpy(filename, udev_root, sizeof(filename));
751 strlcat(filename, "/"RULES_DYN_DIR, sizeof(filename));
752 if (stat(filename, &statbuf) != 0) {
753 create_path(filename);
754 selinux_setfscreatecon(filename, NULL, S_IFDIR|0755);
755 mkdir(filename, 0755);
756 selinux_resetfscreatecon();
758 add_matching_files(&dyn_list, filename, RULESFILE_SUFFIX);
760 /* sort dynamic rules files by basename into list of files */
761 list_for_each_entry_safe(dyn_loop, dyn_tmp, &dyn_list, node) {
762 const char *dyn_base = strrchr(dyn_loop->name, '/');
764 if (dyn_base == NULL)
767 list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
768 const char *name_base = strrchr(name_loop->name, '/');
770 if (name_base == NULL)
773 if (strcmp(name_base, dyn_base) > 0)
776 list_move_tail(&dyn_loop->node, &name_loop->node);
779 /* parse list of files */
780 list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
781 if (stat(name_loop->name, &statbuf) == 0) {
783 parse_file(rules, name_loop->name);
785 dbg("empty rules file '%s'\n", name_loop->name);
787 err("could not read '%s': %s\n", name_loop->name, strerror(errno));
788 list_del(&name_loop->node);
795 void udev_rules_cleanup(struct udev_rules *rules)