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