usr.sbin/efivar/efiutil.c

   1 /*-
   2  * Copyright (c) 2017 Netflix, Inc.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23  * SUCH DAMAGE.
  24  */
  25
  26 #include <sys/cdefs.h>
  27 __FBSDID("$FreeBSD$");
  28
  29 #include <ctype.h>
  30 #include <efivar.h>
  31 #include <efivar-dp.h>
  32 #include <err.h>
  33 #include <errno.h>
  34 #include <getopt.h>
  35 #include <stddef.h>
  36 #include <stdio.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include <unistd.h>
  40 #include "efiutil.h"
  41 #include "efichar.h"
  42 #include <efivar-dp.h>
  43
  44 /*
  45  * Dump the data as ASCII data, which is a pretty
  46  * printed form
  47  */
  48 void
  49 asciidump(uint8_t *data, size_t datalen)
  50 {
  51         size_t i;
  52         int len;
  53
  54         len = 0;
  55         for (i = 0; i < datalen; i++) {
  56                 if (isprint(data[i])) {
  57                         len++;
  58                         if (len > 80) {
  59                                 len = 0;
  60                                 printf("\n");
  61                         }
  62                         printf("%c", data[i]);
  63                 } else {
  64                         len +=3;
  65                         if (len > 80) {
  66                                 len = 0;
  67                                 printf("\n");
  68                         }
  69                         printf("%%%02x", data[i]);
  70                 }
  71         }
  72         printf("\n");
  73 }
  74
  75 void
  76 utf8dump(uint8_t *data, size_t datalen)
  77 {
  78         char *utf8 = NULL;
  79         efi_char *ucs2;
  80
  81         /*
  82          * NUL terminate the string. Not all strings need it, but some
  83          * do and an extra NUL won't change what's printed.
  84          */
  85         ucs2 = malloc(datalen + sizeof(efi_char));
  86         memcpy(ucs2, data, datalen);
  87         ucs2[datalen / sizeof(efi_char)] = 0;
  88         ucs2_to_utf8(ucs2, &utf8);
  89         printf("%s\n", utf8);
  90         free(utf8);
  91         free(ucs2);
  92 }
  93
  94 void
  95 hexdump(uint8_t *data, size_t datalen)
  96 {
  97         size_t i;
  98
  99         for (i = 0; i < datalen; i++) {
 100                 if (i % 16 == 0) {
 101                         if (i != 0)
 102                                 printf("\n");
 103                         printf("%04x: ", (int)i);
 104                 }
 105                 printf("%02x ", data[i]);
 106         }
 107         printf("\n");
 108 }
 109
 110 void
 111 bindump(uint8_t *data, size_t datalen)
 112 {
 113         write(1, data, datalen);
 114 }
 115
 116 #define LOAD_OPTION_ACTIVE 1
 117
 118 void
 119 efi_print_load_option(uint8_t *data, size_t datalen, int Aflag, int bflag, int uflag)
 120 {
 121         uint8_t *ep = data + datalen;
 122         uint8_t *walker = data;
 123         uint32_t attr;
 124         uint16_t fplen;
 125         efi_char *descr;
 126         efidp dp, edp;
 127         char *str = NULL;
 128         char buf[1024];
 129         int len;
 130         void *opt;
 131         int optlen;
 132
 133         if (datalen < sizeof(attr) + sizeof(fplen) + sizeof(efi_char))
 134                 return;
 135         // First 4 bytes are attribute flags
 136         attr = le32dec(walker);
 137         walker += sizeof(attr);
 138         // Next two bytes are length of the file paths
 139         fplen = le16dec(walker);
 140         walker += sizeof(fplen);
 141         // Next we have a 0 terminated UCS2 string that we know to be aligned
 142         descr = (efi_char *)(intptr_t)(void *)walker;
 143         len = ucs2len(descr); // XXX need to sanity check that len < (datalen - (ep - walker) / 2)
 144         walker += (len + 1) * sizeof(efi_char);
 145         if (walker > ep)
 146                 return;
 147         // Now we have fplen bytes worth of file path stuff
 148         dp = (efidp)walker;
 149         walker += fplen;
 150         if (walker > ep)
 151                 return;
 152         edp = (efidp)walker;
 153         // Everything left is the binary option args
 154         opt = walker;
 155         optlen = ep - walker;
 156         // We got to here, everything is good
 157         printf("%c ", attr & LOAD_OPTION_ACTIVE ? '*' : ' ');
 158         ucs2_to_utf8(descr, &str);
 159         printf("%s", str);
 160         free(str);
 161         while (dp < edp) {
 162                 efidp_format_device_path(buf, sizeof(buf), dp,
 163                     (intptr_t)(void *)edp - (intptr_t)(void *)dp);
 164                 dp = (efidp)((char *)dp + efidp_size(dp));
 165                 printf(" %s\n", buf);
 166         }
 167         if (optlen == 0)
 168                 return;
 169         printf("Options: ");
 170         if (Aflag)
 171                 asciidump(opt, optlen);
 172         else if (bflag)
 173                 bindump(opt, optlen);
 174         else if (uflag)
 175                 utf8dump(opt, optlen);
 176         else
 177                 hexdump(opt, optlen);
 178 }