Started with keybox implementation by basing it on code from the GnuPG
[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 #define KEYBOX_WITH_OPENPGP 1 
31 #define KEYBOX_WITH_X509 1
32
33
34 #ifdef KEYBOX_WITH_OPENPGP
35 #  undef KEYBOX_WITH_OPENPGP
36 /*#include <lib-to-handle-gpg-data-structs.h>*/
37 #endif
38
39 #ifdef KEYBOX_WITH_X509
40 # include <ksba.h>
41 #endif
42
43
44 typedef enum {
45   KEYBOX_No_Error = 0,
46   KEYBOX_General_Error = 1,
47   KEYBOX_Out_Of_Core = 2,
48   KEYBOX_Invalid_Value = 3,
49   KEYBOX_Timeout = 4,  
50   KEYBOX_Read_Error = 5,
51   KEYBOX_Write_Error = 6,
52   KEYBOX_File_Error = 7,
53   KEYBOX_Blob_Too_Short = 8,
54   KEYBOX_Blob_Too_Large = 9
55
56 } KeyboxError;
57
58
59
60 typedef struct keybox_handle *KEYBOX_HANDLE;
61
62
63
64 /*-- keybox-init.c --*/
65 void *keybox_register_file (const char *fname, int secret);
66 int keybox_is_writable (void *token);
67
68
69 /*--  --*/
70
71 KEYBOX_HANDLE keybox_new (void *token, int secret);
72 void keybox_release (KEYBOX_HANDLE hd);
73 const char *keybox_get_resource_name (KEYBOX_HANDLE hd);
74 int keybox_lock (KEYBOX_HANDLE hd, int yes);
75 #if 0
76 int keybox_get_keyblock (KEYBOX_HANDLE hd, KBNODE *ret_kb);
77 int keybox_update_keyblock (KEYBOX_HANDLE hd, KBNODE kb);
78 int keybox_insert_keyblock (KEYBOX_HANDLE hd, KBNODE kb);
79 int keybox_locate_writable (KEYBOX_HANDLE hd);
80 int keybox_delete_keyblock (KEYBOX_HANDLE hd);
81 int keybox_search_reset (KEYBOX_HANDLE hd);
82 int keybox_search (KEYBOX_HANDLE hd, KEYDB_SEARCH_DESC *desc, size_t ndesc);
83 int keybox_rebuild_cache (void *);
84 #endif
85
86
87 /*-- keybox-util.c --*/
88 void keybox_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
89                                void *(*new_realloc_func)(void *p, size_t n),
90                                void (*new_free_func)(void*) );
91
92 /*-- keybox-errors.c (built) --*/
93 const char *keybox_strerror (KeyboxError err);
94
95
96 #ifdef __cplusplus
97 }
98 #endif
99 #endif /*KEYBOX_H*/