lib/uuid.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright 2011 Calxeda, Inc.
   4  */
   5
   6 #include <common.h>
   7 #include <command.h>
   8 #include <env.h>
   9 #include <rand.h>
  10 #include <time.h>
  11 #include <uuid.h>
  12 #include <linux/ctype.h>
  13 #include <errno.h>
  14 #include <common.h>
  15 #include <asm/io.h>
  16 #include <part_efi.h>
  17 #include <malloc.h>
  18
  19 /*
  20  * UUID - Universally Unique IDentifier - 128 bits unique number.
  21  *        There are 5 versions and one variant of UUID defined by RFC4122
  22  *        specification. A UUID contains a set of fields. The set varies
  23  *        depending on the version of the UUID, as shown below:
  24  *        - time, MAC address(v1),
  25  *        - user ID(v2),
  26  *        - MD5 of name or URL(v3),
  27  *        - random data(v4),
  28  *        - SHA-1 of name or URL(v5),
  29  *
  30  * Layout of UUID:
  31  * timestamp - 60-bit: time_low, time_mid, time_hi_and_version
  32  * version   - 4 bit (bit 4 through 7 of the time_hi_and_version)
  33  * clock seq - 14 bit: clock_seq_hi_and_reserved, clock_seq_low
  34  * variant:  - bit 6 and 7 of clock_seq_hi_and_reserved
  35  * node      - 48 bit
  36  *
  37  * source: https://www.ietf.org/rfc/rfc4122.txt
  38  *
  39  * UUID binary format (16 bytes):
  40  *
  41  * 4B-2B-2B-2B-6B (big endian - network byte order)
  42  *
  43  * UUID string is 36 length of characters (36 bytes):
  44  *
  45  * 0        9    14   19   24
  46  * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  47  *    be     be   be   be       be
  48  *
  49  * where x is a hexadecimal character. Fields are separated by '-'s.
  50  * When converting to a binary UUID, le means the field should be converted
  51  * to little endian and be means it should be converted to big endian.
  52  *
  53  * UUID is also used as GUID (Globally Unique Identifier) with the same binary
  54  * format but it differs in string format like below.
  55  *
  56  * GUID:
  57  * 0        9    14   19   24
  58  * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  59  *    le     le   le   be       be
  60  *
  61  * GUID is used e.g. in GPT (GUID Partition Table) as a partiions unique id.
  62  */
  63 int uuid_str_valid(const char *uuid)
  64 {
  65         int i, valid;
  66
  67         if (uuid == NULL)
  68                 return 0;
  69
  70         for (i = 0, valid = 1; uuid[i] && valid; i++) {
  71                 switch (i) {
  72                 case 8: case 13: case 18: case 23:
  73                         valid = (uuid[i] == '-');
  74                         break;
  75                 default:
  76                         valid = isxdigit(uuid[i]);
  77                         break;
  78                 }
  79         }
  80
  81         if (i != UUID_STR_LEN || !valid)
  82                 return 0;
  83
  84         return 1;
  85 }
  86
  87 #ifdef CONFIG_PARTITION_TYPE_GUID
  88 static const struct {
  89         const char *string;
  90         efi_guid_t guid;
  91 } list_guid[] = {
  92         {"system",      PARTITION_SYSTEM_GUID},
  93         {"mbr",         LEGACY_MBR_PARTITION_GUID},
  94         {"msft",        PARTITION_MSFT_RESERVED_GUID},
  95         {"data",        PARTITION_BASIC_DATA_GUID},
  96         {"linux",       PARTITION_LINUX_FILE_SYSTEM_DATA_GUID},
  97         {"raid",        PARTITION_LINUX_RAID_GUID},
  98         {"swap",        PARTITION_LINUX_SWAP_GUID},
  99         {"lvm",         PARTITION_LINUX_LVM_GUID}
 100 };
 101
 102 /*
 103  * uuid_guid_get_bin() - this function get GUID bin for string
 104  *
 105  * @param guid_str - pointer to partition type string
 106  * @param guid_bin - pointer to allocated array for big endian output [16B]
 107  */
 108 int uuid_guid_get_bin(const char *guid_str, unsigned char *guid_bin)
 109 {
 110         int i;
 111
 112         for (i = 0; i < ARRAY_SIZE(list_guid); i++) {
 113                 if (!strcmp(list_guid[i].string, guid_str)) {
 114                         memcpy(guid_bin, &list_guid[i].guid, 16);
 115                         return 0;
 116                 }
 117         }
 118         return -ENODEV;
 119 }
 120
 121 /*
 122  * uuid_guid_get_str() - this function get string for GUID.
 123  *
 124  * @param guid_bin - pointer to string with partition type guid [16B]
 125  *
 126  * Returns NULL if the type GUID is not known.
 127  */
 128 const char *uuid_guid_get_str(const unsigned char *guid_bin)
 129 {
 130         int i;
 131
 132         for (i = 0; i < ARRAY_SIZE(list_guid); i++) {
 133                 if (!memcmp(list_guid[i].guid.b, guid_bin, 16)) {
 134                         return list_guid[i].string;
 135                 }
 136         }
 137         return NULL;
 138 }
 139 #endif
 140
 141 /*
 142  * uuid_str_to_bin() - convert string UUID or GUID to big endian binary data.
 143  *
 144  * @param uuid_str - pointer to UUID or GUID string [37B] or GUID shorcut
 145  * @param uuid_bin - pointer to allocated array for big endian output [16B]
 146  * @str_format     - UUID string format: 0 - UUID; 1 - GUID
 147  */
 148 int uuid_str_to_bin(const char *uuid_str, unsigned char *uuid_bin,
 149                     int str_format)
 150 {
 151         uint16_t tmp16;
 152         uint32_t tmp32;
 153         uint64_t tmp64;
 154
 155         if (!uuid_str_valid(uuid_str)) {
 156 #ifdef CONFIG_PARTITION_TYPE_GUID
 157                 if (!uuid_guid_get_bin(uuid_str, uuid_bin))
 158                         return 0;
 159 #endif
 160                 return -EINVAL;
 161         }
 162
 163         if (str_format == UUID_STR_FORMAT_STD) {
 164                 tmp32 = cpu_to_be32(simple_strtoul(uuid_str, NULL, 16));
 165                 memcpy(uuid_bin, &tmp32, 4);
 166
 167                 tmp16 = cpu_to_be16(simple_strtoul(uuid_str + 9, NULL, 16));
 168                 memcpy(uuid_bin + 4, &tmp16, 2);
 169
 170                 tmp16 = cpu_to_be16(simple_strtoul(uuid_str + 14, NULL, 16));
 171                 memcpy(uuid_bin + 6, &tmp16, 2);
 172         } else {
 173                 tmp32 = cpu_to_le32(simple_strtoul(uuid_str, NULL, 16));
 174                 memcpy(uuid_bin, &tmp32, 4);
 175
 176                 tmp16 = cpu_to_le16(simple_strtoul(uuid_str + 9, NULL, 16));
 177                 memcpy(uuid_bin + 4, &tmp16, 2);
 178
 179                 tmp16 = cpu_to_le16(simple_strtoul(uuid_str + 14, NULL, 16));
 180                 memcpy(uuid_bin + 6, &tmp16, 2);
 181         }
 182
 183         tmp16 = cpu_to_be16(simple_strtoul(uuid_str + 19, NULL, 16));
 184         memcpy(uuid_bin + 8, &tmp16, 2);
 185
 186         tmp64 = cpu_to_be64(simple_strtoull(uuid_str + 24, NULL, 16));
 187         memcpy(uuid_bin + 10, (char *)&tmp64 + 2, 6);
 188
 189         return 0;
 190 }
 191
 192 /*
 193  * uuid_bin_to_str() - convert big endian binary data to string UUID or GUID.
 194  *
 195  * @param uuid_bin:     pointer to binary data of UUID (big endian) [16B]
 196  * @param uuid_str:     pointer to allocated array for output string [37B]
 197  * @str_format:         bit 0: 0 - UUID; 1 - GUID
 198  *                      bit 1: 0 - lower case; 2 - upper case
 199  */
 200 void uuid_bin_to_str(const unsigned char *uuid_bin, char *uuid_str,
 201                      int str_format)
 202 {
 203         const u8 uuid_char_order[UUID_BIN_LEN] = {0, 1, 2, 3, 4, 5, 6, 7, 8,
 204                                                   9, 10, 11, 12, 13, 14, 15};
 205         const u8 guid_char_order[UUID_BIN_LEN] = {3, 2, 1, 0, 5, 4, 7, 6, 8,
 206                                                   9, 10, 11, 12, 13, 14, 15};
 207         const u8 *char_order;
 208         const char *format;
 209         int i;
 210
 211         /*
 212          * UUID and GUID bin data - always in big endian:
 213          * 4B-2B-2B-2B-6B
 214          * be be be be be
 215          */
 216         if (str_format & UUID_STR_FORMAT_GUID)
 217                 char_order = guid_char_order;
 218         else
 219                 char_order = uuid_char_order;
 220         if (str_format & UUID_STR_UPPER_CASE)
 221                 format = "%02X";
 222         else
 223                 format = "%02x";
 224
 225         for (i = 0; i < 16; i++) {
 226                 sprintf(uuid_str, format, uuid_bin[char_order[i]]);
 227                 uuid_str += 2;
 228                 switch (i) {
 229                 case 3:
 230                 case 5:
 231                 case 7:
 232                 case 9:
 233                         *uuid_str++ = '-';
 234                         break;
 235                 }
 236         }
 237 }
 238
 239 /*
 240  * gen_rand_uuid() - this function generates a random binary UUID version 4.
 241  *                   In this version all fields beside 4 bits of version and
 242  *                   2 bits of variant are randomly generated.
 243  *
 244  * @param uuid_bin - pointer to allocated array [16B]. Output is in big endian.
 245 */
 246 #if defined(CONFIG_RANDOM_UUID) || defined(CONFIG_CMD_UUID)
 247 void gen_rand_uuid(unsigned char *uuid_bin)
 248 {
 249         u32 ptr[4];
 250         struct uuid *uuid = (struct uuid *)ptr;
 251         int i;
 252
 253         srand(get_ticks() + rand());
 254
 255         /* Set all fields randomly */
 256         for (i = 0; i < 4; i++)
 257                 ptr[i] = rand();
 258
 259         clrsetbits_be16(&uuid->time_hi_and_version,
 260                         UUID_VERSION_MASK,
 261                         UUID_VERSION << UUID_VERSION_SHIFT);
 262
 263         clrsetbits_8(&uuid->clock_seq_hi_and_reserved,
 264                      UUID_VARIANT_MASK,
 265                      UUID_VARIANT << UUID_VARIANT_SHIFT);
 266
 267         memcpy(uuid_bin, uuid, 16);
 268 }
 269
 270 /*
 271  * gen_rand_uuid_str() - this function generates UUID v4 (random) in two string
 272  *                       formats UUID or GUID.
 273  *
 274  * @param uuid_str - pointer to allocated array [37B].
 275  * @param          - uuid output type: UUID - 0, GUID - 1
 276  */
 277 void gen_rand_uuid_str(char *uuid_str, int str_format)
 278 {
 279         unsigned char uuid_bin[UUID_BIN_LEN];
 280
 281         /* Generate UUID (big endian) */
 282         gen_rand_uuid(uuid_bin);
 283
 284         /* Convert UUID bin to UUID or GUID formated STRING  */
 285         uuid_bin_to_str(uuid_bin, uuid_str, str_format);
 286 }
 287
 288 #if !defined(CONFIG_SPL_BUILD) && defined(CONFIG_CMD_UUID)
 289 int do_uuid(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 290 {
 291         char uuid[UUID_STR_LEN + 1];
 292         int str_format;
 293
 294         if (!strcmp(argv[0], "uuid"))
 295                 str_format = UUID_STR_FORMAT_STD;
 296         else
 297                 str_format = UUID_STR_FORMAT_GUID;
 298
 299         if (argc > 2)
 300                 return CMD_RET_USAGE;
 301
 302         gen_rand_uuid_str(uuid, str_format);
 303
 304         if (argc == 1)
 305                 printf("%s\n", uuid);
 306         else
 307                 env_set(argv[1], uuid);
 308
 309         return CMD_RET_SUCCESS;
 310 }
 311
 312 U_BOOT_CMD(uuid, CONFIG_SYS_MAXARGS, 1, do_uuid,
 313            "UUID - generate random Universally Unique Identifier",
 314            "[<varname>]\n"
 315            "Argument:\n"
 316            "varname: for set result in a environment variable\n"
 317            "e.g. uuid uuid_env"
 318 );
 319
 320 U_BOOT_CMD(guid, CONFIG_SYS_MAXARGS, 1, do_uuid,
 321            "GUID - generate Globally Unique Identifier based on random UUID",
 322            "[<varname>]\n"
 323            "Argument:\n"
 324            "varname: for set result in a environment variable\n"
 325            "e.g. guid guid_env"
 326 );
 327 #endif /* CONFIG_CMD_UUID */
 328 #endif /* CONFIG_RANDOM_UUID || CONFIG_CMD_UUID */