cd9660.c revision 329175
1/*	$NetBSD: cd9660.c,v 1.5 1997/06/26 19:11:33 drochner Exp $	*/
2
3/*
4 * Copyright (C) 1996 Wolfgang Solfrank.
5 * Copyright (C) 1996 TooLs GmbH.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 *    must display the following acknowledgement:
18 *	This product includes software developed by TooLs GmbH.
19 * 4. The name of TooLs GmbH may not be used to endorse or promote products
20 *    derived from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
28 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34#include <sys/cdefs.h>
35__FBSDID("$FreeBSD: stable/11/stand/libsa/cd9660.c 329175 2018-02-12 17:44:35Z kevans $");
36
37/*
38 * Stand-alone ISO9660 file reading package.
39 *
40 * Note: This doesn't support Rock Ridge extensions, extended attributes,
41 * blocksizes other than 2048 bytes, multi-extent files, etc.
42 */
43#include <sys/param.h>
44#include <string.h>
45#include <sys/dirent.h>
46#include <fs/cd9660/iso.h>
47#include <fs/cd9660/cd9660_rrip.h>
48
49#include "stand.h"
50
51#define	SUSP_CONTINUATION	"CE"
52#define	SUSP_PRESENT		"SP"
53#define	SUSP_STOP		"ST"
54#define	SUSP_EXTREF		"ER"
55#define	RRIP_NAME		"NM"
56
57typedef struct {
58	ISO_SUSP_HEADER		h;
59	u_char signature	[ISODCL (  5,    6)];
60	u_char len_skp		[ISODCL (  7,    7)]; /* 711 */
61} ISO_SUSP_PRESENT;
62
63static int	buf_read_file(struct open_file *f, char **buf_p,
64		    size_t *size_p);
65static int	cd9660_open(const char *path, struct open_file *f);
66static int	cd9660_close(struct open_file *f);
67static int	cd9660_read(struct open_file *f, void *buf, size_t size,
68		    size_t *resid);
69static int	cd9660_write(struct open_file *f, void *buf, size_t size,
70		    size_t *resid);
71static off_t	cd9660_seek(struct open_file *f, off_t offset, int where);
72static int	cd9660_stat(struct open_file *f, struct stat *sb);
73static int	cd9660_readdir(struct open_file *f, struct dirent *d);
74static int	dirmatch(struct open_file *f, const char *path,
75		    struct iso_directory_record *dp, int use_rrip, int lenskip);
76static int	rrip_check(struct open_file *f, struct iso_directory_record *dp,
77		    int *lenskip);
78static char	*rrip_lookup_name(struct open_file *f,
79		    struct iso_directory_record *dp, int lenskip, size_t *len);
80static ISO_SUSP_HEADER *susp_lookup_record(struct open_file *f,
81		    const char *identifier, struct iso_directory_record *dp,
82		    int lenskip);
83
84struct fs_ops cd9660_fsops = {
85	"cd9660",
86	cd9660_open,
87	cd9660_close,
88	cd9660_read,
89	cd9660_write,
90	cd9660_seek,
91	cd9660_stat,
92	cd9660_readdir
93};
94
95#define	F_ISDIR		0x0001		/* Directory */
96#define	F_ROOTDIR	0x0002		/* Root directory */
97#define	F_RR		0x0004		/* Rock Ridge on this volume */
98
99struct file {
100	int 		f_flags;	/* file flags */
101	off_t 		f_off;		/* Current offset within file */
102	daddr_t 	f_bno;		/* Starting block number */
103	off_t 		f_size;		/* Size of file */
104	daddr_t		f_buf_blkno;	/* block number of data block */
105	char		*f_buf;		/* buffer for data block */
106	int		f_susp_skip;	/* len_skip for SUSP records */
107};
108
109struct ptable_ent {
110	char namlen	[ISODCL( 1, 1)];	/* 711 */
111	char extlen	[ISODCL( 2, 2)];	/* 711 */
112	char block	[ISODCL( 3, 6)];	/* 732 */
113	char parent	[ISODCL( 7, 8)];	/* 722 */
114	char name	[1];
115};
116#define	PTFIXSZ		8
117#define	PTSIZE(pp)	roundup(PTFIXSZ + isonum_711((pp)->namlen), 2)
118
119#define	cdb2devb(bno)	((bno) * ISO_DEFAULT_BLOCK_SIZE / DEV_BSIZE)
120
121static ISO_SUSP_HEADER *
122susp_lookup_record(struct open_file *f, const char *identifier,
123    struct iso_directory_record *dp, int lenskip)
124{
125	static char susp_buffer[ISO_DEFAULT_BLOCK_SIZE];
126	ISO_SUSP_HEADER *sh;
127	ISO_RRIP_CONT *shc;
128	char *p, *end;
129	int error;
130	size_t read;
131
132	p = dp->name + isonum_711(dp->name_len) + lenskip;
133	/* Names of even length have a padding byte after the name. */
134	if ((isonum_711(dp->name_len) & 1) == 0)
135		p++;
136	end = (char *)dp + isonum_711(dp->length);
137	while (p + 3 < end) {
138		sh = (ISO_SUSP_HEADER *)p;
139		if (bcmp(sh->type, identifier, 2) == 0)
140			return (sh);
141		if (bcmp(sh->type, SUSP_STOP, 2) == 0)
142			return (NULL);
143		if (bcmp(sh->type, SUSP_CONTINUATION, 2) == 0) {
144			shc = (ISO_RRIP_CONT *)sh;
145			error = f->f_dev->dv_strategy(f->f_devdata, F_READ,
146			    cdb2devb(isonum_733(shc->location)),
147			    ISO_DEFAULT_BLOCK_SIZE, susp_buffer, &read);
148
149			/* Bail if it fails. */
150			if (error != 0 || read != ISO_DEFAULT_BLOCK_SIZE)
151				return (NULL);
152			p = susp_buffer + isonum_733(shc->offset);
153			end = p + isonum_733(shc->length);
154		} else {
155			/* Ignore this record and skip to the next. */
156			p += isonum_711(sh->length);
157
158			/* Avoid infinite loops with corrupted file systems */
159			if (isonum_711(sh->length) == 0)
160				return (NULL);
161		}
162	}
163	return (NULL);
164}
165
166static char *
167rrip_lookup_name(struct open_file *f, struct iso_directory_record *dp,
168    int lenskip, size_t *len)
169{
170	ISO_RRIP_ALTNAME *p;
171
172	if (len == NULL)
173		return (NULL);
174
175	p = (ISO_RRIP_ALTNAME *)susp_lookup_record(f, RRIP_NAME, dp, lenskip);
176	if (p == NULL)
177		return (NULL);
178	switch (*p->flags) {
179	case ISO_SUSP_CFLAG_CURRENT:
180		*len = 1;
181		return (".");
182	case ISO_SUSP_CFLAG_PARENT:
183		*len = 2;
184		return ("..");
185	case 0:
186		*len = isonum_711(p->h.length) - 5;
187		return ((char *)p + 5);
188	default:
189		/*
190		 * We don't handle hostnames or continued names as they are
191		 * too hard, so just bail and use the default name.
192		 */
193		return (NULL);
194	}
195}
196
197static int
198rrip_check(struct open_file *f, struct iso_directory_record *dp, int *lenskip)
199{
200	ISO_SUSP_PRESENT *sp;
201	ISO_RRIP_EXTREF *er;
202	char *p;
203
204	/* First, see if we can find a SP field. */
205	p = dp->name + isonum_711(dp->name_len);
206	if (p > (char *)dp + isonum_711(dp->length))
207		return (0);
208	sp = (ISO_SUSP_PRESENT *)p;
209	if (bcmp(sp->h.type, SUSP_PRESENT, 2) != 0)
210		return (0);
211	if (isonum_711(sp->h.length) != sizeof(ISO_SUSP_PRESENT))
212		return (0);
213	if (sp->signature[0] != 0xbe || sp->signature[1] != 0xef)
214		return (0);
215	*lenskip = isonum_711(sp->len_skp);
216
217	/*
218	 * Now look for an ER field.  If RRIP is present, then there must
219	 * be at least one of these.  It would be more pedantic to walk
220	 * through the list of fields looking for a Rock Ridge ER field.
221	 */
222	er = (ISO_RRIP_EXTREF *)susp_lookup_record(f, SUSP_EXTREF, dp, 0);
223	if (er == NULL)
224		return (0);
225	return (1);
226}
227
228static int
229dirmatch(struct open_file *f, const char *path, struct iso_directory_record *dp,
230    int use_rrip, int lenskip)
231{
232	size_t len;
233	char *cp;
234	int i, icase;
235
236	if (use_rrip)
237		cp = rrip_lookup_name(f, dp, lenskip, &len);
238	else
239		cp = NULL;
240	if (cp == NULL) {
241		len = isonum_711(dp->name_len);
242		cp = dp->name;
243		icase = 1;
244	} else
245		icase = 0;
246	for (i = len; --i >= 0; path++, cp++) {
247		if (!*path || *path == '/')
248			break;
249		if (*path == *cp)
250			continue;
251		if (!icase && toupper(*path) == *cp)
252			continue;
253		return 0;
254	}
255	if (*path && *path != '/')
256		return 0;
257	/*
258	 * Allow stripping of trailing dots and the version number.
259	 * Note that this will find the first instead of the last version
260	 * of a file.
261	 */
262	if (i >= 0 && (*cp == ';' || *cp == '.')) {
263		/* This is to prevent matching of numeric extensions */
264		if (*cp == '.' && cp[1] != ';')
265			return 0;
266		while (--i >= 0)
267			if (*++cp != ';' && (*cp < '0' || *cp > '9'))
268				return 0;
269	}
270	return 1;
271}
272
273static int
274cd9660_open(const char *path, struct open_file *f)
275{
276	struct file *fp = NULL;
277	void *buf;
278	struct iso_primary_descriptor *vd;
279	size_t buf_size, read, dsize, off;
280	daddr_t bno, boff;
281	struct iso_directory_record rec;
282	struct iso_directory_record *dp = NULL;
283	int rc, first, use_rrip, lenskip;
284
285	/* First find the volume descriptor */
286	buf = malloc(buf_size = ISO_DEFAULT_BLOCK_SIZE);
287	vd = buf;
288	for (bno = 16;; bno++) {
289		twiddle(1);
290		rc = f->f_dev->dv_strategy(f->f_devdata, F_READ, cdb2devb(bno),
291					ISO_DEFAULT_BLOCK_SIZE, buf, &read);
292		if (rc)
293			goto out;
294		if (read != ISO_DEFAULT_BLOCK_SIZE) {
295			rc = EIO;
296			goto out;
297		}
298		rc = EINVAL;
299		if (bcmp(vd->id, ISO_STANDARD_ID, sizeof vd->id) != 0)
300			goto out;
301		if (isonum_711(vd->type) == ISO_VD_END)
302			goto out;
303		if (isonum_711(vd->type) == ISO_VD_PRIMARY)
304			break;
305	}
306	if (isonum_723(vd->logical_block_size) != ISO_DEFAULT_BLOCK_SIZE)
307		goto out;
308
309	rec = *(struct iso_directory_record *) vd->root_directory_record;
310	if (*path == '/') path++; /* eat leading '/' */
311
312	first = 1;
313	use_rrip = 0;
314	while (*path) {
315		bno = isonum_733(rec.extent) + isonum_711(rec.ext_attr_length);
316		dsize = isonum_733(rec.size);
317		off = 0;
318		boff = 0;
319
320		while (off < dsize) {
321			if ((off % ISO_DEFAULT_BLOCK_SIZE) == 0) {
322				twiddle(1);
323				rc = f->f_dev->dv_strategy
324					(f->f_devdata, F_READ,
325					 cdb2devb(bno + boff),
326					 ISO_DEFAULT_BLOCK_SIZE,
327					 buf, &read);
328				if (rc)
329					goto out;
330				if (read != ISO_DEFAULT_BLOCK_SIZE) {
331					rc = EIO;
332					goto out;
333				}
334				boff++;
335				dp = (struct iso_directory_record *) buf;
336			}
337			if (isonum_711(dp->length) == 0) {
338			    /* skip to next block, if any */
339			    off = boff * ISO_DEFAULT_BLOCK_SIZE;
340			    continue;
341			}
342
343			/* See if RRIP is in use. */
344			if (first)
345				use_rrip = rrip_check(f, dp, &lenskip);
346
347			if (dirmatch(f, path, dp, use_rrip,
348				first ? 0 : lenskip)) {
349				first = 0;
350				break;
351			} else
352				first = 0;
353
354			dp = (struct iso_directory_record *)
355				((char *) dp + isonum_711(dp->length));
356			/* If the new block has zero length, it is padding. */
357			if (isonum_711(dp->length) == 0) {
358				/* Skip to next block, if any. */
359				off = boff * ISO_DEFAULT_BLOCK_SIZE;
360				continue;
361			}
362			off += isonum_711(dp->length);
363		}
364		if (off >= dsize) {
365			rc = ENOENT;
366			goto out;
367		}
368
369		rec = *dp;
370		while (*path && *path != '/') /* look for next component */
371			path++;
372		if (*path) path++; /* skip '/' */
373	}
374
375	/* allocate file system specific data structure */
376	fp = malloc(sizeof(struct file));
377	bzero(fp, sizeof(struct file));
378	f->f_fsdata = (void *)fp;
379
380	if ((isonum_711(rec.flags) & 2) != 0) {
381		fp->f_flags = F_ISDIR;
382	}
383	if (first) {
384		fp->f_flags |= F_ROOTDIR;
385
386		/* Check for Rock Ridge since we didn't in the loop above. */
387		bno = isonum_733(rec.extent) + isonum_711(rec.ext_attr_length);
388		twiddle(1);
389		rc = f->f_dev->dv_strategy(f->f_devdata, F_READ, cdb2devb(bno),
390		    ISO_DEFAULT_BLOCK_SIZE, buf, &read);
391		if (rc)
392			goto out;
393		if (read != ISO_DEFAULT_BLOCK_SIZE) {
394			rc = EIO;
395			goto out;
396		}
397		dp = (struct iso_directory_record *)buf;
398		use_rrip = rrip_check(f, dp, &lenskip);
399	}
400	if (use_rrip) {
401		fp->f_flags |= F_RR;
402		fp->f_susp_skip = lenskip;
403	}
404	fp->f_off = 0;
405	fp->f_bno = isonum_733(rec.extent) + isonum_711(rec.ext_attr_length);
406	fp->f_size = isonum_733(rec.size);
407	free(buf);
408
409	return 0;
410
411out:
412	if (fp)
413		free(fp);
414	free(buf);
415
416	return rc;
417}
418
419static int
420cd9660_close(struct open_file *f)
421{
422	struct file *fp = (struct file *)f->f_fsdata;
423
424	f->f_fsdata = NULL;
425	free(fp);
426
427	return 0;
428}
429
430static int
431buf_read_file(struct open_file *f, char **buf_p, size_t *size_p)
432{
433	struct file *fp = (struct file *)f->f_fsdata;
434	daddr_t blkno, blkoff;
435	int rc = 0;
436	size_t read;
437
438	blkno = fp->f_off / ISO_DEFAULT_BLOCK_SIZE + fp->f_bno;
439	blkoff = fp->f_off % ISO_DEFAULT_BLOCK_SIZE;
440
441	if (blkno != fp->f_buf_blkno) {
442		if (fp->f_buf == (char *)0)
443			fp->f_buf = malloc(ISO_DEFAULT_BLOCK_SIZE);
444
445		twiddle(16);
446		rc = f->f_dev->dv_strategy(f->f_devdata, F_READ,
447		    cdb2devb(blkno), ISO_DEFAULT_BLOCK_SIZE,
448		    fp->f_buf, &read);
449		if (rc)
450			return (rc);
451		if (read != ISO_DEFAULT_BLOCK_SIZE)
452			return (EIO);
453
454		fp->f_buf_blkno = blkno;
455	}
456
457	*buf_p = fp->f_buf + blkoff;
458	*size_p = ISO_DEFAULT_BLOCK_SIZE - blkoff;
459
460	if (*size_p > fp->f_size - fp->f_off)
461		*size_p = fp->f_size - fp->f_off;
462	return (rc);
463}
464
465static int
466cd9660_read(struct open_file *f, void *start, size_t size, size_t *resid)
467{
468	struct file *fp = (struct file *)f->f_fsdata;
469	char *buf, *addr;
470	size_t buf_size, csize;
471	int rc = 0;
472
473	addr = start;
474	while (size) {
475		if (fp->f_off < 0 || fp->f_off >= fp->f_size)
476			break;
477
478		rc = buf_read_file(f, &buf, &buf_size);
479		if (rc)
480			break;
481
482		csize = size > buf_size ? buf_size : size;
483		bcopy(buf, addr, csize);
484
485		fp->f_off += csize;
486		addr += csize;
487		size -= csize;
488	}
489	if (resid)
490		*resid = size;
491	return (rc);
492}
493
494static int
495cd9660_readdir(struct open_file *f, struct dirent *d)
496{
497	struct file *fp = (struct file *)f->f_fsdata;
498	struct iso_directory_record *ep;
499	size_t buf_size, reclen, namelen;
500	int error = 0;
501	int lenskip;
502	char *buf, *name;
503
504again:
505	if (fp->f_off >= fp->f_size)
506		return (ENOENT);
507	error = buf_read_file(f, &buf, &buf_size);
508	if (error)
509		return (error);
510	ep = (struct iso_directory_record *)buf;
511
512	if (isonum_711(ep->length) == 0) {
513		daddr_t blkno;
514
515		/* skip to next block, if any */
516		blkno = fp->f_off / ISO_DEFAULT_BLOCK_SIZE;
517		fp->f_off = (blkno + 1) * ISO_DEFAULT_BLOCK_SIZE;
518		goto again;
519	}
520
521	if (fp->f_flags & F_RR) {
522		if (fp->f_flags & F_ROOTDIR && fp->f_off == 0)
523			lenskip = 0;
524		else
525			lenskip = fp->f_susp_skip;
526		name = rrip_lookup_name(f, ep, lenskip, &namelen);
527	} else
528		name = NULL;
529	if (name == NULL) {
530		namelen = isonum_711(ep->name_len);
531		name = ep->name;
532		if (namelen == 1) {
533			if (ep->name[0] == 0)
534				name = ".";
535			else if (ep->name[0] == 1) {
536				namelen = 2;
537				name = "..";
538			}
539		}
540	}
541	reclen = sizeof(struct dirent) - (MAXNAMLEN+1) + namelen + 1;
542	reclen = (reclen + 3) & ~3;
543
544	d->d_fileno = isonum_733(ep->extent);
545	d->d_reclen = reclen;
546	if (isonum_711(ep->flags) & 2)
547		d->d_type = DT_DIR;
548	else
549		d->d_type = DT_REG;
550	d->d_namlen = namelen;
551
552	bcopy(name, d->d_name, d->d_namlen);
553	d->d_name[d->d_namlen] = 0;
554
555	fp->f_off += isonum_711(ep->length);
556	return (0);
557}
558
559static int
560cd9660_write(struct open_file *f __unused, void *start __unused, size_t size __unused, size_t *resid __unused)
561{
562	return EROFS;
563}
564
565static off_t
566cd9660_seek(struct open_file *f, off_t offset, int where)
567{
568	struct file *fp = (struct file *)f->f_fsdata;
569
570	switch (where) {
571	case SEEK_SET:
572		fp->f_off = offset;
573		break;
574	case SEEK_CUR:
575		fp->f_off += offset;
576		break;
577	case SEEK_END:
578		fp->f_off = fp->f_size - offset;
579		break;
580	default:
581		return -1;
582	}
583	return fp->f_off;
584}
585
586static int
587cd9660_stat(struct open_file *f, struct stat *sb)
588{
589	struct file *fp = (struct file *)f->f_fsdata;
590
591	/* only important stuff */
592	sb->st_mode = S_IRUSR | S_IRGRP | S_IROTH;
593	if (fp->f_flags & F_ISDIR)
594		sb->st_mode |= S_IFDIR;
595	else
596		sb->st_mode |= S_IFREG;
597	sb->st_uid = sb->st_gid = 0;
598	sb->st_size = fp->f_size;
599	return 0;
600}
601