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