gpg: Properly account for ring trust packets.
[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 <https://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 #define TRUST_FLAG_TOFU_BASED    512 /* The trust value is based on
39                                       * the TOFU information.  */
40
41 /* Private value used in tofu.c - must be different from the trust
42    values.  */
43 #define _tofu_GET_TRUST_ERROR 100
44
45 /* Length of the hash used to select UIDs in keyedit.c.  */
46 #define NAMEHASH_LEN  20
47
48
49 /*
50  * A structure to store key identification as well as some stuff needed
51  * for validation
52  */
53 struct key_item {
54   struct key_item *next;
55   unsigned int ownertrust,min_ownertrust;
56   byte trust_depth;
57   byte trust_value;
58   char *trust_regexp;
59   u32 kid[2];
60 };
61
62
63 /*
64  * Check whether the signature SIG is in the klist K.
65  */
66 static inline struct key_item *
67 is_in_klist (struct key_item *k, PKT_signature *sig)
68 {
69   for (; k; k = k->next)
70     {
71       if (k->kid[0] == sig->keyid[0] && k->kid[1] == sig->keyid[1])
72         return k;
73     }
74   return NULL;
75 }
76
77
78
79 /*-- trust.c --*/
80 int cache_disabled_value (ctrl_t ctrl, PKT_public_key *pk);
81 void register_trusted_keyid (u32 *keyid);
82 void register_trusted_key (const char *string);
83
84 const char *trust_value_to_string (unsigned int value);
85 int string_to_trust_value (const char *str);
86 const char *uid_trust_string_fixed (ctrl_t ctrl,
87                                     PKT_public_key *key, PKT_user_id *uid);
88
89 unsigned int get_ownertrust (ctrl_t ctrl, PKT_public_key *pk);
90 void update_ownertrust (ctrl_t ctrl,
91                         PKT_public_key *pk, unsigned int new_trust);
92 int clear_ownertrusts (ctrl_t ctrl, PKT_public_key *pk);
93
94 void revalidation_mark (ctrl_t ctrl);
95 void check_trustdb_stale (ctrl_t ctrl);
96 void check_or_update_trustdb (ctrl_t ctrl);
97
98 unsigned int get_validity (ctrl_t ctrl, kbnode_t kb, PKT_public_key *pk,
99                            PKT_user_id *uid,
100                            PKT_signature *sig, int may_ask);
101 int get_validity_info (ctrl_t ctrl, kbnode_t kb, PKT_public_key *pk,
102                        PKT_user_id *uid);
103 const char *get_validity_string (ctrl_t ctrl,
104                                  PKT_public_key *pk, PKT_user_id *uid);
105
106 void mark_usable_uid_certs (ctrl_t ctrl, kbnode_t keyblock, kbnode_t uidnode,
107                             u32 *main_kid, struct key_item *klist,
108                             u32 curtime, u32 *next_expire);
109
110 void clean_one_uid (ctrl_t ctrl, kbnode_t keyblock, kbnode_t uidnode,
111                     int noisy, int self_only,
112                     int *uids_cleaned, int *sigs_cleaned);
113 void clean_key (ctrl_t ctrl, kbnode_t keyblock, int noisy, int self_only,
114                 int *uids_cleaned,int *sigs_cleaned);
115
116
117
118 /*-- trustdb.c --*/
119 void tdb_register_trusted_keyid (u32 *keyid);
120 void tdb_register_trusted_key (const char *string);
121 /* Returns whether KID is on the list of ultimately trusted keys.  */
122 int tdb_keyid_is_utk (u32 *kid);
123 /* Return the list of ultimately trusted keys.  The caller must not
124  * modify this list nor must it free the list.  */
125 struct key_item *tdb_utks (void);
126 void check_trustdb (ctrl_t ctrl);
127 void update_trustdb (ctrl_t ctrl);
128 int setup_trustdb( int level, const char *dbname );
129 void how_to_fix_the_trustdb (void);
130 const char *trust_model_string (int model);
131 gpg_error_t init_trustdb (ctrl_t ctrl, int no_create);
132 int have_trustdb (ctrl_t ctrl);
133 void tdb_check_trustdb_stale (ctrl_t ctrl);
134 void tdb_revalidation_mark (ctrl_t ctrl);
135 int trustdb_pending_check(void);
136 void tdb_check_or_update (ctrl_t ctrl);
137
138 int tdb_cache_disabled_value (ctrl_t ctrl, PKT_public_key *pk);
139
140 unsigned int tdb_get_validity_core (ctrl_t ctrl, kbnode_t kb,
141                                     PKT_public_key *pk, PKT_user_id *uid,
142                                     PKT_public_key *main_pk,
143                                     PKT_signature *sig, int may_ask);
144
145 void list_trust_path( const char *username );
146 int enum_cert_paths( void **context, ulong *lid,
147                      unsigned *ownertrust, unsigned *validity );
148 void enum_cert_paths_print( void **context, FILE *fp,
149                                            int refresh, ulong selected_lid );
150
151 void read_trust_options (ctrl_t ctrl, byte *trust_model,
152                          ulong *created, ulong *nextcheck,
153                          byte *marginals, byte *completes, byte *cert_depth,
154                          byte *min_cert_level);
155
156 unsigned int tdb_get_ownertrust (ctrl_t ctrl, PKT_public_key *pk,
157                                  int no_create);
158 unsigned int tdb_get_min_ownertrust (ctrl_t ctrl, PKT_public_key *pk,
159                                      int no_create);
160 int get_ownertrust_info (ctrl_t ctrl, PKT_public_key *pk, int no_create);
161 const char *get_ownertrust_string (ctrl_t ctrl,
162                                    PKT_public_key *pk, int no_create);
163
164 void tdb_update_ownertrust (ctrl_t ctrl, PKT_public_key *pk,
165                             unsigned int new_trust);
166 int tdb_clear_ownertrusts (ctrl_t ctrl, PKT_public_key *pk);
167
168 /*-- tdbdump.c --*/
169 void list_trustdb (ctrl_t ctrl, estream_t fp, const char *username);
170 void export_ownertrust (ctrl_t ctrl);
171 void import_ownertrust (ctrl_t ctrl, const char *fname);
172
173 /*-- pkclist.c --*/
174 int edit_ownertrust (ctrl_t ctrl, PKT_public_key *pk, int mode);
175
176 #endif /*G10_TRUSTDB_H*/