gpg: Add push/pop found state feature to keydb.
[gnupg.git] / g10 / trustdb.h
1 /* trustdb.h - Trust database
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3  *               2005, 2012 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
42 /*
43  * A structure to store key identification as well as some stuff needed
44  * for validation
45  */
46 struct key_item {
47   struct key_item *next;
48   unsigned int ownertrust,min_ownertrust;
49   byte trust_depth;
50   byte trust_value;
51   char *trust_regexp;
52   u32 kid[2];
53 };
54
55
56 /*
57  * Check whether the signature SIG is in the klist K.
58  */
59 static inline struct key_item *
60 is_in_klist (struct key_item *k, PKT_signature *sig)
61 {
62   for (; k; k = k->next)
63     {
64       if (k->kid[0] == sig->keyid[0] && k->kid[1] == sig->keyid[1])
65         return k;
66     }
67   return NULL;
68 }
69
70
71
72 /*-- trust.c --*/
73 int cache_disabled_value (PKT_public_key *pk);
74 void register_trusted_keyid (u32 *keyid);
75 void register_trusted_key (const char *string);
76
77 const char *trust_value_to_string (unsigned int value);
78 int string_to_trust_value (const char *str);
79 const char *uid_trust_string_fixed (PKT_public_key *key, PKT_user_id *uid);
80
81 unsigned int get_ownertrust (PKT_public_key *pk);
82 void update_ownertrust (PKT_public_key *pk, unsigned int new_trust);
83 int clear_ownertrusts (PKT_public_key *pk);
84
85 void revalidation_mark (void);
86 void check_trustdb_stale (void);
87 void check_or_update_trustdb (void);
88
89 unsigned int get_validity (PKT_public_key *pk, PKT_user_id *uid);
90 int get_validity_info (PKT_public_key *pk, PKT_user_id *uid);
91 const char *get_validity_string (PKT_public_key *pk, PKT_user_id *uid);
92
93 void mark_usable_uid_certs (kbnode_t keyblock, kbnode_t uidnode,
94                             u32 *main_kid, struct key_item *klist,
95                             u32 curtime, u32 *next_expire);
96
97 void clean_one_uid (kbnode_t keyblock, kbnode_t uidnode,
98                     int noisy, int self_only,
99                     int *uids_cleaned, int *sigs_cleaned);
100 void clean_key (kbnode_t keyblock, int noisy, int self_only,
101                 int *uids_cleaned,int *sigs_cleaned);
102
103
104
105 /*-- trustdb.c --*/
106 void tdb_register_trusted_keyid (u32 *keyid);
107 void tdb_register_trusted_key (const char *string);
108 void check_trustdb (void);
109 void update_trustdb (void);
110 int setup_trustdb( int level, const char *dbname );
111 void how_to_fix_the_trustdb (void);
112 void init_trustdb( void );
113 void tdb_check_trustdb_stale (void);
114 void sync_trustdb( void );
115
116 void tdb_revalidation_mark (void);
117 int trustdb_pending_check(void);
118 void tdb_check_or_update (void);
119
120 int tdb_cache_disabled_value (PKT_public_key *pk);
121
122 unsigned int tdb_get_validity_core (PKT_public_key *pk, PKT_user_id *uid,
123                                     PKT_public_key *main_pk);
124
125 void list_trust_path( const char *username );
126 int enum_cert_paths( void **context, ulong *lid,
127                      unsigned *ownertrust, unsigned *validity );
128 void enum_cert_paths_print( void **context, FILE *fp,
129                                            int refresh, ulong selected_lid );
130
131 void read_trust_options(byte *trust_model,ulong *created,ulong *nextcheck,
132                         byte *marginals,byte *completes,byte *cert_depth,
133                         byte *min_cert_level);
134
135 unsigned int tdb_get_ownertrust (PKT_public_key *pk);
136 unsigned int tdb_get_min_ownertrust (PKT_public_key *pk);
137 int get_ownertrust_info (PKT_public_key *pk);
138 const char *get_ownertrust_string (PKT_public_key *pk);
139
140 void tdb_update_ownertrust (PKT_public_key *pk, unsigned int new_trust);
141 int tdb_clear_ownertrusts (PKT_public_key *pk);
142
143 /*-- tdbdump.c --*/
144 void list_trustdb(const char *username);
145 void export_ownertrust(void);
146 void import_ownertrust(const char *fname);
147
148 /*-- pkclist.c --*/
149 int edit_ownertrust (PKT_public_key *pk, int mode );
150
151 #endif /*G10_TRUSTDB_H*/