xref: /freebsd/sys/geom/label/g_label_ntfs.c (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2005 Takanori Watanabe
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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/malloc.h>
36 
37 #include <geom/geom.h>
38 #include <geom/label/g_label.h>
39 
40 #define	NTFS_A_VOLUMENAME	0x60
41 #define	NTFS_FILEMAGIC		((uint32_t)(0x454C4946))
42 #define	NTFS_VOLUMEINO		3
43 
44 struct ntfs_attr {
45 	uint32_t	a_type;
46 	uint32_t	reclen;
47 	uint8_t		a_flag;
48 	uint8_t		a_namelen;
49 	uint8_t		a_nameoff;
50 	uint8_t		reserved1;
51 	uint8_t		a_compression;
52 	uint8_t		reserved2;
53 	uint16_t	a_index;
54 	uint16_t	a_datalen;
55 	uint16_t	reserved3;
56 	uint16_t	a_dataoff;
57 	uint16_t	a_indexed;
58 } __packed;
59 
60 struct ntfs_filerec {
61 	uint32_t	fr_hdrmagic;
62 	uint16_t	fr_hdrfoff;
63 	uint16_t	fr_hdrfnum;
64 	uint8_t		reserved[8];
65 	uint16_t	fr_seqnum;
66 	uint16_t	fr_nlink;
67 	uint16_t	fr_attroff;
68 	uint16_t	fr_flags;
69 	uint32_t	fr_size;
70 	uint32_t	fr_allocated;
71 	uint64_t	fr_mainrec;
72 	uint16_t	fr_attrnum;
73 } __packed;
74 
75 struct ntfs_bootfile {
76 	uint8_t		reserved1[3];
77 	uint8_t		bf_sysid[8];
78 	uint16_t	bf_bps;
79 	uint8_t		bf_spc;
80 	uint8_t		reserved2[7];
81 	uint8_t		bf_media;
82 	uint8_t		reserved3[2];
83 	uint16_t	bf_spt;
84 	uint16_t	bf_heads;
85 	uint8_t		reserver4[12];
86 	uint64_t	bf_spv;
87 	uint64_t	bf_mftcn;
88 	uint64_t	bf_mftmirrcn;
89 	int8_t		bf_mftrecsz;
90 	uint32_t	bf_ibsz;
91 	uint32_t	bf_volsn;
92 } __packed;
93 
94 static void
95 g_label_ntfs_taste(struct g_consumer *cp, char *label, size_t size)
96 {
97 	struct g_provider *pp;
98 	struct ntfs_bootfile *bf;
99 	struct ntfs_filerec *fr;
100 	struct ntfs_attr *atr;
101 	off_t voloff;
102 	size_t recoff;
103 	char *filerecp;
104 	int8_t mftrecsz;
105 	char vnchar;
106 	int recsize, j;
107 
108 	g_topology_assert_not();
109 
110 	label[0] = '\0';
111 	pp = cp->provider;
112 	bf = NULL;
113 	filerecp = NULL;
114 
115 	if (pp->sectorsize < sizeof(*bf))
116 		goto done;
117 
118 	bf = g_read_data(cp, 0, pp->sectorsize, NULL);
119 	if (bf == NULL || strncmp(bf->bf_sysid, "NTFS    ", 8) != 0)
120 		goto done;
121 
122 	mftrecsz = bf->bf_mftrecsz;
123 	recsize = (mftrecsz > 0) ? (mftrecsz * bf->bf_bps * bf->bf_spc) :
124 	    (1 << -mftrecsz);
125 	if (recsize <= 0 || recsize > maxphys || recsize % pp->sectorsize != 0)
126 		goto done;
127 
128 	voloff = bf->bf_mftcn * bf->bf_spc * bf->bf_bps +
129 	    recsize * NTFS_VOLUMEINO;
130 	if (voloff % pp->sectorsize != 0)
131 		goto done;
132 
133 	filerecp = g_read_data(cp, voloff, recsize, NULL);
134 	if (filerecp == NULL)
135 		goto done;
136 	fr = (struct ntfs_filerec *)filerecp;
137 	if (fr->fr_hdrmagic != NTFS_FILEMAGIC)
138 		goto done;
139 
140 	for (recoff = fr->fr_attroff;
141 	    recoff <= recsize - 2 * sizeof(uint32_t);
142 	    recoff += atr->reclen) {
143 		atr = (struct ntfs_attr *)(filerecp + recoff);
144 		if (atr->a_type == -1)
145 			break;
146 		if (atr->reclen < sizeof(*atr))
147 			break;
148 		if (recsize - recoff < atr->reclen)
149 			break;
150 		if (atr->a_type == NTFS_A_VOLUMENAME) {
151 			if (atr->a_dataoff > atr->reclen ||
152 			    atr->a_datalen > atr->reclen - atr->a_dataoff)
153 				break;
154 
155 			/*
156 			 * UNICODE to ASCII.
157 			 * Should we need to use iconv(9)?
158 			 */
159 			if (atr->a_datalen >= size * 2 ||
160 			    atr->a_datalen % 2 != 0)
161 				break;
162 			for (j = 0; j < atr->a_datalen; j++) {
163 				vnchar = ((char *)atr)[atr->a_dataoff + j];
164 				if (j & 1) {
165 					if (vnchar) {
166 						label[0] = 0;
167 						goto done;
168 					}
169 				} else {
170 					label[j / 2] = vnchar;
171 				}
172 			}
173 			label[j / 2] = 0;
174 			break;
175 		}
176 	}
177 done:
178 	if (bf != NULL)
179 		g_free(bf);
180 	if (filerecp != NULL)
181 		g_free(filerecp);
182 }
183 
184 struct g_label_desc g_label_ntfs = {
185 	.ld_taste = g_label_ntfs_taste,
186 	.ld_dirprefix = "ntfs/",
187 	.ld_enabled = 1
188 };
189 
190 G_LABEL_INIT(ntfs, g_label_ntfs, "Create device nodes for NTFS volumes");
191