* configure.ac (have_w32_system): New. Disable Pth checks for W32.
[gnupg.git] / kbx / keybox-defs.h
1 /* keybox-defs.h - interal Keybox defintions
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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef KEYBOX_DEFS_H
22 #define KEYBOX_DEFS_H 1
23
24 #ifdef GPG_ERR_SOURCE_DEFAULT
25 #error GPG_ERR_SOURCE_DEFAULT already defined
26 #endif
27 #define GPG_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_KEYBOX
28
29 #include <gpg-error.h>
30 #include <sys/types.h> /* off_t */
31
32 /* We include the type defintions from jnlib instead of defining our
33    owns here.  This will not allow us build KBX in a standalone way
34    but there is currently no need for it anyway.  Same goes for
35    stringhelp.h which for example provides a replacement for stpcpy -
36    fixme: Better the LIBOBJ mechnism. */
37 #include "../jnlib/types.h"
38 #include "../jnlib/stringhelp.h"
39
40 #include "keybox.h"
41
42
43 enum {
44   BLOBTYPE_EMPTY = 0,
45   BLOBTYPE_HEADER = 1,
46   BLOBTYPE_PGP = 2,
47   BLOBTYPE_X509 = 3
48 };
49
50
51 typedef struct keyboxblob *KEYBOXBLOB;
52
53
54 typedef struct keybox_name *KB_NAME;
55 typedef struct keybox_name const * CONST_KB_NAME;
56 struct keybox_name {
57   struct keybox_name *next;
58   int secret;
59   /*DOTLOCK lockhd;*/
60   int is_locked;
61   int did_full_scan;
62   char fname[1];
63 };
64
65
66
67 struct keybox_handle {
68   CONST_KB_NAME kb;
69   int secret;             /* this is for a secret keybox */
70   FILE *fp;
71   int eof;
72   int error;
73   int ephemeral;  
74   struct {
75     KEYBOXBLOB blob;
76     off_t offset;
77     size_t pk_no;
78     size_t uid_no;
79     unsigned int n_packets; /*used for delete and update*/
80   } found;
81   struct {
82     char *name;
83     char *pattern;
84   } word_match;
85 };
86
87
88 /* Openpgp helper structures. */
89 struct _keybox_openpgp_key_info
90 {
91   struct _keybox_openpgp_key_info *next;
92   unsigned char keyid[8];
93   int fprlen;  /* Either 16 or 20 */
94   unsigned char fpr[20];
95 };
96
97 struct _keybox_openpgp_uid_info
98 {
99   struct _keybox_openpgp_uid_info *next;
100   size_t off;
101   size_t len;
102 };
103
104 struct _keybox_openpgp_info
105 {
106   int is_secret;        /* True if this is a secret key. */
107   unsigned int nsubkeys;/* Total number of subkeys.  */
108   unsigned int nuids;   /* Total number of user IDs in the keyblock. */
109   unsigned int nsigs;   /* Total number of signatures in the keyblock. */
110
111   /* Note, we use 2 structs here to better cope with the most common
112      use of having one primary and one subkey - this allows us to
113      statically allocate this structure and only malloc stuff for more
114      than one subkey. */
115   struct _keybox_openpgp_key_info primary;
116   struct _keybox_openpgp_key_info subkeys;
117   struct _keybox_openpgp_uid_info uids;
118 };
119 typedef struct _keybox_openpgp_info *keybox_openpgp_info_t;
120
121
122 /* Don't know whether this is needed: */
123 /*  static struct { */
124 /*    const char *homedir; */
125 /*    int dry_run; */
126 /*    int quiet; */
127 /*    int verbose; */
128 /*    int preserve_permissions; */
129 /*  } keybox_opt; */
130
131
132 /*-- keybox-blob.c --*/
133 #ifdef KEYBOX_WITH_OPENPGP
134   /* fixme */
135 #endif /*KEYBOX_WITH_OPENPGP*/
136 #ifdef KEYBOX_WITH_X509
137 int _keybox_create_x509_blob (KEYBOXBLOB *r_blob, ksba_cert_t cert,
138                               unsigned char *sha1_digest, int as_ephemeral);
139 #endif /*KEYBOX_WITH_X509*/
140
141 int  _keybox_new_blob (KEYBOXBLOB *r_blob, char *image, size_t imagelen,
142                        off_t off);
143 void _keybox_release_blob (KEYBOXBLOB blob);
144 const char *_keybox_get_blob_image (KEYBOXBLOB blob, size_t *n);
145 off_t _keybox_get_blob_fileoffset (KEYBOXBLOB blob);
146 void _keybox_update_header_blob (KEYBOXBLOB blob);
147
148 /*-- keybox-openpgp.c --*/
149 gpg_error_t _keybox_parse_openpgp (const unsigned char *image, size_t imagelen,
150                                    size_t *nparsed,
151                                    keybox_openpgp_info_t info);
152 void _keybox_destroy_openpgp_info (keybox_openpgp_info_t info);
153
154
155 /*-- keybox-file.c --*/
156 int _keybox_read_blob (KEYBOXBLOB *r_blob, FILE *fp);
157 int _keybox_read_blob2 (KEYBOXBLOB *r_blob, FILE *fp, int *skipped_deleted);
158 int _keybox_write_blob (KEYBOXBLOB blob, FILE *fp);
159 int _keybox_write_header_blob (FILE *fp);
160
161 /*-- keybox-search.c --*/
162 gpg_err_code_t _keybox_get_flag_location (const unsigned char *buffer,
163                                           size_t length,
164                                           int what,
165                                           size_t *flag_off, size_t *flag_size);
166
167 /*-- keybox-dump.c --*/
168 int _keybox_dump_blob (KEYBOXBLOB blob, FILE *fp);
169 int _keybox_dump_file (const char *filename, int stats_only, FILE *outfp);
170
171
172 /*-- keybox-util.c --*/
173 void *_keybox_malloc (size_t n);
174 void *_keybox_calloc (size_t n, size_t m);
175 void *_keybox_realloc (void *p, size_t n);
176 void  _keybox_free (void *p);
177
178 #define xtrymalloc(a)    _keybox_malloc ((a))
179 #define xtrycalloc(a,b)  _keybox_calloc ((a),(b))
180 #define xtryrealloc(a,b) _keybox_realloc((a),(b))
181 #define xfree(a)         _keybox_free ((a))
182
183
184 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
185 #define DIMof(type,member)   DIM(((type *)0)->member)
186 #ifndef STR
187   #define STR(v) #v
188 #endif
189 #define STR2(v) STR(v)
190
191 /*
192   a couple of handy macros 
193 */
194
195 #define return_if_fail(expr) do {                        \
196     if (!(expr)) {                                       \
197         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
198                  __FILE__, __LINE__, #expr );            \
199         return;                                          \
200     } } while (0)
201 #define return_null_if_fail(expr) do {                   \
202     if (!(expr)) {                                       \
203         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
204                  __FILE__, __LINE__, #expr );            \
205         return NULL;                                     \
206     } } while (0)
207 #define return_val_if_fail(expr,val) do {                \
208     if (!(expr)) {                                       \
209         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
210                  __FILE__, __LINE__, #expr );            \
211         return (val);                                    \
212     } } while (0)
213 #define never_reached() do {                                   \
214         fprintf (stderr, "%s:%d: oops; should never get here\n", \
215                  __FILE__, __LINE__ );                         \
216     } while (0)
217
218
219 /* some macros to replace ctype ones and avoid locale problems */
220 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
221 #define hexdigitp(a) (digitp (a)                     \
222                       || (*(a) >= 'A' && *(a) <= 'F')  \
223                       || (*(a) >= 'a' && *(a) <= 'f'))
224 /* the atoi macros assume that the buffer has only valid digits */
225 #define atoi_1(p)   (*(p) - '0' )
226 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
227 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
228 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
229                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
230 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
231
232
233 #endif /*KEYBOX_DEFS_H*/
234
235