1 /* gpgtar-create.c - Create 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/>.
25 #include <sys/types.h>
28 #ifdef HAVE_W32_SYSTEM
29 # define WIN32_LEAN_AND_MEAN
31 #else /*!HAVE_W32_SYSTEM*/
35 #endif /*!HAVE_W32_SYSTEM*/
39 #include "../common/exectool.h"
40 #include "../common/sysutils.h"
41 #include "../common/ccparray.h"
45 #define lstat(a,b) stat ((a), (b))
49 /* Object to control the file scanning. */
51 typedef struct scanctrl_s *scanctrl_t;
55 tar_header_t *flist_tail;
62 /* Given a fresh header object HDR with only the name field set, try
63 to gather all available info. This is the W32 version. */
64 #ifdef HAVE_W32_SYSTEM
66 fillup_entry_w32 (tar_header_t hdr)
70 WIN32_FILE_ATTRIBUTE_DATA fad;
73 for (p=hdr->name; *p; p++)
76 wfname = native_to_wchar (hdr->name);
77 for (p=hdr->name; *p; p++)
82 log_error ("error converting '%s': %s\n", hdr->name, w32_strerror (-1));
83 return gpg_error_from_syserror ();
85 if (!GetFileAttributesExW (wfname, GetFileExInfoStandard, &fad))
87 log_error ("error stat-ing '%s': %s\n", hdr->name, w32_strerror (-1));
89 return gpg_error_from_syserror ();
93 attr = fad.dwFileAttributes;
95 if ((attr & FILE_ATTRIBUTE_NORMAL))
96 hdr->typeflag = TF_REGULAR;
97 else if ((attr & FILE_ATTRIBUTE_DIRECTORY))
98 hdr->typeflag = TF_DIRECTORY;
99 else if ((attr & FILE_ATTRIBUTE_DEVICE))
100 hdr->typeflag = TF_NOTSUP;
101 else if ((attr & (FILE_ATTRIBUTE_OFFLINE | FILE_ATTRIBUTE_TEMPORARY)))
102 hdr->typeflag = TF_NOTSUP;
104 hdr->typeflag = TF_REGULAR;
106 /* Map some attributes to USTAR defined mode bits. */
107 hdr->mode = 0640; /* User may read and write, group only read. */
108 if ((attr & FILE_ATTRIBUTE_DIRECTORY))
109 hdr->mode |= 0110; /* Dirs are user and group executable. */
110 if ((attr & FILE_ATTRIBUTE_READONLY))
111 hdr->mode &= ~0200; /* Clear the user write bit. */
112 if ((attr & FILE_ATTRIBUTE_HIDDEN))
113 hdr->mode &= ~0707; /* Clear all user and other bits. */
114 if ((attr & FILE_ATTRIBUTE_SYSTEM))
115 hdr->mode |= 0004; /* Make it readable by other. */
117 /* Only set the size for a regular file. */
118 if (hdr->typeflag == TF_REGULAR)
119 hdr->size = (fad.nFileSizeHigh * (unsigned long long)(MAXDWORD+1)
122 hdr->mtime = (((unsigned long long)fad.ftLastWriteTime.dwHighDateTime << 32)
123 | fad.ftLastWriteTime.dwLowDateTime);
125 hdr->mtime = (((unsigned long long)fad.ftCreationTime.dwHighDateTime << 32)
126 | fad.ftCreationTime.dwLowDateTime);
127 hdr->mtime -= 116444736000000000ULL; /* The filetime epoch is 1601-01-01. */
128 hdr->mtime /= 10000000; /* Convert from 0.1us to seconds. */
132 #endif /*HAVE_W32_SYSTEM*/
135 /* Given a fresh header object HDR with only the name field set, try
136 to gather all available info. This is the POSIX version. */
137 #ifndef HAVE_W32_SYSTEM
139 fillup_entry_posix (tar_header_t hdr)
144 if (lstat (hdr->name, &sbuf))
146 err = gpg_error_from_syserror ();
147 log_error ("error stat-ing '%s': %s\n", hdr->name, gpg_strerror (err));
151 if (S_ISREG (sbuf.st_mode))
152 hdr->typeflag = TF_REGULAR;
153 else if (S_ISDIR (sbuf.st_mode))
154 hdr->typeflag = TF_DIRECTORY;
155 else if (S_ISCHR (sbuf.st_mode))
156 hdr->typeflag = TF_CHARDEV;
157 else if (S_ISBLK (sbuf.st_mode))
158 hdr->typeflag = TF_BLOCKDEV;
159 else if (S_ISFIFO (sbuf.st_mode))
160 hdr->typeflag = TF_FIFO;
161 else if (S_ISLNK (sbuf.st_mode))
162 hdr->typeflag = TF_SYMLINK;
164 hdr->typeflag = TF_NOTSUP;
166 /* FIXME: Save DEV and INO? */
168 /* Set the USTAR defined mode bits using the system macros. */
169 if (sbuf.st_mode & S_IRUSR)
171 if (sbuf.st_mode & S_IWUSR)
173 if (sbuf.st_mode & S_IXUSR)
175 if (sbuf.st_mode & S_IRGRP)
177 if (sbuf.st_mode & S_IWGRP)
179 if (sbuf.st_mode & S_IXGRP)
181 if (sbuf.st_mode & S_IROTH)
183 if (sbuf.st_mode & S_IWOTH)
185 if (sbuf.st_mode & S_IXOTH)
188 if (sbuf.st_mode & S_IXUID)
192 if (sbuf.st_mode & S_IXGID)
196 if (sbuf.st_mode & S_ISVTX)
200 hdr->nlink = sbuf.st_nlink;
202 hdr->uid = sbuf.st_uid;
203 hdr->gid = sbuf.st_gid;
205 /* Only set the size for a regular file. */
206 if (hdr->typeflag == TF_REGULAR)
207 hdr->size = sbuf.st_size;
209 hdr->mtime = sbuf.st_mtime;
213 #endif /*!HAVE_W32_SYSTEM*/
216 /* Add a new entry. The name of a director entry is ENTRYNAME; if
217 that is NULL, DNAME is the name of the directory itself. Under
218 Windows ENTRYNAME shall have backslashes replaced by standard
221 add_entry (const char *dname, const char *entryname, scanctrl_t scanctrl)
226 size_t dnamelen = strlen (dname);
230 hdr = xtrycalloc (1, sizeof *hdr + dnamelen + 1
231 + (entryname? strlen (entryname) : 0) + 1);
233 return gpg_error_from_syserror ();
235 p = stpcpy (hdr->name, dname);
238 if (dname[dnamelen-1] != '/')
240 strcpy (p, entryname);
244 if (hdr->name[dnamelen-1] == '/')
245 hdr->name[dnamelen-1] = 0;
247 #ifdef HAVE_DOSISH_SYSTEM
248 err = fillup_entry_w32 (hdr);
250 err = fillup_entry_posix (hdr);
257 gpgtar_print_header (hdr, log_get_stream ());
258 *scanctrl->flist_tail = hdr;
259 scanctrl->flist_tail = &hdr->next;
267 scan_directory (const char *dname, scanctrl_t scanctrl)
271 #ifdef HAVE_W32_SYSTEM
273 HANDLE hd = INVALID_HANDLE_VALUE;
277 return 0; /* An empty directory name has no entries. */
283 fname = xtrymalloc (strlen (dname) + 2 + 2 + 1);
286 err = gpg_error_from_syserror ();
289 if (!strcmp (dname, "/"))
290 strcpy (fname, "/*"); /* Trailing slash is not allowed. */
291 else if (!strcmp (dname, "."))
293 else if (*dname && dname[strlen (dname)-1] == '/')
294 strcpy (stpcpy (fname, dname), "*");
295 else if (*dname && dname[strlen (dname)-1] != '*')
296 strcpy (stpcpy (fname, dname), "/*");
298 strcpy (fname, dname);
300 for (p=fname; *p; p++)
303 wfname = native_to_wchar (fname);
307 err = gpg_error_from_syserror ();
308 log_error (_("error reading directory '%s': %s\n"),
309 dname, gpg_strerror (err));
312 hd = FindFirstFileW (wfname, &fi);
313 if (hd == INVALID_HANDLE_VALUE)
315 err = gpg_error_from_syserror ();
316 log_error (_("error reading directory '%s': %s\n"),
317 dname, w32_strerror (-1));
326 char *fname = wchar_to_native (fi.cFileName);
329 err = gpg_error_from_syserror ();
330 log_error ("error converting filename: %s\n", w32_strerror (-1));
333 for (p=fname; *p; p++)
336 if (!strcmp (fname, "." ) || !strcmp (fname, ".."))
337 err = 0; /* Skip self and parent dir entry. */
338 else if (!strncmp (dname, "./", 2) && dname[2])
339 err = add_entry (dname+2, fname, scanctrl);
341 err = add_entry (dname, fname, scanctrl);
344 while (!err && FindNextFileW (hd, &fi));
347 else if (GetLastError () == ERROR_NO_MORE_FILES)
351 err = gpg_error_from_syserror ();
352 log_error (_("error reading directory '%s': %s\n"),
353 dname, w32_strerror (-1));
357 if (hd != INVALID_HANDLE_VALUE)
360 #else /*!HAVE_W32_SYSTEM*/
365 return 0; /* An empty directory name has no entries. */
367 dir = opendir (dname);
370 err = gpg_error_from_syserror ();
371 log_error (_("error reading directory '%s': %s\n"),
372 dname, gpg_strerror (err));
376 while ((de = readdir (dir)))
378 if (!strcmp (de->d_name, "." ) || !strcmp (de->d_name, ".."))
379 continue; /* Skip self and parent dir entry. */
381 err = add_entry (dname, de->d_name, scanctrl);
388 #endif /*!HAVE_W32_SYSTEM*/
394 scan_recursive (const char *dname, scanctrl_t scanctrl)
397 tar_header_t hdr, *start_tail, *stop_tail;
399 if (scanctrl->nestlevel > 200)
401 log_error ("directories too deeply nested\n");
402 return gpg_error (GPG_ERR_RESOURCE_LIMIT);
404 scanctrl->nestlevel++;
406 assert (scanctrl->flist_tail);
407 start_tail = scanctrl->flist_tail;
408 scan_directory (dname, scanctrl);
409 stop_tail = scanctrl->flist_tail;
411 for (; hdr && hdr != *stop_tail; hdr = hdr->next)
412 if (hdr->typeflag == TF_DIRECTORY)
415 log_info ("scanning directory '%s'\n", hdr->name);
416 scan_recursive (hdr->name, scanctrl);
419 scanctrl->nestlevel--;
424 /* Returns true if PATTERN is acceptable. */
426 pattern_valid_p (const char *pattern)
430 if (*pattern == '.' && pattern[1] == '.')
433 #ifdef HAVE_DOSISH_SYSTEM
437 return 0; /* Absolute filenames are not supported. */
438 #ifdef HAVE_DRIVE_LETTERS
439 if (((*pattern >= 'a' && *pattern <= 'z')
440 || (*pattern >= 'A' && *pattern <= 'Z'))
441 && pattern[1] == ':')
442 return 0; /* Drive letter are not allowed either. */
443 #endif /*HAVE_DRIVE_LETTERS*/
445 return 1; /* Okay. */
451 store_xoctal (char *buffer, size_t length, unsigned long long value)
455 unsigned long long v;
461 p = pend = buffer + length;
462 *--p = 0; /* Nul byte. */
466 *--p = '0' + (v % 8);
477 else /* Does not fit into the field. Store as binary number. */
481 p = pend = buffer + length;
496 *p |= 0x80; /* Set binary flag. */
505 store_uname (char *buffer, size_t length, unsigned long uid)
507 static int initialized;
508 static unsigned long lastuid;
509 static char lastuname[32];
511 if (!initialized || uid != lastuid)
513 #ifdef HAVE_W32_SYSTEM
514 mem2str (lastuname, uid? "user":"root", sizeof lastuname);
516 struct passwd *pw = getpwuid (uid);
521 mem2str (lastuname, pw->pw_name, sizeof lastuname);
524 log_info ("failed to get name for uid %lu\n", uid);
529 mem2str (buffer, lastuname, length);
534 store_gname (char *buffer, size_t length, unsigned long gid)
536 static int initialized;
537 static unsigned long lastgid;
538 static char lastgname[32];
540 if (!initialized || gid != lastgid)
542 #ifdef HAVE_W32_SYSTEM
543 mem2str (lastgname, gid? "users":"root", sizeof lastgname);
545 struct group *gr = getgrgid (gid);
550 mem2str (lastgname, gr->gr_name, sizeof lastgname);
553 log_info ("failed to get name for gid %lu\n", gid);
558 mem2str (buffer, lastgname, length);
563 build_header (void *record, tar_header_t hdr)
566 struct ustar_raw_header *raw = record;
568 unsigned long chksum;
571 memset (record, 0, RECORDSIZE);
573 /* Store name and prefix. */
574 namelen = strlen (hdr->name);
575 if (namelen < sizeof raw->name)
576 memcpy (raw->name, hdr->name, namelen);
579 n = (namelen < sizeof raw->prefix)? namelen : sizeof raw->prefix;
581 if (hdr->name[n] == '/')
583 if (namelen - n < sizeof raw->name)
585 /* Note that the N is < sizeof prefix and that the
586 delimiting slash is not stored. */
587 memcpy (raw->prefix, hdr->name, n);
588 memcpy (raw->name, hdr->name+n+1, namelen - n);
592 err = gpg_error (GPG_ERR_TOO_LARGE);
593 log_error ("error storing file '%s': %s\n",
594 hdr->name, gpg_strerror (err));
599 store_xoctal (raw->mode, sizeof raw->mode, hdr->mode);
600 store_xoctal (raw->uid, sizeof raw->uid, hdr->uid);
601 store_xoctal (raw->gid, sizeof raw->gid, hdr->gid);
602 store_xoctal (raw->size, sizeof raw->size, hdr->size);
603 store_xoctal (raw->mtime, sizeof raw->mtime, hdr->mtime);
605 switch (hdr->typeflag)
607 case TF_REGULAR: raw->typeflag[0] = '0'; break;
608 case TF_HARDLINK: raw->typeflag[0] = '1'; break;
609 case TF_SYMLINK: raw->typeflag[0] = '2'; break;
610 case TF_CHARDEV: raw->typeflag[0] = '3'; break;
611 case TF_BLOCKDEV: raw->typeflag[0] = '4'; break;
612 case TF_DIRECTORY: raw->typeflag[0] = '5'; break;
613 case TF_FIFO: raw->typeflag[0] = '6'; break;
614 default: return gpg_error (GPG_ERR_NOT_SUPPORTED);
617 memcpy (raw->magic, "ustar", 6);
618 raw->version[0] = '0';
619 raw->version[1] = '0';
621 store_uname (raw->uname, sizeof raw->uname, hdr->uid);
622 store_gname (raw->gname, sizeof raw->gname, hdr->gid);
624 #ifndef HAVE_W32_SYSTEM
625 if (hdr->typeflag == TF_SYMLINK)
629 nread = readlink (hdr->name, raw->linkname, sizeof raw->linkname -1);
632 err = gpg_error_from_syserror ();
633 log_error ("error reading symlink '%s': %s\n",
634 hdr->name, gpg_strerror (err));
637 raw->linkname[nread] = 0;
639 #endif /*HAVE_W32_SYSTEM*/
641 /* Compute the checksum. */
642 memset (raw->checksum, ' ', sizeof raw->checksum);
645 for (n=0; n < RECORDSIZE; n++)
647 store_xoctal (raw->checksum, sizeof raw->checksum - 1, chksum);
648 raw->checksum[7] = ' ';
655 write_file (estream_t stream, tar_header_t hdr)
658 char record[RECORDSIZE];
660 size_t nread, nbytes;
663 err = build_header (record, hdr);
666 if (gpg_err_code (err) == GPG_ERR_NOT_SUPPORTED)
668 log_info ("skipping unsupported file '%s'\n", hdr->name);
674 if (hdr->typeflag == TF_REGULAR)
676 infp = es_fopen (hdr->name, "rb");
679 err = gpg_error_from_syserror ();
680 log_error ("can't open '%s': %s - skipped\n",
681 hdr->name, gpg_strerror (err));
688 err = write_record (stream, record);
692 if (hdr->typeflag == TF_REGULAR)
694 hdr->nrecords = (hdr->size + RECORDSIZE-1)/RECORDSIZE;
696 while (hdr->nrecords--)
698 nbytes = hdr->nrecords? RECORDSIZE : (hdr->size % RECORDSIZE);
701 nread = es_fread (record, 1, nbytes, infp);
704 err = gpg_error_from_syserror ();
705 log_error ("error reading file '%s': %s%s\n",
706 hdr->name, gpg_strerror (err),
707 any? " (file shrunk?)":"");
711 err = write_record (stream, record);
715 nread = es_fread (record, 1, 1, infp);
717 log_info ("note: file '%s' has grown\n", hdr->name);
723 else if ((err = es_fclose (infp)))
724 log_error ("error closing file '%s': %s\n", hdr->name, gpg_strerror (err));
731 write_eof_mark (estream_t stream)
734 char record[RECORDSIZE];
736 memset (record, 0, sizeof record);
737 err = write_record (stream, record);
739 err = write_record (stream, record);
745 /* Create a new tarball using the names in the array INPATTERN. If
746 INPATTERN is NULL take the pattern as null terminated strings from
749 gpgtar_create (char **inpattern, int encrypt, int sign)
752 struct scanctrl_s scanctrl_buffer;
753 scanctrl_t scanctrl = &scanctrl_buffer;
754 tar_header_t hdr, *start_tail;
755 estream_t outstream = NULL;
756 estream_t cipher_stream = NULL;
760 es_set_binary (es_stdin);
762 memset (scanctrl, 0, sizeof *scanctrl);
763 scanctrl->flist_tail = &scanctrl->flist;
772 const char *pattern = *inpattern;
775 break; /* End of array. */
781 pat = xtrystrdup (pattern);
783 else /* Read null delimited pattern from stdin. */
791 if ((c = es_getc (es_stdin)) == EOF)
793 if (es_ferror (es_stdin))
795 err = gpg_error_from_syserror ();
796 log_error ("error reading '%s': %s\n",
797 "[stdin]", strerror (errno));
800 /* Note: The Nul is a delimiter and not a terminator. */
804 if (n >= sizeof namebuf - 1)
809 log_error ("error reading '%s': %s\n",
810 "[stdin]", "filename too long");
822 if (skip_this || n < 2)
825 pat = xtrystrdup (namebuf);
830 err = gpg_error_from_syserror ();
831 log_error ("memory allocation problem: %s\n", gpg_strerror (err));
839 log_info ("scanning '%s'\n", pat);
841 start_tail = scanctrl->flist_tail;
842 if (skip_this || !pattern_valid_p (pat))
843 log_error ("skipping invalid name '%s'\n", pat);
844 else if (!add_entry (pat, NULL, scanctrl)
845 && *start_tail && ((*start_tail)->typeflag & TF_DIRECTORY))
846 scan_recursive (pat, scanctrl);
853 if (!strcmp (opt.outfile, "-"))
854 outstream = es_stdout;
856 outstream = es_fopen (opt.outfile, "wb");
859 err = gpg_error_from_syserror ();
865 outstream = es_stdout;
868 if (outstream == es_stdout)
869 es_set_binary (es_stdout);
873 cipher_stream = outstream;
874 outstream = es_fopenmem (0, "rwb");
877 err = gpg_error_from_syserror ();
882 for (hdr = scanctrl->flist; hdr; hdr = hdr->next)
884 err = write_file (outstream, hdr);
888 err = write_eof_mark (outstream);
898 err = es_fseek (outstream, 0, SEEK_SET);
902 /* '--encrypt' may be combined with '--symmetric', but 'encrypt'
903 is set either way. Clear it if no recipients are specified.
904 XXX: Fix command handling. */
905 if (opt.symmetric && opt.recipients == NULL)
908 ccparray_init (&ccp, 0);
910 ccparray_put (&ccp, "--encrypt");
912 ccparray_put (&ccp, "--sign");
915 ccparray_put (&ccp, "--local-user");
916 ccparray_put (&ccp, opt.user);
919 ccparray_put (&ccp, "--symmetric");
920 for (arg = opt.recipients; arg; arg = arg->next)
922 ccparray_put (&ccp, "--recipient");
923 ccparray_put (&ccp, arg->d);
925 for (arg = opt.gpg_arguments; arg; arg = arg->next)
926 ccparray_put (&ccp, arg->d);
928 ccparray_put (&ccp, NULL);
929 argv = ccparray_get (&ccp, NULL);
932 err = gpg_error_from_syserror ();
936 err = gnupg_exec_tool_stream (opt.gpg_program, argv,
937 outstream, NULL, cipher_stream, NULL, NULL);
946 gpg_error_t first_err;
947 if (outstream != es_stdout)
948 first_err = es_fclose (outstream);
950 first_err = es_fflush (outstream);
952 if (cipher_stream != es_stdout)
953 err = es_fclose (cipher_stream);
955 err = es_fflush (cipher_stream);
956 cipher_stream = NULL;
962 log_error ("creating tarball '%s' failed: %s\n",
963 opt.outfile ? opt.outfile : "-", gpg_strerror (err));
964 if (outstream && outstream != es_stdout)
965 es_fclose (outstream);
966 if (cipher_stream && cipher_stream != es_stdout)
967 es_fclose (cipher_stream);
969 gnupg_remove (opt.outfile);
971 scanctrl->flist_tail = NULL;
972 while ( (hdr = scanctrl->flist) )
974 scanctrl->flist = hdr->next;