lib/uuid.c

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