Ported changes from 1.4.
[gnupg.git] / g10 / trustdb.h
1 /* trustdb.h - Trust database
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3  *               2005 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef G10_TRUSTDB_H
22 #define G10_TRUSTDB_H
23
24 /* Trust values must be sorted in ascending order */
25 #define TRUST_MASK       15
26 #define TRUST_UNKNOWN     0  /* o: not yet calculated/assigned */
27 #define TRUST_EXPIRED     1  /* e: calculation may be invalid */
28 #define TRUST_UNDEFINED   2  /* q: not enough information for calculation */
29 #define TRUST_NEVER       3  /* n: never trust this pubkey */
30 #define TRUST_MARGINAL    4  /* m: marginally trusted */
31 #define TRUST_FULLY       5  /* f: fully trusted      */
32 #define TRUST_ULTIMATE    6  /* u: ultimately trusted */
33 /* trust values not covered by the mask */
34 #define TRUST_FLAG_REVOKED 32 /* r: revoked */
35 #define TRUST_FLAG_SUB_REVOKED 64 /* r: revoked but for subkeys */
36 #define TRUST_FLAG_DISABLED 128 /* d: key/uid disabled */
37 #define TRUST_FLAG_PENDING_CHECK 256 /* a check-trustdb is pending */
38
39 #define NAMEHASH_LEN  20
40
41 /*-- trustdb.c --*/
42 void register_trusted_keyid(u32 *keyid);
43 void register_trusted_key( const char *string );
44 void check_trustdb (void);
45 void update_trustdb (void);
46 int setup_trustdb( int level, const char *dbname );
47 void init_trustdb( void );
48 void check_trustdb_stale(void);
49 void sync_trustdb( void );
50
51 const char *uid_trust_string_fixed(PKT_public_key *key,PKT_user_id *uid);
52 const char *trust_value_to_string (unsigned int value);
53 int string_to_trust_value (const char *str);
54
55 void revalidation_mark (void);
56 int trustdb_pending_check(void);
57 void trustdb_check_or_update(void);
58
59 int cache_disabled_value(PKT_public_key *pk);
60
61 unsigned int get_validity (PKT_public_key *pk, PKT_user_id *uid);
62 int get_validity_info (PKT_public_key *pk, PKT_user_id *uid);
63 const char *get_validity_string (PKT_public_key *pk, PKT_user_id *uid);
64
65 void list_trust_path( const char *username );
66 int enum_cert_paths( void **context, ulong *lid,
67                      unsigned *ownertrust, unsigned *validity );
68 void enum_cert_paths_print( void **context, FILE *fp,
69                                            int refresh, ulong selected_lid );
70
71 void read_trust_options(byte *trust_model,ulong *created,ulong *nextcheck,
72                         byte *marginals,byte *completes,byte *cert_depth);
73
74 unsigned int get_ownertrust (PKT_public_key *pk);
75 unsigned int get_min_ownertrust (PKT_public_key *pk);
76 int get_ownertrust_info (PKT_public_key *pk);
77 const char *get_ownertrust_string (PKT_public_key *pk);
78
79 void update_ownertrust (PKT_public_key *pk, unsigned int new_trust );
80 int clear_ownertrusts (PKT_public_key *pk);
81
82 void clean_one_uid(KBNODE keyblock,KBNODE uidnode,int noisy,int self_only,
83                    int *uids_cleaned,int *sigs_cleaned);
84 void clean_key(KBNODE keyblock,int noisy,int self_only,
85                int *uids_cleaned,int *sigs_cleaned);
86
87 /*-- tdbdump.c --*/
88 void list_trustdb(const char *username);
89 void export_ownertrust(void);
90 void import_ownertrust(const char *fname);
91
92 /*-- pkclist.c --*/
93 int edit_ownertrust (PKT_public_key *pk, int mode );
94
95 #endif /*G10_TRUSTDB_H*/