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