cleankey.c

   1 /*
   2  * cleankey.c - Routines to look for common key problems and clean them up.
   3  *
   4  * Copyright 2004,2012 Jonathan McDowell <noodles@earth.li>
   5  *
   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.
   9  *
  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
  13  * more details.
  14  *
  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/>.
  17  */
  18
  19 #include <stdbool.h>
  20 #include <stdlib.h>
  21
  22 #include "build-config.h"
  23 #include "cleankey.h"
  24 #include "decodekey.h"
  25 #include "keyid.h"
  26 #include "keystructs.h"
  27 #include "log.h"
  28 #include "mem.h"
  29 #include "merge.h"
  30 #include "openpgp.h"
  31 #include "sigcheck.h"
  32
  33 /**
  34  *      dedupuids - Merge duplicate uids on a key.
  35  *      @key: The key to de-dup uids on.
  36  *
  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.
  39  */
  40 int dedupuids(struct openpgp_publickey *key)
  41 {
  42         struct openpgp_signedpacket_list *curuid = NULL;
  43         struct openpgp_signedpacket_list *dup = NULL;
  44         struct openpgp_signedpacket_list *tmp = NULL;
  45         int                               merged = 0;
  46
  47         log_assert(key != NULL);
  48         curuid = key->uids;
  49         while (curuid != NULL) {
  50                 dup = find_signed_packet(curuid->next, curuid->packet);
  51                 while (dup != NULL) {
  52                         logthing(LOGTHING_INFO, "Found duplicate uid: %.*s",
  53                                         curuid->packet->length,
  54                                         curuid->packet->data);
  55                         merged++;
  56                         merge_packet_sigs(curuid, dup);
  57                         /*
  58                          * Remove the duplicate uid.
  59                          */
  60                         tmp = curuid;
  61                         while (tmp != NULL && tmp->next != dup) {
  62                                 tmp = tmp->next;
  63                         }
  64                         log_assert(tmp != NULL);
  65                         tmp->next = dup->next;
  66                         dup->next = NULL;
  67                         free_signedpacket_list(dup);
  68
  69                         dup = find_signed_packet(curuid->next, curuid->packet);
  70                 }
  71                 curuid = curuid->next;
  72         }
  73
  74         return merged;
  75 }
  76
  77 /**
  78  *      dedupsubkeys - Merge duplicate subkeys on a key.
  79  *      @key: The key to de-dup subkeys on.
  80  *
  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.
  83  */
  84 int dedupsubkeys(struct openpgp_publickey *key)
  85 {
  86         struct openpgp_signedpacket_list *cursubkey = NULL;
  87         struct openpgp_signedpacket_list *dup = NULL;
  88         struct openpgp_signedpacket_list *tmp = NULL;
  89         int                               merged = 0;
  90         uint64_t                          subkeyid;
  91
  92         log_assert(key != NULL);
  93         cursubkey = key->subkeys;
  94         while (cursubkey != NULL) {
  95                 dup = find_signed_packet(cursubkey->next, cursubkey->packet);
  96                 while (dup != NULL) {
  97                         get_packetid(cursubkey->packet, &subkeyid);
  98                         logthing(LOGTHING_INFO,
  99                                 "Found duplicate subkey: 0x%016" PRIX64,
 100                                 subkeyid);
 101                         merged++;
 102                         merge_packet_sigs(cursubkey, dup);
 103                         /*
 104                          * Remove the duplicate uid.
 105                          */
 106                         tmp = cursubkey;
 107                         while (tmp != NULL && tmp->next != dup) {
 108                                 tmp = tmp->next;
 109                         }
 110                         log_assert(tmp != NULL);
 111                         tmp->next = dup->next;
 112                         dup->next = NULL;
 113                         free_signedpacket_list(dup);
 114
 115                         dup = find_signed_packet(cursubkey->next,
 116                                 cursubkey->packet);
 117                 }
 118                 cursubkey = cursubkey->next;
 119         }
 120
 121         return merged;
 122 }
 123
 124 /**
 125  *      check_sighashes - Check that sig hashes are correct.
 126  *      @key - the check to check the sig hashes of.
 127  *
 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.
 135  */
 136 int clean_sighashes(struct onak_dbctx *dbctx,
 137                 struct openpgp_publickey *key,
 138                 struct openpgp_packet *sigdata,
 139                 struct openpgp_packet_list **sigs,
 140                 bool fullverify,
 141                 bool *selfsig, bool *othersig)
 142 {
 143         struct openpgp_packet_list *tmpsig;
 144         struct openpgp_publickey *sigkeys = NULL, *curkey;
 145         onak_status_t ret;
 146         uint8_t hashtype;
 147         uint8_t hash[64];
 148         uint8_t *sighash;
 149         int removed = 0;
 150         uint64_t keyid, sigid;
 151         bool remove;
 152
 153         get_keyid(key, &keyid);
 154         if (selfsig != NULL) {
 155                 *selfsig = false;
 156         }
 157         while (*sigs != NULL) {
 158                 remove = false;
 159                 ret = calculate_packet_sighash(key, sigdata, (*sigs)->packet,
 160                                 &hashtype, hash, &sighash);
 161
 162                 if (ret == ONAK_E_UNSUPPORTED_FEATURE) {
 163                         get_keyid(key, &keyid);
 164                         logthing(LOGTHING_ERROR,
 165                                 "Unsupported signature hash type %d on 0x%016"
 166                                 PRIX64,
 167                                 hashtype,
 168                                 keyid);
 169                         if (fullverify) {
 170                                 remove = true;
 171                         }
 172                 } else if (ret != ONAK_E_OK || (!fullverify &&
 173                                 !(hash[0] == sighash[0] &&
 174                                         hash[1] == sighash[1]))) {
 175                         remove = true;
 176                 }
 177
 178 #if HAVE_CRYPTO
 179                 if (fullverify && !remove) {
 180                         sig_info((*sigs)->packet, &sigid, NULL);
 181
 182                         /* Start by assuming it's a bad sig */
 183
 184                         remove = true;
 185                         if (sigid == keyid) {
 186                                 ret = onak_check_hash_sig(key->publickey,
 187                                                 (*sigs)->packet,
 188                                                 hash, hashtype);
 189
 190                                 /* We have a valid self signature */
 191                                 if (ret == ONAK_E_OK) {
 192                                         remove = false;
 193                                         if (selfsig != NULL) {
 194                                                 *selfsig = true;
 195                                         }
 196                                 }
 197                         }
 198
 199                         if (remove) {
 200                                 dbctx->fetch_key_id(dbctx, sigid,
 201                                                 &sigkeys, false);
 202                         }
 203
 204                         /*
 205                          * A 64 bit collision is probably a sign of something
 206                          * sneaky happening, but if the signature verifies we
 207                          * should keep it.
 208                          */
 209                         for (curkey = sigkeys; curkey != NULL;
 210                                         curkey = curkey->next) {
 211
 212                                 ret = onak_check_hash_sig(curkey->publickey,
 213                                                 (*sigs)->packet,
 214                                                 hash, hashtype);
 215
 216                                 /* Got a valid signature */
 217                                 if (ret == ONAK_E_OK) {
 218                                         remove = false;
 219                                         if (othersig != NULL) {
 220                                                 *othersig = true;
 221                                         }
 222                                         break;
 223                                 }
 224                         }
 225
 226                         free_publickey(sigkeys);
 227                         sigkeys = NULL;
 228                 }
 229 #endif
 230
 231                 if (remove) {
 232                         tmpsig = *sigs;
 233                         *sigs = (*sigs)->next;
 234                         tmpsig->next = NULL;
 235                         free_packet_list(tmpsig);
 236                         removed++;
 237                 } else {
 238                         sigs = &(*sigs)->next;
 239                 }
 240         }
 241
 242         return removed;
 243 }
 244
 245 int clean_list_sighashes(struct onak_dbctx *dbctx,
 246                         struct openpgp_publickey *key,
 247                         struct openpgp_signedpacket_list **siglist,
 248                         bool fullverify, bool needother)
 249 {
 250         struct openpgp_signedpacket_list **orig, *tmp = NULL;
 251         bool selfsig, othersig;
 252         int removed = 0;
 253
 254         othersig = false;
 255         orig = siglist;
 256         while (siglist != NULL && *siglist != NULL) {
 257                 selfsig = false;
 258
 259                 removed += clean_sighashes(dbctx, key, (*siglist)->packet,
 260                         &(*siglist)->sigs, fullverify, &selfsig, &othersig);
 261
 262                 if (fullverify && !selfsig) {
 263                         /* Remove the UID/subkey if there's no selfsig */
 264                         tmp = *siglist;
 265                         *siglist = (*siglist)->next;
 266                         tmp->next = NULL;
 267                         free_signedpacket_list(tmp);
 268                 } else {
 269                         siglist = &(*siglist)->next;
 270                 }
 271         }
 272
 273         /*
 274          * We need at least one UID to have a signature from another key,
 275          * otherwise we remove all of them if needother is set.
 276          */
 277         if (needother && fullverify && !othersig) {
 278                 siglist = orig;
 279                 while (siglist != NULL && *siglist != NULL) {
 280                         tmp = *siglist;
 281                         *siglist = (*siglist)->next;
 282                         tmp->next = NULL;
 283                         free_signedpacket_list(tmp);
 284                 }
 285         }
 286
 287         return removed;
 288 }
 289
 290 int clean_key_signatures(struct onak_dbctx *dbctx,
 291                 struct openpgp_publickey *key, bool fullverify, bool needother)
 292 {
 293         int removed;
 294
 295         removed = clean_sighashes(dbctx, key, NULL, &key->sigs, fullverify,
 296                         NULL, NULL);
 297         removed += clean_list_sighashes(dbctx, key, &key->uids, fullverify,
 298                         needother);
 299         removed += clean_list_sighashes(dbctx, key, &key->subkeys, fullverify,
 300                         false);
 301
 302         return removed;
 303 }
 304
 305 #define UAT_LIMIT       0xFFFF
 306 #define UID_LIMIT       1024
 307 #define PACKET_LIMIT    8383            /* Fits in 2 byte packet length */
 308 int clean_large_packets(struct openpgp_publickey *key)
 309 {
 310         struct openpgp_signedpacket_list **curuid = NULL;
 311         struct openpgp_signedpacket_list *tmp = NULL;
 312         bool                              drop;
 313         int                               dropped = 0;
 314
 315         log_assert(key != NULL);
 316         curuid = &key->uids;
 317         while (*curuid != NULL) {
 318                 drop = false;
 319                 switch ((*curuid)->packet->tag) {
 320                 case OPENPGP_PACKET_UID:
 321                         if ((*curuid)->packet->length > UID_LIMIT)
 322                                 drop = true;
 323                         break;
 324                 case OPENPGP_PACKET_UAT:
 325                         if ((*curuid)->packet->length > UAT_LIMIT)
 326                                 drop = true;
 327                         break;
 328                 default:
 329                         if ((*curuid)->packet->length > PACKET_LIMIT)
 330                                 drop = true;
 331                         break;
 332                 }
 333
 334                 if (drop) {
 335                         logthing(LOGTHING_INFO,
 336                                         "Dropping large (%d) packet, type %d",
 337                                         (*curuid)->packet->length,
 338                                         (*curuid)->packet->tag);
 339                         /* Remove the entire large signed packet list */
 340                         tmp = *curuid;
 341                         *curuid = (*curuid)->next;
 342                         tmp->next = NULL;
 343                         free_signedpacket_list(tmp);
 344                         dropped++;
 345                 } else {
 346                         curuid = &(*curuid)->next;
 347                 }
 348         }
 349
 350         return dropped;
 351 }
 352
 353 /**
 354  *      cleankeys - Apply all available cleaning options on a list of keys.
 355  *      @policies: The cleaning policies to apply.
 356  *
 357  *      Applies the requested cleaning policies to a list of keys. These are
 358  *      specified from the ONAK_CLEAN_* set of flags, or ONAK_CLEAN_ALL to
 359  *      apply all available cleaning options. Returns 0 if no changes were
 360  *      made, otherwise the number of keys cleaned. Note that some options
 361  *      may result in keys being removed entirely from the list.
 362  */
 363 int cleankeys(struct onak_dbctx *dbctx, struct openpgp_publickey **keys,
 364                 uint64_t policies)
 365 {
 366         struct openpgp_publickey **curkey, *tmp;
 367         struct openpgp_fingerprint fp;
 368         int changed = 0, count = 0;
 369         bool needother;
 370
 371         if (keys == NULL)
 372                 return 0;
 373
 374         curkey = keys;
 375         while (*curkey != NULL) {
 376                 if (policies & ONAK_CLEAN_DROP_V3_KEYS) {
 377                         if ((*curkey)->publickey->data[0] < 4) {
 378                                 /* Remove the key from the list if it's < v4 */
 379                                 tmp = *curkey;
 380                                 *curkey = tmp->next;
 381                                 tmp->next = NULL;
 382                                 free_publickey(tmp);
 383                                 changed++;
 384                                 continue;
 385                         }
 386                 }
 387                 if (policies & ONAK_CLEAN_LARGE_PACKETS) {
 388                         count += clean_large_packets(*curkey);
 389                 }
 390                 count += dedupuids(*curkey);
 391                 count += dedupsubkeys(*curkey);
 392                 if (policies & (ONAK_CLEAN_CHECK_SIGHASH |
 393                                         ONAK_CLEAN_VERIFY_SIGNATURES)) {
 394
 395                         needother = policies & ONAK_CLEAN_NEED_OTHER_SIG;
 396                         if (needother) {
 397                                 /*
 398                                  * Check if we already have the key; if we do
 399                                  * then we can skip the check to make sure we
 400                                  * have signatures from other keys.
 401                                  */
 402                                 get_fingerprint((*curkey)->publickey, &fp);
 403                                 tmp = NULL;
 404                                 needother = dbctx->fetch_key(dbctx, &fp,
 405                                                 &tmp, false) == 0;
 406                                 free_publickey(tmp);
 407                         }
 408
 409                         count += clean_key_signatures(dbctx, *curkey,
 410                                 policies & ONAK_CLEAN_VERIFY_SIGNATURES,
 411                                 needother);
 412                 }
 413                 if (count > 0) {
 414                         changed++;
 415                 }
 416                 if ((*curkey)->uids == NULL) {
 417                         /* No valid UIDS so remove the key from the list */
 418                         tmp = *curkey;
 419                         *curkey = tmp->next;
 420                         tmp->next = NULL;
 421                         free_publickey(tmp);
 422                 } else {
 423                         curkey = &(*curkey)->next;
 424                 }
 425         }
 426
 427         return changed;
 428 }