aboutsummaryrefslogtreecommitdiff
path: root/lib/sqfshelper/xattr_reader.c
blob: 399940fc636ccca3fb2a578de2bd4568dcba7c5c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
/* SPDX-License-Identifier: GPL-3.0-or-later */
/*
 * xattr_reader.c
 *
 * Copyright (C) 2019 David Oberhollenzer <goliath@infraroot.at>
 */
#include "config.h"

#include "xattr_reader.h"
#include "meta_reader.h"
#include "util.h"

#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <errno.h>

struct xattr_reader_t {
	uint64_t xattr_start;

	size_t num_id_blocks;
	size_t num_ids;

	uint64_t *id_block_starts;

	meta_reader_t *idrd;
	meta_reader_t *kvrd;
	sqfs_super_t *super;
};

static int get_id_block_locations(xattr_reader_t *xr, int sqfsfd,
				  sqfs_super_t *super)
{
	sqfs_xattr_id_table_t idtbl;
	size_t i;

	if (super->xattr_id_table_start >= super->bytes_used) {
		fputs("xattr ID location table is after end of filesystem\n",
		      stderr);
		return -1;
	}

	if (read_data_at("reading xattr ID location table",
			 super->xattr_id_table_start,
			 sqfsfd, &idtbl, sizeof(idtbl))) {
		return -1;
	}

	xr->xattr_start = le64toh(idtbl.xattr_table_start);
	xr->num_ids = le32toh(idtbl.xattr_ids);
	xr->num_id_blocks =
		(xr->num_ids * sizeof(sqfs_xattr_id_t)) / SQFS_META_BLOCK_SIZE;

	if ((xr->num_ids * sizeof(sqfs_xattr_id_t)) % SQFS_META_BLOCK_SIZE)
		xr->num_id_blocks += 1;

	xr->id_block_starts = alloc_array(sizeof(uint64_t), xr->num_id_blocks);
	if (xr->id_block_starts == NULL) {
		perror("allocating xattr ID location table");
		return -1;
	}

	if (read_data_at("reading xattr ID block locations",
			 super->xattr_id_table_start + sizeof(idtbl),
			 sqfsfd, xr->id_block_starts,
			 sizeof(uint64_t) * xr->num_id_blocks)) {
		goto fail;
	}

	for (i = 0; i < xr->num_id_blocks; ++i) {
		xr->id_block_starts[i] = le64toh(xr->id_block_starts[i]);

		if (xr->id_block_starts[i] > super->bytes_used) {
			fputs("found xattr ID block that is past "
			      "end of filesystem\n", stderr);
			goto fail;
		}
	}

	return 0;
fail:
	free(xr->id_block_starts);
	xr->id_block_starts = NULL;
	return -1;
}

static int get_xattr_desc(xattr_reader_t *xr, uint32_t idx,
			  sqfs_xattr_id_t *desc)
{
	size_t block, offset;

	if (idx >= xr->num_ids) {
		fprintf(stderr, "Tried to access out of bounds "
			"xattr index: 0x%08X\n", idx);
		return -1;
	}

	offset = (idx * sizeof(*desc)) % SQFS_META_BLOCK_SIZE;
	block = (idx * sizeof(*desc)) / SQFS_META_BLOCK_SIZE;

	if (meta_reader_seek(xr->idrd, xr->id_block_starts[block], offset))
		return -1;

	if (meta_reader_read(xr->idrd, desc, sizeof(*desc)))
		return -1;

	desc->xattr = le64toh(desc->xattr);
	desc->count = le32toh(desc->count);
	desc->size = le32toh(desc->size);

	if ((desc->xattr & 0xFFFF) >= SQFS_META_BLOCK_SIZE) {
		fputs("Found xattr ID record pointing outside "
		      "metadata block\n", stderr);
		return -1;
	}

	if ((xr->xattr_start + (desc->xattr >> 16)) >= xr->super->bytes_used) {
		fputs("Found xattr ID record pointing past "
		      "end of filesystem\n", stderr);
		return -1;
	}

	return 0;
}

static sqfs_xattr_entry_t *read_key(xattr_reader_t *xr)
{
	sqfs_xattr_entry_t key, *out;
	const char *prefix;
	size_t plen, total;

	if (meta_reader_read(xr->kvrd, &key, sizeof(key)))
		return NULL;

	key.type = le16toh(key.type);
	key.size = le16toh(key.size);

	prefix = sqfs_get_xattr_prefix(key.type & SQUASHFS_XATTR_PREFIX_MASK);
	if (prefix == NULL) {
		fprintf(stderr, "found unknown xattr type %u\n",
			key.type & SQUASHFS_XATTR_PREFIX_MASK);
		return NULL;
	}

	plen = strlen(prefix);

	if (SZ_ADD_OV(plen, key.size, &total) || SZ_ADD_OV(total, 1, &total) ||
	    SZ_ADD_OV(sizeof(*out), total, &total)) {
		errno = EOVERFLOW;
		goto fail_alloc;
	}

	out = calloc(1, total);
	if (out == NULL) {
		goto fail_alloc;
	}

	*out = key;
	memcpy(out->key, prefix, plen);

	if (meta_reader_read(xr->kvrd, out->key + plen, key.size)) {
		free(out);
		return NULL;
	}

	return out;
fail_alloc:
	perror("allocating xattr key");
	return NULL;
}

