Started with keybox implementation by basing it on code from the GnuPG
[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_HEADER = 1,
39   BLOBTYPE_PGP = 2,
40   BLOBTYPE_X509 = 3
41 };
42
43
44
45 typedef struct keybox_name *KB_NAME;
46 typedef struct keybox_name const * CONST_KB_NAME;
47 struct keybox_name {
48   struct keybox_name *next;
49   int secret;
50   /*DOTLOCK lockhd;*/
51   int is_locked;
52   int did_full_scan;
53   char fname[1];
54 };
55
56
57
58 struct keybox_handle {
59   CONST_KB_NAME resource;
60   int secret;             /* this is for a secret keybox */
61   struct {
62     CONST_KB_NAME kb;
63     /*IOBUF iobuf;*/
64     int eof;
65     int error;
66   } current;
67   struct {
68     CONST_KB_NAME kb; 
69     off_t offset;
70     size_t pk_no;
71     size_t uid_no;
72     unsigned int n_packets; /*used for delete and update*/
73   } found;
74   struct {
75     char *name;
76     char *pattern;
77   } word_match;
78 };
79
80
81 typedef struct keyboxblob *KEYBOXBLOB;
82
83
84
85 /*-- keybox-blob.c --*/
86 int  _keybox_new_blob (KEYBOXBLOB *r_blob, char *image, size_t imagelen);
87 void _keybox_release_blob (KEYBOXBLOB blob);
88 const char *_keybox_get_blob_image (KEYBOXBLOB blob, size_t *n);
89
90 /*-- keybox-file.c --*/
91 int _keybox_read_blob (KEYBOXBLOB *r_blob, FILE *fp);
92
93 /*-- keybox-dump.c --*/
94 int _keybox_dump_blob (KEYBOXBLOB blob, FILE *fp);
95 int _keybox_dump_file (const char *filename, FILE *outfp);
96
97
98 /*-- keybox-util.c --*/
99 void *_keybox_malloc (size_t n);
100 void *_keybox_calloc (size_t n, size_t m);
101 void *_keybox_realloc (void *p, size_t n);
102 void  _keybox_free (void *p);
103
104 #define xtrymalloc(a)    _keybox_malloc ((a))
105 #define xtrycalloc(a,b)  _keybox_calloc ((a),(b))
106 #define xtryrealloc(a,b) _keybox_realloc((a),(b))
107 #define xfree(a)         _keybox_free ((a))
108
109
110 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
111 #define DIMof(type,member)   DIM(((type *)0)->member)
112 #ifndef STR
113   #define STR(v) #v
114 #endif
115 #define STR2(v) STR(v)
116
117 /*
118   a couple of handy macros 
119 */
120
121 #define return_if_fail(expr) do {                        \
122     if (!(expr)) {                                       \
123         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
124                  __FILE__, __LINE__, #expr );            \
125         return;                                          \
126     } } while (0)
127 #define return_null_if_fail(expr) do {                   \
128     if (!(expr)) {                                       \
129         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
130                  __FILE__, __LINE__, #expr );            \
131         return NULL;                                     \
132     } } while (0)
133 #define return_val_if_fail(expr,val) do {                \
134     if (!(expr)) {                                       \
135         fprintf (stderr, "%s:%d: assertion `%s' failed\n", \
136                  __FILE__, __LINE__, #expr );            \
137         return (val);                                    \
138     } } while (0)
139 #define never_reached() do {                                   \
140         fprintf (stderr, "%s:%d: oops; should never get here\n", \
141                  __FILE__, __LINE__ );                         \
142     } while (0)
143
144
145 #endif /*KEYBOX_DEFS_H*/
146
147