xref: /openbmc/linux/lib/uuid.c (revision d063623b6ae7c326d21a2713dd38cab15d794c1c)
1fab1c232SHuang Ying /*
2fab1c232SHuang Ying  * Unified UUID/GUID definition
3fab1c232SHuang Ying  *
4e3a93bceSAndy Shevchenko  * Copyright (C) 2009, 2016 Intel Corp.
5fab1c232SHuang Ying  *	Huang Ying <ying.huang@intel.com>
6fab1c232SHuang Ying  *
7fab1c232SHuang Ying  * This program is free software; you can redistribute it and/or
8fab1c232SHuang Ying  * modify it under the terms of the GNU General Public License version
9fab1c232SHuang Ying  * 2 as published by the Free Software Foundation;
10fab1c232SHuang Ying  *
11fab1c232SHuang Ying  * This program is distributed in the hope that it will be useful,
12fab1c232SHuang Ying  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13fab1c232SHuang Ying  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14fab1c232SHuang Ying  * GNU General Public License for more details.
15fab1c232SHuang Ying  */
16fab1c232SHuang Ying 
17fab1c232SHuang Ying #include <linux/kernel.h>
182b1b0d66SAndy Shevchenko #include <linux/ctype.h>
192b1b0d66SAndy Shevchenko #include <linux/errno.h>
208bc3bcc9SPaul Gortmaker #include <linux/export.h>
21fab1c232SHuang Ying #include <linux/uuid.h>
22fab1c232SHuang Ying #include <linux/random.h>
23fab1c232SHuang Ying 
24ef40dda5SChristoph Hellwig const guid_t guid_null;
25ef40dda5SChristoph Hellwig EXPORT_SYMBOL(guid_null);
26ef40dda5SChristoph Hellwig const uuid_t uuid_null;
27ef40dda5SChristoph Hellwig EXPORT_SYMBOL(uuid_null);
28ef40dda5SChristoph Hellwig 
29f9727a17SChristoph Hellwig const u8 guid_index[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
30f9727a17SChristoph Hellwig const u8 uuid_index[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
312b1b0d66SAndy Shevchenko 
32*d063623bSRandy Dunlap /**
33*d063623bSRandy Dunlap  * generate_random_uuid - generate a random UUID
34*d063623bSRandy Dunlap  * @uuid: where to put the generated UUID
35*d063623bSRandy Dunlap  *
368da4b8c4SAndy Shevchenko  * Random UUID interface
378da4b8c4SAndy Shevchenko  *
38*d063623bSRandy Dunlap  * Used to create a Boot ID or a filesystem UUID/GUID, but can be
39*d063623bSRandy Dunlap  * useful for other kernel drivers.
408da4b8c4SAndy Shevchenko  */
418da4b8c4SAndy Shevchenko void generate_random_uuid(unsigned char uuid[16])
428da4b8c4SAndy Shevchenko {
438da4b8c4SAndy Shevchenko 	get_random_bytes(uuid, 16);
448da4b8c4SAndy Shevchenko 	/* Set UUID version to 4 --- truly random generation */
458da4b8c4SAndy Shevchenko 	uuid[6] = (uuid[6] & 0x0F) | 0x40;
468da4b8c4SAndy Shevchenko 	/* Set the UUID variant to DCE */
478da4b8c4SAndy Shevchenko 	uuid[8] = (uuid[8] & 0x3F) | 0x80;
488da4b8c4SAndy Shevchenko }
498da4b8c4SAndy Shevchenko EXPORT_SYMBOL(generate_random_uuid);
508da4b8c4SAndy Shevchenko 
51fab1c232SHuang Ying static void __uuid_gen_common(__u8 b[16])
52fab1c232SHuang Ying {
53cedddb00SAkinobu Mita 	prandom_bytes(b, 16);
54fab1c232SHuang Ying 	/* reversion 0b10 */
55fab1c232SHuang Ying 	b[8] = (b[8] & 0x3F) | 0x80;
56fab1c232SHuang Ying }
57fab1c232SHuang Ying 
58f9727a17SChristoph Hellwig void guid_gen(guid_t *lu)
59fab1c232SHuang Ying {
60fab1c232SHuang Ying 	__uuid_gen_common(lu->b);
61fab1c232SHuang Ying 	/* version 4 : random generation */
62fab1c232SHuang Ying 	lu->b[7] = (lu->b[7] & 0x0F) | 0x40;
63fab1c232SHuang Ying }
64f9727a17SChristoph Hellwig EXPORT_SYMBOL_GPL(guid_gen);
65fab1c232SHuang Ying 
66f9727a17SChristoph Hellwig void uuid_gen(uuid_t *bu)
67fab1c232SHuang Ying {
68fab1c232SHuang Ying 	__uuid_gen_common(bu->b);
69fab1c232SHuang Ying 	/* version 4 : random generation */
70fab1c232SHuang Ying 	bu->b[6] = (bu->b[6] & 0x0F) | 0x40;
71fab1c232SHuang Ying }
72f9727a17SChristoph Hellwig EXPORT_SYMBOL_GPL(uuid_gen);
732b1b0d66SAndy Shevchenko 
742b1b0d66SAndy Shevchenko /**
75*d063623bSRandy Dunlap  * uuid_is_valid - checks if a UUID string is valid
762b1b0d66SAndy Shevchenko  * @uuid:	UUID string to check
772b1b0d66SAndy Shevchenko  *
782b1b0d66SAndy Shevchenko  * Description:
792b1b0d66SAndy Shevchenko  * It checks if the UUID string is following the format:
802b1b0d66SAndy Shevchenko  *	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
81*d063623bSRandy Dunlap  *
822b1b0d66SAndy Shevchenko  * where x is a hex digit.
832b1b0d66SAndy Shevchenko  *
842b1b0d66SAndy Shevchenko  * Return: true if input is valid UUID string.
852b1b0d66SAndy Shevchenko  */
862b1b0d66SAndy Shevchenko bool uuid_is_valid(const char *uuid)
872b1b0d66SAndy Shevchenko {
882b1b0d66SAndy Shevchenko 	unsigned int i;
892b1b0d66SAndy Shevchenko 
902b1b0d66SAndy Shevchenko 	for (i = 0; i < UUID_STRING_LEN; i++) {
912b1b0d66SAndy Shevchenko 		if (i == 8 || i == 13 || i == 18 || i == 23) {
922b1b0d66SAndy Shevchenko 			if (uuid[i] != '-')
932b1b0d66SAndy Shevchenko 				return false;
942b1b0d66SAndy Shevchenko 		} else if (!isxdigit(uuid[i])) {
952b1b0d66SAndy Shevchenko 			return false;
962b1b0d66SAndy Shevchenko 		}
972b1b0d66SAndy Shevchenko 	}
982b1b0d66SAndy Shevchenko 
992b1b0d66SAndy Shevchenko 	return true;
1002b1b0d66SAndy Shevchenko }
1012b1b0d66SAndy Shevchenko EXPORT_SYMBOL(uuid_is_valid);
1022b1b0d66SAndy Shevchenko 
103f9727a17SChristoph Hellwig static int __uuid_parse(const char *uuid, __u8 b[16], const u8 ei[16])
1042b1b0d66SAndy Shevchenko {
1052b1b0d66SAndy Shevchenko 	static const u8 si[16] = {0,2,4,6,9,11,14,16,19,21,24,26,28,30,32,34};
1062b1b0d66SAndy Shevchenko 	unsigned int i;
1072b1b0d66SAndy Shevchenko 
1082b1b0d66SAndy Shevchenko 	if (!uuid_is_valid(uuid))
1092b1b0d66SAndy Shevchenko 		return -EINVAL;
1102b1b0d66SAndy Shevchenko 
1112b1b0d66SAndy Shevchenko 	for (i = 0; i < 16; i++) {
112bc9dc9d5SBjørn Mork 		int hi = hex_to_bin(uuid[si[i] + 0]);
113bc9dc9d5SBjørn Mork 		int lo = hex_to_bin(uuid[si[i] + 1]);
1142b1b0d66SAndy Shevchenko 
1152b1b0d66SAndy Shevchenko 		b[ei[i]] = (hi << 4) | lo;
1162b1b0d66SAndy Shevchenko 	}
1172b1b0d66SAndy Shevchenko 
1182b1b0d66SAndy Shevchenko 	return 0;
1192b1b0d66SAndy Shevchenko }
1202b1b0d66SAndy Shevchenko 
121f9727a17SChristoph Hellwig int guid_parse(const char *uuid, guid_t *u)
1222b1b0d66SAndy Shevchenko {
123f9727a17SChristoph Hellwig 	return __uuid_parse(uuid, u->b, guid_index);
1242b1b0d66SAndy Shevchenko }
125f9727a17SChristoph Hellwig EXPORT_SYMBOL(guid_parse);
1262b1b0d66SAndy Shevchenko 
127f9727a17SChristoph Hellwig int uuid_parse(const char *uuid, uuid_t *u)
1282b1b0d66SAndy Shevchenko {
129f9727a17SChristoph Hellwig 	return __uuid_parse(uuid, u->b, uuid_index);
1302b1b0d66SAndy Shevchenko }
131f9727a17SChristoph Hellwig EXPORT_SYMBOL(uuid_parse);
132