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