* gpg.sgml: Clarify that --charset applies to informational strings and
[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 #include <ksba.h>
25
26 #include "../kbx/keybox-search-desc.h"
27
28 typedef struct keydb_handle *KEYDB_HANDLE;
29
30
31 /*-- keydb.c --*/
32 int keydb_add_resource (const char *url, int force, int secret);
33 KEYDB_HANDLE keydb_new (int secret);
34 void keydb_release (KEYDB_HANDLE hd);
35 int keydb_set_ephemeral (KEYDB_HANDLE hd, int yes);
36 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
37
38 #if 0 /* pgp stuff */
39 int keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
40 int keydb_update_keyblock (KEYDB_HANDLE hd, KBNODE kb);
41 int keydb_insert_keyblock (KEYDB_HANDLE hd, KBNODE kb);
42 #endif
43
44 int keydb_get_cert (KEYDB_HANDLE hd, KsbaCert *r_cert);
45 int keydb_insert_cert (KEYDB_HANDLE hd, KsbaCert cert);
46 int keydb_update_cert (KEYDB_HANDLE hd, KsbaCert cert);
47
48 int keydb_delete (KEYDB_HANDLE hd);
49
50 int keydb_locate_writable (KEYDB_HANDLE hd, const char *reserved);
51 void keydb_rebuild_caches (void);
52
53 int keydb_search_reset (KEYDB_HANDLE hd);
54 int keydb_search (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc, size_t ndesc);
55 int keydb_search_first (KEYDB_HANDLE hd);
56 int keydb_search_next (KEYDB_HANDLE hd);
57 int keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
58 int keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
59 int keydb_search_issuer (KEYDB_HANDLE hd, const char *issuer);
60 int keydb_search_issuer_sn (KEYDB_HANDLE hd,
61                             const char *issuer, const unsigned char *serial);
62 int keydb_search_subject (KEYDB_HANDLE hd, const char *issuer);
63
64 int keydb_classify_name (const char *name, KEYDB_SEARCH_DESC *desc);
65
66 int keydb_store_cert (KsbaCert cert, int ephemeral, int *existed);
67
68
69 #endif /*GNUPG_KEYDB_H*/
70
71
72
73