gpg: Remove dead code.
[gnupg.git] / kbx / keybox-defs.h
1 /* keybox-defs.h - internal Keybox definitions
2  *      Copyright (C) 2001, 2004 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 KEYBOX_DEFS_H
21 #define KEYBOX_DEFS_H 1
22
23 #ifdef GPG_ERR_SOURCE_DEFAULT
24 # if GPG_ERR_SOURCE_DEFAULT != GPG_ERR_SOURCE_KEYBOX
25 #  error GPG_ERR_SOURCE_DEFAULT already defined
26 # endif
27 #else
28 # define GPG_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_KEYBOX
29 #endif
30 #include <gpg-error.h>
31 #define map_assuan_err(a) \
32         map_assuan_err_with_source (GPG_ERR_SOURCE_DEFAULT, (a))
33
34 #include <sys/types.h> /* off_t */
35
36 /* We include the type defintions from jnlib instead of defining our
37    owns here.  This will not allow us build KBX in a standalone way
38    but there is currently no need for it anyway.  Same goes for
39    stringhelp.h which for example provides a replacement for stpcpy -
40    fixme: Better use the LIBOBJ mechnism. */
41 #include "../common/types.h"
42 #include "../common/stringhelp.h"
43
44 #include "keybox.h"
45
46
47 typedef struct keyboxblob *KEYBOXBLOB;
48
49
50 typedef struct keybox_name *KB_NAME;
51 typedef struct keybox_name const *CONST_KB_NAME;
52 struct keybox_name
53 {
54   /* Link to the next resources, so that we can walk all
55      resources.  */
56   KB_NAME next;
57
58   /* True if this is a keybox with secret keys.  */
59   int secret;
60
61   /*DOTLOCK lockhd;*/
62
63   /* A table with all the handles accessing this resources.
64      HANDLE_TABLE_SIZE gives the allocated length of this table unused
65      entrues are set to NULL.  HANDLE_TABLE may be NULL. */
66   KEYBOX_HANDLE *handle_table;
67   size_t handle_table_size;
68
69   /* Not yet used.  */
70   int is_locked;
71
72   /* Not yet used.  */
73   int did_full_scan;
74
75   /* The name of the resource file. */
76   char fname[1];
77 };
78
79
80 struct keybox_found_s
81 {
82   KEYBOXBLOB blob;
83   size_t pk_no;
84   size_t uid_no;
85 };
86
87 struct keybox_handle {
88   CONST_KB_NAME kb;
89   int secret;             /* this is for a secret keybox */
90   FILE *fp;
91   int eof;
92   int error;
93   int ephemeral;
94   int for_openpgp;        /* Used by gpg.  */
95   struct keybox_found_s found;
96   struct keybox_found_s saved_found;
97   struct {
98     char *name;
99     char *pattern;
100   } word_match;
101 };
102
103
104 /* Openpgp helper structures. */
105 struct _keybox_openpgp_key_info
106 {
107   struct _keybox_openpgp_key_info *next;
108   int algo;
109   unsigned char keyid[8];
110   int fprlen;  /* Either 16 or 20 */
111   unsigned char fpr[20];
112 };
113
114 struct _keybox_openpgp_uid_info
115 {
116   struct _keybox_openpgp_uid_info *next;
117   size_t off;
118   size_t len;
119 };
120
121 struct _keybox_openpgp_info
122 {
123   int is_secret;        /* True if this is a secret key. */
124   unsigned int nsubkeys;/* Total number of subkeys.  */
125   unsigned int nuids;   /* Total number of user IDs in the keyblock. */
126   unsigned int nsigs;   /* Total number of signatures in the keyblock. */
127
128   /* Note, we use 2 structs here to better cope with the most common
129      use of having one primary and one subkey - this allows us to
130      statically allocate this structure and only malloc stuff for more
131      than one subkey. */
132   struct _keybox_openpgp_key_info primary;
133   struct _keybox_openpgp_key_info subkeys;
134   struct _keybox_openpgp_uid_info uids;
135 };
136 typedef struct _keybox_openpgp_info *keybox_openpgp_info_t;
137
138
139 /* Don't know whether this is needed: */
140 /*  static struct { */
141 /*    const char *homedir; */
142 /*    int dry_run; */
143 /*    int quiet; */
144 /*    int verbose; */
145 /*    int preserve_permissions; */
146 /*  } keybox_opt; */
147
148 /*-- keybox-init.c --*/
149 void _keybox_close_file (KEYBOX_HANDLE hd);
150
151
152 /*-- keybox-blob.c --*/
153 gpg_error_t _keybox_create_openpgp_blob (KEYBOXBLOB *r_blob,
154                                          keybox_openpgp_info_t info,
155                                          const unsigned char *image,
156                                          size_t imagelen,
157                                          u32 *sigstatus,
158                                          int as_ephemeral);
159 #ifdef KEYBOX_WITH_X509
160 int _keybox_create_x509_blob (KEYBOXBLOB *r_blob, ksba_cert_t cert,
161                               unsigned char *sha1_digest, int as_ephemeral);
162 #endif /*KEYBOX_WITH_X509*/
163
164 int  _keybox_new_blob (KEYBOXBLOB *r_blob,
165                        unsigned char *image, size_t imagelen,
166                        off_t off);
167 void _keybox_release_blob (KEYBOXBLOB blob);
168 const unsigned char *_keybox_get_blob_image (KEYBOXBLOB blob, size_t *n);
169 off_t _keybox_get_blob_fileoffset (KEYBOXBLOB blob);
170 void _keybox_update_header_blob (KEYBOXBLOB blob, int for_openpgp);
171
172 /*-- keybox-openpgp.c --*/
173 gpg_error_t _keybox_parse_openpgp (const unsigned char *image, size_t imagelen,
174                                    size_t *nparsed,
175                                    keybox_openpgp_info_t info);
176 void _keybox_destroy_openpgp_info (keybox_openpgp_info_t info);
177
178
179 /*-- keybox-file.c --*/
180 int _keybox_read_blob (KEYBOXBLOB *r_blob, FILE *fp);
181 int _keybox_read_blob2 (KEYBOXBLOB *r_blob, FILE *fp, int *skipped_deleted);
182 int _keybox_write_blob (KEYBOXBLOB blob, FILE *fp);
183
184 /*-- keybox-search.c --*/
185 gpg_err_code_t _keybox_get_flag_location (const unsigned char *buffer,
186                                           size_t length,
187                                           int what,
188                                           size_t *flag_off, size_t *flag_size);
189
190 static inline int
191 blob_get_type (KEYBOXBLOB blob)
192 {
193   const unsigned char *buffer;
194   size_t length;
195
196   buffer = _keybox_get_blob_image (blob, &length);
197   if (length < 32)
198     return -1; /* blob too short */
199
200   return buffer[4];
201 }
202
203
204 /*-- keybox-dump.c --*/
205 int _keybox_dump_blob (KEYBOXBLOB blob, FILE *fp);
206 int _keybox_dump_file (const char *filename, int stats_only, FILE *outfp);
207 int _keybox_dump_find_dups (const char *filename, int print_them, FILE *outfp);
208 int _keybox_dump_cut_records (const char *filename, unsigned long from,
209                               unsigned long to, FILE *outfp);
210
211
212 /*-- keybox-util.c --*/
213 void *_keybox_malloc (size_t n);
214 void *_keybox_calloc (size_t n, size_t m);
215 void *_keybox_realloc (void *p, size_t n);
216 void  _keybox_free (void *p);
217
218 #define xtrymalloc(a)    _keybox_malloc ((a))
219 #define xtrycalloc(a,b)  _keybox_calloc ((a),(b))
220 #define xtryrealloc(a,b) _keybox_realloc((a),(b))
221 #define xfree(a)         _keybox_free ((a))
222
223
224 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
225 #define DIMof(type,member)   DIM(((type *)0)->member)
226 #ifndef STR
227 #  define STR(v) #v
228 #endif
229 #define STR2(v) STR(v)
230
231 /*
232   a couple of handy macros
233 */
234
235 #define return_if_fail(expr) do {                        \
236     if (!(expr)) {                                       \
237         fprintf (stderr, "%s:%d: assertion '%s' failed\n", \
238                  __FILE__, __LINE__, #expr );            \
239         return;                                          \
240     } } while (0)
241 #define return_null_if_fail(expr) do {                   \
242     if (!(expr)) {                                       \
243         fprintf (stderr, "%s:%d: assertion '%s' failed\n", \
244                  __FILE__, __LINE__, #expr );            \
245         return NULL;                                     \
246     } } while (0)
247 #define return_val_if_fail(expr,val) do {                \
248     if (!(expr)) {                                       \
249         fprintf (stderr, "%s:%d: assertion '%s' failed\n", \
250                  __FILE__, __LINE__, #expr );            \
251         return (val);                                    \
252     } } while (0)
253 #define never_reached() do {                                   \
254         fprintf (stderr, "%s:%d: oops; should never get here\n", \
255                  __FILE__, __LINE__ );                         \
256     } while (0)
257
258
259 /* some macros to replace ctype ones and avoid locale problems */
260 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
261 #define hexdigitp(a) (digitp (a)                     \
262                       || (*(a) >= 'A' && *(a) <= 'F')  \
263                       || (*(a) >= 'a' && *(a) <= 'f'))
264 /* the atoi macros assume that the buffer has only valid digits */
265 #define atoi_1(p)   (*(p) - '0' )
266 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
267 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
268 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
269                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
270 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
271
272
273 #endif /*KEYBOX_DEFS_H*/