tools/gpgtar: Improve error handling.
[gnupg.git] / tools / gpgtar.h
1 /* gpgtar.h - Global definitions for gpgtar
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 #ifndef GPGTAR_H
21 #define GPGTAR_H
22
23 #include "../common/util.h"
24 #include "../common/strlist.h"
25
26 /* We keep all global options in the structure OPT.  */
27 struct
28 {
29   int verbose;
30   unsigned int debug_level;
31   int quiet;
32   const char *outfile;
33   strlist_t recipients;
34   const char *user;
35   int symmetric;
36   const char *filename;
37 } opt;
38
39
40 /* The size of a tar record.  All IO is done in chunks of this size.
41    Note that we don't care about blocking because this version of tar
42    is not expected to be used directly on a tape drive in fact it is
43    used in a pipeline with GPG and thus any blocking would be
44    useless.  */
45 #define RECORDSIZE 512 
46
47
48 /* Description of the USTAR header format.  */
49 struct ustar_raw_header
50 {
51   char name[100];
52   char mode[8];
53   char uid[8];
54   char gid[8];
55   char size[12];
56   char mtime[12];
57   char checksum[8];
58   char typeflag[1];
59   char linkname[100];
60   char magic[6];
61   char version[2];
62   char uname[32];
63   char gname[32];   
64   char devmajor[8]; 
65   char devminor[8];
66   char prefix[155]; 
67   char pad[12];
68 };
69
70
71 /* Filetypes as defined by USTAR.  */
72 typedef enum 
73   {
74     TF_REGULAR,
75     TF_HARDLINK,
76     TF_SYMLINK,
77     TF_CHARDEV,
78     TF_BLOCKDEV,
79     TF_DIRECTORY,
80     TF_FIFO,
81     TF_RESERVED,
82     TF_UNKNOWN,    /* Needs to be treated as regular file.  */
83     TF_NOTSUP      /* Not supported (used with --create).  */
84   } typeflag_t;
85
86
87 /* The internal represenation of a TAR header.  */
88 struct tar_header_s;
89 typedef struct tar_header_s *tar_header_t;
90 struct tar_header_s
91 {
92   tar_header_t next;        /* Used to build a linked list iof entries.  */
93
94   unsigned long mode;       /* The file mode.  */
95   unsigned long nlink;      /* Number of hard links.  */
96   unsigned long uid;        /* The user id of the file.  */
97   unsigned long gid;        /* The group id of the file.  */
98   unsigned long long size;  /* The size of the file.  */
99   unsigned long long mtime; /* Modification time since Epoch.  Note
100                                that we don't use time_t here but a
101                                type which is more likely to be larger
102                                that 32 bit and thus allows to track
103                                times beyond 2106.  */
104   typeflag_t typeflag;      /* The type of the file.  */
105   
106
107   unsigned long long nrecords; /* Number of data records.  */
108
109   char name[1];             /* Filename (dynamically extended).  */
110 };
111
112
113 /*-- gpgtar.c --*/
114 gpg_error_t read_record (estream_t stream, void *record);
115 gpg_error_t write_record (estream_t stream, const void *record);
116
117 /*-- gpgtar-create.c --*/
118 gpg_error_t gpgtar_create (char **inpattern, int encrypt);
119
120 /*-- gpgtar-extract.c --*/
121 gpg_error_t gpgtar_extract (const char *filename, int decrypt);
122
123 /*-- gpgtar-list.c --*/
124 gpg_error_t gpgtar_list (const char *filename, int decrypt);
125 gpg_error_t gpgtar_read_header (estream_t stream, tar_header_t *r_header);
126 void gpgtar_print_header (tar_header_t header, estream_t out);
127
128
129 #endif /*GPGTAR_H*/