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