lib/efi_loader/efi_variable.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *  EFI utils
   4  *
   5  *  Copyright (c) 2017 Rob Clark
   6  */
   7
   8 #include <malloc.h>
   9 #include <charset.h>
  10 #include <efi_loader.h>
  11 #include <hexdump.h>
  12 #include <environment.h>
  13 #include <search.h>
  14 #include <uuid.h>
  15
  16 #define READ_ONLY BIT(31)
  17
  18 /*
  19  * Mapping between EFI variables and u-boot variables:
  20  *
  21  *   efi_$guid_$varname = {attributes}(type)value
  22  *
  23  * For example:
  24  *
  25  *   efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported=
  26  *      "{ro,boot,run}(blob)0000000000000000"
  27  *   efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_BootOrder=
  28  *      "(blob)00010000"
  29  *
  30  * The attributes are a comma separated list of these possible
  31  * attributes:
  32  *
  33  *   + ro   - read-only
  34  *   + boot - boot-services access
  35  *   + run  - runtime access
  36  *
  37  * NOTE: with current implementation, no variables are available after
  38  * ExitBootServices, and all are persisted (if possible).
  39  *
  40  * If not specified, the attributes default to "{boot}".
  41  *
  42  * The required type is one of:
  43  *
  44  *   + utf8 - raw utf8 string
  45  *   + blob - arbitrary length hex string
  46  *
  47  * Maybe a utf16 type would be useful to for a string value to be auto
  48  * converted to utf16?
  49  */
  50
  51 #define PREFIX_LEN (strlen("efi_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx_"))
  52
  53 /**
  54  * efi_to_native() - convert the UEFI variable name and vendor GUID to U-Boot
  55  *                   variable name
  56  *
  57  * The U-Boot variable name is a concatenation of prefix 'efi', the hexstring
  58  * encoded vendor GUID, and the UTF-8 encoded UEFI variable name separated by
  59  * underscores, e.g. 'efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_BootOrder'.
  60  *
  61  * @native:             pointer to pointer to U-Boot variable name
  62  * @variable_name:      UEFI variable name
  63  * @vendor:             vendor GUID
  64  * Return:              status code
  65  */
  66 static efi_status_t efi_to_native(char **native, const u16 *variable_name,
  67                                   const efi_guid_t *vendor)
  68 {
  69         size_t len;
  70         char *pos;
  71
  72         len = PREFIX_LEN + utf16_utf8_strlen(variable_name) + 1;
  73         *native = malloc(len);
  74         if (!*native)
  75                 return EFI_OUT_OF_RESOURCES;
  76
  77         pos = *native;
  78         pos += sprintf(pos, "efi_%pUl_", vendor);
  79         utf16_utf8_strcpy(&pos, variable_name);
  80
  81         return EFI_SUCCESS;
  82 }
  83
  84 /**
  85  * prefix() - skip over prefix
  86  *
  87  * Skip over a prefix string.
  88  *
  89  * @str:        string with prefix
  90  * @prefix:     prefix string
  91  * Return:      string without prefix, or NULL if prefix not found
  92  */
  93 static const char *prefix(const char *str, const char *prefix)
  94 {
  95         size_t n = strlen(prefix);
  96         if (!strncmp(prefix, str, n))
  97                 return str + n;
  98         return NULL;
  99 }
 100
 101 /**
 102  * parse_attr() - decode attributes part of variable value
 103  *
 104  * Convert the string encoded attributes of a UEFI variable to a bit mask.
 105  * TODO: Several attributes are not supported.
 106  *
 107  * @str:        value of U-Boot variable
 108  * @attrp:      pointer to UEFI attributes
 109  * Return:      pointer to remainder of U-Boot variable value
 110  */
 111 static const char *parse_attr(const char *str, u32 *attrp)
 112 {
 113         u32 attr = 0;
 114         char sep = '{';
 115
 116         if (*str != '{') {
 117                 *attrp = EFI_VARIABLE_BOOTSERVICE_ACCESS;
 118                 return str;
 119         }
 120
 121         while (*str == sep) {
 122                 const char *s;
 123
 124                 str++;
 125
 126                 if ((s = prefix(str, "ro"))) {
 127                         attr |= READ_ONLY;
 128                 } else if ((s = prefix(str, "nv"))) {
 129                         attr |= EFI_VARIABLE_NON_VOLATILE;
 130                 } else if ((s = prefix(str, "boot"))) {
 131                         attr |= EFI_VARIABLE_BOOTSERVICE_ACCESS;
 132                 } else if ((s = prefix(str, "run"))) {
 133                         attr |= EFI_VARIABLE_RUNTIME_ACCESS;
 134                 } else {
 135                         printf("invalid attribute: %s\n", str);
 136                         break;
 137                 }
 138
 139                 str = s;
 140                 sep = ',';
 141         }
 142
 143         str++;
 144
 145         *attrp = attr;
 146
 147         return str;
 148 }
 149
 150 /**
 151  * efi_get_variable() - retrieve value of a UEFI variable
 152  *
 153  * This function implements the GetVariable runtime service.
 154  *
 155  * See the Unified Extensible Firmware Interface (UEFI) specification for
 156  * details.
 157  *
 158  * @variable_name:      name of the variable
 159  * @vendor:             vendor GUID
 160  * @attributes:         attributes of the variable
 161  * @data_size:          size of the buffer to which the variable value is copied
 162  * @data:               buffer to which the variable value is copied
 163  * Return:              status code
 164  */
 165 efi_status_t EFIAPI efi_get_variable(u16 *variable_name,
 166                                      const efi_guid_t *vendor, u32 *attributes,
 167                                      efi_uintn_t *data_size, void *data)
 168 {
 169         char *native_name;
 170         efi_status_t ret;
 171         unsigned long in_size;
 172         const char *val, *s;
 173         u32 attr;
 174
 175         EFI_ENTRY("\"%ls\" %pUl %p %p %p", variable_name, vendor, attributes,
 176                   data_size, data);
 177
 178         if (!variable_name || !vendor || !data_size)
 179                 return EFI_EXIT(EFI_INVALID_PARAMETER);
 180
 181         ret = efi_to_native(&native_name, variable_name, vendor);
 182         if (ret)
 183                 return EFI_EXIT(ret);
 184
 185         EFI_PRINT("get '%s'\n", native_name);
 186
 187         val = env_get(native_name);
 188         free(native_name);
 189         if (!val)
 190                 return EFI_EXIT(EFI_NOT_FOUND);
 191
 192         val = parse_attr(val, &attr);
 193
 194         in_size = *data_size;
 195
 196         if ((s = prefix(val, "(blob)"))) {
 197                 size_t len = strlen(s);
 198
 199                 /* number of hexadecimal digits must be even */
 200                 if (len & 1)
 201                         return EFI_EXIT(EFI_DEVICE_ERROR);
 202
 203                 /* two characters per byte: */
 204                 len /= 2;
 205                 *data_size = len;
 206
 207                 if (in_size < len) {
 208                         ret = EFI_BUFFER_TOO_SMALL;
 209                         goto out;
 210                 }
 211
 212                 if (!data)
 213                         return EFI_EXIT(EFI_INVALID_PARAMETER);
 214
 215                 if (hex2bin(data, s, len))
 216                         return EFI_EXIT(EFI_DEVICE_ERROR);
 217
 218                 EFI_PRINT("got value: \"%s\"\n", s);
 219         } else if ((s = prefix(val, "(utf8)"))) {
 220                 unsigned len = strlen(s) + 1;
 221
 222                 *data_size = len;
 223
 224                 if (in_size < len) {
 225                         ret = EFI_BUFFER_TOO_SMALL;
 226                         goto out;
 227                 }
 228
 229                 if (!data)
 230                         return EFI_EXIT(EFI_INVALID_PARAMETER);
 231
 232                 memcpy(data, s, len);
 233                 ((char *)data)[len] = '\0';
 234
 235                 EFI_PRINT("got value: \"%s\"\n", (char *)data);
 236         } else {
 237                 EFI_PRINT("invalid value: '%s'\n", val);
 238                 return EFI_EXIT(EFI_DEVICE_ERROR);
 239         }
 240
 241 out:
 242         if (attributes)
 243                 *attributes = attr & EFI_VARIABLE_MASK;
 244
 245         return EFI_EXIT(ret);
 246 }
 247
 248 static char *efi_variables_list;
 249 static char *efi_cur_variable;
 250
 251 /**
 252  * parse_uboot_variable() - parse a u-boot variable and get uefi-related
 253  *                          information
 254  * @variable:           whole data of u-boot variable (ie. name=value)
 255  * @variable_name_size: size of variable_name buffer in byte
 256  * @variable_name:      name of uefi variable in u16, null-terminated
 257  * @vendor:             vendor's guid
 258  * @attributes:         attributes
 259  *
 260  * A uefi variable is encoded into a u-boot variable as described above.
 261  * This function parses such a u-boot variable and retrieve uefi-related
 262  * information into respective parameters. In return, variable_name_size
 263  * is the size of variable name including NULL.
 264  *
 265  * Return:              EFI_SUCCESS if parsing is OK, EFI_NOT_FOUND when
 266                         the entire variable list has been returned,
 267                         otherwise non-zero status code
 268  */
 269 static efi_status_t parse_uboot_variable(char *variable,
 270                                          efi_uintn_t *variable_name_size,
 271                                          u16 *variable_name,
 272                                          const efi_guid_t *vendor,
 273                                          u32 *attributes)
 274 {
 275         char *guid, *name, *end, c;
 276         unsigned long name_len;
 277         u16 *p;
 278
 279         guid = strchr(variable, '_');
 280         if (!guid)
 281                 return EFI_INVALID_PARAMETER;
 282         guid++;
 283         name = strchr(guid, '_');
 284         if (!name)
 285                 return EFI_INVALID_PARAMETER;
 286         name++;
 287         end = strchr(name, '=');
 288         if (!end)
 289                 return EFI_INVALID_PARAMETER;
 290
 291         name_len = end - name;
 292         if (*variable_name_size < (name_len + 1)) {
 293                 *variable_name_size = name_len + 1;
 294                 return EFI_BUFFER_TOO_SMALL;
 295         }
 296         end++; /* point to value */
 297
 298         /* variable name */
 299         p = variable_name;
 300         utf8_utf16_strncpy(&p, name, name_len);
 301         variable_name[name_len] = 0;
 302         *variable_name_size = name_len + 1;
 303
 304         /* guid */
 305         c = *(name - 1);
 306         *(name - 1) = '\0'; /* guid need be null-terminated here */
 307         uuid_str_to_bin(guid, (unsigned char *)vendor, UUID_STR_FORMAT_GUID);
 308         *(name - 1) = c;
 309
 310         /* attributes */
 311         parse_attr(end, attributes);
 312
 313         return EFI_SUCCESS;
 314 }
 315
 316 /**
 317  * efi_get_next_variable_name() - enumerate the current variable names
 318  * @variable_name_size: size of variable_name buffer in byte
 319  * @variable_name:      name of uefi variable's name in u16
 320  * @vendor:             vendor's guid
 321  *
 322  * This function implements the GetNextVariableName service.
 323  *
 324  * See the Unified Extensible Firmware Interface (UEFI) specification for
 325  * details: http://wiki.phoenix.com/wiki/index.php/
 326  *              EFI_RUNTIME_SERVICES#GetNextVariableName.28.29
 327  *
 328  * Return: status code
 329  */
 330 efi_status_t EFIAPI efi_get_next_variable_name(efi_uintn_t *variable_name_size,
 331                                                u16 *variable_name,
 332                                                const efi_guid_t *vendor)
 333 {
 334         char *native_name, *variable;
 335         ssize_t name_len, list_len;
 336         char regex[256];
 337         char * const regexlist[] = {regex};
 338         u32 attributes;
 339         int i;
 340         efi_status_t ret;
 341
 342         EFI_ENTRY("%p \"%ls\" %pUl", variable_name_size, variable_name, vendor);
 343
 344         if (!variable_name_size || !variable_name || !vendor)
 345                 return EFI_EXIT(EFI_INVALID_PARAMETER);
 346
 347         if (variable_name[0]) {
 348                 /* check null-terminated string */
 349                 for (i = 0; i < *variable_name_size; i++)
 350                         if (!variable_name[i])
 351                                 break;
 352                 if (i >= *variable_name_size)
 353                         return EFI_EXIT(EFI_INVALID_PARAMETER);
 354
 355                 /* search for the last-returned variable */
 356                 ret = efi_to_native(&native_name, variable_name, vendor);
 357                 if (ret)
 358                         return EFI_EXIT(ret);
 359
 360                 name_len = strlen(native_name);
 361                 for (variable = efi_variables_list; variable && *variable;) {
 362                         if (!strncmp(variable, native_name, name_len) &&
 363                             variable[name_len] == '=')
 364                                 break;
 365
 366                         variable = strchr(variable, '\n');
 367                         if (variable)
 368                                 variable++;
 369                 }
 370
 371                 free(native_name);
 372                 if (!(variable && *variable))
 373                         return EFI_EXIT(EFI_INVALID_PARAMETER);
 374
 375                 /* next variable */
 376                 variable = strchr(variable, '\n');
 377                 if (variable)
 378                         variable++;
 379                 if (!(variable && *variable))
 380                         return EFI_EXIT(EFI_NOT_FOUND);
 381         } else {
 382                 /*
 383                  *new search: free a list used in the previous search
 384                  */
 385                 free(efi_variables_list);
 386                 efi_variables_list = NULL;
 387                 efi_cur_variable = NULL;
 388
 389                 snprintf(regex, 256, "efi_.*-.*-.*-.*-.*_.*");
 390                 list_len = hexport_r(&env_htab, '\n',
 391                                      H_MATCH_REGEX | H_MATCH_KEY,
 392                                      &efi_variables_list, 0, 1, regexlist);
 393                 /* 1 indicates that no match was found */
 394                 if (list_len <= 1)
 395                         return EFI_EXIT(EFI_NOT_FOUND);
 396
 397                 variable = efi_variables_list;
 398         }
 399
 400         ret = parse_uboot_variable(variable, variable_name_size, variable_name,
 401                                    vendor, &attributes);
 402
 403         return EFI_EXIT(ret);
 404 }
 405
 406 /**
 407  * efi_set_variable() - set value of a UEFI variable
 408  *
 409  * This function implements the SetVariable runtime service.
 410  *
 411  * See the Unified Extensible Firmware Interface (UEFI) specification for
 412  * details.
 413  *
 414  * @variable_name:      name of the variable
 415  * @vendor:             vendor GUID
 416  * @attributes:         attributes of the variable
 417  * @data_size:          size of the buffer with the variable value
 418  * @data:               buffer with the variable value
 419  * Return:              status code
 420  */
 421 efi_status_t EFIAPI efi_set_variable(u16 *variable_name,
 422                                      const efi_guid_t *vendor, u32 attributes,
 423                                      efi_uintn_t data_size, const void *data)
 424 {
 425         char *native_name = NULL, *val = NULL, *s;
 426         efi_status_t ret = EFI_SUCCESS;
 427         u32 attr;
 428
 429         EFI_ENTRY("\"%ls\" %pUl %x %zu %p", variable_name, vendor, attributes,
 430                   data_size, data);
 431
 432         /* TODO: implement APPEND_WRITE */
 433         if (!variable_name || !*variable_name || !vendor ||
 434             ((attributes & EFI_VARIABLE_RUNTIME_ACCESS) &&
 435              !(attributes & EFI_VARIABLE_BOOTSERVICE_ACCESS)) ||
 436             (attributes & EFI_VARIABLE_APPEND_WRITE)) {
 437                 ret = EFI_INVALID_PARAMETER;
 438                 goto out;
 439         }
 440
 441         ret = efi_to_native(&native_name, variable_name, vendor);
 442         if (ret)
 443                 goto out;
 444
 445 #define ACCESS_ATTR (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)
 446
 447         if ((data_size == 0) || !(attributes & ACCESS_ATTR)) {
 448                 /* delete the variable: */
 449                 env_set(native_name, NULL);
 450                 ret = EFI_SUCCESS;
 451                 goto out;
 452         }
 453
 454         val = env_get(native_name);
 455         if (val) {
 456                 parse_attr(val, &attr);
 457
 458                 /* We should not free val */
 459                 val = NULL;
 460                 if (attr & READ_ONLY) {
 461                         ret = EFI_WRITE_PROTECTED;
 462                         goto out;
 463                 }
 464
 465                 /*
 466                  * attributes won't be changed
 467                  * TODO: take care of APPEND_WRITE once supported
 468                  */
 469                 if (attr != attributes) {
 470                         ret = EFI_INVALID_PARAMETER;
 471                         goto out;
 472                 }
 473         }
 474
 475         val = malloc(2 * data_size + strlen("{ro,run,boot,nv}(blob)") + 1);
 476         if (!val) {
 477                 ret = EFI_OUT_OF_RESOURCES;
 478                 goto out;
 479         }
 480
 481         s = val;
 482
 483         /*
 484          * store attributes
 485          * TODO: several attributes are not supported
 486          */
 487         attributes &= (EFI_VARIABLE_NON_VOLATILE |
 488                        EFI_VARIABLE_BOOTSERVICE_ACCESS |
 489                        EFI_VARIABLE_RUNTIME_ACCESS);
 490         s += sprintf(s, "{");
 491         while (attributes) {
 492                 u32 attr = 1 << (ffs(attributes) - 1);
 493
 494                 if (attr == EFI_VARIABLE_NON_VOLATILE)
 495                         s += sprintf(s, "nv");
 496                 else if (attr == EFI_VARIABLE_BOOTSERVICE_ACCESS)
 497                         s += sprintf(s, "boot");
 498                 else if (attr == EFI_VARIABLE_RUNTIME_ACCESS)
 499                         s += sprintf(s, "run");
 500
 501                 attributes &= ~attr;
 502                 if (attributes)
 503                         s += sprintf(s, ",");
 504         }
 505         s += sprintf(s, "}");
 506
 507         /* store payload: */
 508         s += sprintf(s, "(blob)");
 509         s = bin2hex(s, data, data_size);
 510         *s = '\0';
 511
 512         EFI_PRINT("setting: %s=%s\n", native_name, val);
 513
 514         if (env_set(native_name, val))
 515                 ret = EFI_DEVICE_ERROR;
 516
 517 out:
 518         free(native_name);
 519         free(val);
 520
 521         return EFI_EXIT(ret);
 522 }
 523
 524 /**
 525  * efi_query_variable_info() - get information about EFI variables
 526  *
 527  * This function implements the QueryVariableInfo() runtime service.
 528  *
 529  * See the Unified Extensible Firmware Interface (UEFI) specification for
 530  * details.
 531  *
 532  * @attributes:                         bitmask to select variables to be
 533  *                                      queried
 534  * @maximum_variable_storage_size:      maximum size of storage area for the
 535  *                                      selected variable types
 536  * @remaining_variable_storage_size:    remaining size of storage are for the
 537  *                                      selected variable types
 538  * @maximum_variable_size:              maximum size of a variable of the
 539  *                                      selected type
 540  * Returns:                             status code
 541  */
 542 efi_status_t __efi_runtime EFIAPI efi_query_variable_info(
 543                         u32 attributes,
 544                         u64 *maximum_variable_storage_size,
 545                         u64 *remaining_variable_storage_size,
 546                         u64 *maximum_variable_size)
 547 {
 548         return EFI_UNSUPPORTED;
 549 }
 550
 551 /**
 552  * efi_get_variable_runtime() - runtime implementation of GetVariable()
 553  */
 554 static efi_status_t __efi_runtime EFIAPI
 555 efi_get_variable_runtime(u16 *variable_name, const efi_guid_t *vendor,
 556                          u32 *attributes, efi_uintn_t *data_size, void *data)
 557 {
 558         return EFI_UNSUPPORTED;
 559 }
 560
 561 /**
 562  * efi_get_next_variable_name_runtime() - runtime implementation of
 563  *                                        GetNextVariable()
 564  */
 565 static efi_status_t __efi_runtime EFIAPI
 566 efi_get_next_variable_name_runtime(efi_uintn_t *variable_name_size,
 567                                    u16 *variable_name, const efi_guid_t *vendor)
 568 {
 569         return EFI_UNSUPPORTED;
 570 }
 571
 572 /**
 573  * efi_set_variable_runtime() - runtime implementation of SetVariable()
 574  */
 575 static efi_status_t __efi_runtime EFIAPI
 576 efi_set_variable_runtime(u16 *variable_name, const efi_guid_t *vendor,
 577                          u32 attributes, efi_uintn_t data_size,
 578                          const void *data)
 579 {
 580         return EFI_UNSUPPORTED;
 581 }
 582
 583 /**
 584  * efi_variables_boot_exit_notify() - notify ExitBootServices() is called
 585  */
 586 void efi_variables_boot_exit_notify(void)
 587 {
 588         efi_runtime_services.get_variable = efi_get_variable_runtime;
 589         efi_runtime_services.get_next_variable_name =
 590                                 efi_get_next_variable_name_runtime;
 591         efi_runtime_services.set_variable = efi_set_variable_runtime;
 592         efi_update_table_header_crc32(&efi_runtime_services.hdr);
 593 }
 594
 595 /**
 596  * efi_init_variables() - initialize variable services
 597  *
 598  * Return:      status code
 599  */
 600 efi_status_t efi_init_variables(void)
 601 {
 602         return EFI_SUCCESS;
 603 }