^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0-only
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Unified UUID/GUID definition
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (C) 2009, 2016 Intel Corp.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Huang Ying <ying.huang@intel.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #include <linux/kernel.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #include <linux/ctype.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #include <linux/errno.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/export.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/uuid.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/random.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) const guid_t guid_null;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) EXPORT_SYMBOL(guid_null);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) const uuid_t uuid_null;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) EXPORT_SYMBOL(uuid_null);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) const u8 guid_index[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) const u8 uuid_index[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) * generate_random_uuid - generate a random UUID
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) * @uuid: where to put the generated UUID
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) * Random UUID interface
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) * Used to create a Boot ID or a filesystem UUID/GUID, but can be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) * useful for other kernel drivers.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) void generate_random_uuid(unsigned char uuid[16])
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) get_random_bytes(uuid, 16);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) /* Set UUID version to 4 --- truly random generation */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) uuid[6] = (uuid[6] & 0x0F) | 0x40;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) /* Set the UUID variant to DCE */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) uuid[8] = (uuid[8] & 0x3F) | 0x80;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) EXPORT_SYMBOL(generate_random_uuid);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) void generate_random_guid(unsigned char guid[16])
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) get_random_bytes(guid, 16);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) /* Set GUID version to 4 --- truly random generation */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) guid[7] = (guid[7] & 0x0F) | 0x40;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) /* Set the GUID variant to DCE */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) guid[8] = (guid[8] & 0x3F) | 0x80;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) EXPORT_SYMBOL(generate_random_guid);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) static void __uuid_gen_common(__u8 b[16])
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) prandom_bytes(b, 16);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) /* reversion 0b10 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) b[8] = (b[8] & 0x3F) | 0x80;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) void guid_gen(guid_t *lu)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) __uuid_gen_common(lu->b);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) /* version 4 : random generation */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) lu->b[7] = (lu->b[7] & 0x0F) | 0x40;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) EXPORT_SYMBOL_GPL(guid_gen);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) void uuid_gen(uuid_t *bu)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) __uuid_gen_common(bu->b);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) /* version 4 : random generation */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) bu->b[6] = (bu->b[6] & 0x0F) | 0x40;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) EXPORT_SYMBOL_GPL(uuid_gen);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) * uuid_is_valid - checks if a UUID string is valid
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) * @uuid: UUID string to check
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) * Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) * It checks if the UUID string is following the format:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) * where x is a hex digit.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) * Return: true if input is valid UUID string.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) bool uuid_is_valid(const char *uuid)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) unsigned int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) for (i = 0; i < UUID_STRING_LEN; i++) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) if (i == 8 || i == 13 || i == 18 || i == 23) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) if (uuid[i] != '-')
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) return false;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) } else if (!isxdigit(uuid[i])) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) return false;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) return true;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) EXPORT_SYMBOL(uuid_is_valid);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) static int __uuid_parse(const char *uuid, __u8 b[16], const u8 ei[16])
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) static const u8 si[16] = {0,2,4,6,9,11,14,16,19,21,24,26,28,30,32,34};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) unsigned int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) if (!uuid_is_valid(uuid))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) return -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) for (i = 0; i < 16; i++) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) int hi = hex_to_bin(uuid[si[i] + 0]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) int lo = hex_to_bin(uuid[si[i] + 1]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) b[ei[i]] = (hi << 4) | lo;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) int guid_parse(const char *uuid, guid_t *u)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) return __uuid_parse(uuid, u->b, guid_index);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) EXPORT_SYMBOL(guid_parse);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) int uuid_parse(const char *uuid, uuid_t *u)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) return __uuid_parse(uuid, u->b, uuid_index);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) EXPORT_SYMBOL(uuid_parse);