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