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