rsa.h 16 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1
/* rsa.h
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

   The RSA publickey algorithm.

   Copyright (C) 2001, 2002 Niels Möller

   This file is part of GNU Nettle.

   GNU Nettle is free software: you can redistribute it and/or
   modify it under the terms of either:

     * the GNU Lesser General Public License as published by the Free
       Software Foundation; either version 3 of the License, or (at your
       option) any later version.

   or

     * the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your
       option) any later version.

   or both in parallel, as here.

   GNU Nettle is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received copies of the GNU General Public License and
   the GNU Lesser General Public License along with this program.  If
   not, see http://www.gnu.org/licenses/.
*/
Niels Möller's avatar
Niels Möller committed
33 34 35 36
 
#ifndef NETTLE_RSA_H_INCLUDED
#define NETTLE_RSA_H_INCLUDED

37
#include "nettle-types.h"
38
#include "bignum.h"
Niels Möller's avatar
Niels Möller committed
39

Niels Möller's avatar
Niels Möller committed
40
#include "md5.h"
41 42
#include "sha1.h"
#include "sha2.h"
Niels Möller's avatar
Niels Möller committed
43

Niels Möller's avatar
Niels Möller committed
44 45 46 47
#ifdef __cplusplus
extern "C" {
#endif

48 49 50 51 52 53 54
/* Name mangling */
#define rsa_public_key_init nettle_rsa_public_key_init
#define rsa_public_key_clear nettle_rsa_public_key_clear
#define rsa_public_key_prepare nettle_rsa_public_key_prepare
#define rsa_private_key_init nettle_rsa_private_key_init
#define rsa_private_key_clear nettle_rsa_private_key_clear
#define rsa_private_key_prepare nettle_rsa_private_key_prepare
55 56 57
#define rsa_pkcs1_verify nettle_rsa_pkcs1_verify
#define rsa_pkcs1_sign nettle_rsa_pkcs1_sign
#define rsa_pkcs1_sign_tr nettle_rsa_pkcs1_sign_tr
58
#define rsa_md5_sign nettle_rsa_md5_sign
59
#define rsa_md5_sign_tr nettle_rsa_md5_sign_tr
60 61
#define rsa_md5_verify nettle_rsa_md5_verify
#define rsa_sha1_sign nettle_rsa_sha1_sign
62
#define rsa_sha1_sign_tr nettle_rsa_sha1_sign_tr
63
#define rsa_sha1_verify nettle_rsa_sha1_verify
64
#define rsa_sha256_sign nettle_rsa_sha256_sign
65
#define rsa_sha256_sign_tr nettle_rsa_sha256_sign_tr
66
#define rsa_sha256_verify nettle_rsa_sha256_verify
67
#define rsa_sha512_sign nettle_rsa_sha512_sign
68
#define rsa_sha512_sign_tr nettle_rsa_sha512_sign_tr
69
#define rsa_sha512_verify nettle_rsa_sha512_verify
70
#define rsa_md5_sign_digest nettle_rsa_md5_sign_digest
71
#define rsa_md5_sign_digest_tr nettle_rsa_md5_sign_digest_tr
72 73
#define rsa_md5_verify_digest nettle_rsa_md5_verify_digest
#define rsa_sha1_sign_digest nettle_rsa_sha1_sign_digest
74
#define rsa_sha1_sign_digest_tr nettle_rsa_sha1_sign_digest_tr
75
#define rsa_sha1_verify_digest nettle_rsa_sha1_verify_digest
76
#define rsa_sha256_sign_digest nettle_rsa_sha256_sign_digest
77
#define rsa_sha256_sign_digest_tr nettle_rsa_sha256_sign_digest_tr
78
#define rsa_sha256_verify_digest nettle_rsa_sha256_verify_digest
79
#define rsa_sha512_sign_digest nettle_rsa_sha512_sign_digest
80
#define rsa_sha512_sign_digest_tr nettle_rsa_sha512_sign_digest_tr
81
#define rsa_sha512_verify_digest nettle_rsa_sha512_verify_digest
82 83 84 85 86 87
#define rsa_pss_sha256_sign_digest_tr nettle_rsa_pss_sha256_sign_digest_tr
#define rsa_pss_sha256_verify_digest nettle_rsa_pss_sha256_verify_digest
#define rsa_pss_sha384_sign_digest_tr nettle_rsa_pss_sha384_sign_digest_tr
#define rsa_pss_sha384_verify_digest nettle_rsa_pss_sha384_verify_digest
#define rsa_pss_sha512_sign_digest_tr nettle_rsa_pss_sha512_sign_digest_tr
#define rsa_pss_sha512_verify_digest nettle_rsa_pss_sha512_verify_digest
88 89
#define rsa_encrypt nettle_rsa_encrypt
#define rsa_decrypt nettle_rsa_decrypt
90
#define rsa_decrypt_tr nettle_rsa_decrypt_tr
91
#define rsa_sec_decrypt nettle_rsa_sec_decrypt
92
#define rsa_compute_root nettle_rsa_compute_root
93
#define rsa_compute_root_tr nettle_rsa_compute_root_tr
94 95 96 97
#define rsa_generate_keypair nettle_rsa_generate_keypair
#define rsa_keypair_to_sexp nettle_rsa_keypair_to_sexp
#define rsa_keypair_from_sexp_alist nettle_rsa_keypair_from_sexp_alist
#define rsa_keypair_from_sexp nettle_rsa_keypair_from_sexp
98 99 100
#define rsa_public_key_from_der_iterator nettle_rsa_public_key_from_der_iterator
#define rsa_private_key_from_der_iterator nettle_rsa_private_key_from_der_iterator
#define rsa_keypair_from_der nettle_rsa_keypair_from_der
101
#define rsa_keypair_to_openpgp nettle_rsa_keypair_to_openpgp
Niels Möller's avatar
Niels Möller committed
102

Niels Möller's avatar
Niels Möller committed
103 104 105 106 107 108 109
/* This limit is somewhat arbitrary. Technically, the smallest modulo
   which makes sense at all is 15 = 3*5, phi(15) = 8, size 4 bits. But
   for ridiculously small keys, not all odd e are possible (e.g., for
   5 bits, the only possible modulo is 3*7 = 21, phi(21) = 12, and e =
   3 don't work). The smallest size that makes sense with pkcs#1, and
   which allows RSA encryption of one byte messages, is 12 octets, 89
   bits. */
110 111

#define RSA_MINIMUM_N_OCTETS 12
112
#define RSA_MINIMUM_N_BITS (8*RSA_MINIMUM_N_OCTETS - 7)
113

Niels Möller's avatar
Niels Möller committed
114 115
struct rsa_public_key
{
Niels Möller's avatar
Niels Möller committed
116 117
  /* Size of the modulo, in octets. This is also the size of all
   * signatures that are created or verified with this key. */
118
  size_t size;
Niels Möller's avatar
Niels Möller committed
119 120
  
  /* Modulo */
Niels Möller's avatar
Niels Möller committed
121
  mpz_t n;
Niels Möller's avatar
Niels Möller committed
122 123

  /* Public exponent */
Niels Möller's avatar
Niels Möller committed
124 125 126 127 128
  mpz_t e;
};

struct rsa_private_key
{
129
  size_t size;
130 131 132 133

  /* d is filled in by the key generation function; otherwise it's
   * completely unused. */
  mpz_t d;
Niels Möller's avatar
Niels Möller committed
134
  
Niels Möller's avatar
Niels Möller committed
135 136 137 138 139 140 141 142 143 144 145
  /* The two factors */
  mpz_t p; mpz_t q;

  /* d % (p-1), i.e. a e = 1 (mod (p-1)) */
  mpz_t a;

  /* d % (q-1), i.e. b e = 1 (mod (q-1)) */
  mpz_t b;

  /* modular inverse of q , i.e. c q = 1 (mod p) */
  mpz_t c;
Niels Möller's avatar
Niels Möller committed
146 147
};

Niels Möller's avatar
Niels Möller committed
148 149 150 151
/* Signing a message works as follows:
 *
 * Store the private key in a rsa_private_key struct.
 *
Niels Möller's avatar
Niels Möller committed
152
 * Call rsa_private_key_prepare. This initializes the size attribute
Niels Möller's avatar
Niels Möller committed
153 154 155 156 157 158 159 160
 * to the length of a signature.
 *
 * Initialize a hashing context, by callling
 *   md5_init
 *
 * Hash the message by calling
 *   md5_update
 *
161
 * Create the signature by calling
Niels Möller's avatar
Niels Möller committed
162 163
 *   rsa_md5_sign
 *
164 165 166
 * The signature is represented as a mpz_t bignum. This call also
 * resets the hashing context.
 *
167 168
 * When done with the key and signature, don't forget to call
 * mpz_clear.
Niels Möller's avatar
Niels Möller committed
169
 */
170
 
171 172
/* Calls mpz_init to initialize bignum storage. */
void
173
rsa_public_key_init(struct rsa_public_key *key);
174 175 176

/* Calls mpz_clear to deallocate bignum storage. */
void
177
rsa_public_key_clear(struct rsa_public_key *key);
178

Niels Möller's avatar
Niels Möller committed
179
int
180
rsa_public_key_prepare(struct rsa_public_key *key);
Niels Möller's avatar
Niels Möller committed
181

182 183
/* Calls mpz_init to initialize bignum storage. */
void
184
rsa_private_key_init(struct rsa_private_key *key);
185 186 187

/* Calls mpz_clear to deallocate bignum storage. */
void
188
rsa_private_key_clear(struct rsa_private_key *key);
189

Niels Möller's avatar
Niels Möller committed
190
int
191
rsa_private_key_prepare(struct rsa_private_key *key);
Niels Möller's avatar
Niels Möller committed
192

193

Niels Möller's avatar
Niels Möller committed
194
/* PKCS#1 style signatures */
195 196
int
rsa_pkcs1_sign(const struct rsa_private_key *key,
197
	       size_t length, const uint8_t *digest_info,
198 199 200 201 202
	       mpz_t s);

int
rsa_pkcs1_sign_tr(const struct rsa_public_key *pub,
  	          const struct rsa_private_key *key,
203
	          void *random_ctx, nettle_random_func *random,
204
	          size_t length, const uint8_t *digest_info,
205 206 207
   	          mpz_t s);
int
rsa_pkcs1_verify(const struct rsa_public_key *key,
208
		 size_t length, const uint8_t *digest_info,
209 210
		 const mpz_t signature);

211
int
212
rsa_md5_sign(const struct rsa_private_key *key,
Niels Möller's avatar
Niels Möller committed
213
             struct md5_ctx *hash,
214
             mpz_t signature);
Niels Möller's avatar
Niels Möller committed
215

216 217 218 219 220 221
int
rsa_md5_sign_tr(const struct rsa_public_key *pub,
		const struct rsa_private_key *key,
		void *random_ctx, nettle_random_func *random,
		struct md5_ctx *hash, mpz_t s);

Niels Möller's avatar
Niels Möller committed
222 223

int
224
rsa_md5_verify(const struct rsa_public_key *key,
Niels Möller's avatar
Niels Möller committed
225
               struct md5_ctx *hash,
226
	       const mpz_t signature);
Niels Möller's avatar
Niels Möller committed
227

228
int
229
rsa_sha1_sign(const struct rsa_private_key *key,
Niels Möller's avatar
Niels Möller committed
230
              struct sha1_ctx *hash,
231
              mpz_t signature);
Niels Möller's avatar
Niels Möller committed
232

233 234 235 236 237 238 239
int
rsa_sha1_sign_tr(const struct rsa_public_key *pub,
		 const struct rsa_private_key *key,
		 void *random_ctx, nettle_random_func *random,
		 struct sha1_ctx *hash,
		 mpz_t s);

Niels Möller's avatar
Niels Möller committed
240
int
241
rsa_sha1_verify(const struct rsa_public_key *key,
Niels Möller's avatar
Niels Möller committed
242
                struct sha1_ctx *hash,
243
		const mpz_t signature);
Niels Möller's avatar
Niels Möller committed
244

245
int
246 247 248 249
rsa_sha256_sign(const struct rsa_private_key *key,
		struct sha256_ctx *hash,
		mpz_t signature);

250 251 252 253 254 255 256
int
rsa_sha256_sign_tr(const struct rsa_public_key *pub,
		   const struct rsa_private_key *key,
		   void *random_ctx, nettle_random_func *random,
		   struct sha256_ctx *hash,
		   mpz_t s);

257 258 259 260 261
int
rsa_sha256_verify(const struct rsa_public_key *key,
		  struct sha256_ctx *hash,
		  const mpz_t signature);

262
int
263 264 265 266
rsa_sha512_sign(const struct rsa_private_key *key,
		struct sha512_ctx *hash,
		mpz_t signature);

267 268 269 270 271 272 273
int
rsa_sha512_sign_tr(const struct rsa_public_key *pub,
		   const struct rsa_private_key *key,
		   void *random_ctx, nettle_random_func *random,
		   struct sha512_ctx *hash,
		   mpz_t s);

274 275 276 277 278
int
rsa_sha512_verify(const struct rsa_public_key *key,
		  struct sha512_ctx *hash,
		  const mpz_t signature);

279
/* Variants taking the digest as argument. */
280
int
281 282 283 284
rsa_md5_sign_digest(const struct rsa_private_key *key,
		    const uint8_t *digest,
		    mpz_t s);

285 286 287 288 289 290
int
rsa_md5_sign_digest_tr(const struct rsa_public_key *pub,
		       const struct rsa_private_key *key,
		       void *random_ctx, nettle_random_func *random,
		       const uint8_t *digest, mpz_t s);

291 292 293 294 295
int
rsa_md5_verify_digest(const struct rsa_public_key *key,
		      const uint8_t *digest,
		      const mpz_t signature);

296
int
297 298 299 300
rsa_sha1_sign_digest(const struct rsa_private_key *key,
		     const uint8_t *digest,
		     mpz_t s);

301 302 303 304 305 306 307
int
rsa_sha1_sign_digest_tr(const struct rsa_public_key *pub,
			const struct rsa_private_key *key,
			void *random_ctx, nettle_random_func *random,
			const uint8_t *digest,
			mpz_t s);

308 309 310 311 312
int
rsa_sha1_verify_digest(const struct rsa_public_key *key,
		       const uint8_t *digest,
		       const mpz_t signature);

313
int
314 315 316 317
rsa_sha256_sign_digest(const struct rsa_private_key *key,
		       const uint8_t *digest,
		       mpz_t s);

318 319 320 321 322 323 324
int
rsa_sha256_sign_digest_tr(const struct rsa_public_key *pub,
			  const struct rsa_private_key *key,
			  void *random_ctx, nettle_random_func *random,
			  const uint8_t *digest,
			  mpz_t s);

325 326 327 328 329
int
rsa_sha256_verify_digest(const struct rsa_public_key *key,
			 const uint8_t *digest,
			 const mpz_t signature);

330
int
331 332 333 334
rsa_sha512_sign_digest(const struct rsa_private_key *key,
		       const uint8_t *digest,
		       mpz_t s);

335 336 337 338 339 340 341
int
rsa_sha512_sign_digest_tr(const struct rsa_public_key *pub,
			  const struct rsa_private_key *key,
			  void *random_ctx, nettle_random_func *random,
			  const uint8_t *digest,
			  mpz_t s);

342 343 344 345 346
int
rsa_sha512_verify_digest(const struct rsa_public_key *key,
			 const uint8_t *digest,
			 const mpz_t signature);

347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
/* PSS style signatures */
int
rsa_pss_sha256_sign_digest_tr(const struct rsa_public_key *pub,
			      const struct rsa_private_key *key,
			      void *random_ctx, nettle_random_func *random,
			      size_t salt_length, const uint8_t *salt,
			      const uint8_t *digest,
			      mpz_t s);

int
rsa_pss_sha256_verify_digest(const struct rsa_public_key *key,
			     size_t salt_length,
			     const uint8_t *digest,
			     const mpz_t signature);

int
rsa_pss_sha384_sign_digest_tr(const struct rsa_public_key *pub,
			      const struct rsa_private_key *key,
			      void *random_ctx, nettle_random_func *random,
			      size_t salt_length, const uint8_t *salt,
			      const uint8_t *digest,
			      mpz_t s);

int
rsa_pss_sha384_verify_digest(const struct rsa_public_key *key,
			     size_t salt_length,
			     const uint8_t *digest,
			     const mpz_t signature);

int
rsa_pss_sha512_sign_digest_tr(const struct rsa_public_key *pub,
			      const struct rsa_private_key *key,
			      void *random_ctx, nettle_random_func *random,
			      size_t salt_length, const uint8_t *salt,
			      const uint8_t *digest,
			      mpz_t s);

int
rsa_pss_sha512_verify_digest(const struct rsa_public_key *key,
			     size_t salt_length,
			     const uint8_t *digest,
			     const mpz_t signature);

Niels Möller's avatar
Niels Möller committed
390 391

/* RSA encryption, using PKCS#1 */
Niels Möller's avatar
Niels Möller committed
392 393
/* These functions uses the v1.5 padding. What should the v2 (OAEP)
 * functions be called? */
Niels Möller's avatar
Niels Möller committed
394 395 396 397

/* Returns 1 on success, 0 on failure, which happens if the
 * message is too long for the key. */
int
398
rsa_encrypt(const struct rsa_public_key *key,
Niels Möller's avatar
Niels Möller committed
399
	    /* For padding */
400
	    void *random_ctx, nettle_random_func *random,
401
	    size_t length, const uint8_t *cleartext,
Niels Möller's avatar
Niels Möller committed
402
	    mpz_t cipher);
Niels Möller's avatar
Niels Möller committed
403 404 405 406 407 408 409

/* Message must point to a buffer of size *LENGTH. KEY->size is enough
 * for all valid messages. On success, *LENGTH is updated to reflect
 * the actual length of the message. Returns 1 on success, 0 on
 * failure, which happens if decryption failed or if the message
 * didn't fit. */
int
410
rsa_decrypt(const struct rsa_private_key *key,
411
	    size_t *length, uint8_t *cleartext,
Niels Möller's avatar
Niels Möller committed
412
	    const mpz_t ciphertext);
Niels Möller's avatar
Niels Möller committed
413

414 415 416 417 418
/* Timing-resistant version, using randomized RSA blinding. */
int
rsa_decrypt_tr(const struct rsa_public_key *pub,
	       const struct rsa_private_key *key,
	       void *random_ctx, nettle_random_func *random,	       
419
	       size_t *length, uint8_t *message,
420 421
	       const mpz_t gibberish);

422 423 424 425 426 427 428 429 430
/* like rsa_decrypt_tr but with additional side-channel resistance.
 * NOTE: the length of the final message must be known in advance. */
int
rsa_sec_decrypt(const struct rsa_public_key *pub,
	        const struct rsa_private_key *key,
	        void *random_ctx, nettle_random_func *random,
	        size_t length, uint8_t *message,
	        const mpz_t gibberish);

Niels Möller's avatar
Niels Möller committed
431
/* Compute x, the e:th root of m. Calling it with x == m is allowed. */
Niels Möller's avatar
Niels Möller committed
432
void
433 434
rsa_compute_root(const struct rsa_private_key *key,
		 mpz_t x, const mpz_t m);
Niels Möller's avatar
Niels Möller committed
435

436 437 438 439 440 441 442
/* Safer variant, using RSA blinding, and checking the result after
   CRT. */
int
rsa_compute_root_tr(const struct rsa_public_key *pub,
		    const struct rsa_private_key *key,
		    void *random_ctx, nettle_random_func *random,
		    mpz_t x, const mpz_t m);
443 444

/* Key generation */
445 446

/* Note that the key structs must be initialized first. */
447 448
int
rsa_generate_keypair(struct rsa_public_key *pub,
449 450
		     struct rsa_private_key *key,

451 452
		     void *random_ctx, nettle_random_func *random,
		     void *progress_ctx, nettle_progress_func *progress,
453

454 455 456 457 458 459 460
		     /* Desired size of modulo, in bits */
		     unsigned n_size,
		     
		     /* Desired size of public exponent, in bits. If
		      * zero, the passed in value pub->e is used. */
		     unsigned e_size);

461

Niels Möller's avatar
Niels Möller committed
462 463 464 465 466 467 468 469 470
#define RSA_SIGN(key, algorithm, ctx, length, data, signature) ( \
  algorithm##_update(ctx, length, data), \
  rsa_##algorithm##_sign(key, ctx, signature) \
)

