kbx: Let keydb_search skip unwanted blobs.
[gnupg.git] / kbx / keybox.h
1 /* keybox.h - Keybox operations
2  * Copyright (C) 2001, 2003, 2012 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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef KEYBOX_H
21 #define KEYBOX_H 1
22 #ifdef __cplusplus
23 extern "C" {
24 #if 0
25  }
26 #endif
27 #endif
28
29 #include "../common/iobuf.h"
30 #include "keybox-search-desc.h"
31
32 #define KEYBOX_WITH_X509 1
33
34
35 #ifdef KEYBOX_WITH_X509
36 # include <ksba.h>
37 #endif
38
39 typedef struct keybox_handle *KEYBOX_HANDLE;
40
41
42 typedef enum
43   {
44     KEYBOX_FLAG_BLOB,       /* The blob flags. */
45     KEYBOX_FLAG_VALIDITY,   /* The validity of the entire key. */
46     KEYBOX_FLAG_OWNERTRUST, /* The assigned ownertrust. */
47     KEYBOX_FLAG_KEY,        /* The key flags; requires a key index. */
48     KEYBOX_FLAG_UID,        /* The user ID flags; requires an uid index. */
49     KEYBOX_FLAG_UID_VALIDITY,/* The validity of a specific uid, requires
50                                an uid index. */
51     KEYBOX_FLAG_CREATED_AT, /* The date the block was created. */
52     KEYBOX_FLAG_SIG_INFO,   /* The signature info block.  */
53   } keybox_flag_t;
54
55 /* Flag values used with KEYBOX_FLAG_BLOB.  */
56 #define KEYBOX_FLAG_BLOB_SECRET     1
57 #define KEYBOX_FLAG_BLOB_EPHEMERAL  2
58
59 /* The keybox blob types.  */
60 typedef enum
61   {
62     KEYBOX_BLOBTYPE_EMPTY  = 0,
63     KEYBOX_BLOBTYPE_HEADER = 1,
64     KEYBOX_BLOBTYPE_PGP    = 2,
65     KEYBOX_BLOBTYPE_X509   = 3
66   } keybox_blobtype_t;
67
68
69 /*-- keybox-init.c --*/
70 void *keybox_register_file (const char *fname, int secret);
71 int keybox_is_writable (void *token);
72
73 KEYBOX_HANDLE keybox_new_openpgp (void *token, int secret);
74 KEYBOX_HANDLE keybox_new_x509 (void *token, int secret);
75 void keybox_release (KEYBOX_HANDLE hd);
76 void keybox_push_found_state (KEYBOX_HANDLE hd);
77 void keybox_pop_found_state (KEYBOX_HANDLE hd);
78 const char *keybox_get_resource_name (KEYBOX_HANDLE hd);
79 int keybox_set_ephemeral (KEYBOX_HANDLE hd, int yes);
80
81 int keybox_lock (KEYBOX_HANDLE hd, int yes);
82
83 /*-- keybox-file.c --*/
84 /* Fixme: This function does not belong here: Provide a better
85    interface to create a new keybox file.  */
86 int _keybox_write_header_blob (FILE *fp, int openpgp_flag);
87
88 /*-- keybox-search.c --*/
89 gpg_error_t keybox_get_keyblock (KEYBOX_HANDLE hd, iobuf_t *r_iobuf,
90                                  int *r_uid_no, int *r_pk_no, u32 **sigstatus);
91 #ifdef KEYBOX_WITH_X509
92 int keybox_get_cert (KEYBOX_HANDLE hd, ksba_cert_t *ret_cert);
93 #endif /*KEYBOX_WITH_X509*/
94 int keybox_get_flags (KEYBOX_HANDLE hd, int what, int idx, unsigned int *value);
95
96 int keybox_search_reset (KEYBOX_HANDLE hd);
97 int keybox_search (KEYBOX_HANDLE hd, KEYBOX_SEARCH_DESC *desc, size_t ndesc,
98                    keybox_blobtype_t want_blobtype,
99                    size_t *r_descindex, unsigned long *r_skipped);
100
101
102 /*-- keybox-update.c --*/
103 gpg_error_t keybox_insert_keyblock (KEYBOX_HANDLE hd,
104                                     const void *image, size_t imagelen,
105                                     u32 *sigstatus);
106 gpg_error_t keybox_update_keyblock (KEYBOX_HANDLE hd,
107                                     const void *image, size_t imagelen);
108
109 #ifdef KEYBOX_WITH_X509
110 int keybox_insert_cert (KEYBOX_HANDLE hd, ksba_cert_t cert,
111                         unsigned char *sha1_digest);
112 int keybox_update_cert (KEYBOX_HANDLE hd, ksba_cert_t cert,
113                         unsigned char *sha1_digest);
114 #endif /*KEYBOX_WITH_X509*/
115 int keybox_set_flags (KEYBOX_HANDLE hd, int what, int idx, unsigned int value);
116
117 int keybox_delete (KEYBOX_HANDLE hd);
118 int keybox_compress (KEYBOX_HANDLE hd);
119
120
121 /*--  --*/
122
123 #if 0
124 int keybox_locate_writable (KEYBOX_HANDLE hd);
125 int keybox_rebuild_cache (void *);
126 #endif
127
128
129 /*-- keybox-util.c --*/
130 void keybox_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
131                                void *(*new_realloc_func)(void *p, size_t n),
132                                void (*new_free_func)(void*) );
133
134
135 #ifdef __cplusplus
136 }
137 #endif
138 #endif /*KEYBOX_H*/