* w32reg.c (read_w32_registry_string): Fallback to HLM.
[gnupg.git] / kbx / keybox.h
1 /* keybox.h - Keybox operations
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_H
22 #define KEYBOX_H 1
23 #ifdef __cplusplus
24 extern "C" { 
25 #if 0
26  }
27 #endif
28 #endif
29
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
46 typedef enum {
47   KEYBOX_No_Error = 0,
48   KEYBOX_General_Error = 1,
49   KEYBOX_Out_Of_Core = 2,
50   KEYBOX_Invalid_Value = 3,
51   KEYBOX_Timeout = 4,  
52   KEYBOX_Read_Error = 5,
53   KEYBOX_Write_Error = 6,
54   KEYBOX_File_Error = 7,
55   KEYBOX_Blob_Too_Short = 8,
56   KEYBOX_Blob_Too_Large = 9,
57   KEYBOX_Invalid_Handle = 10,
58   KEYBOX_File_Create_Error = 11,
59   KEYBOX_File_Open_Error = 12,
60   KEYBOX_File_Close_Error = 13,
61   KEYBOX_Nothing_Found = 14,
62   KEYBOX_Wrong_Blob_Type = 15,
63   KEYBOX_Missing_Value = 16,
64 } KeyboxError;
65
66
67
68 typedef struct keybox_handle *KEYBOX_HANDLE;
69
70
71 /*-- keybox-init.c --*/
72 void *keybox_register_file (const char *fname, int secret);
73 int keybox_is_writable (void *token);
74
75 KEYBOX_HANDLE keybox_new (void *token, int secret);
76 void keybox_release (KEYBOX_HANDLE hd);
77 const char *keybox_get_resource_name (KEYBOX_HANDLE hd);
78 int keybox_set_ephemeral (KEYBOX_HANDLE hd, int yes);
79
80
81 /*-- keybox-search.c --*/
82 #ifdef KEYBOX_WITH_X509 
83 int keybox_get_cert (KEYBOX_HANDLE hd, KsbaCert *ret_cert);
84 #endif /*KEYBOX_WITH_X509*/
85
86 int keybox_search_reset (KEYBOX_HANDLE hd);
87 int keybox_search (KEYBOX_HANDLE hd, KEYBOX_SEARCH_DESC *desc, size_t ndesc);
88
89
90 /*-- keybox-update.c --*/
91 #ifdef KEYBOX_WITH_X509 
92 int keybox_insert_cert (KEYBOX_HANDLE hd, KsbaCert cert,
93                         unsigned char *sha1_digest);
94 int keybox_update_cert (KEYBOX_HANDLE hd, KsbaCert cert,
95                         unsigned char *sha1_digest);
96 #endif /*KEYBOX_WITH_X509*/
97
98 int keybox_delete (KEYBOX_HANDLE hd);
99
100
101 /*--  --*/
102
103 #if 0
104 int keybox_lock (KEYBOX_HANDLE hd, int yes);
105 int keybox_get_keyblock (KEYBOX_HANDLE hd, KBNODE *ret_kb);
106 int keybox_locate_writable (KEYBOX_HANDLE hd);
107 int keybox_search_reset (KEYBOX_HANDLE hd);
108 int keybox_search (KEYBOX_HANDLE hd, KEYDB_SEARCH_DESC *desc, size_t ndesc);
109 int keybox_rebuild_cache (void *);
110 #endif
111
112
113 /*-- keybox-util.c --*/
114 void keybox_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
115                                void *(*new_realloc_func)(void *p, size_t n),
116                                void (*new_free_func)(void*) );
117
118 /*-- keybox-errors.c (built) --*/
119 const char *keybox_strerror (KeyboxError err);
120
121
122 #ifdef __cplusplus
123 }
124 #endif
125 #endif /*KEYBOX_H*/