src/udev/scsi_id/scsi_id.c

   1 /*
   2  * Copyright (C) IBM Corp. 2003
   3  * Copyright (C) SUSE Linux Products GmbH, 2006
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <stdarg.h>
  22 #include <stdbool.h>
  23 #include <unistd.h>
  24 #include <signal.h>
  25 #include <fcntl.h>
  26 #include <errno.h>
  27 #include <string.h>
  28 #include <syslog.h>
  29 #include <ctype.h>
  30 #include <getopt.h>
  31 #include <sys/stat.h>
  32
  33 #include "libudev.h"
  34 #include "libudev-private.h"
  35 #include "scsi_id.h"
  36 #include "udev-util.h"
  37
  38 static const struct option options[] = {
  39         { "device",             required_argument, NULL, 'd' },
  40         { "config",             required_argument, NULL, 'f' },
  41         { "page",               required_argument, NULL, 'p' },
  42         { "blacklisted",        no_argument,       NULL, 'b' },
  43         { "whitelisted",        no_argument,       NULL, 'g' },
  44         { "replace-whitespace", no_argument,       NULL, 'u' },
  45         { "sg-version",         required_argument, NULL, 's' },
  46         { "verbose",            no_argument,       NULL, 'v' },
  47         { "version",            no_argument,       NULL, 'V' },
  48         { "export",             no_argument,       NULL, 'x' },
  49         { "help",               no_argument,       NULL, 'h' },
  50         {}
  51 };
  52
  53 static bool all_good = false;
  54 static bool dev_specified = false;
  55 static char config_file[MAX_PATH_LEN] = "/etc/scsi_id.config";
  56 static enum page_code default_page_code = PAGE_UNSPECIFIED;
  57 static int sg_version = 4;
  58 static int debug = 0;
  59 static bool reformat_serial = false;
  60 static bool export = false;
  61 static char vendor_str[64];
  62 static char model_str[64];
  63 static char vendor_enc_str[256];
  64 static char model_enc_str[256];
  65 static char revision_str[16];
  66 static char type_str[16];
  67
  68 _printf_(6,0)
  69 static void log_fn(struct udev *udev, int priority,
  70                    const char *file, int line, const char *fn,
  71                    const char *format, va_list args)
  72 {
  73         vsyslog(priority, format, args);
  74 }
  75
  76 static void set_type(const char *from, char *to, size_t len)
  77 {
  78         int type_num;
  79         char *eptr;
  80         const char *type = "generic";
  81
  82         type_num = strtoul(from, &eptr, 0);
  83         if (eptr != from) {
  84                 switch (type_num) {
  85                 case 0:
  86                         type = "disk";
  87                         break;
  88                 case 1:
  89                         type = "tape";
  90                         break;
  91                 case 4:
  92                         type = "optical";
  93                         break;
  94                 case 5:
  95                         type = "cd";
  96                         break;
  97                 case 7:
  98                         type = "optical";
  99                         break;
 100                 case 0xe:
 101                         type = "disk";
 102                         break;
 103                 case 0xf:
 104                         type = "optical";
 105                         break;
 106                 default:
 107                         break;
 108                 }
 109         }
 110         strscpy(to, len, type);
 111 }
 112
 113 /*
 114  * get_value:
 115  *
 116  * buf points to an '=' followed by a quoted string ("foo") or a string ending
 117  * with a space or ','.
 118  *
 119  * Return a pointer to the NUL terminated string, returns NULL if no
 120  * matches.
 121  */
 122 static char *get_value(char **buffer)
 123 {
 124         static const char *quote_string = "\"\n";
 125         static const char *comma_string = ",\n";
 126         char *val;
 127         const char *end;
 128
 129         if (**buffer == '"') {
 130                 /*
 131                  * skip leading quote, terminate when quote seen
 132                  */
 133                 (*buffer)++;
 134                 end = quote_string;
 135         } else {
 136                 end = comma_string;
 137         }
 138         val = strsep(buffer, end);
 139         if (val && end == quote_string)
 140                 /*
 141                  * skip trailing quote
 142                  */
 143                 (*buffer)++;
 144
 145         while (isspace(**buffer))
 146                 (*buffer)++;
 147
 148         return val;
 149 }
 150
 151 static int argc_count(char *opts)
 152 {
 153         int i = 0;
 154         while (*opts != '\0')
 155                 if (*opts++ == ' ')
 156                         i++;
 157         return i;
 158 }
 159
 160 /*
 161  * get_file_options:
 162  *
 163  * If vendor == NULL, find a line in the config file with only "OPTIONS=";
 164  * if vendor and model are set find the first OPTIONS line in the config
 165  * file that matches. Set argc and argv to match the OPTIONS string.
 166  *
 167  * vendor and model can end in '\n'.
 168  */
 169 static int get_file_options(struct udev *udev,
 170                             const char *vendor, const char *model,
 171                             int *argc, char ***newargv)
 172 {
 173         char *buffer;
 174         _cleanup_fclose_ FILE *f;
 175         char *buf;
 176         char *str1;
 177         char *vendor_in, *model_in, *options_in; /* read in from file */
 178         int lineno;
 179         int c;
 180         int retval = 0;
 181
 182         f = fopen(config_file, "re");
 183         if (f == NULL) {
 184                 if (errno == ENOENT)
 185                         return 1;
 186                 else {
 187                         log_error("can't open %s: %m\n", config_file);
 188                         return -1;
 189                 }
 190         }
 191
 192         /*
 193          * Allocate a buffer rather than put it on the stack so we can
 194          * keep it around to parse any options (any allocated newargv
 195          * points into this buffer for its strings).
 196          */
 197         buffer = malloc(MAX_BUFFER_LEN);
 198         if (!buffer)
 199                 return log_oom();
 200
 201         *newargv = NULL;
 202         lineno = 0;
 203         while (1) {
 204                 vendor_in = model_in = options_in = NULL;
 205
 206                 buf = fgets(buffer, MAX_BUFFER_LEN, f);
 207                 if (buf == NULL)
 208                         break;
 209                 lineno++;
 210                 if (buf[strlen(buffer) - 1] != '\n') {
 211                         log_error("Config file line %d too long\n", lineno);
 212                         break;
 213                 }
 214
 215                 while (isspace(*buf))
 216                         buf++;
 217
 218                 /* blank or all whitespace line */
 219                 if (*buf == '\0')
 220                         continue;
 221
 222                 /* comment line */
 223                 if (*buf == '#')
 224                         continue;
 225
 226                 str1 = strsep(&buf, "=");
 227                 if (str1 && strcaseeq(str1, "VENDOR")) {
 228                         str1 = get_value(&buf);
 229                         if (!str1) {
 230                                 retval = log_oom();
 231                                 break;
 232                         }
 233                         vendor_in = str1;
 234
 235                         str1 = strsep(&buf, "=");
 236                         if (str1 && strcaseeq(str1, "MODEL")) {
 237                                 str1 = get_value(&buf);
 238                                 if (!str1) {
 239                                         retval = log_oom();
 240                                         break;
 241                                 }
 242                                 model_in = str1;
 243                                 str1 = strsep(&buf, "=");
 244                         }
 245                 }
 246
 247                 if (str1 && strcaseeq(str1, "OPTIONS")) {
 248                         str1 = get_value(&buf);
 249                         if (!str1) {
 250                                 retval = log_oom();
 251                                 break;
 252                         }
 253                         options_in = str1;
 254                 }
 255
 256                 /*
 257                  * Only allow: [vendor=foo[,model=bar]]options=stuff
 258                  */
 259                 if (!options_in || (!vendor_in && model_in)) {
 260                         log_error("Error parsing config file line %d '%s'\n", lineno, buffer);
 261                         retval = -1;
 262                         break;
 263                 }
 264                 if (vendor == NULL) {
 265                         if (vendor_in == NULL)
 266                                 break;
 267                 } else if (vendor_in &&
 268                            strneq(vendor, vendor_in, strlen(vendor_in)) &&
 269                            (!model_in ||
 270                             (strneq(model, model_in, strlen(model_in))))) {
 271                                 /*
 272                                  * Matched vendor and optionally model.
 273                                  *
 274                                  * Note: a short vendor_in or model_in can
 275                                  * give a partial match (that is FOO
 276                                  * matches FOOBAR).
 277                                  */
 278                                 break;
 279                 }
 280         }
 281
 282         if (retval == 0) {
 283                 if (vendor_in != NULL || model_in != NULL ||
 284                     options_in != NULL) {
 285                         /*
 286                          * Something matched. Allocate newargv, and store
 287                          * values found in options_in.
 288                          */
 289                         strcpy(buffer, options_in);
 290                         c = argc_count(buffer) + 2;
 291                         *newargv = calloc(c, sizeof(**newargv));
 292                         if (!*newargv) {
 293                                 retval = log_oom();
 294                         } else {
 295                                 *argc = c;
 296                                 c = 0;
 297                                 /*
 298                                  * argv[0] at 0 is skipped by getopt, but
 299                                  * store the buffer address there for
 300                                  * later freeing
 301                                  */
 302                                 (*newargv)[c] = buffer;
 303                                 for (c = 1; c < *argc; c++)
 304                                         (*newargv)[c] = strsep(&buffer, " \t");
 305                         }
 306                 } else {
 307                         /* No matches  */
 308                         retval = 1;
 309                 }
 310         }
 311         if (retval != 0)
 312                 free(buffer);
 313         return retval;
 314 }
 315
 316 static int set_options(struct udev *udev,
 317                        int argc, char **argv,
 318                        char *maj_min_dev)
 319 {
 320         int option;
 321
 322         /*
 323          * optind is a global extern used by getopt. Since we can call
 324          * set_options twice (once for command line, and once for config
 325          * file) we have to reset this back to 1.
 326          */
 327         optind = 1;
 328         while ((option = getopt_long(argc, argv, "d:f:ghp:uvVx", options, NULL)) >= 0)
 329                 switch (option) {
 330                 case 'b':
 331                         all_good = false;
 332                         break;
 333
 334                 case 'd':
 335                         dev_specified = true;
 336                         strscpy(maj_min_dev, MAX_PATH_LEN, optarg);
 337                         break;
 338
 339                 case 'f':
 340                         strscpy(config_file, MAX_PATH_LEN, optarg);
 341                         break;
 342
 343                 case 'g':
 344                         all_good = true;
 345                         break;
 346
 347                 case 'h':
 348                         printf("Usage: scsi_id [OPTION...] DEVICE\n"
 349                                "  --device=                     device node for SG_IO commands\n"
 350                                "  --config=                     location of config file\n"
 351                                "  --page=0x80|0x83|pre-spc3-83  SCSI page (0x80, 0x83, pre-spc3-83)\n"
 352                                "  --sg-version=3|4              use SGv3 or SGv4\n"
 353                                "  --blacklisted                 threat device as blacklisted\n"
 354                                "  --whitelisted                 threat device as whitelisted\n"
 355                                "  --replace-whitespace          replace all whitespace by underscores\n"
 356                                "  --verbose                     verbose logging\n"
 357                                "  --version                     print version\n"
 358                                "  --export                      print values as environment keys\n"
 359                                "  --help                        print this help text\n\n");
 360                         exit(0);
 361
 362                 case 'p':
 363                         if (streq(optarg, "0x80"))
 364                                 default_page_code = PAGE_80;
 365                         else if (streq(optarg, "0x83"))
 366                                 default_page_code = PAGE_83;
 367                         else if (streq(optarg, "pre-spc3-83"))
 368                                 default_page_code = PAGE_83_PRE_SPC3;
 369                         else {
 370                                 log_error("Unknown page code '%s'\n", optarg);
 371                                 return -1;
 372                         }
 373                         break;
 374
 375                 case 's':
 376                         sg_version = atoi(optarg);
 377                         if (sg_version < 3 || sg_version > 4) {
 378                                 log_error("Unknown SG version '%s'\n", optarg);
 379                                 return -1;
 380                         }
 381                         break;
 382
 383                 case 'u':
 384                         reformat_serial = true;
 385                         break;
 386
 387                 case 'v':
 388                         debug++;
 389                         break;
 390
 391                 case 'V':
 392                         printf("%s\n", VERSION);
 393                         exit(0);
 394                         break;
 395
 396                 case 'x':
 397                         export = true;
 398                         break;
 399
 400                 case '?':
 401                         return -1;
 402
 403                 default:
 404                         assert_not_reached("Unknown option");
 405                 }
 406
 407         if (optind < argc && !dev_specified) {
 408                 dev_specified = true;
 409                 strscpy(maj_min_dev, MAX_PATH_LEN, argv[optind]);
 410         }
 411
 412         return 0;
 413 }
 414
 415 static int per_dev_options(struct udev *udev,
 416                            struct scsi_id_device *dev_scsi, int *good_bad, int *page_code)
 417 {
 418         int retval;
 419         int newargc;
 420         char **newargv = NULL;
 421         int option;
 422
 423         *good_bad = all_good;
 424         *page_code = default_page_code;
 425
 426         retval = get_file_options(udev, vendor_str, model_str, &newargc, &newargv);
 427
 428         optind = 1; /* reset this global extern */
 429         while (retval == 0) {
 430                 option = getopt_long(newargc, newargv, "bgp:", options, NULL);
 431                 if (option == -1)
 432                         break;
 433
 434                 switch (option) {
 435                 case 'b':
 436                         *good_bad = 0;
 437                         break;
 438
 439                 case 'g':
 440                         *good_bad = 1;
 441                         break;
 442
 443                 case 'p':
 444                         if (streq(optarg, "0x80")) {
 445                                 *page_code = PAGE_80;
 446                         } else if (streq(optarg, "0x83")) {
 447                                 *page_code = PAGE_83;
 448                         } else if (streq(optarg, "pre-spc3-83")) {
 449                                 *page_code = PAGE_83_PRE_SPC3;
 450                         } else {
 451                                 log_error("Unknown page code '%s'\n", optarg);
 452                                 retval = -1;
 453                         }
 454                         break;
 455
 456                 default:
 457                         log_error("Unknown or bad option '%c' (0x%x)\n", option, option);
 458                         retval = -1;
 459                         break;
 460                 }
 461         }
 462
 463         if (newargv) {
 464                 free(newargv[0]);
 465                 free(newargv);
 466         }
 467         return retval;
 468 }
 469
 470 static int set_inq_values(struct udev *udev, struct scsi_id_device *dev_scsi, const char *path)
 471 {
 472         int retval;
 473
 474         dev_scsi->use_sg = sg_version;
 475
 476         retval = scsi_std_inquiry(udev, dev_scsi, path);
 477         if (retval)
 478                 return retval;
 479
 480         udev_util_encode_string(dev_scsi->vendor, vendor_enc_str, sizeof(vendor_enc_str));
 481         udev_util_encode_string(dev_scsi->model, model_enc_str, sizeof(model_enc_str));
 482
 483         util_replace_whitespace(dev_scsi->vendor, vendor_str, sizeof(vendor_str));
 484         util_replace_chars(vendor_str, NULL);
 485         util_replace_whitespace(dev_scsi->model, model_str, sizeof(model_str));
 486         util_replace_chars(model_str, NULL);
 487         set_type(dev_scsi->type, type_str, sizeof(type_str));
 488         util_replace_whitespace(dev_scsi->revision, revision_str, sizeof(revision_str));
 489         util_replace_chars(revision_str, NULL);
 490         return 0;
 491 }
 492
 493 /*
 494  * scsi_id: try to get an id, if one is found, printf it to stdout.
 495  * returns a value passed to exit() - 0 if printed an id, else 1.
 496  */
 497 static int scsi_id(struct udev *udev, char *maj_min_dev)
 498 {
 499         struct scsi_id_device dev_scsi = {};
 500         int good_dev;
 501         int page_code;
 502         int retval = 0;
 503
 504         if (set_inq_values(udev, &dev_scsi, maj_min_dev) < 0) {
 505                 retval = 1;
 506                 goto out;
 507         }
 508
 509         /* get per device (vendor + model) options from the config file */
 510         per_dev_options(udev, &dev_scsi, &good_dev, &page_code);
 511         if (!good_dev) {
 512                 retval = 1;
 513                 goto out;
 514         }
 515
 516         /* read serial number from mode pages (no values for optical drives) */
 517         scsi_get_serial(udev, &dev_scsi, maj_min_dev, page_code, MAX_SERIAL_LEN);
 518
 519         if (export) {
 520                 char serial_str[MAX_SERIAL_LEN];
 521
 522                 printf("ID_SCSI=1\n");
 523                 printf("ID_VENDOR=%s\n", vendor_str);
 524                 printf("ID_VENDOR_ENC=%s\n", vendor_enc_str);
 525                 printf("ID_MODEL=%s\n", model_str);
 526                 printf("ID_MODEL_ENC=%s\n", model_enc_str);
 527                 printf("ID_REVISION=%s\n", revision_str);
 528                 printf("ID_TYPE=%s\n", type_str);
 529                 if (dev_scsi.serial[0] != '\0') {
 530                         util_replace_whitespace(dev_scsi.serial, serial_str, sizeof(serial_str));
 531                         util_replace_chars(serial_str, NULL);
 532                         printf("ID_SERIAL=%s\n", serial_str);
 533                         util_replace_whitespace(dev_scsi.serial_short, serial_str, sizeof(serial_str));
 534                         util_replace_chars(serial_str, NULL);
 535                         printf("ID_SERIAL_SHORT=%s\n", serial_str);
 536                 }
 537                 if (dev_scsi.wwn[0] != '\0') {
 538                         printf("ID_WWN=0x%s\n", dev_scsi.wwn);
 539                         if (dev_scsi.wwn_vendor_extension[0] != '\0') {
 540                                 printf("ID_WWN_VENDOR_EXTENSION=0x%s\n", dev_scsi.wwn_vendor_extension);
 541                                 printf("ID_WWN_WITH_EXTENSION=0x%s%s\n", dev_scsi.wwn, dev_scsi.wwn_vendor_extension);
 542                         } else {
 543                                 printf("ID_WWN_WITH_EXTENSION=0x%s\n", dev_scsi.wwn);
 544                         }
 545                 }
 546                 if (dev_scsi.tgpt_group[0] != '\0') {
 547                         printf("ID_TARGET_PORT=%s\n", dev_scsi.tgpt_group);
 548                 }
 549                 if (dev_scsi.unit_serial_number[0] != '\0') {
 550                         printf("ID_SCSI_SERIAL=%s\n", dev_scsi.unit_serial_number);
 551                 }
 552                 goto out;
 553         }
 554
 555         if (dev_scsi.serial[0] == '\0') {
 556                 retval = 1;
 557                 goto out;
 558         }
 559
 560         if (reformat_serial) {
 561                 char serial_str[MAX_SERIAL_LEN];
 562
 563                 util_replace_whitespace(dev_scsi.serial, serial_str, sizeof(serial_str));
 564                 util_replace_chars(serial_str, NULL);
 565                 printf("%s\n", serial_str);
 566                 goto out;
 567         }
 568
 569         printf("%s\n", dev_scsi.serial);
 570 out:
 571         return retval;
 572 }
 573
 574 int main(int argc, char **argv)
 575 {
 576         _cleanup_udev_unref_ struct udev *udev;
 577         int retval = 0;
 578         char maj_min_dev[MAX_PATH_LEN];
 579         int newargc;
 580         char **newargv = NULL;
 581
 582         udev = udev_new();
 583         if (udev == NULL)
 584                 goto exit;
 585
 586         log_open();
 587         udev_set_log_fn(udev, log_fn);
 588
 589         /*
 590          * Get config file options.
 591          */
 592         retval = get_file_options(udev, NULL, NULL, &newargc, &newargv);
 593         if (retval < 0) {
 594                 retval = 1;
 595                 goto exit;
 596         }
 597         if (retval == 0) {
 598                 assert(newargv);
 599
 600                 if (set_options(udev, newargc, newargv, maj_min_dev) < 0) {
 601                         retval = 2;
 602                         goto exit;
 603                 }
 604         }
 605
 606         /*
 607          * Get command line options (overriding any config file settings).
 608          */
 609         if (set_options(udev, argc, argv, maj_min_dev) < 0)
 610                 exit(1);
 611
 612         if (!dev_specified) {
 613                 log_error("no device specified\n");
 614                 retval = 1;
 615                 goto exit;
 616         }
 617
 618         retval = scsi_id(udev, maj_min_dev);
 619
 620 exit:
 621         if (newargv) {
 622                 free(newargv[0]);
 623                 free(newargv);
 624         }
 625         log_close();
 626         return retval;
 627 }