xref: /dragonfly/bin/pax/tar.c (revision 9b5ae8ee)
1 /*-
2  * Copyright (c) 1992 Keith Muller.
3  * Copyright (c) 1992, 1993
4  *	The Regents of the University of California.  All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * Keith Muller of the University of California, San Diego.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed by the University of
20  *	California, Berkeley and its contributors.
21  * 4. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  * @(#)tar.c	8.2 (Berkeley) 4/18/94
38  * $FreeBSD: src/bin/pax/tar.c,v 1.13.2.1 2001/08/01 05:03:12 obrien Exp $
39  * $DragonFly: src/bin/pax/tar.c,v 1.7 2006/09/27 21:58:08 pavalos Exp $
40  */
41 
42 #include <sys/types.h>
43 #include <sys/time.h>
44 #include <sys/stat.h>
45 #include <string.h>
46 #include <stdio.h>
47 #include <unistd.h>
48 #include <stdlib.h>
49 #include "pax.h"
50 #include "extern.h"
51 #include "tar.h"
52 
53 /*
54  * Routines for reading, writing and header identify of various versions of tar
55  */
56 
57 static u_long tar_chksm (char *, int);
58 static char *name_split (char *, int);
59 static int ul_oct (u_long, char *, int, int);
60 static int uqd_oct (u_quad_t, char *, int, int);
61 
62 /*
63  * Routines common to all versions of tar
64  */
65 
66 static int tar_nodir;			/* do not write dirs under old tar */
67 
68 /*
69  * tar_endwr()
70  *	add the tar trailer of two null blocks
71  * Return:
72  *	0 if ok, -1 otherwise (what wr_skip returns)
73  */
74 
75 int
76 tar_endwr(void)
77 {
78 	return(wr_skip((off_t)(NULLCNT*BLKMULT)));
79 }
80 
81 /*
82  * tar_endrd()
83  *	no cleanup needed here, just return size of trailer (for append)
84  * Return:
85  *	size of trailer (2 * BLKMULT)
86  */
87 
88 off_t
89 tar_endrd(void)
90 {
91 	return((off_t)(NULLCNT*BLKMULT));
92 }
93 
94 /*
95  * tar_trail()
96  *	Called to determine if a header block is a valid trailer. We are passed
97  *	the block, the in_sync flag (which tells us we are in resync mode;
98  *	looking for a valid header), and cnt (which starts at zero) which is
99  *	used to count the number of empty blocks we have seen so far.
100  * Return:
101  *	0 if a valid trailer, -1 if not a valid trailer, or 1 if the block
102  *	could never contain a header.
103  */
104 
105 int
106 tar_trail(char *buf, int in_resync, int *cnt)
107 {
108 	int i;
109 
110 	/*
111 	 * look for all zero, trailer is two consecutive blocks of zero
112 	 */
113 	for (i = 0; i < BLKMULT; ++i) {
114 		if (buf[i] != '\0')
115 			break;
116 	}
117 
118 	/*
119 	 * if not all zero it is not a trailer, but MIGHT be a header.
120 	 */
121 	if (i != BLKMULT)
122 		return(-1);
123 
124 	/*
125 	 * When given a zero block, we must be careful!
126 	 * If we are not in resync mode, check for the trailer. Have to watch
127 	 * out that we do not mis-identify file data as the trailer, so we do
128 	 * NOT try to id a trailer during resync mode. During resync mode we
129 	 * might as well throw this block out since a valid header can NEVER be
130 	 * a block of all 0 (we must have a valid file name).
131 	 */
132 	if (!in_resync && (++*cnt >= NULLCNT))
133 		return(0);
134 	return(1);
135 }
136 
137 /*
138  * ul_oct()
139  *	convert an unsigned long to an octal string. many oddball field
140  *	termination characters are used by the various versions of tar in the
141  *	different fields. term selects which kind to use. str is '0' padded
142  *	at the front to len. we are unable to use only one format as many old
143  *	tar readers are very cranky about this.
144  * Return:
145  *	0 if the number fit into the string, -1 otherwise
146  */
147 
148 static int
149 ul_oct(u_long val, char *str, int len, int term)
150 {
151 	char *pt;
152 
153 	/*
154 	 * term selects the appropriate character(s) for the end of the string
155 	 */
156 	pt = str + len - 1;
157 	switch(term) {
158 	case 3:
159 		*pt-- = '\0';
160 		break;
161 	case 2:
162 		*pt-- = ' ';
163 		*pt-- = '\0';
164 		break;
165 	case 1:
166 		*pt-- = ' ';
167 		break;
168 	case 0:
169 	default:
170 		*pt-- = '\0';
171 		*pt-- = ' ';
172 		break;
173 	}
174 
175 	/*
176 	 * convert and blank pad if there is space
177 	 */
178 	while (pt >= str) {
179 		*pt-- = '0' + (char)(val & 0x7);
180 		if ((val = val >> 3) == (u_long)0)
181 			break;
182 	}
183 
184 	while (pt >= str)
185 		*pt-- = '0';
186 	if (val != (u_long)0)
187 		return(-1);
188 	return(0);
189 }
190 
191 /*
192  * uqd_oct()
193  *	convert an u_quad_t to an octal string. one of many oddball field
194  *	termination characters are used by the various versions of tar in the
195  *	different fields. term selects which kind to use. str is '0' padded
196  *	at the front to len. we are unable to use only one format as many old
197  *	tar readers are very cranky about this.
198  * Return:
199  *	0 if the number fit into the string, -1 otherwise
200  */
201 
202 static int
203 uqd_oct(u_quad_t val, char *str, int len, int term)
204 {
205 	char *pt;
206 
207 	/*
208 	 * term selects the appropriate character(s) for the end of the string
209 	 */
210 	pt = str + len - 1;
211 	switch(term) {
212 	case 3:
213 		*pt-- = '\0';
214 		break;
215 	case 2:
216 		*pt-- = ' ';
217 		*pt-- = '\0';
218 		break;
219 	case 1:
220 		*pt-- = ' ';
221 		break;
222 	case 0:
223 	default:
224 		*pt-- = '\0';
225 		*pt-- = ' ';
226 		break;
227 	}
228 
229 	/*
230 	 * convert and blank pad if there is space
231 	 */
232 	while (pt >= str) {
233 		*pt-- = '0' + (char)(val & 0x7);
234 		if ((val = val >> 3) == 0)
235 			break;
236 	}
237 
238 	while (pt >= str)
239 		*pt-- = '0';
240 	if (val != (u_quad_t)0)
241 		return(-1);
242 	return(0);
243 }
244 
245 /*
246  * tar_chksm()
247  *	calculate the checksum for a tar block counting the checksum field as
248  *	all blanks (BLNKSUM is that value pre-calculated, the sum of 8 blanks).
249  *	NOTE: we use len to short circuit summing 0's on write since we ALWAYS
250  *	pad headers with 0.
251  * Return:
252  *	unsigned long checksum
253  */
254 
255 static u_long
256 tar_chksm(char *blk, int len)
257 {
258 	char *stop;
259 	char *pt;
260 	u_long chksm = BLNKSUM;	/* initial value is checksum field sum */
261 
262 	/*
263 	 * add the part of the block before the checksum field
264 	 */
265 	pt = blk;
266 	stop = blk + CHK_OFFSET;
267 	while (pt < stop)
268 		chksm += (u_long)(*pt++ & 0xff);
269 	/*
270 	 * move past the checksum field and keep going, spec counts the
271 	 * checksum field as the sum of 8 blanks (which is pre-computed as
272 	 * BLNKSUM).
273 	 * ASSUMED: len is greater than CHK_OFFSET. (len is where our 0 padding
274 	 * starts, no point in summing zero's)
275 	 */
276 	pt += CHK_LEN;
277 	stop = blk + len;
278 	while (pt < stop)
279 		chksm += (u_long)(*pt++ & 0xff);
280 	return(chksm);
281 }
282 
283 /*
284  * Routines for old BSD style tar (also made portable to sysV tar)
285  */
286 
287 /*
288  * tar_id()
289  *	determine if a block given to us is a valid tar header (and not a USTAR
290  *	header). We have to be on the lookout for those pesky blocks of	all
291  *	zero's.
292  * Return:
293  *	0 if a tar header, -1 otherwise
294  */
295 
296 int
297 tar_id(char *blk, int size)
298 {
299 	HD_TAR *hd;
300 	HD_USTAR *uhd;
301 
302 	if (size < BLKMULT)
303 		return(-1);
304 	hd = (HD_TAR *)blk;
305 	uhd = (HD_USTAR *)blk;
306 
307 	/*
308 	 * check for block of zero's first, a simple and fast test, then make
309 	 * sure this is not a ustar header by looking for the ustar magic
310 	 * cookie. We should use TMAGLEN, but some USTAR archive programs are
311 	 * wrong and create archives missing the \0. Last we check the
312 	 * checksum. If this is ok we have to assume it is a valid header.
313 	 */
314 	if (hd->name[0] == '\0')
315 		return(-1);
316 	if (strncmp(uhd->magic, TMAGIC, TMAGLEN - 1) == 0)
317 		return(-1);
318 	if (asc_ul(hd->chksum,sizeof(hd->chksum),OCT) != tar_chksm(blk,BLKMULT))
319 		return(-1);
320 	return(0);
321 }
322 
323 /*
324  * tar_opt()
325  *	handle tar format specific -o options
326  * Return:
327  *	0 if ok -1 otherwise
328  */
329 
330 int
331 tar_opt(void)
332 {
333 	OPLIST *opt;
334 
335 	while ((opt = opt_next()) != NULL) {
336 		if (strcmp(opt->name, TAR_OPTION) ||
337 		    strcmp(opt->value, TAR_NODIR)) {
338 			paxwarn(1, "Unknown tar format -o option/value pair %s=%s",
339 			    opt->name, opt->value);
340 			paxwarn(1,"%s=%s is the only supported tar format option",
341 			    TAR_OPTION, TAR_NODIR);
342 			return(-1);
343 		}
344 
345 		/*
346 		 * we only support one option, and only when writing
347 		 */
348 		if ((act != APPND) && (act != ARCHIVE)) {
349 			paxwarn(1, "%s=%s is only supported when writing.",
350 			    opt->name, opt->value);
351 			return(-1);
352 		}
353 		tar_nodir = 1;
354 	}
355 	return(0);
356 }
357 
358 
359 /*
360  * tar_rd()
361  *	extract the values out of block already determined to be a tar header.
362  *	store the values in the ARCHD parameter.
363  * Return:
364  *	0
365  */
366 
367 int
368 tar_rd(ARCHD *arcn, char *buf)
369 {
370 	HD_TAR *hd;
371 	char *pt;
372 
373 	/*
374 	 * we only get proper sized buffers passed to us
375 	 */
376 	if (tar_id(buf, BLKMULT) < 0)
377 		return(-1);
378 	arcn->org_name = arcn->name;
379 	arcn->sb.st_nlink = 1;
380 	arcn->pat = NULL;
381 
382 	/*
383 	 * copy out the name and values in the stat buffer
384 	 */
385 	hd = (HD_TAR *)buf;
386 	arcn->nlen = l_strncpy(arcn->name, hd->name, sizeof(arcn->name) - 1);
387 	arcn->name[arcn->nlen] = '\0';
388 	arcn->sb.st_mode = (mode_t)(asc_ul(hd->mode,sizeof(hd->mode),OCT) &
389 	    0xfff);
390 	arcn->sb.st_uid = (uid_t)asc_ul(hd->uid, sizeof(hd->uid), OCT);
391 	arcn->sb.st_gid = (gid_t)asc_ul(hd->gid, sizeof(hd->gid), OCT);
392 	arcn->sb.st_size = (off_t)asc_uqd(hd->size, sizeof(hd->size), OCT);
393 	arcn->sb.st_mtime = (time_t)asc_ul(hd->mtime, sizeof(hd->mtime), OCT);
394 	arcn->sb.st_ctime = arcn->sb.st_atime = arcn->sb.st_mtime;
395 
396 	/*
397 	 * have to look at the last character, it may be a '/' and that is used
398 	 * to encode this as a directory
399 	 */
400 	pt = &(arcn->name[arcn->nlen - 1]);
401 	arcn->pad = 0;
402 	arcn->skip = 0;
403 	switch(hd->linkflag) {
404 	case SYMTYPE:
405 		/*
406 		 * symbolic link, need to get the link name and set the type in
407 		 * the st_mode so -v printing will look correct.
408 		 */
409 		arcn->type = PAX_SLK;
410 		arcn->ln_nlen = l_strncpy(arcn->ln_name, hd->linkname,
411 			sizeof(arcn->ln_name) - 1);
412 		arcn->ln_name[arcn->ln_nlen] = '\0';
413 		arcn->sb.st_mode |= S_IFLNK;
414 		break;
415 	case LNKTYPE:
416 		/*
417 		 * hard link, need to get the link name, set the type in the
418 		 * st_mode and st_nlink so -v printing will look better.
419 		 */
420 		arcn->type = PAX_HLK;
421 		arcn->sb.st_nlink = 2;
422 		arcn->ln_nlen = l_strncpy(arcn->ln_name, hd->linkname,
423 			sizeof(arcn->ln_name) - 1);
424 		arcn->ln_name[arcn->ln_nlen] = '\0';
425 
426 		/*
427 		 * no idea of what type this thing really points at, but
428 		 * we set something for printing only.
429 		 */
430 		arcn->sb.st_mode |= S_IFREG;
431 		break;
432 	case DIRTYPE:
433 		/*
434 		 * It is a directory, set the mode for -v printing
435 		 */
436 		arcn->type = PAX_DIR;
437 		arcn->sb.st_mode |= S_IFDIR;
438 		arcn->sb.st_nlink = 2;
439 		arcn->ln_name[0] = '\0';
440 		arcn->ln_nlen = 0;
441 		break;
442 	case AREGTYPE:
443 	case REGTYPE:
444 	default:
445 		/*
446 		 * If we have a trailing / this is a directory and NOT a file.
447 		 */
448 		arcn->ln_name[0] = '\0';
449 		arcn->ln_nlen = 0;
450 		if (*pt == '/') {
451 			/*
452 			 * it is a directory, set the mode for -v printing
453 			 */
454 			arcn->type = PAX_DIR;
455 			arcn->sb.st_mode |= S_IFDIR;
456 			arcn->sb.st_nlink = 2;
457 		} else {
458 			/*
459 			 * have a file that will be followed by data. Set the
460 			 * skip value to the size field and calculate the size
461 			 * of the padding.
462 			 */
463 			arcn->type = PAX_REG;
464 			arcn->sb.st_mode |= S_IFREG;
465 			arcn->pad = TAR_PAD(arcn->sb.st_size);
466 			arcn->skip = arcn->sb.st_size;
467 		}
468 		break;
469 	}
470 
471 	/*
472 	 * strip off any trailing slash.
473 	 */
474 	if (*pt == '/') {
475 		*pt = '\0';
476 		--arcn->nlen;
477 	}
478 	return(0);
479 }
480 
481 /*
482  * tar_wr()
483  *	write a tar header for the file specified in the ARCHD to the archive.
484  *	Have to check for file types that cannot be stored and file names that
485  *	are too long. Be careful of the term (last arg) to ul_oct, each field
486  *	of tar has it own spec for the termination character(s).
487  *	ASSUMED: space after header in header block is zero filled
488  * Return:
489  *	0 if file has data to be written after the header, 1 if file has NO
490  *	data to write after the header, -1 if archive write failed
491  */
492 
493 int
494 tar_wr(ARCHD *arcn)
495 {
496 	HD_TAR *hd;
497 	int len;
498 	char hdblk[sizeof(HD_TAR)];
499 
500 	/*
501 	 * check for those file system types which tar cannot store
502 	 */
503 	switch(arcn->type) {
504 	case PAX_DIR:
505 		/*
506 		 * user asked that dirs not be written to the archive
507 		 */
508 		if (tar_nodir)
509 			return(1);
510 		break;
511 	case PAX_CHR:
512 		paxwarn(1, "Tar cannot archive a character device %s",
513 		    arcn->org_name);
514 		return(1);
515 	case PAX_BLK:
516 		paxwarn(1, "Tar cannot archive a block device %s", arcn->org_name);
517 		return(1);
518 	case PAX_SCK:
519 		paxwarn(1, "Tar cannot archive a socket %s", arcn->org_name);
520 		return(1);
521 	case PAX_FIF:
522 		paxwarn(1, "Tar cannot archive a fifo %s", arcn->org_name);
523 		return(1);
524 	case PAX_SLK:
525 	case PAX_HLK:
526 	case PAX_HRG:
527 		if (arcn->ln_nlen > sizeof(hd->linkname)) {
528 			paxwarn(1,"Link name too long for tar %s", arcn->ln_name);
529 			return(1);
530 		}
531 		break;
532 	case PAX_REG:
533 	case PAX_CTG:
534 	default:
535 		break;
536 	}
537 
538 	/*
539 	 * check file name len, remember extra char for dirs (the / at the end)
540 	 */
541 	len = arcn->nlen;
542 	if (arcn->type == PAX_DIR)
543 		++len;
544 	if (len >= sizeof(hd->name)) {
545 		paxwarn(1, "File name too long for tar %s", arcn->name);
546 		return(1);
547 	}
548 
549 	/*
550 	 * copy the data out of the ARCHD into the tar header based on the type
551 	 * of the file. Remember many tar readers want the unused fields to be
552 	 * padded with zero. We set the linkflag field (type), the linkname
553 	 * (or zero if not used),the size, and set the padding (if any) to be
554 	 * added after the file data (0 for all other types, as they only have
555 	 * a header)
556 	 */
557 	hd = (HD_TAR *)hdblk;
558 	l_strncpy(hd->name, arcn->name, sizeof(hd->name) - 1);
559 	hd->name[sizeof(hd->name) - 1] = '\0';
560 	arcn->pad = 0;
561 
562 	if (arcn->type == PAX_DIR) {
563 		/*
564 		 * directories are the same as files, except have a filename
565 		 * that ends with a /, we add the slash here. No data follows
566 		 * dirs, so no pad.
567 		 */
568 		hd->linkflag = AREGTYPE;
569 		memset(hd->linkname, 0, sizeof(hd->linkname));
570 		hd->name[len-1] = '/';
571 		if (ul_oct((u_long)0L, hd->size, sizeof(hd->size), 1))
572 			goto out;
573 	} else if (arcn->type == PAX_SLK) {
574 		/*
575 		 * no data follows this file, so no pad
576 		 */
577 		hd->linkflag = SYMTYPE;
578 		l_strncpy(hd->linkname,arcn->ln_name, sizeof(hd->linkname) - 1);
579 		hd->linkname[sizeof(hd->linkname) - 1] = '\0';
580 		if (ul_oct((u_long)0L, hd->size, sizeof(hd->size), 1))
581 			goto out;
582 	} else if ((arcn->type == PAX_HLK) || (arcn->type == PAX_HRG)) {
583 		/*
584 		 * no data follows this file, so no pad
585 		 */
586 		hd->linkflag = LNKTYPE;
587 		l_strncpy(hd->linkname,arcn->ln_name, sizeof(hd->linkname) - 1);
588 		hd->linkname[sizeof(hd->linkname) - 1] = '\0';
589 		if (ul_oct((u_long)0L, hd->size, sizeof(hd->size), 1))
590 			goto out;
591 	} else {
592 		/*
593 		 * data follows this file, so set the pad
594 		 */
595 		hd->linkflag = AREGTYPE;
596 		memset(hd->linkname, 0, sizeof(hd->linkname));
597 		if (uqd_oct((u_quad_t)arcn->sb.st_size, hd->size,
598 		    sizeof(hd->size), 1)) {
599 			paxwarn(1,"File is too large for tar %s", arcn->org_name);
600 			return(1);
601 		}
602 		arcn->pad = TAR_PAD(arcn->sb.st_size);
603 	}
604 
605 	/*
606 	 * copy those fields that are independent of the type
607 	 */
608 	if (ul_oct((u_long)arcn->sb.st_mode, hd->mode, sizeof(hd->mode), 0) ||
609 	    ul_oct((u_long)arcn->sb.st_uid, hd->uid, sizeof(hd->uid), 0) ||
610 	    ul_oct((u_long)arcn->sb.st_gid, hd->gid, sizeof(hd->gid), 0) ||
611 	    ul_oct((u_long)arcn->sb.st_mtime, hd->mtime, sizeof(hd->mtime), 1))
612 		goto out;
613 
614 	/*
615 	 * calculate and add the checksum, then write the header. A return of
616 	 * 0 tells the caller to now write the file data, 1 says no data needs
617 	 * to be written
618 	 */
619 	if (ul_oct(tar_chksm(hdblk, sizeof(HD_TAR)), hd->chksum,
620 	    sizeof(hd->chksum), 3))
621 		goto out;
622 	if (wr_rdbuf(hdblk, sizeof(HD_TAR)) < 0)
623 		return(-1);
624 	if (wr_skip((off_t)(BLKMULT - sizeof(HD_TAR))) < 0)
625 		return(-1);
626 	if ((arcn->type == PAX_CTG) || (arcn->type == PAX_REG))
627 		return(0);
628 	return(1);
629 
630     out:
631 	/*
632 	 * header field is out of range
633 	 */
634 	paxwarn(1, "Tar header field is too small for %s", arcn->org_name);
635 	return(1);
636 }
637 
638 /*
639  * Routines for POSIX ustar
640  */
641 
642 /*
643  * ustar_strd()
644  *	initialization for ustar read
645  * Return:
646  *	0 if ok, -1 otherwise
647  */
648 
649 int
650 ustar_strd(void)
651 {
652 	if ((usrtb_start() < 0) || (grptb_start() < 0))
653 		return(-1);
654 	return(0);
655 }
656 
657 /*
658  * ustar_stwr()
659  *	initialization for ustar write
660  * Return:
661  *	0 if ok, -1 otherwise
662  */
663 
664 int
665 ustar_stwr(void)
666 {
667 	if ((uidtb_start() < 0) || (gidtb_start() < 0))
668 		return(-1);
669 	return(0);
670 }
671 
672 /*
673  * ustar_id()
674  *	determine if a block given to us is a valid ustar header. We have to
675  *	be on the lookout for those pesky blocks of all zero's
676  * Return:
677  *	0 if a ustar header, -1 otherwise
678  */
679 
680 int
681 ustar_id(char *blk, int size)
682 {
683 	HD_USTAR *hd;
684 
685 	if (size < BLKMULT)
686 		return(-1);
687 	hd = (HD_USTAR *)blk;
688 
689 	/*
690 	 * check for block of zero's first, a simple and fast test then check
691 	 * ustar magic cookie. We should use TMAGLEN, but some USTAR archive
692 	 * programs are fouled up and create archives missing the \0. Last we
693 	 * check the checksum. If ok we have to assume it is a valid header.
694 	 */
695 	if (hd->name[0] == '\0')
696 		return(-1);
697 	if (strncmp(hd->magic, TMAGIC, TMAGLEN - 1) != 0)
698 		return(-1);
699 	if (asc_ul(hd->chksum,sizeof(hd->chksum),OCT) != tar_chksm(blk,BLKMULT))
700 		return(-1);
701 	return(0);
702 }
703 
704 /*
705  * ustar_rd()
706  *	extract the values out of block already determined to be a ustar header.
707  *	store the values in the ARCHD parameter.
708  * Return:
709  *	0
710  */
711 
712 int
713 ustar_rd(ARCHD *arcn, char *buf)
714 {
715 	HD_USTAR *hd;
716 	char *dest;
717 	int cnt = 0;
718 	dev_t devmajor;
719 	dev_t devminor;
720 
721 	/*
722 	 * we only get proper sized buffers
723 	 */
724 	if (ustar_id(buf, BLKMULT) < 0)
725 		return(-1);
726 	arcn->org_name = arcn->name;
727 	arcn->sb.st_nlink = 1;
728 	arcn->pat = NULL;
729 	arcn->nlen = 0;
730 	hd = (HD_USTAR *)buf;
731 
732 	/*
733 	 * see if the filename is split into two parts. if, so joint the parts.
734 	 * we copy the prefix first and add a / between the prefix and name.
735 	 */
736 	dest = arcn->name;
737 	if (*(hd->prefix) != '\0') {
738 		cnt = l_strncpy(dest, hd->prefix, sizeof(arcn->name) - 2);
739 		dest += cnt;
740 		*dest++ = '/';
741 		cnt++;
742 	}
743 	arcn->nlen = cnt + l_strncpy(dest, hd->name, sizeof(arcn->name) - cnt);
744 	arcn->name[arcn->nlen] = '\0';
745 
746 	/*
747 	 * follow the spec to the letter. we should only have mode bits, strip
748 	 * off all other crud we may be passed.
749 	 */
750 	arcn->sb.st_mode = (mode_t)(asc_ul(hd->mode, sizeof(hd->mode), OCT) &
751 	    0xfff);
752 	arcn->sb.st_size = (off_t)asc_uqd(hd->size, sizeof(hd->size), OCT);
753 	arcn->sb.st_mtime = (time_t)asc_ul(hd->mtime, sizeof(hd->mtime), OCT);
754 	arcn->sb.st_ctime = arcn->sb.st_atime = arcn->sb.st_mtime;
755 
756 	/*
757 	 * If we can find the ascii names for gname and uname in the password
758 	 * and group files we will use the uid's and gid they bind. Otherwise
759 	 * we use the uid and gid values stored in the header. (This is what
760 	 * the POSIX spec wants).
761 	 */
762 	hd->gname[sizeof(hd->gname) - 1] = '\0';
763 	if (gid_name(hd->gname, &(arcn->sb.st_gid)) < 0)
764 		arcn->sb.st_gid = (gid_t)asc_ul(hd->gid, sizeof(hd->gid), OCT);
765 	hd->uname[sizeof(hd->uname) - 1] = '\0';
766 	if (uid_name(hd->uname, &(arcn->sb.st_uid)) < 0)
767 		arcn->sb.st_uid = (uid_t)asc_ul(hd->uid, sizeof(hd->uid), OCT);
768 
769 	/*
770 	 * set the defaults, these may be changed depending on the file type
771 	 */
772 	arcn->ln_name[0] = '\0';
773 	arcn->ln_nlen = 0;
774 	arcn->pad = 0;
775 	arcn->skip = 0;
776 	arcn->sb.st_rdev = (dev_t)0;
777 
778 	/*
779 	 * set the mode and PAX type according to the typeflag in the header
780 	 */
781 	switch(hd->typeflag) {
782 	case FIFOTYPE:
783 		arcn->type = PAX_FIF;
784 		arcn->sb.st_mode |= S_IFIFO;
785 		break;
786 	case DIRTYPE:
787 		arcn->type = PAX_DIR;
788 		arcn->sb.st_mode |= S_IFDIR;
789 		arcn->sb.st_nlink = 2;
790 
791 		/*
792 		 * Some programs that create ustar archives append a '/'
793 		 * to the pathname for directories. This clearly violates
794 		 * ustar specs, but we will silently strip it off anyway.
795 		 */
796 		if (arcn->name[arcn->nlen - 1] == '/')
797 			arcn->name[--arcn->nlen] = '\0';
798 		break;
799 	case BLKTYPE:
800 	case CHRTYPE:
801 		/*
802 		 * this type requires the rdev field to be set.
803 		 */
804 		if (hd->typeflag == BLKTYPE) {
805 			arcn->type = PAX_BLK;
806 			arcn->sb.st_mode |= S_IFBLK;
807 		} else {
808 			arcn->type = PAX_CHR;
809 			arcn->sb.st_mode |= S_IFCHR;
810 		}
811 		devmajor = (dev_t)asc_ul(hd->devmajor,sizeof(hd->devmajor),OCT);
812 		devminor = (dev_t)asc_ul(hd->devminor,sizeof(hd->devminor),OCT);
813 		arcn->sb.st_rdev = TODEV(devmajor, devminor);
814 		break;
815 	case SYMTYPE:
816 	case LNKTYPE:
817 		if (hd->typeflag == SYMTYPE) {
818 			arcn->type = PAX_SLK;
819 			arcn->sb.st_mode |= S_IFLNK;
820 		} else {
821 			arcn->type = PAX_HLK;
822 			/*
823 			 * so printing looks better
824 			 */
825 			arcn->sb.st_mode |= S_IFREG;
826 			arcn->sb.st_nlink = 2;
827 		}
828 		/*
829 		 * copy the link name
830 		 */
831 		arcn->ln_nlen = l_strncpy(arcn->ln_name, hd->linkname,
832 			sizeof(arcn->ln_name) - 1);
833 		arcn->ln_name[arcn->ln_nlen] = '\0';
834 		break;
835 	case CONTTYPE:
836 	case AREGTYPE:
837 	case REGTYPE:
838 	default:
839 		/*
840 		 * these types have file data that follows. Set the skip and
841 		 * pad fields.
842 		 */
843 		arcn->type = PAX_REG;
844 		arcn->pad = TAR_PAD(arcn->sb.st_size);
845 		arcn->skip = arcn->sb.st_size;
846 		arcn->sb.st_mode |= S_IFREG;
847 		break;
848 	}
849 	return(0);
850 }
851 
852 /*
853  * ustar_wr()
854  *	write a ustar header for the file specified in the ARCHD to the archive
855  *	Have to check for file types that cannot be stored and file names that
856  *	are too long. Be careful of the term (last arg) to ul_oct, we only use
857  *	'\0' for the termination character (this is different than picky tar)
858  *	ASSUMED: space after header in header block is zero filled
859  * Return:
860  *	0 if file has data to be written after the header, 1 if file has NO
861  *	data to write after the header, -1 if archive write failed
862  */
863 
864 int
865 ustar_wr(ARCHD *arcn)
866 {
867 	HD_USTAR *hd;
868 	char *pt;
869 	char hdblk[sizeof(HD_USTAR)];
870 
871 	/*
872 	 * check for those file system types ustar cannot store
873 	 */
874 	if (arcn->type == PAX_SCK) {
875 		paxwarn(1, "Ustar cannot archive a socket %s", arcn->org_name);
876 		return(1);
877 	}
878 
879 	/*
880 	 * check the length of the linkname
881 	 */
882 	if (((arcn->type == PAX_SLK) || (arcn->type == PAX_HLK) ||
883 	    (arcn->type == PAX_HRG)) && (arcn->ln_nlen >= sizeof(hd->linkname))){
884 		paxwarn(1, "Link name too long for ustar %s", arcn->ln_name);
885 		return(1);
886 	}
887 
888 	/*
889 	 * split the path name into prefix and name fields (if needed). if
890 	 * pt != arcn->name, the name has to be split
891 	 */
892 	if ((pt = name_split(arcn->name, arcn->nlen)) == NULL) {
893 		paxwarn(1, "File name too long for ustar %s", arcn->name);
894 		return(1);
895 	}
896 	hd = (HD_USTAR *)hdblk;
897 	arcn->pad = 0L;
898 
899 	/*
900 	 * split the name, or zero out the prefix
901 	 */
902 	if (pt != arcn->name) {
903 		/*
904 		 * name was split, pt points at the / where the split is to
905 		 * occur, we remove the / and copy the first part to the prefix
906 		 */
907 		*pt = '\0';
908 		l_strncpy(hd->prefix, arcn->name, sizeof(hd->prefix) - 1);
909 		*pt++ = '/';
910 	} else
911 		memset(hd->prefix, 0, sizeof(hd->prefix));
912 
913 	/*
914 	 * copy the name part. this may be the whole path or the part after
915 	 * the prefix
916 	 */
917 	l_strncpy(hd->name, pt, sizeof(hd->name) - 1);
918 	hd->name[sizeof(hd->name) - 1] = '\0';
919 
920 	/*
921 	 * set the fields in the header that are type dependent
922 	 */
923 	switch(arcn->type) {
924 	case PAX_DIR:
925 		hd->typeflag = DIRTYPE;
926 		memset(hd->linkname, 0, sizeof(hd->linkname));
927 		memset(hd->devmajor, 0, sizeof(hd->devmajor));
928 		memset(hd->devminor, 0, sizeof(hd->devminor));
929 		if (ul_oct((u_long)0L, hd->size, sizeof(hd->size), 3))
930 			goto out;
931 		break;
932 	case PAX_CHR:
933 	case PAX_BLK:
934 		if (arcn->type == PAX_CHR)
935 			hd->typeflag = CHRTYPE;
936 		else
937 			hd->typeflag = BLKTYPE;
938 		memset(hd->linkname, 0, sizeof(hd->linkname));
939 		if (ul_oct((u_long)MAJOR(arcn->sb.st_rdev), hd->devmajor,
940 		   sizeof(hd->devmajor), 3) ||
941 		   ul_oct((u_long)MINOR(arcn->sb.st_rdev), hd->devminor,
942 		   sizeof(hd->devminor), 3) ||
943 		   ul_oct((u_long)0L, hd->size, sizeof(hd->size), 3))
944 			goto out;
945 		break;
946 	case PAX_FIF:
947 		hd->typeflag = FIFOTYPE;
948 		memset(hd->linkname, 0, sizeof(hd->linkname));
949 		memset(hd->devmajor, 0, sizeof(hd->devmajor));
950 		memset(hd->devminor, 0, sizeof(hd->devminor));
951 		if (ul_oct((u_long)0L, hd->size, sizeof(hd->size), 3))
952 			goto out;
953 		break;
954 	case PAX_SLK:
955 	case PAX_HLK:
956 	case PAX_HRG:
957 		if (arcn->type == PAX_SLK)
958 			hd->typeflag = SYMTYPE;
959 		else
960 			hd->typeflag = LNKTYPE;
961 		l_strncpy(hd->linkname,arcn->ln_name, sizeof(hd->linkname) - 1);
962 		hd->linkname[sizeof(hd->linkname) - 1] = '\0';
963 		memset(hd->devmajor, 0, sizeof(hd->devmajor));
964 		memset(hd->devminor, 0, sizeof(hd->devminor));
965 		if (ul_oct((u_long)0L, hd->size, sizeof(hd->size), 3))
966 			goto out;
967 		break;
968 	case PAX_REG:
969 	case PAX_CTG:
970 	default:
971 		/*
972 		 * file data with this type, set the padding
973 		 */
974 		if (arcn->type == PAX_CTG)
975 			hd->typeflag = CONTTYPE;
976 		else
977 			hd->typeflag = REGTYPE;
978 		memset(hd->linkname, 0, sizeof(hd->linkname));
979 		memset(hd->devmajor, 0, sizeof(hd->devmajor));
980 		memset(hd->devminor, 0, sizeof(hd->devminor));
981 		arcn->pad = TAR_PAD(arcn->sb.st_size);
982 		if (uqd_oct((u_quad_t)arcn->sb.st_size, hd->size,
983 		    sizeof(hd->size), 3)) {
984 			paxwarn(1,"File is too long for ustar %s",arcn->org_name);
985 			return(1);
986 		}
987 		break;
988 	}
989 
990 	l_strncpy(hd->magic, TMAGIC, TMAGLEN);
991 	l_strncpy(hd->version, TVERSION, TVERSLEN);
992 
993 	/*
994 	 * set the remaining fields. Some versions want all 16 bits of mode
995 	 * we better humor them (they really do not meet spec though)....
996 	 */
997 	if (ul_oct((u_long)arcn->sb.st_mode, hd->mode, sizeof(hd->mode), 3) ||
998 	    ul_oct((u_long)arcn->sb.st_uid, hd->uid, sizeof(hd->uid), 3)  ||
999 	    ul_oct((u_long)arcn->sb.st_gid, hd->gid, sizeof(hd->gid), 3) ||
1000 	    ul_oct((u_long)arcn->sb.st_mtime,hd->mtime,sizeof(hd->mtime),3))
1001 		goto out;
1002 	l_strncpy(hd->uname,name_uid(arcn->sb.st_uid, 0),sizeof(hd->uname));
1003 	l_strncpy(hd->gname,name_gid(arcn->sb.st_gid, 0),sizeof(hd->gname));
1004 
1005 	/*
1006 	 * calculate and store the checksum write the header to the archive
1007 	 * return 0 tells the caller to now write the file data, 1 says no data
1008 	 * needs to be written
1009 	 */
1010 	if (ul_oct(tar_chksm(hdblk, sizeof(HD_USTAR)), hd->chksum,
1011 	   sizeof(hd->chksum), 3))
1012 		goto out;
1013 	if (wr_rdbuf(hdblk, sizeof(HD_USTAR)) < 0)
1014 		return(-1);
1015 	if (wr_skip((off_t)(BLKMULT - sizeof(HD_USTAR))) < 0)
1016 		return(-1);
1017 	if ((arcn->type == PAX_CTG) || (arcn->type == PAX_REG))
1018 		return(0);
1019 	return(1);
1020 
1021     out:
1022     	/*
1023 	 * header field is out of range
1024 	 */
1025 	paxwarn(1, "Ustar header field is too small for %s", arcn->org_name);
1026 	return(1);
1027 }
1028 
1029 /*
1030  * name_split()
1031  *	see if the name has to be split for storage in a ustar header. We try
1032  *	to fit the entire name in the name field without splitting if we can.
1033  *	The split point is always at a /
1034  * Return
1035  *	character pointer to split point (always the / that is to be removed
1036  *	if the split is not needed, the points is set to the start of the file
1037  *	name (it would violate the spec to split there). A NULL is returned if
1038  *	the file name is too long
1039  */
1040 
1041 static char *
1042 name_split(char *name, int len)
1043 {
1044 	char *start;
1045 
1046 	/*
1047 	 * check to see if the file name is small enough to fit in the name
1048 	 * field. if so just return a pointer to the name.
1049 	 */
1050 	if (len < TNMSZ)
1051 		return(name);
1052 	if (len > (TPFSZ + TNMSZ))
1053 		return(NULL);
1054 
1055 	/*
1056 	 * we start looking at the biggest sized piece that fits in the name
1057 	 * field. We walk forward looking for a slash to split at. The idea is
1058 	 * to find the biggest piece to fit in the name field (or the smallest
1059 	 * prefix we can find)
1060 	 */
1061 	start = name + len - TNMSZ;
1062 	while ((*start != '\0') && (*start != '/'))
1063 		++start;
1064 
1065 	/*
1066 	 * if we hit the end of the string, this name cannot be split, so we
1067 	 * cannot store this file.
1068 	 */
1069 	if (*start == '\0')
1070 		return(NULL);
1071 	len = start - name;
1072 
1073 	/*
1074 	 * NOTE: /str where the length of str == TNMSZ can not be stored under
1075 	 * the p1003.1-1990 spec for ustar. We could force a prefix of / and
1076 	 * the file would then expand on extract to //str. The len == 0 below
1077 	 * makes this special case follow the spec to the letter.
1078 	 */
1079 	if ((len >= TPFSZ) || (len == 0))
1080 		return(NULL);
1081 
1082 	/*
1083 	 * ok have a split point, return it to the caller
1084 	 */
1085 	return(start);
1086 }
1087