#define RSA_VERIFY(key, algorithm, ctx, length, data, signature) ( \
  algorithm##_update(ctx, length, data), \
  rsa_##algorithm##_verify(key, ctx, signature) \
)
Niels Möller's avatar
Niels Möller committed
471

472 473 474 475 476 477 478 479

/* Keys in sexp form. */

struct nettle_buffer;

/* Generates a public-key expression if PRIV is NULL .*/
int
rsa_keypair_to_sexp(struct nettle_buffer *buffer,
480
		    const char *algorithm_name, /* NULL means "rsa" */
481 482 483
		    const struct rsa_public_key *pub,
		    const struct rsa_private_key *priv);

484 485 486 487 488
struct sexp_iterator;

int
rsa_keypair_from_sexp_alist(struct rsa_public_key *pub,
			    struct rsa_private_key *priv,
489
			    unsigned limit,
490 491
			    struct sexp_iterator *i);

492 493 494 495 496 497 498
/* If PRIV is NULL, expect a public-key expression. If PUB is NULL,
 * expect a private key expression and ignore the parts not needed for
 * the public key. */
/* Keys must be initialized before calling this function, as usual. */
int
rsa_keypair_from_sexp(struct rsa_public_key *pub,
		      struct rsa_private_key *priv,
499
		      unsigned limit,
500
		      size_t length, const uint8_t *expr);
