2 * Copyright (C) IBM Corp. 2003
3 * Copyright (C) SUSE Linux Products GmbH, 2006
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.
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.
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/>.
34 #include "libudev-private.h"
36 #include "udev-util.h"
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' }, /* don't advertise -V */
48 { "export", no_argument, NULL, 'x' },
49 { "help", no_argument, NULL, 'h' },
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;
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];
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)
73 vsyslog(priority, format, args);
76 static void set_type(const char *from, char *to, size_t len)
80 const char *type = "generic";
82 type_num = strtoul(from, &eptr, 0);
110 strscpy(to, len, type);
116 * buf points to an '=' followed by a quoted string ("foo") or a string ending
117 * with a space or ','.
119 * Return a pointer to the NUL terminated string, returns NULL if no
122 static char *get_value(char **buffer)
124 static const char *quote_string = "\"\n";
125 static const char *comma_string = ",\n";
129 if (**buffer == '"') {
131 * skip leading quote, terminate when quote seen
138 val = strsep(buffer, end);
139 if (val && end == quote_string)
141 * skip trailing quote
145 while (isspace(**buffer))
151 static int argc_count(char *opts)
154 while (*opts != '\0')
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.
167 * vendor and model can end in '\n'.
169 static int get_file_options(struct udev *udev,
170 const char *vendor, const char *model,
171 int *argc, char ***newargv)
174 _cleanup_fclose_ FILE *f;
177 char *vendor_in, *model_in, *options_in; /* read in from file */
182 f = fopen(config_file, "re");
187 log_error("can't open %s: %m", config_file);
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).
197 buffer = malloc(MAX_BUFFER_LEN);
204 vendor_in = model_in = options_in = NULL;
206 buf = fgets(buffer, MAX_BUFFER_LEN, f);
210 if (buf[strlen(buffer) - 1] != '\n') {
211 log_error("Config file line %d too long", lineno);
215 while (isspace(*buf))
218 /* blank or all whitespace line */
226 str1 = strsep(&buf, "=");
227 if (str1 && strcaseeq(str1, "VENDOR")) {
228 str1 = get_value(&buf);
235 str1 = strsep(&buf, "=");
236 if (str1 && strcaseeq(str1, "MODEL")) {
237 str1 = get_value(&buf);
243 str1 = strsep(&buf, "=");
247 if (str1 && strcaseeq(str1, "OPTIONS")) {
248 str1 = get_value(&buf);
257 * Only allow: [vendor=foo[,model=bar]]options=stuff
259 if (!options_in || (!vendor_in && model_in)) {
260 log_error("Error parsing config file line %d '%s'", lineno, buffer);
264 if (vendor == NULL) {
265 if (vendor_in == NULL)
267 } else if (vendor_in &&
268 strneq(vendor, vendor_in, strlen(vendor_in)) &&
270 (strneq(model, model_in, strlen(model_in))))) {
272 * Matched vendor and optionally model.
274 * Note: a short vendor_in or model_in can
275 * give a partial match (that is FOO
283 if (vendor_in != NULL || model_in != NULL ||
284 options_in != NULL) {
286 * Something matched. Allocate newargv, and store
287 * values found in options_in.
289 strcpy(buffer, options_in);
290 c = argc_count(buffer) + 2;
291 *newargv = calloc(c, sizeof(**newargv));
298 * argv[0] at 0 is skipped by getopt, but
299 * store the buffer address there for
302 (*newargv)[c] = buffer;
303 for (c = 1; c < *argc; c++)
304 (*newargv)[c] = strsep(&buffer, " \t");
316 static void help(void) {
317 printf("Usage: scsi_id [OPTION...] DEVICE\n"
318 " -d,--device= device node for SG_IO commands\n"
319 " -f,--config= location of config file\n"
320 " -p,--page=0x80|0x83|pre-spc3-83 SCSI page (0x80, 0x83, pre-spc3-83)\n"
321 " -s,--sg-version=3|4 use SGv3 or SGv4\n"
322 " -b,--blacklisted threat device as blacklisted\n"
323 " -g,--whitelisted threat device as whitelisted\n"
324 " -u,--replace-whitespace replace all whitespace by underscores\n"
325 " -v,--verbose verbose logging\n"
326 " --version print version\n"
327 " -x,--export print values as environment keys\n"
328 " -h,--help print this help text\n\n");
332 static int set_options(struct udev *udev,
333 int argc, char **argv,
339 * optind is a global extern used by getopt. Since we can call
340 * set_options twice (once for command line, and once for config
341 * file) we have to reset this back to 1.
344 while ((option = getopt_long(argc, argv, "d:f:gp:uvVxh", options, NULL)) >= 0)
351 dev_specified = true;
352 strscpy(maj_min_dev, MAX_PATH_LEN, optarg);
356 strscpy(config_file, MAX_PATH_LEN, optarg);
368 if (streq(optarg, "0x80"))
369 default_page_code = PAGE_80;
370 else if (streq(optarg, "0x83"))
371 default_page_code = PAGE_83;
372 else if (streq(optarg, "pre-spc3-83"))
373 default_page_code = PAGE_83_PRE_SPC3;
375 log_error("Unknown page code '%s'", optarg);
381 sg_version = atoi(optarg);
382 if (sg_version < 3 || sg_version > 4) {
383 log_error("Unknown SG version '%s'", optarg);
389 reformat_serial = true;
397 printf("%s\n", VERSION);
408 assert_not_reached("Unknown option");
411 if (optind < argc && !dev_specified) {
412 dev_specified = true;
413 strscpy(maj_min_dev, MAX_PATH_LEN, argv[optind]);
419 static int per_dev_options(struct udev *udev,
420 struct scsi_id_device *dev_scsi, int *good_bad, int *page_code)
424 char **newargv = NULL;
427 *good_bad = all_good;
428 *page_code = default_page_code;
430 retval = get_file_options(udev, vendor_str, model_str, &newargc, &newargv);
432 optind = 1; /* reset this global extern */
433 while (retval == 0) {
434 option = getopt_long(newargc, newargv, "bgp:", options, NULL);
448 if (streq(optarg, "0x80")) {
449 *page_code = PAGE_80;
450 } else if (streq(optarg, "0x83")) {
451 *page_code = PAGE_83;
452 } else if (streq(optarg, "pre-spc3-83")) {
453 *page_code = PAGE_83_PRE_SPC3;
455 log_error("Unknown page code '%s'", optarg);
461 log_error("Unknown or bad option '%c' (0x%x)", option, option);
474 static int set_inq_values(struct udev *udev, struct scsi_id_device *dev_scsi, const char *path)
478 dev_scsi->use_sg = sg_version;
480 retval = scsi_std_inquiry(udev, dev_scsi, path);
484 udev_util_encode_string(dev_scsi->vendor, vendor_enc_str, sizeof(vendor_enc_str));
485 udev_util_encode_string(dev_scsi->model, model_enc_str, sizeof(model_enc_str));
487 util_replace_whitespace(dev_scsi->vendor, vendor_str, sizeof(vendor_str));
488 util_replace_chars(vendor_str, NULL);
489 util_replace_whitespace(dev_scsi->model, model_str, sizeof(model_str));
490 util_replace_chars(model_str, NULL);
491 set_type(dev_scsi->type, type_str, sizeof(type_str));
492 util_replace_whitespace(dev_scsi->revision, revision_str, sizeof(revision_str));
493 util_replace_chars(revision_str, NULL);
498 * scsi_id: try to get an id, if one is found, printf it to stdout.
499 * returns a value passed to exit() - 0 if printed an id, else 1.
501 static int scsi_id(struct udev *udev, char *maj_min_dev)
503 struct scsi_id_device dev_scsi = {};
508 if (set_inq_values(udev, &dev_scsi, maj_min_dev) < 0) {
513 /* get per device (vendor + model) options from the config file */
514 per_dev_options(udev, &dev_scsi, &good_dev, &page_code);
520 /* read serial number from mode pages (no values for optical drives) */
521 scsi_get_serial(udev, &dev_scsi, maj_min_dev, page_code, MAX_SERIAL_LEN);
524 char serial_str[MAX_SERIAL_LEN];
526 printf("ID_SCSI=1\n");
527 printf("ID_VENDOR=%s\n", vendor_str);
528 printf("ID_VENDOR_ENC=%s\n", vendor_enc_str);
529 printf("ID_MODEL=%s\n", model_str);
530 printf("ID_MODEL_ENC=%s\n", model_enc_str);
531 printf("ID_REVISION=%s\n", revision_str);
532 printf("ID_TYPE=%s\n", type_str);
533 if (dev_scsi.serial[0] != '\0') {
534 util_replace_whitespace(dev_scsi.serial, serial_str, sizeof(serial_str));
535 util_replace_chars(serial_str, NULL);
536 printf("ID_SERIAL=%s\n", serial_str);
537 util_replace_whitespace(dev_scsi.serial_short, serial_str, sizeof(serial_str));
538 util_replace_chars(serial_str, NULL);
539 printf("ID_SERIAL_SHORT=%s\n", serial_str);
541 if (dev_scsi.wwn[0] != '\0') {
542 printf("ID_WWN=0x%s\n", dev_scsi.wwn);
543 if (dev_scsi.wwn_vendor_extension[0] != '\0') {
544 printf("ID_WWN_VENDOR_EXTENSION=0x%s\n", dev_scsi.wwn_vendor_extension);
545 printf("ID_WWN_WITH_EXTENSION=0x%s%s\n", dev_scsi.wwn, dev_scsi.wwn_vendor_extension);
547 printf("ID_WWN_WITH_EXTENSION=0x%s\n", dev_scsi.wwn);
550 if (dev_scsi.tgpt_group[0] != '\0') {
551 printf("ID_TARGET_PORT=%s\n", dev_scsi.tgpt_group);
553 if (dev_scsi.unit_serial_number[0] != '\0') {
554 printf("ID_SCSI_SERIAL=%s\n", dev_scsi.unit_serial_number);
559 if (dev_scsi.serial[0] == '\0') {
564 if (reformat_serial) {
565 char serial_str[MAX_SERIAL_LEN];
567 util_replace_whitespace(dev_scsi.serial, serial_str, sizeof(serial_str));
568 util_replace_chars(serial_str, NULL);
569 printf("%s\n", serial_str);
573 printf("%s\n", dev_scsi.serial);
578 int main(int argc, char **argv)
580 _cleanup_udev_unref_ struct udev *udev;
582 char maj_min_dev[MAX_PATH_LEN];
584 char **newargv = NULL;
591 udev_set_log_fn(udev, log_fn);
594 * Get config file options.
596 retval = get_file_options(udev, NULL, NULL, &newargc, &newargv);
604 if (set_options(udev, newargc, newargv, maj_min_dev) < 0) {
611 * Get command line options (overriding any config file settings).
613 if (set_options(udev, argc, argv, maj_min_dev) < 0)
616 if (!dev_specified) {
617 log_error("no device specified");
622 retval = scsi_id(udev, maj_min_dev);