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 *sigkey = NULL;
 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 (othersig != NULL) {
 155                 *othersig = false;
 156         }
 157         if (selfsig != NULL) {
 158                 *selfsig = false;
 159         }
 160         while (*sigs != NULL) {
 161                 remove = false;
 162                 ret = calculate_packet_sighash(key, sigdata, (*sigs)->packet,
 163                                 &hashtype, hash, &sighash);
 164
 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"
 169                                 PRIX64,
 170                                 hashtype,
 171                                 keyid);
 172                         if (fullverify) {
 173                                 remove = true;
 174                         }
 175                 } else if (ret != ONAK_E_OK || (!fullverify &&
 176                                 !(hash[0] == sighash[0] &&
 177                                         hash[1] == sighash[1]))) {
 178                         remove = true;
 179                 }
 180
 181 #if HAVE_CRYPTO
 182                 if (fullverify && !remove) {
 183                         sig_info((*sigs)->packet, &sigid, NULL);
 184
 185                         /* Start by assuming it's a bad sig */
 186
 187                         remove = true;
 188                         if (sigid == keyid) {
 189                                 ret = onak_check_hash_sig(key, (*sigs)->packet,
 190                                                 hash, hashtype);
 191
 192                                 /* We have a valid self signature */
 193                                 if (ret == ONAK_E_OK) {
 194                                         remove = false;
 195                                         if (selfsig != NULL) {
 196                                                 *selfsig = true;
 197                                         }
 198                                 }
 199                         }
 200
 201                         if (remove && dbctx->fetch_key_id(dbctx, sigid,
 202                                                 &sigkey, false)) {
 203
 204                                 ret = onak_check_hash_sig(sigkey,
 205                                                 (*sigs)->packet,
 206                                                 hash, hashtype);
 207
 208                                 /* Got a valid signature */
 209                                 if (ret == ONAK_E_OK) {
 210                                         remove = false;
 211                                         if (othersig != NULL) {
 212                                                 *othersig = true;
 213                                         }
 214                                 }
 215
 216                                 free_publickey(sigkey);
 217                                 sigkey = NULL;
 218                         }
 219                 }
 220 #endif
 221
 222                 if (remove) {
 223                         tmpsig = *sigs;
 224                         *sigs = (*sigs)->next;
 225                         tmpsig->next = NULL;
 226                         free_packet_list(tmpsig);
 227                         removed++;
 228                 } else {
 229                         sigs = &(*sigs)->next;
 230                 }
 231         }
 232
 233         return removed;
 234 }
 235
 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)
 240 {
 241         struct openpgp_signedpacket_list *tmp = NULL;
 242         bool selfsig, othersig;
 243         int removed = 0;
 244
 245         while (siglist != NULL && *siglist != NULL) {
 246                 selfsig = othersig = false;
 247
 248                 removed += clean_sighashes(dbctx, key, (*siglist)->packet,
 249                         &(*siglist)->sigs, fullverify, &selfsig, &othersig);
 250
 251                 if (fullverify && (!selfsig || (needother && !othersig))) {
 252                         /* Remove the UID/subkey if there's no selfsig */
 253                         tmp = *siglist;
 254                         *siglist = (*siglist)->next;
 255                         tmp->next = NULL;
 256                         free_signedpacket_list(tmp);
 257                 } else {
 258                         siglist = &(*siglist)->next;
 259                 }
 260         }
 261
 262         return removed;
 263 }
 264
 265 int clean_key_signatures(struct onak_dbctx *dbctx,
 266                 struct openpgp_publickey *key, bool fullverify, bool needother)
 267 {
 268         int removed;
 269
 270         removed = clean_sighashes(dbctx, key, NULL, &key->sigs, fullverify,
 271                         NULL, NULL);
 272         removed += clean_list_sighashes(dbctx, key, &key->uids, fullverify,
 273                         needother);
 274         removed += clean_list_sighashes(dbctx, key, &key->subkeys, fullverify,
 275                         false);
 276
 277         return removed;
 278 }
 279
 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)
 284 {
 285         struct openpgp_signedpacket_list **curuid = NULL;
 286         struct openpgp_signedpacket_list *tmp = NULL;
 287         bool                              drop;
 288         int                               dropped = 0;
 289
 290         log_assert(key != NULL);
 291         curuid = &key->uids;
 292         while (*curuid != NULL) {
 293                 drop = false;
 294                 switch ((*curuid)->packet->tag) {
 295                 case OPENPGP_PACKET_UID:
 296                         if ((*curuid)->packet->length > UID_LIMIT)
 297                                 drop = true;
 298                         break;
 299                 case OPENPGP_PACKET_UAT:
 300                         if ((*curuid)->packet->length > UAT_LIMIT)
 301                                 drop = true;
 302                         break;
 303                 default:
 304                         if ((*curuid)->packet->length > PACKET_LIMIT)
 305                                 drop = true;
 306                         break;
 307                 }
 308
 309                 if (drop) {
 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 */
 315                         tmp = *curuid;
 316                         *curuid = (*curuid)->next;
 317                         tmp->next = NULL;
 318                         free_signedpacket_list(tmp);
 319                         dropped++;
 320                 } else {
 321                         curuid = &(*curuid)->next;
 322                 }
 323         }
 324
 325         return dropped;
 326 }
 327
 328 /**
 329  *      cleankeys - Apply all available cleaning options on a list of keys.
 330  *      @policies: The cleaning policies to apply.
 331  *
 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.
 337  */
 338 int cleankeys(struct onak_dbctx *dbctx, struct openpgp_publickey **keys,
 339                 uint64_t policies)
 340 {
 341         struct openpgp_publickey **curkey, *tmp;
 342         int changed = 0, count = 0;
 343
 344         if (keys == NULL)
 345                 return 0;
 346
 347         curkey = keys;
 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 */
 352                                 tmp = *curkey;
 353                                 *curkey = tmp->next;
 354                                 tmp->next = NULL;
 355                                 free_publickey(tmp);
 356                                 changed++;
 357                                 continue;
 358                         }
 359                 }
 360                 if (policies & ONAK_CLEAN_LARGE_PACKETS) {
 361                         count += clean_large_packets(*curkey);
 362                 }
 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);
 370                 }
 371                 if (count > 0) {
 372                         changed++;
 373                 }
 374                 if ((*curkey)->uids == NULL) {
 375                         /* No valid UIDS so remove the key from the list */
 376                         tmp = *curkey;
 377                         *curkey = tmp->next;
 378                         tmp->next = NULL;
 379                         free_publickey(tmp);
 380                 } else {
 381                         curkey = &(*curkey)->next;
 382                 }
 383         }
 384
 385         return changed;
 386 }