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", rules->bufsize);
40 struct udev_rule *udev_rules_iter_next(struct udev_rules *rules)
42 static struct udev_rule *rule;
47 dbg("current=%zi", rules->current);
48 if (rules->current >= rules->bufsize) {
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", rules->current);
66 if (rules->current >= rules->bufsize) {
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'", label);
74 rules->current += sizeof(struct udev_rule) + rule->bufsize;
78 dbg("found label '%s'", 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");
127 } else if (linepos[0] == '!' && linepos[1] == '=') {
128 *operation = KEY_OP_NOMATCH;
130 dbg("operator=nomatch");
131 } else if (linepos[0] == '+' && linepos[1] == '=') {
132 *operation = KEY_OP_ADD;
135 } else if (linepos[0] == '=') {
136 *operation = KEY_OP_ASSIGN;
138 dbg("operator=assign");
139 } else if (linepos[0] == ':' && linepos[1] == '=') {
140 *operation = KEY_OP_ASSIGN_FINAL;
142 dbg("operator=assign_final");
148 dbg("key='%s'", *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'", *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");
191 dbg("attribute='%s'", 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");
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;
251 /* get all the keys */
255 enum key_operation operation = KEY_OP_UNSET;
257 retval = get_key(&linepos, &key, &operation, &value);
261 if (strcasecmp(key, "ACTION") == 0) {
262 if (operation != KEY_OP_MATCH &&
263 operation != KEY_OP_NOMATCH) {
264 err("invalid ACTION operation");
267 add_rule_key(rule, &rule->action, operation, value);
272 if (strcasecmp(key, "DEVPATH") == 0) {
273 if (operation != KEY_OP_MATCH &&
274 operation != KEY_OP_NOMATCH) {
275 err("invalid DEVPATH operation");
278 add_rule_key(rule, &rule->devpath, operation, value);
283 if (strcasecmp(key, "KERNEL") == 0) {
284 if (operation != KEY_OP_MATCH &&
285 operation != KEY_OP_NOMATCH) {
286 err("invalid KERNEL operation");
289 add_rule_key(rule, &rule->kernel, operation, value);
294 if (strcasecmp(key, "SUBSYSTEM") == 0) {
295 if (operation != KEY_OP_MATCH &&
296 operation != KEY_OP_NOMATCH) {
297 err("invalid SUBSYSTEM operation");
300 /* bus, class, subsystem events should all be the same */
301 if (strcmp(value, "subsystem") == 0 ||
302 strcmp(value, "bus") == 0 ||
303 strcmp(value, "class") == 0) {
304 if (strcmp(value, "bus") == 0 || strcmp(value, "class") == 0)
305 err("'%s' must be specified as 'subsystem' "
306 "please fix it in %s:%u", value, filename, lineno);
307 add_rule_key(rule, &rule->subsystem, operation, "subsystem|class|bus");
309 add_rule_key(rule, &rule->subsystem, operation, value);
314 if (strcasecmp(key, "DRIVER") == 0) {
315 if (operation != KEY_OP_MATCH &&
316 operation != KEY_OP_NOMATCH) {
317 err("invalid DRIVER operation");
320 add_rule_key(rule, &rule->driver, operation, value);
325 if (strncasecmp(key, "ATTR{", sizeof("ATTR{")-1) == 0) {
326 attr = get_key_attribute(key + sizeof("ATTR")-1);
328 err("error parsing ATTR attribute");
331 if (add_rule_key_pair(rule, &rule->attr, operation, attr, value) != 0)
337 if (strcasecmp(key, "KERNELS") == 0 ||
338 strcasecmp(key, "ID") == 0) {
339 if (operation != KEY_OP_MATCH &&
340 operation != KEY_OP_NOMATCH) {
341 err("invalid KERNELS operation");
344 add_rule_key(rule, &rule->kernels, operation, value);
349 if (strcasecmp(key, "SUBSYSTEMS") == 0 ||
350 strcasecmp(key, "BUS") == 0) {
351 if (operation != KEY_OP_MATCH &&
352 operation != KEY_OP_NOMATCH) {
353 err("invalid SUBSYSTEMS operation");
356 add_rule_key(rule, &rule->subsystems, operation, value);
361 if (strcasecmp(key, "DRIVERS") == 0) {
362 if (operation != KEY_OP_MATCH &&
363 operation != KEY_OP_NOMATCH) {
364 err("invalid DRIVERS operation");
367 add_rule_key(rule, &rule->drivers, operation, value);
372 if (strncasecmp(key, "ATTRS{", sizeof("ATTRS{")-1) == 0 ||
373 strncasecmp(key, "SYSFS{", sizeof("SYSFS{")-1) == 0) {
374 if (operation != KEY_OP_MATCH &&
375 operation != KEY_OP_NOMATCH) {
376 err("invalid ATTRS operation");
379 attr = get_key_attribute(key + sizeof("ATTRS")-1);
381 err("error parsing ATTRS attribute");
384 if (strncmp(attr, "device/", 7) == 0)
385 err("the 'device' link is deprecated and will be removed from a future kernel, "
386 "please fix it in %s:%u", filename, lineno);
387 else if (strstr(attr, "../") != NULL)
388 err("do not reference parent sysfs directories directly, that may break with a future kernel, "
389 "please fix it in %s:%u", filename, lineno);
390 if (add_rule_key_pair(rule, &rule->attrs, operation, attr, value) != 0)
396 if (strncasecmp(key, "ENV{", sizeof("ENV{")-1) == 0) {
397 attr = get_key_attribute(key + sizeof("ENV")-1);
399 err("error parsing ENV attribute");
402 if (strncmp(attr, "PHYSDEV", 7) == 0)
404 if (add_rule_key_pair(rule, &rule->env, operation, attr, value) != 0)
410 if (strcasecmp(key, "PROGRAM") == 0) {
411 add_rule_key(rule, &rule->program, operation, value);
416 if (strcasecmp(key, "RESULT") == 0) {
417 if (operation != KEY_OP_MATCH &&
418 operation != KEY_OP_NOMATCH) {
419 err("invalid RESULT operation");
422 add_rule_key(rule, &rule->result, operation, value);
427 if (strncasecmp(key, "IMPORT", sizeof("IMPORT")-1) == 0) {
428 attr = get_key_attribute(key + sizeof("IMPORT")-1);
429 if (attr != NULL && strstr(attr, "program")) {
430 dbg("IMPORT will be executed");
431 rule->import_type = IMPORT_PROGRAM;
432 } else if (attr != NULL && strstr(attr, "file")) {
433 dbg("IMPORT will be included as file");
434 rule->import_type = IMPORT_FILE;
435 } else if (attr != NULL && strstr(attr, "parent")) {
436 dbg("IMPORT will include the parent values");
437 rule->import_type = IMPORT_PARENT;
439 /* figure it out if it is executable */
440 char file[PATH_SIZE];
444 strlcpy(file, value, sizeof(file));
445 pos = strchr(file, ' ');
449 /* allow programs in /lib/udev called without the path */
450 if (strchr(file, '/') == NULL) {
451 strlcpy(file, "/lib/udev/", sizeof(file));
452 strlcat(file, value, sizeof(file));
453 pos = strchr(file, ' ');
458 dbg("IMPORT auto mode for '%s'", file);
459 if (!lstat(file, &statbuf) && (statbuf.st_mode & S_IXUSR)) {
460 dbg("IMPORT is executable, will be executed (autotype)");
461 rule->import_type = IMPORT_PROGRAM;
463 dbg("IMPORT is not executable, will be included as file (autotype)");
464 rule->import_type = IMPORT_FILE;
467 add_rule_key(rule, &rule->import, operation, value);
472 if (strncasecmp(key, "TEST", sizeof("TEST")-1) == 0) {
473 if (operation != KEY_OP_MATCH &&
474 operation != KEY_OP_NOMATCH) {
475 err("invalid TEST operation");
478 attr = get_key_attribute(key + sizeof("TEST")-1);
480 rule->test_mode_mask = strtol(attr, NULL, 8);
481 add_rule_key(rule, &rule->test, operation, value);
486 if (strncasecmp(key, "RUN", sizeof("RUN")-1) == 0) {
487 attr = get_key_attribute(key + sizeof("RUN")-1);
489 if (strstr(attr, "ignore_error"))
490 rule->run_ignore_error = 1;
492 add_rule_key(rule, &rule->run, operation, value);
497 if (strcasecmp(key, "WAIT_FOR_SYSFS") == 0) {
498 add_rule_key(rule, &rule->wait_for_sysfs, operation, value);
503 if (strcasecmp(key, "LABEL") == 0) {
504 add_rule_key(rule, &rule->label, operation, value);
509 if (strcasecmp(key, "GOTO") == 0) {
510 add_rule_key(rule, &rule->goto_label, operation, value);
515 if (strncasecmp(key, "NAME", sizeof("NAME")-1) == 0) {
516 attr = get_key_attribute(key + sizeof("NAME")-1);
518 if (strstr(attr, "all_partitions") != NULL) {
519 dbg("creation of partition nodes requested");
520 rule->partitions = DEFAULT_PARTITIONS_COUNT;
522 if (strstr(attr, "ignore_remove") != NULL) {
523 dbg("remove event should be ignored");
524 rule->ignore_remove = 1;
527 if (value[0] == '\0')
528 dbg("name empty, node creation supressed");
529 add_rule_key(rule, &rule->name, operation, value);
533 if (strcasecmp(key, "SYMLINK") == 0) {
534 if (operation == KEY_OP_MATCH ||
535 operation == KEY_OP_NOMATCH)
536 add_rule_key(rule, &rule->symlink_match, operation, value);
538 add_rule_key(rule, &rule->symlink, operation, value);
543 if (strcasecmp(key, "OWNER") == 0) {
545 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
547 strtoul(value, &endptr, 10);
548 if (endptr[0] != '\0') {
550 uid_t uid = lookup_user(value);
551 dbg("replacing username='%s' by id=%i", value, uid);
552 sprintf(owner, "%u", (unsigned int) uid);
553 add_rule_key(rule, &rule->owner, operation, owner);
558 add_rule_key(rule, &rule->owner, operation, value);
562 if (strcasecmp(key, "GROUP") == 0) {
564 if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
566 strtoul(value, &endptr, 10);
567 if (endptr[0] != '\0') {
569 gid_t gid = lookup_group(value);
570 dbg("replacing groupname='%s' by id=%i", value, gid);
571 sprintf(group, "%u", (unsigned int) gid);
572 add_rule_key(rule, &rule->group, operation, group);
577 add_rule_key(rule, &rule->group, operation, value);
581 if (strcasecmp(key, "MODE") == 0) {
582 rule->mode = strtol(value, NULL, 8);
583 rule->mode_operation = operation;
588 if (strcasecmp(key, "OPTIONS") == 0) {
591 if (strstr(value, "last_rule") != NULL) {
592 dbg("last rule to be applied");
595 if (strstr(value, "ignore_device") != NULL) {
596 dbg("device should be ignored");
597 rule->ignore_device = 1;
599 if (strstr(value, "ignore_remove") != NULL) {
600 dbg("remove event should be ignored");
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", rule->link_priority);
608 pos = strstr(value, "string_escape=");
610 pos = &pos[strlen("string_escape=")];
611 if (strncmp(pos, "none", strlen("none")) == 0)
612 rule->string_escape = ESCAPE_NONE;
613 else if (strncmp(pos, "replace", strlen("replace")) == 0)
614 rule->string_escape = ESCAPE_REPLACE;
616 if (strstr(value, "all_partitions") != NULL) {
617 dbg("creation of partition nodes requested");
618 rule->partitions = DEFAULT_PARTITIONS_COUNT;
624 err("unknown key '%s' in %s:%u", key, filename, lineno);
627 if (physdev && rule->wait_for_sysfs.operation == KEY_OP_UNSET)
628 err("PHYSDEV* values are deprecated and will be removed from a future kernel, "
629 "please fix it in %s:%u", filename, lineno);
631 /* skip line if not any valid key was found */
635 /* grow buffer and add rule */
636 rule_size = sizeof(struct udev_rule) + rule->bufsize;
637 padding = (sizeof(size_t) - rule_size % sizeof(size_t)) % sizeof(size_t);
638 dbg("add %zi padding bytes", padding);
639 rule_size += padding;
640 rule->bufsize += padding;
642 rules->buf = realloc(rules->buf, rules->bufsize + rule_size);
644 err("realloc failed");
647 dbg("adding rule to offset %zi", rules->bufsize);
648 memcpy(rules->buf + rules->bufsize, rule, rule_size);
649 rules->bufsize += rule_size;
654 err("invalid rule '%s:%u'", filename, lineno);
658 static int parse_file(struct udev_rules *rules, const char *filename)
660 char line[LINE_SIZE];
669 if (file_map(filename, &buf, &bufsize) != 0) {
670 err("can't open '%s' as rules file: %s", filename, strerror(errno));
673 info("reading '%s' as rules file", filename);
675 /* loop through the whole file */
678 while (cur < bufsize) {
681 count = buf_get_line(buf, bufsize, cur);
686 /* eat the whitespace */
687 while ((count > 0) && isspace(bufline[0])) {
694 /* see if this is a comment */
695 if (bufline[0] == COMMENT_CHARACTER)
698 if (count >= sizeof(line)) {
699 err("line too long, rule skipped '%s:%u'", filename, lineno);
703 /* skip backslash and newline from multiline rules */
704 for (i = j = 0; i < count; i++) {
705 if (bufline[i] == '\\' && bufline[i+1] == '\n')
708 line[j++] = bufline[i];
712 dbg("read '%s'", line);
713 add_to_rules(rules, line, filename, lineno);
716 file_unmap(buf, bufsize);
720 int udev_rules_init(struct udev_rules *rules, int resolve_names)
723 char filename[PATH_MAX];
724 LIST_HEAD(name_list);
726 struct name_entry *name_loop, *name_tmp;
727 struct name_entry *dyn_loop, *dyn_tmp;
730 memset(rules, 0x00, sizeof(struct udev_rules));
731 rules->resolve_names = resolve_names;
733 /* read main config from single file or all files in a directory */
734 if (stat(udev_rules_dir, &statbuf) != 0)
736 if ((statbuf.st_mode & S_IFMT) != S_IFDIR) {
737 dbg("parse single rules file '%s'", udev_rules_dir);
738 name_list_add(&name_list, udev_rules_dir, 1);
740 dbg("parse rules directory '%s'", udev_rules_dir);
741 retval = add_matching_files(&name_list, udev_rules_dir, RULESFILE_SUFFIX);
744 /* read dynamic rules directory */
745 strlcpy(filename, udev_root, sizeof(filename));
746 strlcat(filename, "/"RULES_DYN_DIR, sizeof(filename));
747 if (stat(filename, &statbuf) != 0) {
748 create_path(filename);
749 selinux_setfscreatecon(filename, NULL, S_IFDIR|0755);
750 mkdir(filename, 0755);
751 selinux_resetfscreatecon();
753 add_matching_files(&dyn_list, filename, RULESFILE_SUFFIX);
755 /* sort dynamic rules files by basename into list of files */
756 list_for_each_entry_safe(dyn_loop, dyn_tmp, &dyn_list, node) {
757 const char *dyn_base = strrchr(dyn_loop->name, '/');
759 if (dyn_base == NULL)
762 list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
763 const char *name_base = strrchr(name_loop->name, '/');
765 if (name_base == NULL)
768 if (strcmp(name_base, dyn_base) > 0)
771 list_move_tail(&dyn_loop->node, &name_loop->node);
774 /* parse list of files */
775 list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
776 if (stat(name_loop->name, &statbuf) == 0) {
778 parse_file(rules, name_loop->name);
780 dbg("empty rules file '%s'", name_loop->name);
782 err("could not read '%s': %s", name_loop->name, strerror(errno));
783 list_del(&name_loop->node);
790 void udev_rules_cleanup(struct udev_rules *rules)