1 /* gpgtar-list.c - List a TAR archive
2 * Copyright (C) 2016-2017, 2019-2022 g10 Code GmbH
3 * Copyright (C) 2010, 2012, 2013 Werner Koch
4 * Copyright (C) 2010 Free Software Foundation, Inc.
6 * This file is part of GnuPG.
8 * GnuPG is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * GnuPG is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, see <https://www.gnu.org/licenses/>.
20 * SPDX-License-Identifier: GPL-3.0-or-later
29 #include "../common/i18n.h"
30 #include <gpg-error.h>
32 #include "../common/exechelp.h"
33 #include "../common/sysutils.h"
34 #include "../common/ccparray.h"
38 static unsigned long long
39 parse_xoctal (const void *data, size_t length, const char *filename)
41 const unsigned char *p = data;
42 unsigned long long value;
46 else if ( (*p & 0x80))
49 value = (*p++ & 0x7f);
60 /* Skip leading spaces and zeroes. */
61 for (; length && (*p == ' ' || *p == '0'); length--, p++)
63 for (; length && *p; length--, p++)
65 if (*p >= '0' && *p <= '7')
72 log_error ("%s: invalid octal number encountered - assuming 0\n",
84 parse_header (const void *record, const char *filename, tarinfo_t info)
86 const struct ustar_raw_header *raw = record;
87 size_t n, namelen, prefixlen;
92 info->headerblock = info->nblocks - 1;
94 use_prefix = (!memcmp (raw->magic, "ustar", 5)
95 && (raw->magic[5] == ' ' || !raw->magic[5]));
98 for (namelen=0; namelen < sizeof raw->name && raw->name[namelen]; namelen++)
100 if (namelen == sizeof raw->name)
102 log_info ("%s: warning: name not terminated by a nul\n", filename);
105 for (n=namelen+1; n < sizeof raw->name; n++)
108 log_info ("%s: warning: garbage after name\n", filename);
113 if (use_prefix && raw->prefix[0])
115 for (prefixlen=0; (prefixlen < sizeof raw->prefix
116 && raw->prefix[prefixlen]); prefixlen++)
118 if (prefixlen == sizeof raw->prefix)
119 log_info ("%s: warning: prefix not terminated by a nul (block %llu)\n",
120 filename, info->headerblock);
121 for (n=prefixlen+1; n < sizeof raw->prefix; n++)
124 log_info ("%s: warning: garbage after prefix\n", filename);
132 header = xtrycalloc (1, sizeof *header + prefixlen + 1 + namelen);
135 log_error ("%s: error allocating header: %s\n",
136 filename, gpg_strerror (gpg_error_from_syserror ()));
142 memcpy (header->name, raw->prefix, n);
143 if (raw->prefix[n-1] != '/')
144 header->name[n++] = '/';
148 memcpy (header->name+n, raw->name, namelen);
149 header->name[n+namelen] = 0;
151 header->mode = parse_xoctal (raw->mode, sizeof raw->mode, filename);
152 header->uid = parse_xoctal (raw->uid, sizeof raw->uid, filename);
153 header->gid = parse_xoctal (raw->gid, sizeof raw->gid, filename);
154 header->size = parse_xoctal (raw->size, sizeof raw->size, filename);
155 header->mtime = parse_xoctal (raw->mtime, sizeof raw->mtime, filename);
157 switch (raw->typeflag[0])
159 case '0': header->typeflag = TF_REGULAR; break;
160 case '1': header->typeflag = TF_HARDLINK; break;
161 case '2': header->typeflag = TF_SYMLINK; break;
162 case '3': header->typeflag = TF_CHARDEV; break;
163 case '4': header->typeflag = TF_BLOCKDEV; break;
164 case '5': header->typeflag = TF_DIRECTORY; break;
165 case '6': header->typeflag = TF_FIFO; break;
166 case '7': header->typeflag = TF_RESERVED; break;
167 case 'g': header->typeflag = TF_GEXTHDR; break;
168 case 'x': header->typeflag = TF_EXTHDR; break;
169 default: header->typeflag = TF_UNKNOWN; break;
172 /* Compute the number of data records following this header. */
173 if (header->typeflag == TF_REGULAR
174 || header->typeflag == TF_EXTHDR
175 || header->typeflag == TF_UNKNOWN)
176 header->nrecords = (header->size + RECORDSIZE-1)/RECORDSIZE;
178 header->nrecords = 0;
182 log_info ("%s: header block %llu is corrupt"
183 " (size=%llu type=%d nrec=%llu)\n",
184 filename, info->headerblock,
185 header->size, header->typeflag, header->nrecords);
186 /* log_printhex (record, RECORDSIZE, " "); */
192 /* Parse the extended header. This funcion may modify BUFFER. */
194 parse_extended_header (const char *fname,
195 char *buffer, size_t buflen, strlist_t *r_exthdr)
198 unsigned char *p, *record;
203 record = buffer; /* Remember begin of record. */
205 for (p = buffer; buflen && digitp (p); buflen--, p++)
208 reclen += (*p - '0');
210 if (!buflen || *p != ' ')
212 log_error ("%s: malformed record length in extended header\n", fname);
213 return gpg_error (GPG_ERR_INV_RECORD);
215 p++; /* Skip space. */
217 if (buflen + (p-record) < reclen)
219 log_error ("%s: extended header record larger"
220 " than total extended header data\n", fname);
221 return gpg_error (GPG_ERR_INV_RECORD);
223 if (reclen < (p-record)+2 || record[reclen-1] != '\n')
225 log_error ("%s: malformed extended header record\n", fname);
226 return gpg_error (GPG_ERR_INV_RECORD);
228 record[reclen-1] = 0; /* For convenience change LF to a Nul. */
229 reclen -= (p-record);
230 /* P points to the begin of the keyword and RECLEN is the
231 * remaining length of the record excluding the LF. */
232 if (memchr (p, 0, reclen-1)
233 && (!strncmp (p, "path=", 5) || !strncmp (p, "linkpath=", 9)))
235 log_error ("%s: extended header record has an embedded nul"
236 " - ignoring\n", fname);
238 else if (!strncmp (p, "path=", 5))
240 sl = add_to_strlist_try (r_exthdr, p+5);
242 return gpg_error_from_syserror ();
243 sl->flags = 1; /* Mark as path */
245 else if (!strncmp (p, "linkpath=", 9))
247 sl = add_to_strlist_try (r_exthdr, p+9);
249 return gpg_error_from_syserror ();
250 sl->flags = 2; /* Mark as linkpath */
261 /* Read the next block, assuming it is a tar header. Returns a header
262 * object on success in R_HEADER, or an error. If the stream is
263 * consumed (i.e. end-of-archive), R_HEADER is set to NULL. In case
264 * of an error an error message is printed. If the header is an
265 * extended header, a string list is allocated and stored at
266 * R_EXTHEADER; the caller should provide a pointer to NULL. Such an
267 * extended header is fully processed here and the returned R_HEADER
268 * has then the next regular header. */
270 read_header (estream_t stream, tarinfo_t info,
271 tar_header_t *r_header, strlist_t *r_extheader)
274 char record[RECORDSIZE];
280 err = read_record (stream, record);
285 for (i=0; i < RECORDSIZE && !record[i]; i++)
289 /* All zero header - check whether it is the first part of an
290 end of archive mark. */
291 err = read_record (stream, record);
296 for (i=0; i < RECORDSIZE && !record[i]; i++)
299 log_info ("%s: warning: skipping empty header\n",
300 es_fname_get (stream));
303 /* End of archive - FIXME: we might want to check for garbage. */
309 *r_header = parse_header (record, es_fname_get (stream), info);
311 return gpg_error_from_syserror ();
314 if (hdr->typeflag != TF_EXTHDR || !r_extheader)
317 /* Read the extended header. */
320 /* More than 64k for an extedned header is surely too large. */
321 log_info ("%s: warning: empty extended header\n",
322 es_fname_get (stream));
325 if (hdr->nrecords > 65536 / RECORDSIZE)
327 /* More than 64k for an extedned header is surely too large. */
328 log_error ("%s: extended header too large - skipping\n",
329 es_fname_get (stream));
333 buffer = xtrymalloc (hdr->nrecords * RECORDSIZE);
336 err = gpg_error_from_syserror ();
337 log_error ("%s: error allocating space for extended header: %s\n",
338 es_fname_get (stream), gpg_strerror (err));
343 for (nrec=0; nrec < hdr->nrecords;)
345 err = read_record (stream, buffer + buflen);
353 if (nrec < hdr->nrecords || (hdr->size && !(hdr->size % RECORDSIZE)))
354 buflen += RECORDSIZE;
356 buflen += (hdr->size % RECORDSIZE);
359 err = parse_extended_header (es_fname_get (stream),
360 buffer, buflen, r_extheader);
363 free_strlist (*r_extheader);
368 /* Now tha the extedned header has been read, we read the next
369 * header without allowing an extended header. */
370 return read_header (stream, info, r_header, NULL);
374 /* Skip the data records according to HEADER. Prints an error message
375 on error and return -1. */
377 skip_data (estream_t stream, tarinfo_t info, tar_header_t header)
379 char record[RECORDSIZE];
380 unsigned long long n;
382 for (n=0; n < header->nrecords; n++)
384 if (read_record (stream, record))
395 print_header (tar_header_t header, strlist_t extheader, estream_t out)
401 const char *name, *linkname;
404 switch (header->typeflag)
406 case TF_REGULAR: *modestr = '-'; break;
407 case TF_HARDLINK: *modestr = 'h'; break;
408 case TF_SYMLINK: *modestr = 'l'; break;
409 case TF_CHARDEV: *modestr = 'c'; break;
410 case TF_BLOCKDEV: *modestr = 'b'; break;
411 case TF_DIRECTORY:*modestr = 'd'; break;
412 case TF_FIFO: *modestr = 'f'; break;
413 case TF_RESERVED: *modestr = '='; break;
414 case TF_EXTHDR: break;
415 case TF_GEXTHDR: break;
416 case TF_UNKNOWN: break;
417 case TF_NOTSUP: break;
419 for (mask = 0400, i = 0; i < 9; i++, mask >>= 1)
420 modestr[1+i] = (header->mode & mask)? "rwxrwxrwx"[i]:'-';
421 if ((header->typeflag & 04000))
422 modestr[3] = modestr[3] == 'x'? 's':'S';
423 if ((header->typeflag & 02000))
424 modestr[6] = modestr[6] == 'x'? 's':'S';
425 if ((header->typeflag & 01000))
426 modestr[9] = modestr[9] == 'x'? 't':'T';
429 /* FIXME: We do not parse the linkname unless its part of an
430 * extended header. */
432 linkname = header->typeflag == TF_SYMLINK? "?" : NULL;
434 for (sl = extheader; sl; sl = sl->next)
438 else if (sl->flags == 2)
442 es_fprintf (out, "%s %lu %lu/%lu %12llu %s %s%s%s\n",
443 modestr, header->nlink, header->uid, header->gid, header->size,
444 isotimestamp (header->mtime),
446 linkname? " -> " : "",
447 linkname? linkname : "");
452 /* List the tarball FILENAME or, if FILENAME is NULL, the tarball read
455 gpgtar_list (const char *filename, int decrypt)
458 estream_t stream = NULL;
459 tar_header_t header = NULL;
460 strlist_t extheader = NULL;
461 struct tarinfo_s tarinfo_buffer;
462 tarinfo_t tarinfo = &tarinfo_buffer;
463 pid_t pid = (pid_t)(-1);
465 memset (&tarinfo_buffer, 0, sizeof tarinfo_buffer);
473 ccparray_init (&ccp, 0);
475 ccparray_put (&ccp, "--batch");
476 if (opt.require_compliance)
477 ccparray_put (&ccp, "--require-compliance");
478 if (opt.status_fd != -1)
480 static char tmpbuf[40];
482 snprintf (tmpbuf, sizeof tmpbuf, "--status-fd=%d", opt.status_fd);
483 ccparray_put (&ccp, tmpbuf);
485 ccparray_put (&ccp, "--output");
486 ccparray_put (&ccp, "-");
487 ccparray_put (&ccp, "--decrypt");
488 for (arg = opt.gpg_arguments; arg; arg = arg->next)
489 ccparray_put (&ccp, arg->d);
492 ccparray_put (&ccp, "--");
493 ccparray_put (&ccp, filename);
496 ccparray_put (&ccp, NULL);
497 argv = ccparray_get (&ccp, NULL);
500 err = gpg_error_from_syserror ();
504 err = gnupg_spawn_process (opt.gpg_program, argv, NULL,
505 ((filename? 0 : GNUPG_SPAWN_KEEP_STDIN)
506 | GNUPG_SPAWN_KEEP_STDERR),
507 NULL, &stream, NULL, &pid);
511 es_set_binary (stream);
513 else if (filename) /* No decryption requested. */
515 if (!strcmp (filename, "-"))
518 stream = es_fopen (filename, "rb,sysopen");
521 err = gpg_error_from_syserror ();
522 log_error ("error opening '%s': %s\n", filename, gpg_strerror (err));
525 if (stream == es_stdin)
526 es_set_binary (es_stdin);
531 es_set_binary (es_stdin);
536 err = read_header (stream, tarinfo, &header, &extheader);
537 if (err || header == NULL)
540 print_header (header, extheader, es_stdout);
542 if (skip_data (stream, tarinfo, header))
544 free_strlist (extheader);
550 if (pid != (pid_t)(-1))
554 err = es_fclose (stream);
557 log_error ("error closing pipe: %s\n", gpg_strerror (err));
560 err = gnupg_wait_process (opt.gpg_program, pid, 1, &exitcode);
562 log_error ("running %s failed (exitcode=%d): %s",
563 opt.gpg_program, exitcode, gpg_strerror (err));
564 gnupg_release_process (pid);
570 free_strlist (extheader);
572 if (stream != es_stdin)
579 gpgtar_read_header (estream_t stream, tarinfo_t info,
580 tar_header_t *r_header, strlist_t *r_extheader)
582 return read_header (stream, info, r_header, r_extheader);
586 gpgtar_print_header (tar_header_t header, strlist_t extheader, estream_t out)
589 print_header (header, extheader, out);