2 * cleankey.c - Routines to look for common key problems and clean them up.
4 * Copyright 2004,2012 Jonathan McDowell <noodles@earth.li>
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the Free
8 * Software Foundation; version 2 of the License.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program. If not, see <https://www.gnu.org/licenses/>.
22 #include "build-config.h"
24 #include "decodekey.h"
26 #include "keystructs.h"
34 * dedupuids - Merge duplicate uids on a key.
35 * @key: The key to de-dup uids on.
37 * This function attempts to merge duplicate IDs on a key. It returns 0
38 * if the key is unchanged, otherwise the number of dups merged.
40 int dedupuids(struct openpgp_publickey *key)
42 struct openpgp_signedpacket_list *curuid = NULL;
43 struct openpgp_signedpacket_list *dup = NULL;
44 struct openpgp_signedpacket_list *tmp = NULL;
47 log_assert(key != NULL);
49 while (curuid != NULL) {
50 dup = find_signed_packet(curuid->next, curuid->packet);
52 logthing(LOGTHING_INFO, "Found duplicate uid: %.*s",
53 curuid->packet->length,
54 curuid->packet->data);
56 merge_packet_sigs(curuid, dup);
58 * Remove the duplicate uid.
61 while (tmp != NULL && tmp->next != dup) {
64 log_assert(tmp != NULL);
65 tmp->next = dup->next;
67 free_signedpacket_list(dup);
69 dup = find_signed_packet(curuid->next, curuid->packet);
71 curuid = curuid->next;
78 * dedupsubkeys - Merge duplicate subkeys on a key.
79 * @key: The key to de-dup subkeys on.
81 * This function attempts to merge duplicate subkeys on a key. It returns
82 * 0 if the key is unchanged, otherwise the number of dups merged.
84 int dedupsubkeys(struct openpgp_publickey *key)
86 struct openpgp_signedpacket_list *cursubkey = NULL;
87 struct openpgp_signedpacket_list *dup = NULL;
88 struct openpgp_signedpacket_list *tmp = NULL;
92 log_assert(key != NULL);
93 cursubkey = key->subkeys;
94 while (cursubkey != NULL) {
95 dup = find_signed_packet(cursubkey->next, cursubkey->packet);
97 get_packetid(cursubkey->packet, &subkeyid);
98 logthing(LOGTHING_INFO,
99 "Found duplicate subkey: 0x%016" PRIX64,
102 merge_packet_sigs(cursubkey, dup);
104 * Remove the duplicate uid.
107 while (tmp != NULL && tmp->next != dup) {
110 log_assert(tmp != NULL);
111 tmp->next = dup->next;
113 free_signedpacket_list(dup);
115 dup = find_signed_packet(cursubkey->next,
118 cursubkey = cursubkey->next;
125 * check_sighashes - Check that sig hashes are correct.
126 * @key - the check to check the sig hashes of.
128 * Given an OpenPGP key confirm that all of the sigs on it have the
129 * appropriate 2 octet hash beginning, as stored as part of the sig.
130 * This is a simple way to remove junk sigs and, for example, catches
131 * subkey sig corruption as produced by old pksd implementations.
132 * Any sig that has an incorrect hash is removed from the key. If the
133 * hash cannot be checked (eg we don't support that hash type) we err
134 * on the side of caution and keep it.
136 int clean_sighashes(struct onak_dbctx *dbctx,
137 struct openpgp_publickey *key,
138 struct openpgp_packet *sigdata,
139 struct openpgp_packet_list **sigs,
141 bool *selfsig, bool *othersig)
143 struct openpgp_packet_list *tmpsig;
144 struct openpgp_publickey *sigkey = NULL;
150 uint64_t keyid, sigid;
153 get_keyid(key, &keyid);
154 if (othersig != NULL) {
157 if (selfsig != NULL) {
160 while (*sigs != NULL) {
162 ret = calculate_packet_sighash(key, sigdata, (*sigs)->packet,
163 &hashtype, hash, &sighash);
165 if (ret == ONAK_E_UNSUPPORTED_FEATURE) {
166 get_keyid(key, &keyid);
167 logthing(LOGTHING_ERROR,
168 "Unsupported signature hash type %d on 0x%016"
175 } else if (ret != ONAK_E_OK || (!fullverify &&
176 !(hash[0] == sighash[0] &&
177 hash[1] == sighash[1]))) {
182 if (fullverify && !remove) {
183 sig_info((*sigs)->packet, &sigid, NULL);
185 /* Start by assuming it's a bad sig */
188 if (sigid == keyid) {
189 ret = onak_check_hash_sig(key, (*sigs)->packet,
192 /* We have a valid self signature */
193 if (ret == ONAK_E_OK) {
195 if (selfsig != NULL) {
201 if (remove && dbctx->fetch_key_id(dbctx, sigid,
204 ret = onak_check_hash_sig(sigkey,
208 /* Got a valid signature */
209 if (ret == ONAK_E_OK) {
211 if (othersig != NULL) {
216 free_publickey(sigkey);
224 *sigs = (*sigs)->next;
226 free_packet_list(tmpsig);
229 sigs = &(*sigs)->next;
236 int clean_list_sighashes(struct onak_dbctx *dbctx,
237 struct openpgp_publickey *key,
238 struct openpgp_signedpacket_list **siglist,
239 bool fullverify, bool needother)
241 struct openpgp_signedpacket_list *tmp = NULL;
242 bool selfsig, othersig;
245 while (siglist != NULL && *siglist != NULL) {
246 selfsig = othersig = false;
248 removed += clean_sighashes(dbctx, key, (*siglist)->packet,
249 &(*siglist)->sigs, fullverify, &selfsig, &othersig);
251 if (fullverify && (!selfsig || (needother && !othersig))) {
252 /* Remove the UID/subkey if there's no selfsig */
254 *siglist = (*siglist)->next;
256 free_signedpacket_list(tmp);
258 siglist = &(*siglist)->next;
265 int clean_key_signatures(struct onak_dbctx *dbctx,
266 struct openpgp_publickey *key, bool fullverify, bool needother)
270 removed = clean_sighashes(dbctx, key, NULL, &key->sigs, fullverify,
272 removed += clean_list_sighashes(dbctx, key, &key->uids, fullverify,
274 removed += clean_list_sighashes(dbctx, key, &key->subkeys, fullverify,
280 #define UAT_LIMIT 0xFFFF
281 #define UID_LIMIT 1024
282 #define PACKET_LIMIT 8383 /* Fits in 2 byte packet length */
283 int clean_large_packets(struct openpgp_publickey *key)
285 struct openpgp_signedpacket_list **curuid = NULL;
286 struct openpgp_signedpacket_list *tmp = NULL;
290 log_assert(key != NULL);
292 while (*curuid != NULL) {
294 switch ((*curuid)->packet->tag) {
295 case OPENPGP_PACKET_UID:
296 if ((*curuid)->packet->length > UID_LIMIT)
299 case OPENPGP_PACKET_UAT:
300 if ((*curuid)->packet->length > UAT_LIMIT)
304 if ((*curuid)->packet->length > PACKET_LIMIT)
310 logthing(LOGTHING_INFO,
311 "Dropping large (%d) packet, type %d",
312 (*curuid)->packet->length,
313 (*curuid)->packet->tag);
314 /* Remove the entire large signed packet list */
316 *curuid = (*curuid)->next;
318 free_signedpacket_list(tmp);
321 curuid = &(*curuid)->next;
329 * cleankeys - Apply all available cleaning options on a list of keys.
330 * @policies: The cleaning policies to apply.
332 * Applies the requested cleaning policies to a list of keys. These are
333 * specified from the ONAK_CLEAN_* set of flags, or ONAK_CLEAN_ALL to
334 * apply all available cleaning options. Returns 0 if no changes were
335 * made, otherwise the number of keys cleaned. Note that some options
336 * may result in keys being removed entirely from the list.
338 int cleankeys(struct onak_dbctx *dbctx, struct openpgp_publickey **keys,
341 struct openpgp_publickey **curkey, *tmp;
342 int changed = 0, count = 0;
348 while (*curkey != NULL) {
349 if (policies & ONAK_CLEAN_DROP_V3_KEYS) {
350 if ((*curkey)->publickey->data[0] < 4) {
351 /* Remove the key from the list if it's < v4 */
360 if (policies & ONAK_CLEAN_LARGE_PACKETS) {
361 count += clean_large_packets(*curkey);
363 count += dedupuids(*curkey);
364 count += dedupsubkeys(*curkey);
365 if (policies & (ONAK_CLEAN_CHECK_SIGHASH |
366 ONAK_CLEAN_VERIFY_SIGNATURES)) {
367 count += clean_key_signatures(dbctx, *curkey,
368 policies & ONAK_CLEAN_VERIFY_SIGNATURES,
369 policies & ONAK_CLEAN_NEED_OTHER_SIG);
374 if ((*curkey)->uids == NULL) {
375 /* No valid UIDS so remove the key from the list */
381 curkey = &(*curkey)->next;