We now need a way to store keys
[gnupg.git] / sm / keydb.h
1 /* keydb.h - Key database
2  * Copyright (C) 1998, 1999, 2000, 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 GNUPG_KEYDB_H
22 #define GNUPG_KEYDB_H
23
24 typedef struct keydb_handle *KEYDB_HANDLE;
25
26 typedef enum {
27     KEYDB_SEARCH_MODE_NONE,
28     KEYDB_SEARCH_MODE_EXACT,
29     KEYDB_SEARCH_MODE_SUBSTR,
30     KEYDB_SEARCH_MODE_MAIL,
31     KEYDB_SEARCH_MODE_MAILSUB,
32     KEYDB_SEARCH_MODE_MAILEND,
33     KEYDB_SEARCH_MODE_WORDS,
34     KEYDB_SEARCH_MODE_SHORT_KID,
35     KEYDB_SEARCH_MODE_LONG_KID,
36     KEYDB_SEARCH_MODE_FPR16,
37     KEYDB_SEARCH_MODE_FPR20,
38     KEYDB_SEARCH_MODE_FPR,
39     KEYDB_SEARCH_MODE_FIRST,
40     KEYDB_SEARCH_MODE_NEXT
41 } KeydbSearchMode;
42
43 struct keydb_search_desc {
44     KeydbSearchMode mode;
45     int (*skipfnc)(void *,u32*);
46     void *skipfncvalue;
47     union {
48         const char *name;
49         char fpr[MAX_FINGERPRINT_LEN];
50         u32  kid[2];
51     } u;
52 };
53
54 /*-- keydb.c --*/
55 int keydb_add_resource (const char *url, int force, int secret);
56 KEYDB_HANDLE keydb_new (int secret);
57 void keydb_release (KEYDB_HANDLE hd);
58 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
59 int keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
60 int keydb_update_keyblock (KEYDB_HANDLE hd, KBNODE kb);
61 int keydb_insert_keyblock (KEYDB_HANDLE hd, KBNODE kb);
62 int keydb_delete_keyblock (KEYDB_HANDLE hd);
63 int keydb_locate_writable (KEYDB_HANDLE hd, const char *reserved);
64 void keydb_rebuild_caches (void);
65 int keydb_search_reset (KEYDB_HANDLE hd);
66 int keydb_search (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc, size_t ndesc);
67 int keydb_search_first (KEYDB_HANDLE hd);
68 int keydb_search_next (KEYDB_HANDLE hd);
69 int keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
70 int keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
71
72
73 #endif /*GNUPG_KEYDB_H*/
74
75
76
77