uuid.c 8.5 KB

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