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