uuid.c 8.4 KB

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