xref: /freebsd/stand/libsa/uuid_from_string.c (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * Copyright (c) 2015 M. Warner Losh <imp@FreeBSD.org>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  */
25 
26 /*
27  * Note: some comments taken from lib/libc/uuid/uuid_from_string.c
28  * Copyright (c) 2002 Marcel Moolenaar
29  * Copyright (c) 2002 Hiten Mahesh Pandya
30  */
31 
32 
33 #include <stand.h>
34 #include <uuid.h>
35 
36 static int
37 hex2int(int ch)
38 {
39 	if (ch >= '0' && ch <= '9')
40 		return ch - '0';
41 	if (ch >= 'a' && ch <= 'f')
42 		return 10 + ch - 'a';
43 	if (ch >= 'A' && ch <= 'F')
44 		return 10 + ch - 'A';
45 	return 16;
46 }
47 
48 static uint32_t
49 fromhex(const char *s, int len, int *ok)
50 {
51 	uint32_t v;
52 	int i, h;
53 
54 	if (!*ok)
55 		return 0;
56 	v = 0;
57 	for (i = 0; i < len; i++) {
58 		h = hex2int(s[i]);
59 		if (h == 16) {
60 			*ok = 0;
61 			return v;
62 		}
63 		v = (v << 4) | h;
64 	}
65 	return v;
66 }
67 
68 /*
69  * uuid_from_string() - convert a string representation of an UUID into
70  *			a binary representation.
71  * See also:
72  *	http://www.opengroup.org/onlinepubs/009629399/uuid_from_string.htm
73  *
74  * NOTE: The sequence field is in big-endian, while the time fields are in
75  *	 native byte order.
76  *
77  * 01234567-89ab-cdef-0123-456789abcdef
78  * 000000000011111111112222222222333333
79  * 012345678901234567890123456789012345
80  *         -    -    -    -
81  * hhhhhhhh-hhhh-hhhh-bbbb-bbbbbbbbbbbb
82  *
83  */
84 void
85 uuid_from_string(const char *s, uuid_t *u, uint32_t *status)
86 {
87 	int ok = 1;
88 	int n;
89 
90 	if (s == NULL || *s == '\0') {
91 		uuid_create_nil(u, status);
92 		return;
93 	}
94 
95 	if (status != NULL)
96 		*status = uuid_s_invalid_string_uuid;
97 	if (strlen(s) != 36)
98 		return;
99 	/* Only support new format, check for all the right dashes */
100 	if (s[8] != '-' || s[13] != '-' || s[18] != '-' || s[23] != '-')
101 		return;
102 	/* native byte order */
103 	u->time_low                  = fromhex(s     , 8, &ok);
104 	u->time_mid                  = fromhex(s +  9, 4, &ok);
105 	u->time_hi_and_version       = fromhex(s + 14, 4, &ok);
106 	/* Big endian, but presented as a whole number so decode as such */
107 	u->clock_seq_hi_and_reserved = fromhex(s + 19, 2, &ok);
108 	u->clock_seq_low             = fromhex(s + 21, 2, &ok);
109 	u->node[0]                   = fromhex(s + 24, 2, &ok);
110 	u->node[1]                   = fromhex(s + 26, 2, &ok);
111 	u->node[2]                   = fromhex(s + 28, 2, &ok);
112 	u->node[3]                   = fromhex(s + 30, 2, &ok);
113 	u->node[4]                   = fromhex(s + 32, 2, &ok);
114 	u->node[5]                   = fromhex(s + 34, 2, &ok);
115 	if (!ok)
116 		return;
117 
118 	/* We have a successful scan. Check semantics... */
119 	n = u->clock_seq_hi_and_reserved;
120 	if ((n & 0x80) != 0x00 &&			/* variant 0? */
121 	    (n & 0xc0) != 0x80 &&			/* variant 1? */
122 	    (n & 0xe0) != 0xc0) {			/* variant 2? */
123 		if (status != NULL)
124 			*status = uuid_s_bad_version;
125 	} else {
126 		if (status != NULL)
127 			*status = uuid_s_ok;
128 	}
129 }
130