* keybox-defs.h: New BLOBTYPTE_EMPTY.
[gnupg.git] / kbx / keybox-defs.h
1 /* keybox-defs.h - interal Keybox defintions
2  *      Copyright (C) 2001 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 #include <sys/types.h> /* off_t */
25 #include "keybox.h"
26
27 #ifndef HAVE_BYTE_TYPEDEF
28 typedef unsigned char byte; /* fixme */
29 #endif
30 #ifndef HAVE_U16_TYPEDEF
31 typedef unsigned short u16; /* fixme */
32 #endif
33 #ifndef HAVE_U32_TYPEDEF
34 typedef unsigned int u32; /* fixme */
35 #endif
36
37 enum {
38   BLOBTYPE_EMPTY = 0,
39   BLOBTYPE_HEADER = 1,
40   BLOBTYPE_PGP = 2,
41   BLOBTYPE_X509 = 3
42 };
43
44
45 typedef struct keyboxblob *KEYBOXBLOB;
46
47
48 typedef struct keybox_name *KB_NAME;
49 typedef struct keybox_name const * CONST_KB_NAME;
50 struct keybox_name {
51   struct keybox_name *next;
52   int secret;
53   /*DOTLOCK lockhd;*/
54   int is_locked;
55   int did_full_scan;
56   char fname[1];
57 };
58
59
60
61 struct keybox_handle {
62   CONST_KB_NAME kb;
63   int secret;             /* this is for a secret keybox */
64   FILE *fp;
65   int eof;
66   int error;
67   int ephemeral;  
68   struct {
69     KEYBOXBLOB blob;
70     off_t offset;
71     size_t pk_no;
72     size_t uid_no;
73     unsigned int n_packets; /*used for delete and update*/
74   } found;
75   struct {
76     char *name;
77     char *pattern;
78   } word_match;
79 };
80
81
82 /* Don't know whether this is needed: */
83 /*  static struct { */
84 /*    const char *homedir; */
85 /*    int dry_run; */
86 /*    int quiet; */
87 /*    int verbose; */
88 /*    int preserve_permissions; */
89 /*  } keybox_opt; */
90
91
92 /*-- keybox-blob.c --*/
93 #ifdef KEYBOX_WITH_OPENPGP
94   /* fixme */
95 #endif /*KEYBOX_WITH_OPENPGP*/
96 #ifdef KEYBOX_WITH_X509
97 int _keybox_create_x509_blob (KEYBOXBLOB *r_blob, KsbaCert cert,
98                               unsigned char *sha1_digest, int as_ephemeral);
99 #endif /*KEYBOX_WITH_X509*/
100
101 int  _keybox_new_blob (KEYBOXBLOB *r_blob, char *image, size_t imagelen,
102                        off_t off);
103 void _keybox_release_blob (KEYBOXBLOB blob);
104 const char *_keybox_get_blob_image (KEYBOXBLOB blob, size_t *n);
105 off_t _keybox_get_blob_fileoffset (KEYBOXBLOB blob);
106
107 /*-- keybox-file.c --*/
108 int _keybox_read_blob (KEYBOXBLOB *r_blob, FILE *fp);
109 int _keybox_write_blob (KEYBOXBLOB blob, FILE *fp);
110
111 /*-- keybox-dump.c --*/
112 int _keybox_dump_blob (KEYBOXBLOB blob, FILE *fp);
113 int _keybox_dump_file (const char *filename, FILE *outfp);
114
115
116 /*-- keybox-util.c --*/
117 void *_keybox_malloc (size_t n);
118 void *_keybox_calloc (size_t n, size_t m);
119 void *_keybox_realloc (void *p, size_t n);
120 void  _keybox_free (void *p);
121
122 #define xtrymalloc(a)    _keybox_malloc ((a))
123 #define xtrycalloc(a,b)  _keybox_calloc ((a),(b))
124 #define xtryrealloc(a,b) _keybox_realloc((a),(b))
125 #define xfree(a)         _keybox_free ((a))
126
127
128 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
129 #define DIMof(type,member)   DIM(((type *)0)->member)
130 #ifndef STR
131   #define STR(v) #v
132 #endif
133 #define STR2(v) STR(v)
134
135 /*
136   a couple of handy macros 
137 */
138
139 #define return_if_fail(expr) do {                        \
140     if (!(expr)) {                                       \
141         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
142                  __FILE__, __LINE__, #expr );            \
143         return;                                          \
144     } } while (0)
145 #define return_null_if_fail(expr) do {                   \
146     if (!(expr)) {                                       \
147         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
148                  __FILE__, __LINE__, #expr );            \
149         return NULL;                                     \
150     } } while (0)
151 #define return_val_if_fail(expr,val) do {                \
152     if (!(expr)) {                                       \
153         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
154                  __FILE__, __LINE__, #expr );            \
155         return (val);                                    \
156     } } while (0)
157 #define never_reached() do {                                   \
158         fprintf (stderr, "%s:%d: oops; should never get here\n", \
159                  __FILE__, __LINE__ );                         \
160     } while (0)
161
162
163 /* some macros to replace ctype ones and avoid locale problems */
164 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
165 #define hexdigitp(a) (digitp (a)                     \
166                       || (*(a) >= 'A' && *(a) <= 'F')  \
167                       || (*(a) >= 'a' && *(a) <= 'f'))
168 /* the atoi macros assume that the buffer has only valid digits */
169 #define atoi_1(p)   (*(p) - '0' )
170 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
171 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
172 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
173                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
174 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
175
176
177 #endif /*KEYBOX_DEFS_H*/
178
179