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