* keybox-dump.c (_keybox_dump_file): New arg STATS_ONLY.
[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 /* Don't know whether this is needed: */
86 /*  static struct { */
87 /*    const char *homedir; */
88 /*    int dry_run; */
89 /*    int quiet; */
90 /*    int verbose; */
91 /*    int preserve_permissions; */
92 /*  } keybox_opt; */
93
94
95 /*-- keybox-blob.c --*/
96 #ifdef KEYBOX_WITH_OPENPGP
97   /* fixme */
98 #endif /*KEYBOX_WITH_OPENPGP*/
99 #ifdef KEYBOX_WITH_X509
100 int _keybox_create_x509_blob (KEYBOXBLOB *r_blob, ksba_cert_t cert,
101                               unsigned char *sha1_digest, int as_ephemeral);
102 #endif /*KEYBOX_WITH_X509*/
103
104 int  _keybox_new_blob (KEYBOXBLOB *r_blob, char *image, size_t imagelen,
105                        off_t off);
106 void _keybox_release_blob (KEYBOXBLOB blob);
107 const char *_keybox_get_blob_image (KEYBOXBLOB blob, size_t *n);
108 off_t _keybox_get_blob_fileoffset (KEYBOXBLOB blob);
109 void _keybox_update_header_blob (KEYBOXBLOB blob);
110
111 /*-- keybox-file.c --*/
112 int _keybox_read_blob (KEYBOXBLOB *r_blob, FILE *fp);
113 int _keybox_read_blob2 (KEYBOXBLOB *r_blob, FILE *fp, int *skipped_deleted);
114 int _keybox_write_blob (KEYBOXBLOB blob, FILE *fp);
115 int _keybox_write_header_blob (FILE *fp);
116
117 /*-- keybox-search.c --*/
118 gpg_err_code_t _keybox_get_flag_location (const unsigned char *buffer,
119                                           size_t length,
120                                           int what,
121                                           size_t *flag_off, size_t *flag_size);
122
123 /*-- keybox-dump.c --*/
124 int _keybox_dump_blob (KEYBOXBLOB blob, FILE *fp);
125 int _keybox_dump_file (const char *filename, int stats_only, FILE *outfp);
126
127
128 /*-- keybox-util.c --*/
129 void *_keybox_malloc (size_t n);
130 void *_keybox_calloc (size_t n, size_t m);
131 void *_keybox_realloc (void *p, size_t n);
132 void  _keybox_free (void *p);
133
134 #define xtrymalloc(a)    _keybox_malloc ((a))
135 #define xtrycalloc(a,b)  _keybox_calloc ((a),(b))
136 #define xtryrealloc(a,b) _keybox_realloc((a),(b))
137 #define xfree(a)         _keybox_free ((a))
138
139
140 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
141 #define DIMof(type,member)   DIM(((type *)0)->member)
142 #ifndef STR
143   #define STR(v) #v
144 #endif
145 #define STR2(v) STR(v)
146
147 /*
148   a couple of handy macros 
149 */
150
151 #define return_if_fail(expr) do {                        \
152     if (!(expr)) {                                       \
153         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
154                  __FILE__, __LINE__, #expr );            \
155         return;                                          \
156     } } while (0)
157 #define return_null_if_fail(expr) do {                   \
158     if (!(expr)) {                                       \
159         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
160                  __FILE__, __LINE__, #expr );            \
161         return NULL;                                     \
162     } } while (0)
163 #define return_val_if_fail(expr,val) do {                \
164     if (!(expr)) {                                       \
165         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
166                  __FILE__, __LINE__, #expr );            \
167         return (val);                                    \
168     } } while (0)
169 #define never_reached() do {                                   \
170         fprintf (stderr, "%s:%d: oops; should never get here\n", \
171                  __FILE__, __LINE__ );                         \
172     } while (0)
173
174
175 /* some macros to replace ctype ones and avoid locale problems */
176 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
177 #define hexdigitp(a) (digitp (a)                     \
178                       || (*(a) >= 'A' && *(a) <= 'F')  \
179                       || (*(a) >= 'a' && *(a) <= 'f'))
180 /* the atoi macros assume that the buffer has only valid digits */
181 #define atoi_1(p)   (*(p) - '0' )
182 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
183 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
184 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
185                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
186 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
187
188
189 #endif /*KEYBOX_DEFS_H*/
190
191