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