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