static sqfs_xattr_value_t *read_value(xattr_reader_t *xr,
				      const sqfs_xattr_entry_t *key)
{
	size_t offset, new_offset, size;
	sqfs_xattr_value_t value, *out;
	uint64_t ref, start, new_start;

	if (meta_reader_read(xr->kvrd, &value, sizeof(value)))
		return NULL;

	if (key->type & SQUASHFS_XATTR_FLAG_OOL) {
		if (meta_reader_read(xr->kvrd, &ref, sizeof(ref)))
			return NULL;

		meta_reader_get_position(xr->kvrd, &start, &offset);

		new_start = xr->xattr_start + (ref >> 16);
		new_offset = ref & 0xFFFF;

		if (new_start > xr->super->bytes_used) {
			fputs("OOL xattr reference points past end of "
			      "filesystem\n", stderr);
			return NULL;
		}

		if (new_offset >= SQFS_META_BLOCK_SIZE) {
			fputs("OOL xattr reference points outside "
			      "metadata block\n", stderr);
			return NULL;
		}

		if (meta_reader_seek(xr->kvrd, new_start, new_offset))
			return NULL;
	}

	value.size = le32toh(value.size);

	if (SZ_ADD_OV(sizeof(*out), value.size, &size) ||
	    SZ_ADD_OV(size, 1, &size)) {
		errno = EOVERFLOW;
		goto fail_alloc;
	}

	out = calloc(1, size);
	if (out == NULL)
		goto fail_alloc;

	*out = value;

	if (meta_reader_read(xr->kvrd, out->value, value.size))
		goto fail;

	if (key->type & SQUASHFS_XATTR_FLAG_OOL) {
		if (meta_reader_seek(xr->kvrd, start, offset))
			goto fail;
	}

	return out;
fail_alloc:
	perror("allocating xattr value");
	return NULL;
fail:
	free(out);
	return NULL;
}

static int restore_kv_pairs(xattr_reader_t *xr, fstree_t *fs,
			    tree_node_t *node)
{
	size_t i, key_idx, val_idx;
	sqfs_xattr_entry_t *key;
	sqfs_xattr_value_t *val;
	int ret;

	if (meta_reader_seek(xr->kvrd, node->xattr->block,
			     node->xattr->offset)) {
		return -1;
	}

	for (i = 0; i < node->xattr->num_attr; ++i) {
		key = read_key(xr);
		if (key == NULL)
			return -1;

		val = read_value(xr, key);
		if (val == NULL)
			goto fail_key;

		ret = str_table_get_index(&fs->xattr_keys,
					  (const char *)key->key, &key_idx);
		if (ret)
			goto fail_kv;

		ret = str_table_get_index(&fs->xattr_values,
					  (const char *)val->value, &val_idx);
		if (ret)
			goto fail_kv;

		if (sizeof(size_t) > sizeof(uint32_t)) {
			if (key_idx > 0xFFFFFFFFUL) {
				fputs("too many unique xattr keys\n", stderr);
				goto fail_kv;
			}

			if (val_idx > 0xFFFFFFFFUL) {
				fputs("too many unique xattr values\n", stderr);
				goto fail_kv;
			}
		}

		node->xattr->attr[i].key_index = key_idx;
		node->xattr->attr[i].value_index = val_idx;

		free(key);
		free(val);
	}

	return 0;
fail_kv:
	free(val);
fail_key:
	free(key);
	return -1;
}

int xattr_reader_restore_node(xattr_reader_t *xr, fstree_t *fs,
			      tree_node_t *node, uint32_t xattr)
{
	sqfs_xattr_id_t desc;
	tree_xattr_t *it;

	if (xr->kvrd == NULL || xr->idrd == NULL)
		return 0;

	if (xattr == 0xFFFFFFFF)
		return 0;

	for (it = fs->xattr; it != NULL; it = it->next) {
		if (it->index == xattr) {
			node->xattr = it;
			return 0;
		}
	}

	if (get_xattr_desc(xr, xattr, &desc))
		return -1;

	node->xattr = alloc_flex(sizeof(*node->xattr),
				 sizeof(node->xattr->attr[0]), desc.count);
	if (node->xattr == NULL) {
		perror("creating xattr structure");
		return -1;
	}

	node->xattr->num_attr = desc.count;
	node->xattr->max_attr = desc.count;
	node->xattr->block = xr->xattr_start + (desc.xattr >> 16);
	node->xattr->offset = desc.xattr & 0xFFFF;
	node->xattr->size = desc.size;
	node->xattr->index = xattr;
	node->xattr->owner = node;

	if (restore_kv_pairs(xr, fs, node)) {
		free(node->xattr);
		return -1;
	}

	node->xattr->next = fs->xattr;
	fs->xattr = node->xattr;
	return 0;
}

void xattr_reader_destroy(xattr_reader_t *xr)
{
	if (xr->kvrd != NULL)
		meta_reader_destroy(xr->kvrd);

	if (xr->idrd != NULL)
		meta_reader_destroy(xr->idrd);

	free(xr->id_block_starts);
	free(xr);
}

xattr_reader_t *xattr_reader_create(int sqfsfd, sqfs_super_t *super,
				    compressor_t *cmp)
{
	xattr_reader_t *xr = calloc(1, sizeof(*xr));

	if (xr == NULL) {
		perror("creating xattr reader");
		return NULL;
	}

	if (super->flags & SQFS_FLAG_NO_XATTRS)
		return xr;

	if (super->xattr_id_table_start == 0xFFFFFFFFFFFFFFFF)
		return xr;

	if (get_id_block_locations(xr, sqfsfd, super))
		goto fail;

	xr->idrd = meta_reader_create(sqfsfd, cmp,
				      super->id_table_start,
				      super->bytes_used);
	if (xr->idrd == NULL)
		goto fail;

	xr->kvrd = meta_reader_create(sqfsfd, cmp,
				      super->id_table_start,
				      super->bytes_used);
	if (xr->kvrd == NULL)
		goto fail;

	xr->super = super;
	return xr;
fail:
	xattr_reader_destroy(xr);
	return NULL;
}