rsa.c

   1 /*
   2  * rsa.c: implementation of RSA with PKCS#1 padding
   3  */
   4 /*
   5  * This file is Free Software.  It was originally written for secnet.
   6  *
   7  * Copyright 1995-2003 Stephen Early
   8  * Copyright 2002-2014 Ian Jackson
   9  * Copyright 2001      Simon Tatham
  10  * Copyright 2013      Mark Wooding
  11  *
  12  * You may redistribute secnet as a whole and/or modify it under the
  13  * terms of the GNU General Public License as published by the Free
  14  * Software Foundation; either version 3, or (at your option) any
  15  * later version.
  16  *
  17  * You may redistribute this file and/or modify it under the terms of
  18  * the GNU General Public License as published by the Free Software
  19  * Foundation; either version 2, or (at your option) any later
  20  * version.
  21  *
  22  * This software is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this software; if not, see
  29  * https://www.gnu.org/licenses/gpl.html.
  30  */
  31
  32
  33 #include <stdio.h>
  34 #include <string.h>
  35 #include <gmp.h>
  36 #include "secnet.h"
  37 #include "util.h"
  38 #include "unaligned.h"
  39
  40 #define AUTHFILE_ID_STRING "SSH PRIVATE KEY FILE FORMAT 1.1\n"
  41
  42 #define mpp(s,n) do { char *p = mpz_get_str(NULL,16,n); printf("%s 0x%sL\n", s, p); free(p); } while (0)
  43
  44 struct rsacommon {
  45     uint8_t *hashbuf;
  46 };
  47
  48 struct rsapriv {
  49     closure_t cl;
  50     struct sigprivkey_if ops;
  51     struct cloc loc;
  52     struct rsacommon common;
  53     MP_INT n;
  54     MP_INT p, dp;
  55     MP_INT q, dq;
  56     MP_INT w;
  57 };
  58 struct rsapub {
  59     closure_t cl;
  60     struct sigpubkey_if ops;
  61     struct cloc loc;
  62     struct rsacommon common;
  63     MP_INT e;
  64     MP_INT n;
  65 };
  66 /* Sign data. NB data must be smaller than modulus */
  67
  68 #define RSA_MAX_MODBYTES 2048
  69 /* The largest modulus I've seen is 15360 bits, which works out at 1920
  70  * bytes.  Using keys this big is quite implausible, but it doesn't cost us
  71  * much to support them.
  72  */
  73
  74 static const char *hexchars="0123456789abcdef";
  75
  76 static void rsa_sethash(struct rsacommon *c, struct hash_if *hash,
  77                         const struct hash_if **in_ops)
  78 {
  79     free(c->hashbuf);
  80     c->hashbuf=safe_malloc(hash->hlen, "generate_msg");
  81     *in_ops=hash;
  82 }
  83 static void rsa_pub_sethash(void *sst, struct hash_if *hash)
  84 {
  85     struct rsapub *st=sst;
  86     rsa_sethash(&st->common, hash, &st->ops.hash);
  87 }
  88 static void rsa_priv_sethash(void *sst, struct hash_if *hash)
  89 {
  90     struct rsapriv *st=sst;
  91     rsa_sethash(&st->common, hash, &st->ops.hash);
  92 }
  93
  94 static void emsa_pkcs1(MP_INT *n, MP_INT *m,
  95                        const uint8_t *data, int32_t datalen)
  96 {
  97     char buff[2*RSA_MAX_MODBYTES + 1];
  98     int msize, i;
  99
 100     /* RSA PKCS#1 v1.5 signature padding:
 101      *
 102      * <------------ msize hex digits ---------->
 103      *
 104      * 00 01 ff ff .... ff ff 00 vv vv vv .... vv
 105      *
 106      *                           <--- datalen -->
 107      *                                 bytes
 108      *                         = datalen*2 hex digits
 109      *
 110      * NB that according to PKCS#1 v1.5 we're supposed to include a
 111      * hash function OID in the data.  We don't do that (because we
 112      * don't have the hash function OID to hand here), thus violating
 113      * the spec in a way that affects interop but not security.
 114      *
 115      * -iwj 17.9.2002
 116      */
 117
 118     msize=mpz_sizeinbase(n, 16);
 119
 120     if (datalen*2+6>=msize) {
 121         fatal("rsa: message too big");
 122     }
 123
 124     strcpy(buff,"0001");
 125
 126     for (i=0; i<datalen; i++) {
 127         buff[msize+(-datalen+i)*2]=hexchars[(data[i]&0xf0)>>4];
 128         buff[msize+(-datalen+i)*2+1]=hexchars[data[i]&0xf];
 129     }
 130
 131     buff[msize-datalen*2-2]= '0';
 132     buff[msize-datalen*2-1]= '0';
 133
 134     for (i=4; i<msize-datalen*2-2; i++)
 135        buff[i]='f';
 136
 137     buff[msize]=0;
 138
 139     mpz_set_str(m, buff, 16);
 140 }
 141
 142 static bool_t rsa_sign(void *sst, uint8_t *data, int32_t datalen,
 143                        struct buffer_if *msg)
 144 {
 145     struct rsapriv *st=sst;
 146     MP_INT a, b, u, v, tmp, tmp2;
 147     string_t signature = 0;
 148     bool_t ok;
 149
 150     mpz_init(&a);
 151     mpz_init(&b);
 152
 153     hash_hash(st->ops.hash,data,datalen,st->common.hashbuf);
 154     /* Construct the message representative. */
 155     emsa_pkcs1(&st->n, &a, st->common.hashbuf, st->ops.hash->hlen);
 156
 157     /*
 158      * Produce an RSA signature (a^d mod n) using the Chinese
 159      * Remainder Theorem. We compute:
 160      *
 161      *   u = a^dp mod p    (== a^d mod p, since dp == d mod (p-1))
 162      *   v = a^dq mod q    (== a^d mod q, similarly)
 163      *
 164      * We also know w == iqmp * q, which has the property that w ==
 165      * 0 mod q and w == 1 mod p. So (1-w) has the reverse property
 166      * (congruent to 0 mod p and to 1 mod q). Hence we now compute
 167      *
 168      *   b = w * u + (1-w) * v
 169      *     = w * (u-v) + v
 170      *
 171      * so that b is congruent to a^d both mod p and mod q. Hence b,
 172      * reduced mod n, is the required signature.
 173      */
 174     mpz_init(&tmp);
 175     mpz_init(&tmp2);
 176     mpz_init(&u);
 177     mpz_init(&v);
 178
 179     mpz_powm_sec(&u, &a, &st->dp, &st->p);
 180     mpz_powm_sec(&v, &a, &st->dq, &st->q);
 181     mpz_sub(&tmp, &u, &v);
 182     mpz_mul(&tmp2, &tmp, &st->w);
 183     mpz_add(&tmp, &tmp2, &v);
 184     mpz_mod(&b, &tmp, &st->n);
 185
 186     mpz_clear(&tmp);
 187     mpz_clear(&tmp2);
 188     mpz_clear(&u);
 189     mpz_clear(&v);
 190
 191     signature=write_mpstring(&b);
 192
 193     uint8_t *op = buf_append(msg,2);
 194     if (!op) { ok=False; goto out; }
 195     size_t l = strlen(signature);
 196     assert(l < 65536);
 197     put_uint16(op, l);
 198     op = buf_append(msg,l);
 199     if (!op) { ok=False; goto out; }
 200     memcpy(op, signature, l);
 201
 202     ok = True;
 203
 204  out:
 205     free(signature);
 206     mpz_clear(&b);
 207     mpz_clear(&a);
 208     return ok;
 209 }
 210
 211 static bool_t rsa_sig_unpick(void *sst, struct buffer_if *msg,
 212                              struct alg_msg_data *sig)
 213 {
 214     uint8_t *lp = buf_unprepend(msg, 2);
 215     if (!lp) return False;
 216     sig->len = get_uint16(lp);
 217     sig->start = buf_unprepend(msg, sig->len);
 218     if (!sig->start) return False;
 219
 220     /* In `rsa_sig_check' below, we assume that we can write a nul
 221      * terminator following the signature.  Make sure there's enough space.
 222      */
 223     if (msg->start >= msg->base + msg->alloclen)
 224         return False;
 225
 226     return True;
 227 }
 228
 229 static sig_checksig_fn rsa_sig_check;
 230 static bool_t rsa_sig_check(void *sst, uint8_t *data, int32_t datalen,
 231                             const struct alg_msg_data *sig)
 232 {
 233     struct rsapub *st=sst;
 234     MP_INT a, b, c;
 235     bool_t ok;
 236
 237     mpz_init(&a);
 238     mpz_init(&b);
 239     mpz_init(&c);
 240
 241     hash_hash(st->ops.hash,data,datalen,st->common.hashbuf);
 242     emsa_pkcs1(&st->n, &a, st->common.hashbuf, st->ops.hash->hlen);
 243
 244     /* Terminate signature with a '0' - already checked that this will fit */
 245     int save = sig->start[sig->len];
 246     sig->start[sig->len] = 0;
 247     mpz_set_str(&b, sig->start, 16);
 248     sig->start[sig->len] = save;
 249
 250     mpz_powm(&c, &b, &st->e, &st->n);
 251
 252     ok=(mpz_cmp(&a, &c)==0);
 253
 254     mpz_clear(&c);
 255     mpz_clear(&b);
 256     mpz_clear(&a);
 257
 258     return ok;
 259 }
 260
 261 static list_t *rsapub_apply(closure_t *self, struct cloc loc, dict_t *context,
 262                             list_t *args)
 263 {
 264     struct rsapub *st;
 265     item_t *i;
 266     string_t e,n;
 267
 268     NEW(st);
 269     st->cl.description="rsapub";
 270     st->cl.type=CL_SIGPUBKEY;
 271     st->cl.apply=NULL;
 272     st->cl.interface=&st->ops;
 273     st->ops.st=st;
 274     st->ops.sethash=rsa_pub_sethash;
 275     st->common.hashbuf=NULL;
 276     st->ops.unpick=rsa_sig_unpick;
 277     st->ops.check=rsa_sig_check;
 278     st->ops.hash=0;
 279     st->ops.dispose=0; /* xxx */
 280     st->loc=loc;
 281
 282     i=list_elem(args,0);
 283     if (i) {
 284         if (i->type!=t_string) {
 285             cfgfatal(i->loc,"rsa-public","first argument must be a string\n");
 286         }
 287         e=i->data.string;
 288         if (mpz_init_set_str(&st->e,e,10)!=0) {
 289             cfgfatal(i->loc,"rsa-public","encryption key \"%s\" is not a "
 290                      "decimal number string\n",e);
 291         }
 292     } else {
 293         cfgfatal(loc,"rsa-public","you must provide an encryption key\n");
 294     }
 295     if (mpz_sizeinbase(&st->e, 256) > RSA_MAX_MODBYTES) {
 296         cfgfatal(loc, "rsa-public", "implausibly large public exponent\n");
 297     }
 298
 299     i=list_elem(args,1);
 300     if (i) {
 301         if (i->type!=t_string) {
 302             cfgfatal(i->loc,"rsa-public","second argument must be a string\n");
 303         }
 304         n=i->data.string;
 305         if (mpz_init_set_str(&st->n,n,10)!=0) {
 306             cfgfatal(i->loc,"rsa-public","modulus \"%s\" is not a decimal "
 307                      "number string\n",n);
 308         }
 309     } else {
 310         cfgfatal(loc,"rsa-public","you must provide a modulus\n");
 311     }
 312     if (mpz_sizeinbase(&st->n, 256) > RSA_MAX_MODBYTES) {
 313         cfgfatal(loc, "rsa-public", "implausibly large modulus\n");
 314     }
 315     return new_closure(&st->cl);
 316 }
 317
 318 static uint32_t keyfile_get_int(struct cloc loc, FILE *f)
 319 {
 320     uint32_t r;
 321     r=fgetc(f)<<24;
 322     r|=fgetc(f)<<16;
 323     r|=fgetc(f)<<8;
 324     r|=fgetc(f);
 325     cfgfile_postreadcheck(loc,f);
 326     return r;
 327 }
 328
 329 static uint16_t keyfile_get_short(struct cloc loc, FILE *f)
 330 {
 331     uint16_t r;
 332     r=fgetc(f)<<8;
 333     r|=fgetc(f);
 334     cfgfile_postreadcheck(loc,f);
 335     return r;
 336 }
 337
 338 #define LDFATAL(...)      cfgfatal(loc,__VA_ARGS__)
 339 #define LDUNSUP(...)      cfgfatal(loc,__VA_ARGS__)
 340 #define LDFATAL_FILE(...) cfgfatal_maybefile(f,loc,__VA_ARGS__)
 341 #define LDUNSUP_FILE(...) cfgfatal_maybefile(f,loc,__VA_ARGS__)
 342 #define FREE(b)           free(b)
 343
 344 static list_t *rsapriv_apply(closure_t *self, struct cloc loc, dict_t *context,
 345                              list_t *args)
 346 {
 347     struct rsapriv *st;
 348     FILE *f;
 349     cstring_t filename;
 350     item_t *i;
 351     long length;
 352     uint8_t *b, *c;
 353     int cipher_type;
 354     MP_INT e,d,iqmp,tmp,tmp2,tmp3;
 355     bool_t valid;
 356
 357     NEW(st);
 358     st->cl.description="rsapriv";
 359     st->cl.type=CL_SIGPRIVKEY;
 360     st->cl.apply=NULL;
 361     st->cl.interface=&st->ops;
 362     st->ops.st=st;
 363     st->ops.sethash=rsa_priv_sethash;
 364     st->common.hashbuf=NULL;
 365     st->ops.sign=rsa_sign;
 366     st->ops.hash=0;
 367     st->ops.dispose=0; /* xxx */
 368     st->loc=loc;
 369
 370     /* Argument is filename pointing to SSH1 private key file */
 371     i=list_elem(args,0);
 372     if (i) {
 373         if (i->type!=t_string) {
 374             cfgfatal(i->loc,"rsa-private","first argument must be a string\n");
 375         }
 376         filename=i->data.string;
 377     } else {
 378         filename=NULL; /* Make compiler happy */
 379         cfgfatal(loc,"rsa-private","you must provide a filename\n");
 380     }
 381
 382     f=fopen(filename,"rb");
 383     if (!f) {
 384         if (just_check_config) {
 385             Message(M_WARNING,"rsa-private (%s:%d): cannot open keyfile "
 386                     "\"%s\"; assuming it's valid while we check the "
 387                     "rest of the configuration\n",loc.file,loc.line,filename);
 388             goto assume_valid;
 389         } else {
 390             fatal_perror("rsa-private (%s:%d): cannot open file \"%s\"",
 391                          loc.file,loc.line,filename);
 392         }
 393     }
 394
 395     /* Check that the ID string is correct */
 396     length=strlen(AUTHFILE_ID_STRING)+1;
 397     b=safe_malloc(length,"rsapriv_apply");
 398     if (fread(b,length,1,f)!=1 || memcmp(b,AUTHFILE_ID_STRING,length)!=0) {
 399         LDUNSUP_FILE("rsa-private","failed to read magic ID"
 400                            " string from SSH1 private keyfile \"%s\"\n",
 401                            filename);
 402     }
 403     FREE(b);
 404
 405     cipher_type=fgetc(f);
 406     keyfile_get_int(loc,f); /* "Reserved data" */
 407     if (cipher_type != 0) {
 408         LDUNSUP("rsa-private","we don't support encrypted keyfiles\n");
 409     }
 410
 411     /* Read the public key */
 412     keyfile_get_int(loc,f); /* Not sure what this is */
 413     length=(keyfile_get_short(loc,f)+7)/8;
 414     if (length>RSA_MAX_MODBYTES) {
 415         LDFATAL("rsa-private","implausible length %ld for modulus\n",
 416                  length);
 417     }
 418     b=safe_malloc(length,"rsapriv_apply");
 419     if (fread(b,length,1,f) != 1) {
 420         LDFATAL_FILE("rsa-private","error reading modulus\n");
 421     }
 422     mpz_init(&st->n);
 423     read_mpbin(&st->n,b,length);
 424     FREE(b);
 425     length=(keyfile_get_short(loc,f)+7)/8;
 426     if (length>RSA_MAX_MODBYTES) {
 427         LDFATAL("rsa-private","implausible length %ld for e\n",length);
 428     }
 429     b=safe_malloc(length,"rsapriv_apply");
 430     if (fread(b,length,1,f)!=1) {
 431         LDFATAL_FILE("rsa-private","error reading e\n");
 432     }
 433     mpz_init(&e);
 434     read_mpbin(&e,b,length);
 435     FREE(b);
 436
 437     length=keyfile_get_int(loc,f);
 438     if (length>1024) {
 439         LDFATAL("rsa-private","implausibly long (%ld) key comment\n",
 440                  length);
 441     }
 442     c=safe_malloc(length+1,"rsapriv_apply");
 443     if (fread(c,length,1,f)!=1) {
 444         LDFATAL_FILE("rsa-private","error reading key comment\n");
 445     }
 446     c[length]=0;
 447
 448     /* Check that the next two pairs of characters are identical - the
 449        keyfile is not encrypted, so they should be */
 450
 451     if (keyfile_get_short(loc,f) != keyfile_get_short(loc,f)) {
 452         LDFATAL("rsa-private","corrupt keyfile\n");
 453     }
 454
 455     /* Read d */
 456     length=(keyfile_get_short(loc,f)+7)/8;
 457     if (length>RSA_MAX_MODBYTES) {
 458         LDFATAL("rsa-private","implausibly long (%ld) decryption key\n",
 459                  length);
 460     }
 461     b=safe_malloc(length,"rsapriv_apply");
 462     if (fread(b,length,1,f)!=1) {
 463         LDFATAL_FILE("rsa-private",
 464                            "error reading decryption key\n");
 465     }
 466     mpz_init(&d);
 467     read_mpbin(&d,b,length);
 468     FREE(b);
 469     /* Read iqmp (inverse of q mod p) */
 470     length=(keyfile_get_short(loc,f)+7)/8;
 471     if (length>RSA_MAX_MODBYTES) {
 472         LDFATAL("rsa-private","implausibly long (%ld)"
 473                  " iqmp auxiliary value\n", length);
 474     }
 475     b=safe_malloc(length,"rsapriv_apply");
 476     if (fread(b,length,1,f)!=1) {
 477         LDFATAL_FILE("rsa-private",
 478                            "error reading decryption key\n");
 479     }
 480     mpz_init(&iqmp);
 481     read_mpbin(&iqmp,b,length);
 482     FREE(b);
 483     /* Read q (the smaller of the two primes) */
 484     length=(keyfile_get_short(loc,f)+7)/8;
 485     if (length>RSA_MAX_MODBYTES) {
 486         LDFATAL("rsa-private","implausibly long (%ld) q value\n",
 487                  length);
 488     }
 489     b=safe_malloc(length,"rsapriv_apply");
 490     if (fread(b,length,1,f)!=1) {
 491         LDFATAL_FILE("rsa-private",
 492                            "error reading q value\n");
 493     }
 494     mpz_init(&st->q);
 495     read_mpbin(&st->q,b,length);
 496     FREE(b);
 497     /* Read p (the larger of the two primes) */
 498     length=(keyfile_get_short(loc,f)+7)/8;
 499     if (length>RSA_MAX_MODBYTES) {
 500         LDFATAL("rsa-private","implausibly long (%ld) p value\n",
 501                  length);
 502     }
 503     b=safe_malloc(length,"rsapriv_apply");
 504     if (fread(b,length,1,f)!=1) {
 505         LDFATAL_FILE("rsa-private",
 506                            "error reading p value\n");
 507     }
 508     mpz_init(&st->p);
 509     read_mpbin(&st->p,b,length);
 510     FREE(b);
 511
 512     if (fclose(f)!=0) {
 513         fatal_perror("rsa-private (%s:%d): fclose",loc.file,loc.line);
 514     }
 515
 516     /*
 517      * Now verify the validity of the key, and set up the auxiliary
 518      * values for fast CRT signing.
 519      */
 520     valid=False;
 521     i=list_elem(args,1);
 522     mpz_init(&tmp);
 523     mpz_init(&tmp2);
 524     mpz_init(&tmp3);
 525     if (i && i->type==t_bool && i->data.bool==False) {
 526         Message(M_INFO,"rsa-private (%s:%d): skipping RSA key validity "
 527                 "check\n",loc.file,loc.line);
 528     } else {
 529         /* Verify that p*q is equal to n. */
 530         mpz_mul(&tmp, &st->p, &st->q);
 531         if (mpz_cmp(&tmp, &st->n) != 0)
 532             goto done_checks;
 533
 534         /*
 535          * Verify that d*e is congruent to 1 mod (p-1), and mod
 536          * (q-1). This is equivalent to it being congruent to 1 mod
 537          * lambda(n) = lcm(p-1,q-1).  The usual `textbook' condition,
 538          * that d e == 1 (mod (p-1)(q-1)) is sufficient, but not
 539          * actually necessary.
 540          */
 541         mpz_mul(&tmp, &d, &e);
 542         mpz_sub_ui(&tmp2, &st->p, 1);
 543         mpz_mod(&tmp3, &tmp, &tmp2);
 544         if (mpz_cmp_si(&tmp3, 1) != 0)
 545             goto done_checks;
 546         mpz_sub_ui(&tmp2, &st->q, 1);
 547         mpz_mod(&tmp3, &tmp, &tmp2);
 548         if (mpz_cmp_si(&tmp3, 1) != 0)
 549             goto done_checks;
 550
 551         /* Verify that q*iqmp is congruent to 1 mod p. */
 552         mpz_mul(&tmp, &st->q, &iqmp);
 553         mpz_mod(&tmp2, &tmp, &st->p);
 554         if (mpz_cmp_si(&tmp2, 1) != 0)
 555             goto done_checks;
 556     }
 557     /* Now we know the key is valid (or we don't care). */
 558     valid = True;
 559
 560     /*
 561      * Now we compute auxiliary values dp, dq and w to allow us
 562      * to use the CRT optimisation when signing.
 563      *
 564      *   dp == d mod (p-1)      so that a^dp == a^d mod p, for all a
 565      *   dq == d mod (q-1)      similarly mod q
 566      *   w == iqmp * q          so that w == 0 mod q, and w == 1 mod p
 567      */
 568     mpz_init(&st->dp);
 569     mpz_init(&st->dq);
 570     mpz_init(&st->w);
 571     mpz_sub_ui(&tmp, &st->p, 1);
 572     mpz_mod(&st->dp, &d, &tmp);
 573     mpz_sub_ui(&tmp, &st->q, 1);
 574     mpz_mod(&st->dq, &d, &tmp);
 575     mpz_mul(&st->w, &iqmp, &st->q);
 576
 577 done_checks:
 578     if (!valid) {
 579         LDFATAL("rsa-private","file \"%s\" does not contain a "
 580                  "valid RSA key!\n",filename);
 581     }
 582     mpz_clear(&tmp);
 583     mpz_clear(&tmp2);
 584     mpz_clear(&tmp3);
 585
 586     FREE(c);
 587     mpz_clear(&e);
 588     mpz_clear(&d);
 589     mpz_clear(&iqmp);
 590
 591 assume_valid:
 592     return new_closure(&st->cl);
 593 }
 594
 595 void rsa_module(dict_t *dict)
 596 {
 597     add_closure(dict,"rsa-private",rsapriv_apply);
 598     add_closure(dict,"rsa-public",rsapub_apply);
 599 }