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