xref: /freebsd/sys/geom/label/g_label_ntfs.c (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/malloc.h>
34 
35 #include <geom/geom.h>
36 #include <geom/label/g_label.h>
37 
38 #define	NTFS_A_VOLUMENAME	0x60
39 #define	NTFS_FILEMAGIC		((uint32_t)(0x454C4946))
40 #define	NTFS_VOLUMEINO		3
41 
42 struct ntfs_attr {
43 	uint32_t	a_type;
44 	uint32_t	reclen;
45 	uint8_t		a_flag;
46 	uint8_t		a_namelen;
47 	uint8_t		a_nameoff;
48 	uint8_t		reserved1;
49 	uint8_t		a_compression;
50 	uint8_t		reserved2;
51 	uint16_t	a_index;
52 	uint16_t	a_datalen;
53 	uint16_t	reserved3;
54 	uint16_t	a_dataoff;
55 	uint16_t	a_indexed;
56 } __packed;
57 
58 struct ntfs_filerec {
59 	uint32_t	fr_hdrmagic;
60 	uint16_t	fr_hdrfoff;
61 	uint16_t	fr_hdrfnum;
62 	uint8_t		reserved[8];
63 	uint16_t	fr_seqnum;
64 	uint16_t	fr_nlink;
65 	uint16_t	fr_attroff;
66 	uint16_t	fr_flags;
67 	uint32_t	fr_size;
68 	uint32_t	fr_allocated;
69 	uint64_t	fr_mainrec;
70 	uint16_t	fr_attrnum;
71 } __packed;
72 
73 struct ntfs_bootfile {
74 	uint8_t		reserved1[3];
75 	uint8_t		bf_sysid[8];
76 	uint16_t	bf_bps;
77 	uint8_t		bf_spc;
78 	uint8_t		reserved2[7];
79 	uint8_t		bf_media;
80 	uint8_t		reserved3[2];
81 	uint16_t	bf_spt;
82 	uint16_t	bf_heads;
83 	uint8_t		reserver4[12];
84 	uint64_t	bf_spv;
85 	uint64_t	bf_mftcn;
86 	uint64_t	bf_mftmirrcn;
87 	int8_t		bf_mftrecsz;
88 	uint32_t	bf_ibsz;
89 	uint32_t	bf_volsn;
90 } __packed;
91 
92 static void
93 g_label_ntfs_taste(struct g_consumer *cp, char *label, size_t size)
94 {
95 	struct g_provider *pp;
96 	struct ntfs_bootfile *bf;
97 	struct ntfs_filerec *fr;
98 	struct ntfs_attr *atr;
99 	off_t voloff;
100 	size_t recoff;
101 	char *filerecp;
102 	int8_t mftrecsz;
103 	char vnchar;
104 	int recsize, j;
105 
106 	g_topology_assert_not();
107 
108 	label[0] = '\0';
109 	pp = cp->provider;
110 	bf = NULL;
111 	filerecp = NULL;
112 
113 	if (pp->sectorsize < sizeof(*bf))
114 		goto done;
115 
116 	bf = g_read_data(cp, 0, pp->sectorsize, NULL);
117 	if (bf == NULL || strncmp(bf->bf_sysid, "NTFS    ", 8) != 0)
118 		goto done;
119 
120 	mftrecsz = bf->bf_mftrecsz;
121 	recsize = (mftrecsz > 0) ? (mftrecsz * bf->bf_bps * bf->bf_spc) :
122 	    (1 << -mftrecsz);
123 	if (recsize <= 0 || recsize > maxphys || recsize % pp->sectorsize != 0)
124 		goto done;
125 
126 	voloff = bf->bf_mftcn * bf->bf_spc * bf->bf_bps +
127 	    recsize * NTFS_VOLUMEINO;
128 	if (voloff % pp->sectorsize != 0)
129 		goto done;
130 
131 	filerecp = g_read_data(cp, voloff, recsize, NULL);
132 	if (filerecp == NULL)
133 		goto done;
134 	fr = (struct ntfs_filerec *)filerecp;
135 	if (fr->fr_hdrmagic != NTFS_FILEMAGIC)
136 		goto done;
137 
138 	for (recoff = fr->fr_attroff;
139 	    recoff <= recsize - 2 * sizeof(uint32_t);
140 	    recoff += atr->reclen) {
141 		atr = (struct ntfs_attr *)(filerecp + recoff);
142 		if (atr->a_type == -1)
143 			break;
144 		if (atr->reclen < sizeof(*atr))
145 			break;
146 		if (recsize - recoff < atr->reclen)
147 			break;
148 		if (atr->a_type == NTFS_A_VOLUMENAME) {
149 			if (atr->a_dataoff > atr->reclen ||
150 			    atr->a_datalen > atr->reclen - atr->a_dataoff)
151 				break;
152 
153 			/*
154 			 * UNICODE to ASCII.
155 			 * Should we need to use iconv(9)?
156 			 */
157 			if (atr->a_datalen >= size * 2 ||
158 			    atr->a_datalen % 2 != 0)
159 				break;
160 			for (j = 0; j < atr->a_datalen; j++) {
161 				vnchar = ((char *)atr)[atr->a_dataoff + j];
162 				if (j & 1) {
163 					if (vnchar) {
164 						label[0] = 0;
165 						goto done;
166 					}
167 				} else {
168 					label[j / 2] = vnchar;
169 				}
170 			}
171 			label[j / 2] = 0;
172 			break;
173 		}
174 	}
175 done:
176 	g_free(bf);
177 	g_free(filerecp);
178 }
179 
180 struct g_label_desc g_label_ntfs = {
181 	.ld_taste = g_label_ntfs_taste,
182 	.ld_dirprefix = "ntfs/",
183 	.ld_enabled = 1
184 };
185 
186 G_LABEL_INIT(ntfs, g_label_ntfs, "Create device nodes for NTFS volumes");
187