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