1 /* gpgtar-list.c - List a TAR archive
2 * Copyright (C) 2010 Free Software Foundation, Inc.
4 * This file is part of GnuPG.
6 * GnuPG is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * GnuPG is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <https://www.gnu.org/licenses/>.
27 #include "../common/i18n.h"
29 #include "../common/exectool.h"
30 #include "../common/ccparray.h"
34 static unsigned long long
35 parse_xoctal (const void *data, size_t length, const char *filename)
37 const unsigned char *p = data;
38 unsigned long long value;
42 else if ( (*p & 0x80))
45 value = (*p++ & 0x7f);
56 /* Skip leading spaces and zeroes. */
57 for (; length && (*p == ' ' || *p == '0'); length--, p++)
59 for (; length && *p; length--, p++)
61 if (*p >= '0' && *p <= '7')
68 log_error ("%s: invalid octal number encountered - assuming 0\n",
80 parse_header (const void *record, const char *filename, tarinfo_t info)
82 const struct ustar_raw_header *raw = record;
83 size_t n, namelen, prefixlen;
88 info->headerblock = info->nblocks - 1;
90 use_prefix = (!memcmp (raw->magic, "ustar", 5)
91 && (raw->magic[5] == ' ' || !raw->magic[5]));
94 for (namelen=0; namelen < sizeof raw->name && raw->name[namelen]; namelen++)
96 if (namelen == sizeof raw->name)
98 log_info ("%s: warning: name not terminated by a nul\n", filename);
101 for (n=namelen+1; n < sizeof raw->name; n++)
104 log_info ("%s: warning: garbage after name\n", filename);
109 if (use_prefix && raw->prefix[0])
111 for (prefixlen=0; (prefixlen < sizeof raw->prefix
112 && raw->prefix[prefixlen]); prefixlen++)
114 if (prefixlen == sizeof raw->prefix)
115 log_info ("%s: warning: prefix not terminated by a nul (block %llu)\n",
116 filename, info->headerblock);
117 for (n=prefixlen+1; n < sizeof raw->prefix; n++)
120 log_info ("%s: warning: garbage after prefix\n", filename);
128 header = xtrycalloc (1, sizeof *header + prefixlen + 1 + namelen);
131 log_error ("%s: error allocating header: %s\n",
132 filename, gpg_strerror (gpg_error_from_syserror ()));
138 memcpy (header->name, raw->prefix, n);
139 if (raw->prefix[n-1] != '/')
140 header->name[n++] = '/';
144 memcpy (header->name+n, raw->name, namelen);
145 header->name[n+namelen] = 0;
147 header->mode = parse_xoctal (raw->mode, sizeof raw->mode, filename);
148 header->uid = parse_xoctal (raw->uid, sizeof raw->uid, filename);
149 header->gid = parse_xoctal (raw->gid, sizeof raw->gid, filename);
150 header->size = parse_xoctal (raw->size, sizeof raw->size, filename);
151 header->mtime = parse_xoctal (raw->mtime, sizeof raw->mtime, filename);
153 switch (raw->typeflag[0])
155 case '0': header->typeflag = TF_REGULAR; break;
156 case '1': header->typeflag = TF_HARDLINK; break;
157 case '2': header->typeflag = TF_SYMLINK; break;
158 case '3': header->typeflag = TF_CHARDEV; break;
159 case '4': header->typeflag = TF_BLOCKDEV; break;
160 case '5': header->typeflag = TF_DIRECTORY; break;
161 case '6': header->typeflag = TF_FIFO; break;
162 case '7': header->typeflag = TF_RESERVED; break;
163 default: header->typeflag = TF_UNKNOWN; break;
166 /* Compute the number of data records following this header. */
167 if (header->typeflag == TF_REGULAR || header->typeflag == TF_UNKNOWN)
168 header->nrecords = (header->size + RECORDSIZE-1)/RECORDSIZE;
170 header->nrecords = 0;
174 log_info ("%s: header block %llu is corrupt"
175 " (size=%llu type=%d nrec=%llu)\n",
176 filename, info->headerblock,
177 header->size, header->typeflag, header->nrecords);
178 /* log_printhex (record, RECORDSIZE, " "); */
186 /* Read the next block, assuming it is a tar header. Returns a header
187 object on success in R_HEADER, or an error. If the stream is
188 consumed, R_HEADER is set to NULL. In case of an error an error
189 message has been printed. */
191 read_header (estream_t stream, tarinfo_t info, tar_header_t *r_header)
194 char record[RECORDSIZE];
197 err = read_record (stream, record);
202 for (i=0; i < RECORDSIZE && !record[i]; i++)
206 /* All zero header - check whether it is the first part of an
207 end of archive mark. */
208 err = read_record (stream, record);
213 for (i=0; i < RECORDSIZE && !record[i]; i++)
216 log_info ("%s: warning: skipping empty header\n",
217 es_fname_get (stream));
220 /* End of archive - FIXME: we might want to check for garbage. */
226 *r_header = parse_header (record, es_fname_get (stream), info);
227 return *r_header ? 0 : gpg_error_from_syserror ();
231 /* Skip the data records according to HEADER. Prints an error message
232 on error and return -1. */
234 skip_data (estream_t stream, tarinfo_t info, tar_header_t header)
236 char record[RECORDSIZE];
237 unsigned long long n;
239 for (n=0; n < header->nrecords; n++)
241 if (read_record (stream, record))
252 print_header (tar_header_t header, estream_t out)
259 switch (header->typeflag)
261 case TF_REGULAR: *modestr = '-'; break;
262 case TF_HARDLINK: *modestr = 'h'; break;
263 case TF_SYMLINK: *modestr = 'l'; break;
264 case TF_CHARDEV: *modestr = 'c'; break;
265 case TF_BLOCKDEV: *modestr = 'b'; break;
266 case TF_DIRECTORY:*modestr = 'd'; break;
267 case TF_FIFO: *modestr = 'f'; break;
268 case TF_RESERVED: *modestr = '='; break;
269 case TF_UNKNOWN: break;
270 case TF_NOTSUP: break;
272 for (mask = 0400, i = 0; i < 9; i++, mask >>= 1)
273 modestr[1+i] = (header->mode & mask)? "rwxrwxrwx"[i]:'-';
274 if ((header->typeflag & 04000))
275 modestr[3] = modestr[3] == 'x'? 's':'S';
276 if ((header->typeflag & 02000))
277 modestr[6] = modestr[6] == 'x'? 's':'S';
278 if ((header->typeflag & 01000))
279 modestr[9] = modestr[9] == 'x'? 't':'T';
282 es_fprintf (out, "%s %lu %lu/%lu %12llu %s %s\n",
283 modestr, header->nlink, header->uid, header->gid, header->size,
284 isotimestamp (header->mtime), header->name);
289 /* List the tarball FILENAME or, if FILENAME is NULL, the tarball read
292 gpgtar_list (const char *filename, int decrypt)
296 estream_t cipher_stream = NULL;
297 tar_header_t header = NULL;
298 struct tarinfo_s tarinfo_buffer;
299 tarinfo_t tarinfo = &tarinfo_buffer;
301 memset (&tarinfo_buffer, 0, sizeof tarinfo_buffer);
305 if (!strcmp (filename, "-"))
308 stream = es_fopen (filename, "rb");
311 err = gpg_error_from_syserror ();
312 log_error ("error opening '%s': %s\n", filename, gpg_strerror (err));
319 if (stream == es_stdin)
320 es_set_binary (es_stdin);
328 cipher_stream = stream;
329 stream = es_fopenmem (0, "rwb");
332 err = gpg_error_from_syserror ();
336 ccparray_init (&ccp, 0);
338 ccparray_put (&ccp, "--decrypt");
339 for (arg = opt.gpg_arguments; arg; arg = arg->next)
340 ccparray_put (&ccp, arg->d);
342 ccparray_put (&ccp, NULL);
343 argv = ccparray_get (&ccp, NULL);
346 err = gpg_error_from_syserror ();
350 err = gnupg_exec_tool_stream (opt.gpg_program, argv,
351 cipher_stream, NULL, stream, NULL, NULL);
356 err = es_fseek (stream, 0, SEEK_SET);
363 err = read_header (stream, tarinfo, &header);
364 if (err || header == NULL)
367 print_header (header, es_stdout);
369 if (skip_data (stream, tarinfo, header))
378 if (stream != es_stdin)
380 if (stream != cipher_stream)
381 es_fclose (cipher_stream);
386 gpgtar_read_header (estream_t stream, tarinfo_t info, tar_header_t *r_header)
388 return read_header (stream, info, r_header);
392 gpgtar_print_header (tar_header_t header, estream_t out)
395 print_header (header, out);