xref: /netbsd-src/sbin/gpt/gpt_uuid.c (revision 946379e7b37692fc43f68eb0d1c10daa0a7f3b6c)
1 /*	$NetBSD: gpt_uuid.c,v 1.13 2015/12/06 00:39:26 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 2014 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #if HAVE_NBTOOL_CONFIG_H
30 #include "nbtool_config.h"
31 #endif
32 
33 #include <sys/cdefs.h>
34 #ifdef __RCSID
35 __RCSID("$NetBSD: gpt_uuid.c,v 1.13 2015/12/06 00:39:26 christos Exp $");
36 #endif
37 
38 #include <err.h>
39 #include <fcntl.h>
40 #include <stdio.h>
41 #include <unistd.h>
42 
43 #include "map.h"
44 #include "gpt.h"
45 
46 #if defined(HAVE_SYS_ENDIAN_H) || ! defined(HAVE_NBTOOL_CONFIG_H)
47 #include <sys/endian.h>
48 #endif
49 
50 
51 const gpt_uuid_t gpt_uuid_nil;
52 
53 struct dce_uuid {
54 	uint32_t	time_low;
55 	uint16_t	time_mid;
56 	uint16_t	time_hi_and_version;
57 	uint8_t		clock_seq_hi_and_reserved;
58 	uint8_t		clock_seq_low;
59 	uint8_t		node[6];
60 };
61 
62 static const struct {
63 	struct dce_uuid u;
64 	const char *n;
65 	const char *d;
66 } gpt_nv[] = {
67 	{ GPT_ENT_TYPE_APPLE_HFS, "apple", "Apple HFS" },
68 	{ GPT_ENT_TYPE_APPLE_UFS, "apple-ufs", "Apple UFS" },
69 	{ GPT_ENT_TYPE_BIOS, "bios", "BIOS Boot" },
70 	{ GPT_ENT_TYPE_EFI, "efi", "EFI System" },
71 	{ GPT_ENT_TYPE_FREEBSD, "fbsd-legacy", "FreeBSD legacy" },
72 	{ GPT_ENT_TYPE_FREEBSD_SWAP, "fbsd-swap", "FreeBSD swap" },
73 	{ GPT_ENT_TYPE_FREEBSD_UFS, "fbsd-ufs", "FreeBSD UFS/UFS2" },
74 	{ GPT_ENT_TYPE_FREEBSD_VINUM, "fbsd-vinum", "FreeBSD vinum" },
75 	{ GPT_ENT_TYPE_FREEBSD_ZFS, "fbsd-zfs", "FreeBSD ZFS" },
76 	{ GPT_ENT_TYPE_LINUX_DATA, "linux-data", "Linux data" },
77 	{ GPT_ENT_TYPE_LINUX_RAID, "linux-raid", "Linux RAID" },
78 	{ GPT_ENT_TYPE_LINUX_SWAP, "linux-swap", "Linux swap" },
79 	{ GPT_ENT_TYPE_LINUX_LVM, "linux-lvm", "Linux LVM" },
80 	{ GPT_ENT_TYPE_MS_BASIC_DATA, "windows", "Windows basic data" },
81 	{ GPT_ENT_TYPE_MS_RESERVED, "windows-reserved", "Windows reserved" },
82 	{ GPT_ENT_TYPE_NETBSD_CCD, "ccd", "NetBSD ccd component" },
83 	{ GPT_ENT_TYPE_NETBSD_CGD, "cgd", "NetBSD Cryptographic Disk" },
84 	{ GPT_ENT_TYPE_NETBSD_FFS, "ffs", "NetBSD FFSv1/FFSv2" },
85 	{ GPT_ENT_TYPE_NETBSD_LFS, "lfs", "NetBSD LFS" },
86 	{ GPT_ENT_TYPE_NETBSD_RAIDFRAME, "raid",
87 	    "NetBSD RAIDFrame component" },
88 	{ GPT_ENT_TYPE_NETBSD_SWAP, "swap", "NetBSD swap" },
89 };
90 
91 static void
92 gpt_uuid_to_dce(const gpt_uuid_t buf, struct dce_uuid *uuid)
93 {
94 	const uint8_t *p = buf;
95 	size_t i;
96 
97 	uuid->time_low = le32dec(p);
98 	uuid->time_mid = le16dec(p + 4);
99 	uuid->time_hi_and_version = le16dec(p + 6);
100 	uuid->clock_seq_hi_and_reserved = p[8];
101 	uuid->clock_seq_low = p[9];
102 	for (i = 0; i < sizeof(uuid->node); i++)
103 		uuid->node[i] = p[10 + i];
104 }
105 
106 static void
107 gpt_dce_to_uuid(const struct dce_uuid *uuid, uint8_t *buf)
108 {
109 	uint8_t *p = buf;
110 	size_t i;
111 
112 	le32enc(p, uuid->time_low);
113 	le16enc(p + 4, uuid->time_mid);
114 	le16enc(p + 6, uuid->time_hi_and_version);
115 	p[8] = uuid->clock_seq_hi_and_reserved;
116 	p[9] = uuid->clock_seq_low;
117 	for (i = 0; i < sizeof(uuid->node); i++)
118 		p[10 + i] = uuid->node[i];
119 }
120 
121 static int
122 gpt_uuid_numeric(char *buf, size_t bufsiz, const struct dce_uuid *u)
123 {
124 	return snprintf(buf, bufsiz,
125 	    "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
126 	    u->time_low, u->time_mid, u->time_hi_and_version,
127 	    u->clock_seq_hi_and_reserved, u->clock_seq_low, u->node[0],
128 	    u->node[1], u->node[2], u->node[3], u->node[4], u->node[5]);
129 }
130 
131 
132 static int
133 gpt_uuid_symbolic(char *buf, size_t bufsiz, const struct dce_uuid *u)
134 {
135 	size_t i;
136 
137 	for (i = 0; i < __arraycount(gpt_nv); i++)
138 		if (memcmp(&gpt_nv[i].u, u, sizeof(*u)) == 0)
139 			return (int)strlcpy(buf, gpt_nv[i].n, bufsiz);
140 	return -1;
141 }
142 
143 static int
144 gpt_uuid_descriptive(char *buf, size_t bufsiz, const struct dce_uuid *u)
145 {
146 	size_t i;
147 
148 	for (i = 0; i < __arraycount(gpt_nv); i++)
149 		if (memcmp(&gpt_nv[i].u, u, sizeof(*u)) == 0)
150 			return (int)strlcpy(buf, gpt_nv[i].d, bufsiz);
151 	return -1;
152 }
153 
154 int
155 gpt_uuid_snprintf(char *buf, size_t bufsiz, const char *fmt,
156     const gpt_uuid_t uu)
157 {
158 	struct dce_uuid u;
159 	gpt_uuid_to_dce(uu, &u);
160 
161 	if (fmt[1] == 's') {
162 		int r;
163 		if ((r = gpt_uuid_symbolic(buf, bufsiz, &u)) != -1)
164 			return r;
165 	}
166 	if (fmt[1] == 'l') {
167 		int r;
168 		if ((r = gpt_uuid_descriptive(buf, bufsiz, &u)) != -1)
169 			return r;
170 	}
171 	return gpt_uuid_numeric(buf, bufsiz, &u);
172 }
173 
174 static int
175 gpt_uuid_parse_numeric(const char *s, struct dce_uuid *u)
176 {
177 	int n;
178 
179 	if (s == NULL || *s == '\0') {
180 		memset(u, 0, sizeof(*u));
181 		return 0;
182 	}
183 
184 	n = sscanf(s,
185 	    "%8x-%4hx-%4hx-%2hhx%2hhx-%2hhx%2hhx%2hhx%2hhx%2hhx%2hhx",
186 	    &u->time_low, &u->time_mid, &u->time_hi_and_version,
187 	    &u->clock_seq_hi_and_reserved, &u->clock_seq_low, &u->node[0],
188 	    &u->node[1], &u->node[2], &u->node[3], &u->node[4], &u->node[5]);
189 
190 	/* Make sure we have all conversions. */
191 	if (n != 11)
192 		return -1;
193 
194 	/* We have a successful scan. Check semantics... */
195 	n = u->clock_seq_hi_and_reserved;
196 	if ((n & 0x80) != 0x00 &&			/* variant 0? */
197 	    (n & 0xc0) != 0x80 &&			/* variant 1? */
198 	    (n & 0xe0) != 0xc0) 			/* variant 2? */
199 		return -1;
200 	return 0;
201 }
202 
203 static int
204 gpt_uuid_parse_symbolic(const char *s, struct dce_uuid *u)
205 {
206 	size_t i;
207 
208 	for (i = 0; i < __arraycount(gpt_nv); i++)
209 		if (strcmp(gpt_nv[i].n, s) == 0) {
210 			*u = gpt_nv[i].u;
211 			return 0;
212 		}
213 	return -1;
214 }
215 
216 int
217 gpt_uuid_parse(const char *s, gpt_uuid_t uuid)
218 {
219 	struct dce_uuid u;
220 
221 	if (gpt_uuid_parse_numeric(s, &u) != -1) {
222 		gpt_dce_to_uuid(&u, uuid);
223 		return 0;
224 	}
225 
226 	if (gpt_uuid_parse_symbolic(s, &u) == -1)
227 		return -1;
228 
229 	gpt_dce_to_uuid(&u, uuid);
230 	return 0;
231 }
232 
233 void
234 gpt_uuid_help(const char *prefix)
235 {
236 	size_t i;
237 
238 	for (i = 0; i < __arraycount(gpt_nv); i++)
239 		printf("%s%18.18s\t%s\n", prefix, gpt_nv[i].n, gpt_nv[i].d);
240 }
241 
242 void
243 gpt_uuid_create(gpt_type_t t, gpt_uuid_t u, uint16_t *b, size_t s)
244 {
245 	gpt_dce_to_uuid(&gpt_nv[t].u, u);
246 	if (b)
247 		utf8_to_utf16((const uint8_t *)gpt_nv[t].d, b, s / sizeof(*b));
248 }
249 
250 int
251 gpt_uuid_generate(gpt_t gpt, gpt_uuid_t t)
252 {
253 	struct dce_uuid u;
254 	int fd;
255 	uint8_t *p;
256 	size_t n;
257 	ssize_t nread;
258 
259 	/* Randomly generate the content.  */
260 	fd = open("/dev/urandom", O_RDONLY | O_CLOEXEC);
261 	if (fd == -1) {
262 		gpt_warn(gpt, "Can't open `/dev/urandom'");
263 		return -1;
264 	}
265 	for (p = (void *)&u, n = sizeof u; n > 0; p += nread, n -= (size_t)nread) {
266 		nread = read(fd, p, n);
267 		if (nread < 0) {
268 			gpt_warn(gpt, "Can't read `/dev/urandom'");
269 			goto out;
270 		}
271 		if (nread == 0) {
272 			gpt_warn(gpt, "EOF from /dev/urandom");
273 			goto out;
274 		}
275 		if ((size_t)nread > n) {
276 			gpt_warnx(gpt, "read too much: %zd > %zu", nread, n);
277 			goto out;
278 		}
279 	}
280 	(void)close(fd);
281 
282 	/* Set the version number to 4.  */
283 	u.time_hi_and_version &= (uint16_t)~0xf000;
284 	u.time_hi_and_version |= 0x4000;
285 
286 	/* Fix the reserved bits.  */
287 	u.clock_seq_hi_and_reserved &= (uint8_t)~0x40;
288 	u.clock_seq_hi_and_reserved |= 0x80;
289 
290 	gpt_dce_to_uuid(&u, t);
291 	close(fd);
292 	return 0;
293 out:
294 	return -1;
295 }
296