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