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