uuid.c 8.2 KB

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