gpg: First working support for keyboxes.
[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_OPENPGP 1
33 #define KEYBOX_WITH_X509 1
34
35
36 #ifdef KEYBOX_WITH_OPENPGP
37 #  undef KEYBOX_WITH_OPENPGP
38 /*#include <lib-to-handle-gpg-data-structs.h>*/
39 #endif
40
41 #ifdef KEYBOX_WITH_X509
42 # include <ksba.h>
43 #endif
44
45 typedef struct keybox_handle *KEYBOX_HANDLE;
46
47
48 typedef enum
49   {
50     KEYBOX_FLAG_BLOB,       /* The blob flags. */
51     KEYBOX_FLAG_VALIDITY,   /* The validity of the entire key. */
52     KEYBOX_FLAG_OWNERTRUST, /* The assigned ownertrust. */
53     KEYBOX_FLAG_KEY,        /* The key flags; requires a key index. */
54     KEYBOX_FLAG_UID,        /* The user ID flags; requires an uid index. */
55     KEYBOX_FLAG_UID_VALIDITY,/* The validity of a specific uid, requires
56                                an uid index. */
57     KEYBOX_FLAG_CREATED_AT  /* The date the block was created. */
58   } keybox_flag_t;
59
60 /* Flag values used with KEYBOX_FLAG_BLOB.  */
61 #define KEYBOX_FLAG_BLOB_SECRET     1
62 #define KEYBOX_FLAG_BLOB_EPHEMERAL  2
63
64
65
66 /*-- keybox-init.c --*/
67 void *keybox_register_file (const char *fname, int secret);
68 int keybox_is_writable (void *token);
69
70 KEYBOX_HANDLE keybox_new (void *token, int secret);
71 void keybox_release (KEYBOX_HANDLE hd);
72 const char *keybox_get_resource_name (KEYBOX_HANDLE hd);
73 int keybox_set_ephemeral (KEYBOX_HANDLE hd, int yes);
74
75 int keybox_lock (KEYBOX_HANDLE hd, int yes);
76
77 /*-- keybox-file.c --*/
78 /* Fixme: This function does not belong here: Provide a better
79    interface to create a new keybox file.  */
80 int _keybox_write_header_blob (FILE *fp);
81
82 /*-- keybox-search.c --*/
83 gpg_error_t keybox_get_keyblock (KEYBOX_HANDLE hd, iobuf_t *r_iobuf);
84 #ifdef KEYBOX_WITH_X509
85 int keybox_get_cert (KEYBOX_HANDLE hd, ksba_cert_t *ret_cert);
86 #endif /*KEYBOX_WITH_X509*/
87 int keybox_get_flags (KEYBOX_HANDLE hd, int what, int idx, unsigned int *value);
88
89 int keybox_search_reset (KEYBOX_HANDLE hd);
90 int keybox_search (KEYBOX_HANDLE hd, KEYBOX_SEARCH_DESC *desc, size_t ndesc);
91
92
93 /*-- keybox-update.c --*/
94 gpg_error_t keybox_insert_keyblock (KEYBOX_HANDLE hd,
95                                     const void *image, size_t imagelen);
96 gpg_error_t keybox_update_keyblock (KEYBOX_HANDLE hd,
97                                     const void *image, size_t imagelen);
98
99 #ifdef KEYBOX_WITH_X509
100 int keybox_insert_cert (KEYBOX_HANDLE hd, ksba_cert_t cert,
101                         unsigned char *sha1_digest);
102 int keybox_update_cert (KEYBOX_HANDLE hd, ksba_cert_t cert,
103                         unsigned char *sha1_digest);
104 #endif /*KEYBOX_WITH_X509*/
105 int keybox_set_flags (KEYBOX_HANDLE hd, int what, int idx, unsigned int value);
106
107 int keybox_delete (KEYBOX_HANDLE hd);
108 int keybox_compress (KEYBOX_HANDLE hd);
109
110
111 /*--  --*/
112
113 #if 0
114 int keybox_get_keyblock (KEYBOX_HANDLE hd, KBNODE *ret_kb);
115 int keybox_locate_writable (KEYBOX_HANDLE hd);
116 int keybox_search_reset (KEYBOX_HANDLE hd);
117 int keybox_search (KEYBOX_HANDLE hd, KEYDB_SEARCH_DESC *desc, size_t ndesc);
118 int keybox_rebuild_cache (void *);
119 #endif
120
121
122 /*-- keybox-util.c --*/
123 void keybox_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
124                                void *(*new_realloc_func)(void *p, size_t n),
125                                void (*new_free_func)(void*) );
126
127
128 #ifdef __cplusplus
129 }
130 #endif
131 #endif /*KEYBOX_H*/