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