501 502


503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
/* Keys in PKCS#1 format. */
struct asn1_der_iterator;

int
rsa_public_key_from_der_iterator(struct rsa_public_key *pub,
				 unsigned limit,
				 struct asn1_der_iterator *i);

int
rsa_private_key_from_der_iterator(struct rsa_public_key *pub,
				  struct rsa_private_key *priv,
				  unsigned limit,
				  struct asn1_der_iterator *i);

/* For public keys, use PRIV == NULL */ 
int
rsa_keypair_from_der(struct rsa_public_key *pub,
		     struct rsa_private_key *priv,
		     unsigned limit, 
Niels Möller's avatar
Niels Möller committed
522
		     size_t length, const uint8_t *data);
523

524 525 526 527 528 529
/* OpenPGP format. Experimental interface, subject to change. */
int
rsa_keypair_to_openpgp(struct nettle_buffer *buffer,
		       const struct rsa_public_key *pub,
		       const struct rsa_private_key *priv,
		       /* A single user id. NUL-terminated utf8. */
530
		       const char *userid);
531

532

Niels Möller's avatar
Niels Möller committed
533 534 535 536
#ifdef __cplusplus
}
#endif

Niels Möller's avatar
Niels Möller committed
537
#endif /* NETTLE_RSA_H_INCLUDED */