7bbcf83cfc54da1cd2e083bdcb8dc2ed2cfb0e07
[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   struct keybox_found_s found;
105   struct keybox_found_s saved_found;
106   struct {
107     char *name;
108     char *pattern;
109   } word_match;
110 };
111
112
113 /* Openpgp helper structures. */
114 struct _keybox_openpgp_key_info
115 {
116   struct _keybox_openpgp_key_info *next;
117   int algo;
118   unsigned char keyid[8];
119   int fprlen;  /* Either 16 or 20 */
120   unsigned char fpr[20];
121 };
122
123 struct _keybox_openpgp_uid_info
124 {
125   struct _keybox_openpgp_uid_info *next;
126   size_t off;
127   size_t len;
128 };
129
130 struct _keybox_openpgp_info
131 {
132   int is_secret;        /* True if this is a secret key. */
133   unsigned int nsubkeys;/* Total number of subkeys.  */
134   unsigned int nuids;   /* Total number of user IDs in the keyblock. */
135   unsigned int nsigs;   /* Total number of signatures in the keyblock. */
136
137   /* Note, we use 2 structs here to better cope with the most common
138      use of having one primary and one subkey - this allows us to
139      statically allocate this structure and only malloc stuff for more
140      than one subkey. */
141   struct _keybox_openpgp_key_info primary;
142   struct _keybox_openpgp_key_info subkeys;
143   struct _keybox_openpgp_uid_info uids;
144 };
145 typedef struct _keybox_openpgp_info *keybox_openpgp_info_t;
146
147
148 /* Don't know whether this is needed: */
149 /*  static struct { */
150 /*    const char *homedir; */
151 /*    int dry_run; */
152 /*    int quiet; */
153 /*    int verbose; */
154 /*    int preserve_permissions; */
155 /*  } keybox_opt; */
156
157 /*-- keybox-init.c --*/
158 void _keybox_close_file (KEYBOX_HANDLE hd);
159
160
161 /*-- keybox-blob.c --*/
162 gpg_error_t _keybox_create_openpgp_blob (KEYBOXBLOB *r_blob,
163                                          keybox_openpgp_info_t info,
164                                          const unsigned char *image,
165                                          size_t imagelen,
166                                          u32 *sigstatus,
167                                          int as_ephemeral);
168 #ifdef KEYBOX_WITH_X509
169 int _keybox_create_x509_blob (KEYBOXBLOB *r_blob, ksba_cert_t cert,
170                               unsigned char *sha1_digest, int as_ephemeral);
171 #endif /*KEYBOX_WITH_X509*/
172
173 int  _keybox_new_blob (KEYBOXBLOB *r_blob,
174                        unsigned char *image, size_t imagelen,
175                        off_t off);
176 void _keybox_release_blob (KEYBOXBLOB blob);
177 const unsigned char *_keybox_get_blob_image (KEYBOXBLOB blob, size_t *n);
178 off_t _keybox_get_blob_fileoffset (KEYBOXBLOB blob);
179 void _keybox_update_header_blob (KEYBOXBLOB blob);
180
181 /*-- keybox-openpgp.c --*/
182 gpg_error_t _keybox_parse_openpgp (const unsigned char *image, size_t imagelen,
183                                    size_t *nparsed,
184                                    keybox_openpgp_info_t info);
185 void _keybox_destroy_openpgp_info (keybox_openpgp_info_t info);
186
187
188 /*-- keybox-file.c --*/
189 int _keybox_read_blob (KEYBOXBLOB *r_blob, FILE *fp);
190 int _keybox_read_blob2 (KEYBOXBLOB *r_blob, FILE *fp, int *skipped_deleted);
191 int _keybox_write_blob (KEYBOXBLOB blob, FILE *fp);
192
193 /*-- keybox-search.c --*/
194 gpg_err_code_t _keybox_get_flag_location (const unsigned char *buffer,
195                                           size_t length,
196                                           int what,
197                                           size_t *flag_off, size_t *flag_size);
198
199 static inline int
200 blob_get_type (KEYBOXBLOB blob)
201 {
202   const unsigned char *buffer;
203   size_t length;
204
205   buffer = _keybox_get_blob_image (blob, &length);
206   if (length < 32)
207     return -1; /* blob too short */
208
209   return buffer[4];
210 }
211
212
213 /*-- keybox-dump.c --*/
214 int _keybox_dump_blob (KEYBOXBLOB blob, FILE *fp);
215 int _keybox_dump_file (const char *filename, int stats_only, FILE *outfp);
216 int _keybox_dump_find_dups (const char *filename, int print_them, FILE *outfp);
217 int _keybox_dump_cut_records (const char *filename, unsigned long from,
218                               unsigned long to, FILE *outfp);
219
220
221 /*-- keybox-util.c --*/
222 void *_keybox_malloc (size_t n);
223 void *_keybox_calloc (size_t n, size_t m);
224 void *_keybox_realloc (void *p, size_t n);
225 void  _keybox_free (void *p);
226
227 #define xtrymalloc(a)    _keybox_malloc ((a))
228 #define xtrycalloc(a,b)  _keybox_calloc ((a),(b))
229 #define xtryrealloc(a,b) _keybox_realloc((a),(b))
230 #define xfree(a)         _keybox_free ((a))
231
232
233 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
234 #define DIMof(type,member)   DIM(((type *)0)->member)
235 #ifndef STR
236 #  define STR(v) #v
237 #endif
238 #define STR2(v) STR(v)
239
240 /*
241   a couple of handy macros
242 */
243
244 #define return_if_fail(expr) do {                        \
245     if (!(expr)) {                                       \
246         fprintf (stderr, "%s:%d: assertion '%s' failed\n", \
247                  __FILE__, __LINE__, #expr );            \
248         return;                                          \
249     } } while (0)
250 #define return_null_if_fail(expr) do {                   \
251     if (!(expr)) {                                       \
252         fprintf (stderr, "%s:%d: assertion '%s' failed\n", \
253                  __FILE__, __LINE__, #expr );            \
254         return NULL;                                     \
255     } } while (0)
256 #define return_val_if_fail(expr,val) do {                \
257     if (!(expr)) {                                       \
258         fprintf (stderr, "%s:%d: assertion '%s' failed\n", \
259                  __FILE__, __LINE__, #expr );            \
260         return (val);                                    \
261     } } while (0)
262 #define never_reached() do {                                   \
263         fprintf (stderr, "%s:%d: oops; should never get here\n", \
264                  __FILE__, __LINE__ );                         \
265     } while (0)
266
267
268 /* some macros to replace ctype ones and avoid locale problems */
269 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
270 #define hexdigitp(a) (digitp (a)                     \
271                       || (*(a) >= 'A' && *(a) <= 'F')  \
272                       || (*(a) >= 'a' && *(a) <= 'f'))
273 /* the atoi macros assume that the buffer has only valid digits */
274 #define atoi_1(p)   (*(p) - '0' )
275 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
276 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
277 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
278                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
279 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
280
281
282 #endif /*KEYBOX_DEFS_H*/