udev_rules_parse.c

   1 /*
   2  * udev_rules_parse.c
   3  *
   4  * Copyright (C) 2003,2004 Greg Kroah-Hartman <greg@kroah.com>
   5  * Copyright (C) 2003-2005 Kay Sievers <kay.sievers@vrfy.org>
   6  *
   7  *      This program is free software; you can redistribute it and/or modify it
   8  *      under the terms of the GNU General Public License as published by the
   9  *      Free Software Foundation version 2 of the License.
  10  *
  11  *      This program is distributed in the hope that it will be useful, but
  12  *      WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  *      General Public License for more details.
  15  *
  16  *      You should have received a copy of the GNU General Public License along
  17  *      with this program; if not, write to the Free Software Foundation, Inc.,
  18  *      675 Mass Ave, Cambridge, MA 02139, USA.
  19  *
  20  */
  21
  22 #include <stddef.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <stdio.h>
  26 #include <ctype.h>
  27 #include <unistd.h>
  28 #include <sys/stat.h>
  29 #include <errno.h>
  30
  31 #include "udev.h"
  32 #include "udev_rules.h"
  33
  34
  35 void udev_rules_iter_init(struct udev_rules *rules)
  36 {
  37         dbg("bufsize=%zi", rules->bufsize);
  38         rules->current = 0;
  39 }
  40
  41 struct udev_rule *udev_rules_iter_next(struct udev_rules *rules)
  42 {
  43         static struct udev_rule *rule;
  44
  45         if (!rules)
  46                 return NULL;
  47
  48         dbg("current=%zi", rules->current);
  49         if (rules->current >= rules->bufsize) {
  50                 dbg("no more rules");
  51                 return NULL;
  52         }
  53
  54         /* get next rule */
  55         rule = (struct udev_rule *) (rules->buf + rules->current);
  56         rules->current += sizeof(struct udev_rule) + rule->bufsize;
  57
  58         return rule;
  59 }
  60
  61 struct udev_rule *udev_rules_iter_label(struct udev_rules *rules, const char *label)
  62 {
  63         static struct udev_rule *rule;
  64
  65 next:
  66         dbg("current=%zi", rules->current);
  67         if (rules->current >= rules->bufsize) {
  68                 dbg("no more rules");
  69                 return NULL;
  70         }
  71         rule = (struct udev_rule *) (rules->buf + rules->current);
  72
  73         if (strcmp(&rule->buf[rule->label.val_off], label) != 0) {
  74                 dbg("moving forward, looking for label '%s'", label);
  75                 rules->current += sizeof(struct udev_rule) + rule->bufsize;
  76                 goto next;
  77         }
  78
  79         dbg("found label '%s'", label);
  80         return rule;
  81 }
  82
  83 static int get_key(char **line, char **key, enum key_operation *operation, char **value)
  84 {
  85         char *linepos;
  86         char *temp;
  87
  88         linepos = *line;
  89         if (linepos == NULL && linepos[0] == '\0')
  90                 return -1;
  91
  92         /* skip whitespace */
  93         while (isspace(linepos[0]) || linepos[0] == ',')
  94                 linepos++;
  95
  96         /* get the key */
  97         if (linepos[0] == '\0')
  98                 return -1;
  99         *key = linepos;
 100
 101         while (1) {
 102                 linepos++;
 103                 if (linepos[0] == '\0')
 104                         return -1;
 105                 if (isspace(linepos[0]))
 106                         break;
 107                 if (linepos[0] == '=')
 108                         break;
 109                 if (linepos[0] == '+')
 110                         break;
 111                 if (linepos[0] == '!')
 112                         break;
 113                 if (linepos[0] == ':')
 114                         break;
 115         }
 116
 117         /* remember end of key */
 118         temp = linepos;
 119
 120         /* skip whitespace after key */
 121         while (isspace(linepos[0]))
 122                 linepos++;
 123         if (linepos[0] == '\0')
 124                 return -1;
 125
 126         /* get operation type */
 127         if (linepos[0] == '=' && linepos[1] == '=') {
 128                 *operation = KEY_OP_MATCH;
 129                 linepos += 2;
 130                 dbg("operator=match");
 131         } else if (linepos[0] == '!' && linepos[1] == '=') {
 132                 *operation = KEY_OP_NOMATCH;
 133                 linepos += 2;
 134                 dbg("operator=nomatch");
 135         } else if (linepos[0] == '+' && linepos[1] == '=') {
 136                 *operation = KEY_OP_ADD;
 137                 linepos += 2;
 138                 dbg("operator=add");
 139         } else if (linepos[0] == '=') {
 140                 *operation = KEY_OP_ASSIGN;
 141                 linepos++;
 142                 dbg("operator=assign");
 143         } else if (linepos[0] == ':' && linepos[1] == '=') {
 144                 *operation = KEY_OP_ASSIGN_FINAL;
 145                 linepos += 2;
 146                 dbg("operator=assign_final");
 147         } else
 148                 return -1;
 149
 150         /* terminate key */
 151         temp[0] = '\0';
 152         dbg("key='%s'", *key);
 153
 154         /* skip whitespace after operator */
 155         while (isspace(linepos[0]))
 156                 linepos++;
 157         if (linepos[0] == '\0')
 158                 return -1;
 159
 160         /* get the value*/
 161         if (linepos[0] == '"')
 162                 linepos++;
 163         else
 164                 return -1;
 165         *value = linepos;
 166
 167         temp = strchr(linepos, '"');
 168         if (!temp)
 169                 return -1;
 170         temp[0] = '\0';
 171         temp++;
 172         dbg("value='%s'", *value);
 173
 174         /* move line to next key */
 175         *line = temp;
 176
 177         return 0;
 178 }
 179
 180 /* extract possible KEY{attr} */
 181 static char *get_key_attribute(char *str)
 182 {
 183         char *pos;
 184         char *attr;
 185
 186         attr = strchr(str, '{');
 187         if (attr != NULL) {
 188                 attr++;
 189                 pos = strchr(attr, '}');
 190                 if (pos == NULL) {
 191                         err("missing closing brace for format");
 192                         return NULL;
 193                 }
 194                 pos[0] = '\0';
 195                 dbg("attribute='%s'", attr);
 196                 return attr;
 197         }
 198
 199         return NULL;
 200 }
 201
 202 static int add_rule_key(struct udev_rule *rule, struct key *key,
 203                         enum key_operation operation, const char *value)
 204 {
 205         size_t val_len = strnlen(value, PATH_SIZE);
 206
 207         key->operation = operation;
 208
 209         key->val_off = rule->bufsize;
 210         strlcpy(rule->buf + rule->bufsize, value, val_len+1);
 211         rule->bufsize += val_len+1;
 212
 213         return 0;
 214 }
 215
 216 static int add_rule_key_pair(struct udev_rule *rule, struct key_pairs *pairs,
 217                              enum key_operation operation, const char *key, const char *value)
 218 {
 219         size_t key_len = strnlen(key, PATH_SIZE);
 220
 221         if (pairs->count >= PAIRS_MAX) {
 222                 err("skip, too many keys in a single rule");
 223                 return -1;
 224         }
 225
 226         add_rule_key(rule, &pairs->keys[pairs->count].key, operation, value);
 227
 228         /* add the key-name of the pair */
 229         pairs->keys[pairs->count].key_name_off = rule->bufsize;
 230         strlcpy(rule->buf + rule->bufsize, key, key_len+1);
 231         rule->bufsize += key_len+1;
 232
 233         pairs->count++;
 234
 235         return 0;
 236 }
 237
 238 static int add_to_rules(struct udev_rules *rules, char *line, const char *filename, unsigned int lineno)
 239 {
 240         struct udev_rule *rule;
 241         size_t rule_size;
 242         int valid;
 243         char *linepos;
 244         char *attr;
 245         size_t padding;
 246         int retval;
 247
 248         /* get all the keys */
 249         rule = calloc(1, sizeof (struct udev_rule) + LINE_SIZE);
 250         if (!rule) {
 251                 err("malloc failed");
 252                 return -1;
 253         }
 254         linepos = line;
 255         valid = 0;
 256
 257         while (1) {
 258                 char *key;
 259                 char *value;
 260                 enum key_operation operation = KEY_OP_UNSET;
 261
 262                 retval = get_key(&linepos, &key, &operation, &value);
 263                 if (retval)
 264                         break;
 265
 266                 if (strcasecmp(key, "LABEL") == 0) {
 267                         add_rule_key(rule, &rule->label, operation, value);
 268                         valid = 1;
 269                         continue;
 270                 }
 271
 272                 if (strcasecmp(key, "GOTO") == 0) {
 273                         add_rule_key(rule, &rule->goto_label, operation, value);
 274                         valid = 1;
 275                         continue;
 276                 }
 277
 278                 if (strcasecmp(key, "KERNEL") == 0) {
 279                         if (operation != KEY_OP_MATCH &&
 280                             operation != KEY_OP_NOMATCH) {
 281                                 err("invalid KERNEL operation");
 282                                 goto invalid;
 283                         }
 284                         add_rule_key(rule, &rule->kernel_name, operation, value);
 285                         valid = 1;
 286                         continue;
 287                 }
 288
 289                 if (strcasecmp(key, "SUBSYSTEM") == 0) {
 290                         if (operation != KEY_OP_MATCH &&
 291                             operation != KEY_OP_NOMATCH) {
 292                                 err("invalid SUBSYSTEM operation");
 293                                 goto invalid;
 294                         }
 295                         add_rule_key(rule, &rule->subsystem, operation, value);
 296                         valid = 1;
 297                         continue;
 298                 }
 299
 300                 if (strcasecmp(key, "ACTION") == 0) {
 301                         if (operation != KEY_OP_MATCH &&
 302                             operation != KEY_OP_NOMATCH) {
 303                                 err("invalid ACTION operation");
 304                                 goto invalid;
 305                         }
 306                         add_rule_key(rule, &rule->action, operation, value);
 307                         valid = 1;
 308                         continue;
 309                 }
 310
 311                 if (strcasecmp(key, "DEVPATH") == 0) {
 312                         if (operation != KEY_OP_MATCH &&
 313                             operation != KEY_OP_NOMATCH) {
 314                                 err("invalid DEVPATH operation");
 315                                 goto invalid;
 316                         }
 317                         add_rule_key(rule, &rule->devpath, operation, value);
 318                         valid = 1;
 319                         continue;
 320                 }
 321
 322                 if (strcasecmp(key, "BUS") == 0) {
 323                         if (operation != KEY_OP_MATCH &&
 324                             operation != KEY_OP_NOMATCH) {
 325                                 err("invalid BUS operation");
 326                                 goto invalid;
 327                         }
 328                         add_rule_key(rule, &rule->bus, operation, value);
 329                         valid = 1;
 330                         continue;
 331                 }
 332
 333                 if (strcasecmp(key, "ID") == 0) {
 334                         if (operation != KEY_OP_MATCH &&
 335                             operation != KEY_OP_NOMATCH) {
 336                                 err("invalid ID operation");
 337                                 goto invalid;
 338                         }
 339                         add_rule_key(rule, &rule->id, operation, value);
 340                         valid = 1;
 341                         continue;
 342                 }
 343
 344                 if (strncasecmp(key, "SYSFS", sizeof("SYSFS")-1) == 0) {
 345                         if (operation != KEY_OP_MATCH &&
 346                             operation != KEY_OP_NOMATCH) {
 347                                 err("invalid SYSFS operation");
 348                                 goto invalid;
 349                         }
 350                         attr = get_key_attribute(key + sizeof("SYSFS")-1);
 351                         if (attr == NULL) {
 352                                 err("error parsing SYSFS attribute in '%s'", line);
 353                                 continue;
 354                         }
 355                         add_rule_key_pair(rule, &rule->sysfs, operation, attr, value);
 356                         valid = 1;
 357                         continue;
 358                 }
 359
 360                 if (strcasecmp(key, "WAIT_FOR_SYSFS") == 0) {
 361                         add_rule_key(rule, &rule->wait_for_sysfs, operation, value);
 362                         valid = 1;
 363                         continue;
 364                 }
 365
 366                 if (strncasecmp(key, "ENV", sizeof("ENV")-1) == 0) {
 367                         attr = get_key_attribute(key + sizeof("ENV")-1);
 368                         if (attr == NULL) {
 369                                 err("error parsing ENV attribute");
 370                                 continue;
 371                         }
 372                         add_rule_key_pair(rule, &rule->env, operation, attr, value);
 373                         valid = 1;
 374                         continue;
 375                 }
 376
 377                 if (strcasecmp(key, "MODALIAS") == 0) {
 378                         add_rule_key(rule, &rule->modalias, operation, value);
 379                         valid = 1;
 380                         continue;
 381                 }
 382
 383                 if (strncasecmp(key, "IMPORT", sizeof("IMPORT")-1) == 0) {
 384                         attr = get_key_attribute(key + sizeof("IMPORT")-1);
 385                         if (attr && strstr(attr, "program")) {
 386                                 dbg("IMPORT will be executed");
 387                                 rule->import_type  = IMPORT_PROGRAM;
 388                         } else if (attr && strstr(attr, "file")) {
 389                                 dbg("IMPORT will be included as file");
 390                                 rule->import_type  = IMPORT_FILE;
 391                         } else if (attr && strstr(attr, "parent")) {
 392                                 dbg("IMPORT will include the parent values");
 393                                 rule->import_type = IMPORT_PARENT;
 394                         } else {
 395                                 /* figure it out if it is executable */
 396                                 char file[PATH_SIZE];
 397                                 char *pos;
 398                                 struct stat stats;
 399
 400                                 strlcpy(file, value, sizeof(file));
 401                                 pos = strchr(file, ' ');
 402                                 if (pos)
 403                                         pos[0] = '\0';
 404
 405                                 /* allow programs in /lib/udev called without the path */
 406                                 if (strchr(file, '/') == NULL) {
 407                                         strlcpy(file, "/lib/udev/", sizeof(file));
 408                                         strlcat(file, value, sizeof(file));
 409                                         pos = strchr(file, ' ');
 410                                         if (pos)
 411                                                 pos[0] = '\0';
 412                                 }
 413
 414                                 dbg("IMPORT auto mode for '%s'", file);
 415                                 if (!lstat(file, &stats) && (stats.st_mode & S_IXUSR)) {
 416                                         dbg("IMPORT is executable, will be executed (autotype)");
 417                                         rule->import_type  = IMPORT_PROGRAM;
 418                                 } else {
 419                                         dbg("IMPORT is not executable, will be included as file (autotype)");
 420                                         rule->import_type  = IMPORT_FILE;
 421                                 }
 422                         }
 423                         add_rule_key(rule, &rule->import, operation, value);
 424                         valid = 1;
 425                         continue;
 426                 }
 427
 428                 if (strcasecmp(key, "DRIVER") == 0) {
 429                         if (operation != KEY_OP_MATCH &&
 430                             operation != KEY_OP_NOMATCH) {
 431                                 err("invalid DRIVER operation");
 432                                 goto invalid;
 433                         }
 434                         add_rule_key(rule, &rule->driver, operation, value);
 435                         valid = 1;
 436                         continue;
 437                 }
 438
 439                 if (strcasecmp(key, "RESULT") == 0) {
 440                         if (operation != KEY_OP_MATCH &&
 441                             operation != KEY_OP_NOMATCH) {
 442                                 err("invalid RESULT operation");
 443                                 goto invalid;
 444                         }
 445                         add_rule_key(rule, &rule->result, operation, value);
 446                         valid = 1;
 447                         continue;
 448                 }
 449
 450                 if (strcasecmp(key, "PROGRAM") == 0) {
 451                         add_rule_key(rule, &rule->program, operation, value);
 452                         valid = 1;
 453                         continue;
 454                 }
 455
 456                 if (strncasecmp(key, "NAME", sizeof("NAME")-1) == 0) {
 457                         attr = get_key_attribute(key + sizeof("NAME")-1);
 458                         if (attr != NULL) {
 459                                 if (strstr(attr, "all_partitions") != NULL) {
 460                                         dbg("creation of partition nodes requested");
 461                                         rule->partitions = DEFAULT_PARTITIONS_COUNT;
 462                                 }
 463                                 if (strstr(attr, "ignore_remove") != NULL) {
 464                                         dbg("remove event should be ignored");
 465                                         rule->ignore_remove = 1;
 466                                 }
 467                         }
 468                         if (value[0] == '\0')
 469                                 dbg("name empty, node creation supressed");
 470                         add_rule_key(rule, &rule->name, operation, value);
 471                         continue;
 472                 }
 473
 474                 if (strcasecmp(key, "SYMLINK") == 0) {
 475                         add_rule_key(rule, &rule->symlink, operation, value);
 476                         valid = 1;
 477                         continue;
 478                 }
 479
 480                 if (strcasecmp(key, "OWNER") == 0) {
 481                         valid = 1;
 482                         if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
 483                                 char *endptr;
 484                                 strtoul(value, &endptr, 10);
 485                                 if (endptr[0] != '\0') {
 486                                         char owner[32];
 487                                         uid_t uid = lookup_user(value);
 488                                         dbg("replacing username='%s' by id=%i", value, uid);
 489                                         sprintf(owner, "%u", (unsigned int) uid);
 490                                         add_rule_key(rule, &rule->owner, operation, owner);
 491                                         continue;
 492                                 }
 493                         }
 494
 495                         add_rule_key(rule, &rule->owner, operation, value);
 496                         continue;
 497                 }
 498
 499                 if (strcasecmp(key, "GROUP") == 0) {
 500                         valid = 1;
 501                         if (rules->resolve_names && (!strchr(value, '$') && !strchr(value, '%'))) {
 502                                 char *endptr;
 503                                 strtoul(value, &endptr, 10);
 504                                 if (endptr[0] != '\0') {
 505                                         char group[32];
 506                                         gid_t gid = lookup_group(value);
 507                                         dbg("replacing groupname='%s' by id=%i", value, gid);
 508                                         sprintf(group, "%u", (unsigned int) gid);
 509                                         add_rule_key(rule, &rule->group, operation, group);
 510                                         continue;
 511                                 }
 512                         }
 513
 514                         add_rule_key(rule, &rule->group, operation, value);
 515                         continue;
 516                 }
 517
 518                 if (strcasecmp(key, "MODE") == 0) {
 519                         rule->mode = strtol(value, NULL, 8);
 520                         rule->mode_operation = operation;
 521                         valid = 1;
 522                         continue;
 523                 }
 524
 525                 if (strcasecmp(key, "RUN") == 0) {
 526                         add_rule_key(rule, &rule->run, operation, value);
 527                         valid = 1;
 528                         continue;
 529                 }
 530
 531                 if (strcasecmp(key, "OPTIONS") == 0) {
 532                         if (strstr(value, "last_rule") != NULL) {
 533                                 dbg("last rule to be applied");
 534                                 rule->last_rule = 1;
 535                         }
 536                         if (strstr(value, "ignore_device") != NULL) {
 537                                 dbg("device should be ignored");
 538                                 rule->ignore_device = 1;
 539                         }
 540                         if (strstr(value, "ignore_remove") != NULL) {
 541                                 dbg("remove event should be ignored");
 542                                 rule->ignore_remove = 1;
 543                         }
 544                         if (strstr(value, "all_partitions") != NULL) {
 545                                 dbg("creation of partition nodes requested");
 546                                 rule->partitions = DEFAULT_PARTITIONS_COUNT;
 547                         }
 548                         valid = 1;
 549                         continue;
 550                 }
 551
 552                 err("unknown key '%s'", key);
 553         }
 554
 555         /* skip line if not any valid key was found */
 556         if (!valid)
 557                 goto invalid;
 558
 559         /* grow buffer and add rule */
 560         rule_size = sizeof(struct udev_rule) + rule->bufsize;
 561         padding = (sizeof(size_t) - rule_size % sizeof(size_t)) % sizeof(size_t);
 562         dbg("add %zi padding bytes", padding);
 563         rule_size += padding;
 564         rule->bufsize += padding;
 565
 566         rules->buf = realloc(rules->buf, rules->bufsize + rule_size);
 567         if (!rules->buf) {
 568                 err("realloc failed");
 569                 goto exit;
 570         }
 571         dbg("adding rule to offset %zi", rules->bufsize);
 572         memcpy(rules->buf + rules->bufsize, rule, rule_size);
 573         rules->bufsize += rule_size;
 574 exit:
 575         free(rule);
 576         return 0;
 577
 578 invalid:
 579         free(rule);
 580         err("invalid rule '%s:%u'", filename, lineno);
 581         return -1;
 582 }
 583
 584 static int parse_file(struct udev_rules *rules, const char *filename)
 585 {
 586         char line[LINE_SIZE];
 587         char *bufline;
 588         unsigned int lineno;
 589         char *buf;
 590         size_t bufsize;
 591         size_t cur;
 592         size_t count;
 593         int retval = 0;
 594
 595         if (file_map(filename, &buf, &bufsize) != 0) {
 596                 err("can't open '%s' as rules file: %s", filename, strerror(errno));
 597                 return -1;
 598         }
 599         dbg("reading '%s' as rules file", filename);
 600
 601         /* loop through the whole file */
 602         cur = 0;
 603         lineno = 0;
 604         while (cur < bufsize) {
 605                 unsigned int i, j;
 606
 607                 count = buf_get_line(buf, bufsize, cur);
 608                 bufline = &buf[cur];
 609                 cur += count+1;
 610                 lineno++;
 611
 612                 if (count >= sizeof(line)) {
 613                         err("line too long, rule skipped '%s:%u'", filename, lineno);
 614                         continue;
 615                 }
 616
 617                 /* eat the whitespace */
 618                 while ((count > 0) && isspace(bufline[0])) {
 619                         bufline++;
 620                         count--;
 621                 }
 622                 if (count == 0)
 623                         continue;
 624
 625                 /* see if this is a comment */
 626                 if (bufline[0] == COMMENT_CHARACTER)
 627                         continue;
 628
 629                 /* skip backslash and newline from multi line rules */
 630                 for (i = j = 0; i < count; i++) {
 631                         if (bufline[i] == '\\' && bufline[i+1] == '\n')
 632                                 continue;
 633
 634                         line[j++] = bufline[i];
 635                 }
 636                 line[j] = '\0';
 637
 638                 dbg("read '%s'", line);
 639                 add_to_rules(rules, line, filename, lineno);
 640         }
 641
 642         file_unmap(buf, bufsize);
 643         return retval;
 644 }
 645
 646 int udev_rules_init(struct udev_rules *rules, int resolve_names)
 647 {
 648         struct stat stats;
 649         int retval;
 650
 651         memset(rules, 0x00, sizeof(struct udev_rules));
 652         rules->resolve_names = resolve_names;
 653
 654         /* parse rules file or all matching files in directory */
 655         if (stat(udev_rules_filename, &stats) != 0)
 656                 return -1;
 657
 658         if ((stats.st_mode & S_IFMT) != S_IFDIR) {
 659                 dbg("parse single rules file '%s'", udev_rules_filename);
 660                 retval = parse_file(rules, udev_rules_filename);
 661         } else {
 662                 struct name_entry *name_loop, *name_tmp;
 663                 LIST_HEAD(name_list);
 664
 665                 dbg("parse rules directory '%s'", udev_rules_filename);
 666                 retval = add_matching_files(&name_list, udev_rules_filename, RULEFILE_SUFFIX);
 667
 668                 list_for_each_entry_safe(name_loop, name_tmp, &name_list, node) {
 669                         if (stat(name_loop->name, &stats) == 0) {
 670                                 if (stats.st_size)
 671                                         parse_file(rules, name_loop->name);
 672                                 else
 673                                         dbg("empty rules file '%s'", name_loop->name);
 674                         } else
 675                                 err("could not read '%s': %s", name_loop->name, strerror(errno));
 676                         list_del(&name_loop->node);
 677                         free(name_loop);
 678                 }
 679         }
 680
 681         return retval;
 682 }
 683
 684 void udev_rules_cleanup(struct udev_rules *rules)
 685 {
 686         if (rules->buf) {
 687                 free(rules->buf);
 688                 rules->buf = NULL;
 689         }
 690 }