tools/gpgtar: Use the new exectool helper.
[gnupg.git] / tools / gpgtar-extract.c
1 /* gpgtar-extract.c - Extract from a TAR archive
2  * Copyright (C) 2010 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
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.
10  *
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.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <errno.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <sys/types.h>
26 #include <sys/stat.h>
27 #include <unistd.h>
28 #include <assert.h>
29
30 #include "i18n.h"
31 #include "../common/sh-exectool.h"
32 #include "../common/sysutils.h"
33 #include "gpgtar.h"
34
35
36 static gpg_error_t
37 extract_regular (estream_t stream, const char *dirname,
38                  tar_header_t hdr)
39 {
40   gpg_error_t err;
41   char record[RECORDSIZE];
42   size_t n, nbytes, nwritten;
43   char *fname;
44   estream_t outfp = NULL;
45
46   fname = strconcat (dirname, "/", hdr->name, NULL);
47   if (!fname)
48     {
49       err = gpg_error_from_syserror ();
50       log_error ("error creating filename: %s\n", gpg_strerror (err));
51       goto leave;
52     }
53   else
54     err = 0;
55
56   if (opt.dry_run)
57     outfp = es_fopenmem (0, "wb");
58   else
59     outfp = es_fopen (fname, "wb");
60   if (!outfp)
61     {
62       err = gpg_error_from_syserror ();
63       log_error ("error creating '%s': %s\n", fname, gpg_strerror (err));
64       goto leave;
65     }
66
67   for (n=0; n < hdr->nrecords;)
68     {
69       err = read_record (stream, record);
70       if (err)
71         goto leave;
72       n++;
73       if (n < hdr->nrecords || (hdr->size && !(hdr->size % RECORDSIZE)))
74         nbytes = RECORDSIZE;
75       else
76         nbytes = (hdr->size % RECORDSIZE);
77
78       nwritten = es_fwrite (record, 1, nbytes, outfp);
79       if (nwritten != nbytes)
80         {
81           err = gpg_error_from_syserror ();
82           log_error ("error writing '%s': %s\n", fname, gpg_strerror (err));
83           goto leave;
84         }
85     }
86   /* Fixme: Set permissions etc.  */
87
88  leave:
89   if (!err && opt.verbose)
90     log_info ("extracted '%s'\n", fname);
91   es_fclose (outfp);
92   if (err && fname && outfp)
93     {
94       if (gnupg_remove (fname))
95         log_error ("error removing incomplete file '%s': %s\n",
96                    fname, gpg_strerror (gpg_error_from_syserror ()));
97     }
98   xfree (fname);
99   return err;
100 }
101
102
103 static gpg_error_t
104 extract_directory (const char *dirname, tar_header_t hdr)
105 {
106   gpg_error_t err;
107   char *fname;
108   size_t prefixlen;
109
110   prefixlen = strlen (dirname) + 1;
111   fname = strconcat (dirname, "/", hdr->name, NULL);
112   if (!fname)
113     {
114       err = gpg_error_from_syserror ();
115       log_error ("error creating filename: %s\n", gpg_strerror (err));
116       goto leave;
117     }
118   else
119     err = 0;
120
121   if (fname[strlen (fname)-1] == '/')
122     fname[strlen (fname)-1] = 0;
123
124  /* Note that we don't need to care about EEXIST because we always
125      extract into a new hierarchy.  */
126   if (! opt.dry_run && gnupg_mkdir (fname, "-rwx------"))
127     {
128       err = gpg_error_from_syserror ();
129       if (gpg_err_code (err) == GPG_ERR_ENOENT)
130         {
131           /* Try to create the directory with parents but keep the
132              original error code in case of a failure.  */
133           char *p;
134           int rc = 0;
135
136           for (p = fname+prefixlen; (p = strchr (p, '/')); p++)
137             {
138               *p = 0;
139               rc = gnupg_mkdir (fname, "-rwx------");
140               *p = '/';
141               if (rc)
142                 break;
143             }
144           if (!rc && !gnupg_mkdir (fname, "-rwx------"))
145             err = 0;
146         }
147       if (err)
148         log_error ("error creating directory '%s': %s\n",
149                    fname, gpg_strerror (err));
150     }
151
152  leave:
153   if (!err && opt.verbose)
154     log_info ("created   '%s/'\n", fname);
155   xfree (fname);
156   return err;
157 }
158
159
160 static gpg_error_t
161 extract (estream_t stream, const char *dirname, tar_header_t hdr)
162 {
163   gpg_error_t err;
164   size_t n;
165
166   n = strlen (hdr->name);
167 #ifdef HAVE_DOSISH_SYSTEM
168   if (strchr (hdr->name, '\\'))
169     {
170       log_error ("filename '%s' contains a backslash - "
171                  "can't extract on this system\n", hdr->name);
172       return gpg_error (GPG_ERR_INV_NAME);
173     }
174 #endif /*HAVE_DOSISH_SYSTEM*/
175
176   if (!n
177       || strstr (hdr->name, "//")
178       || strstr (hdr->name, "/../")
179       || !strncmp (hdr->name, "../", 3)
180       || (n >= 3 && !strcmp (hdr->name+n-3, "/.." )))
181     {
182       log_error ("filename '%s' as suspicious parts - not extracting\n",
183                  hdr->name);
184       return gpg_error (GPG_ERR_INV_NAME);
185     }
186
187   if (hdr->typeflag == TF_REGULAR || hdr->typeflag == TF_UNKNOWN)
188     err = extract_regular (stream, dirname, hdr);
189   else if (hdr->typeflag == TF_DIRECTORY)
190     err = extract_directory (dirname, hdr);
191   else
192     {
193       char record[RECORDSIZE];
194
195       log_info ("unsupported file type %d for '%s' - skipped\n",
196                 (int)hdr->typeflag, hdr->name);
197       for (err = 0, n=0; !err && n < hdr->nrecords; n++)
198         err = read_record (stream, record);
199     }
200   return err;
201 }
202
203
204 /* Create a new directory to be used for extracting the tarball.
205    Returns the name of the directory which must be freed by the
206    caller.  In case of an error a diagnostic is printed and NULL
207    returned.  */
208 static char *
209 create_directory (const char *dirprefix)
210 {
211   gpg_error_t err = 0;
212   char *prefix_buffer = NULL;
213   char *dirname = NULL;
214   size_t n;
215   int idx;
216
217   /* Remove common suffixes.  */
218   n = strlen (dirprefix);
219   if (n > 4 && (!compare_filenames    (dirprefix + n - 4, EXTSEP_S GPGEXT_GPG)
220                 || !compare_filenames (dirprefix + n - 4, EXTSEP_S "pgp")
221                 || !compare_filenames (dirprefix + n - 4, EXTSEP_S "asc")
222                 || !compare_filenames (dirprefix + n - 4, EXTSEP_S "pem")
223                 || !compare_filenames (dirprefix + n - 4, EXTSEP_S "p7m")
224                 || !compare_filenames (dirprefix + n - 4, EXTSEP_S "p7e")))
225     {
226       prefix_buffer = xtrystrdup (dirprefix);
227       if (!prefix_buffer)
228         {
229           err = gpg_error_from_syserror ();
230           goto leave;
231         }
232       prefix_buffer[n-4] = 0;
233       dirprefix = prefix_buffer;
234     }
235
236
237
238   for (idx=1; idx < 5000; idx++)
239     {
240       xfree (dirname);
241       dirname = xtryasprintf ("%s_%d_", dirprefix, idx);
242       if (!dirname)
243         {
244           err = gpg_error_from_syserror ();
245           goto leave;
246         }
247       if (!gnupg_mkdir (dirname, "-rwx------"))
248         goto leave; /* Ready.  */
249       if (errno != EEXIST && errno != ENOTDIR)
250         {
251           err = gpg_error_from_syserror ();
252           goto leave;
253         }
254     }
255   err = gpg_error (GPG_ERR_LIMIT_REACHED);
256
257  leave:
258   if (err)
259     {
260       log_error ("error creating an extract directory: %s\n",
261                  gpg_strerror (err));
262       xfree (dirname);
263       dirname = NULL;
264     }
265   xfree (prefix_buffer);
266   return dirname;
267 }
268
269
270 \f
271 gpg_error_t
272 gpgtar_extract (const char *filename, int decrypt)
273 {
274   gpg_error_t err;
275   estream_t stream;
276   estream_t cipher_stream = NULL;
277   tar_header_t header = NULL;
278   const char *dirprefix = NULL;
279   char *dirname = NULL;
280
281   if (filename)
282     {
283       if (!strcmp (filename, "-"))
284         stream = es_stdout;
285       else
286         stream = es_fopen (filename, "rb");
287       if (!stream)
288         {
289           err = gpg_error_from_syserror ();
290           log_error ("error opening '%s': %s\n", filename, gpg_strerror (err));
291           return err;
292         }
293     }
294   else
295     stream = es_stdin;
296
297   if (stream == es_stdin)
298     es_set_binary (es_stdin);
299
300   if (decrypt)
301     {
302       int i;
303       strlist_t arg;
304       const char **argv;
305
306       cipher_stream = stream;
307       stream = es_fopenmem (0, "rwb");
308       if (! stream)
309         {
310           err = gpg_error_from_syserror ();
311           goto leave;
312         }
313
314       argv = xtrycalloc (strlist_length (opt.gpg_arguments) + 2,
315                          sizeof *argv);
316       if (argv == NULL)
317         {
318           err = gpg_error_from_syserror ();
319           goto leave;
320         }
321       i = 0;
322       argv[i++] = "--decrypt";
323       for (arg = opt.gpg_arguments; arg; arg = arg->next)
324         argv[i++] = arg->d;
325       argv[i++] = NULL;
326       assert (i == strlist_length (opt.gpg_arguments) + 2);
327
328       err = sh_exec_tool_stream (opt.gpg_program, argv,
329                                  cipher_stream, stream);
330       xfree (argv);
331       if (err)
332         goto leave;
333
334       err = es_fseek (stream, 0, SEEK_SET);
335       if (err)
336         goto leave;
337     }
338
339   if (opt.directory)
340     dirname = xtrystrdup (opt.directory);
341   else
342     {
343       if (filename)
344         {
345           dirprefix = strrchr (filename, '/');
346           if (dirprefix)
347             dirprefix++;
348           else
349             dirprefix = filename;
350         }
351       else if (opt.filename)
352         {
353           dirprefix = strrchr (opt.filename, '/');
354           if (dirprefix)
355             dirprefix++;
356           else
357             dirprefix = opt.filename;
358         }
359
360       if (!dirprefix || !*dirprefix)
361         dirprefix = "GPGARCH";
362
363       dirname = create_directory (dirprefix);
364       if (!dirname)
365         {
366           err = gpg_error (GPG_ERR_GENERAL);
367           goto leave;
368         }
369     }
370
371   if (opt.verbose)
372     log_info ("extracting to '%s/'\n", dirname);
373
374   for (;;)
375     {
376       err = gpgtar_read_header (stream, &header);
377       if (err || header == NULL)
378         goto leave;
379
380       err = extract (stream, dirname, header);
381       if (err)
382         goto leave;
383       xfree (header);
384       header = NULL;
385     }
386
387
388  leave:
389   xfree (header);
390   xfree (dirname);
391   if (stream != es_stdin)
392     es_fclose (stream);
393   if (stream != cipher_stream)
394     es_fclose (cipher_stream);
395   return err;
396 }