rsa.h 14.5 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
#define rsa_encrypt nettle_rsa_encrypt
#define rsa_decrypt nettle_rsa_decrypt
84
#define rsa_decrypt_tr nettle_rsa_decrypt_tr
85
#define rsa_compute_root nettle_rsa_compute_root
86
#define rsa_compute_root_tr nettle_rsa_compute_root_tr
87 88 89 90
#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
91 92 93
#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
94 95 96
#define rsa_keypair_to_openpgp nettle_rsa_keypair_to_openpgp
#define _rsa_verify _nettle_rsa_verify
#define _rsa_check_size _nettle_rsa_check_size
97 98
#define _rsa_blind _nettle_rsa_blind
#define _rsa_unblind _nettle_rsa_unblind
Niels Möller's avatar
Niels Möller committed
99

Niels Möller's avatar
Niels Möller committed
100 101 102 103 104 105 106
/* 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. */
107 108

#define RSA_MINIMUM_N_OCTETS 12
109
#define RSA_MINIMUM_N_BITS (8*RSA_MINIMUM_N_OCTETS - 7)
110

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

  /* Public exponent */
Niels Möller's avatar
Niels Möller committed
121 122 123 124 125
  mpz_t e;
};

struct rsa_private_key
{
126
  size_t size;
127 128 129 130

  /* 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
131
  
Niels Möller's avatar
Niels Möller committed
132 133 134 135 136 137 138 139 140 141 142
  /* 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
143 144
};

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

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

Niels Möller's avatar
Niels Möller committed
176
int
177
rsa_public_key_prepare(struct rsa_public_key *key);
Niels Möller's avatar
Niels Möller committed
178

179 180
/* Calls mpz_init to initialize bignum storage. */
void
181
rsa_private_key_init(struct rsa_private_key *key);
182 183 184

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

Niels Möller's avatar
Niels Möller committed
187
int
188
rsa_private_key_prepare(struct rsa_private_key *key);
Niels Möller's avatar
Niels Möller committed
189

190

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

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

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

213 214 215 216 217 218
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
219 220

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

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

230 231 232 233 234 235 236
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
237
int
238
rsa_sha1_verify(const struct rsa_public_key *key,
Niels Möller's avatar
Niels Möller committed
239
                struct sha1_ctx *hash,
240
		const mpz_t signature);
Niels Möller's avatar
Niels Möller committed
241

242
int
243 244 245 246
rsa_sha256_sign(const struct rsa_private_key *key,
		struct sha256_ctx *hash,
		mpz_t signature);

247 248 249 250 251 252 253
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);

254 255 256 257 258
int
rsa_sha256_verify(const struct rsa_public_key *key,
		  struct sha256_ctx *hash,
		  const mpz_t signature);

259
int
260 261 262 263
rsa_sha512_sign(const struct rsa_private_key *key,
		struct sha512_ctx *hash,
		mpz_t signature);

264 265 266 267 268 269 270
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);

271 272 273 274 275
int
rsa_sha512_verify(const struct rsa_public_key *key,
		  struct sha512_ctx *hash,
		  const mpz_t signature);

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

282 283 284 285 286 287
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);

288 289 290 291 292
int
rsa_md5_verify_digest(const struct rsa_public_key *key,
		      const uint8_t *digest,
		      const mpz_t signature);

293
int
294 295 296 297
rsa_sha1_sign_digest(const struct rsa_private_key *key,
		     const uint8_t *digest,
		     mpz_t s);

298 299 300 301 302 303 304
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);

305 306 307 308 309
int
rsa_sha1_verify_digest(const struct rsa_public_key *key,
		       const uint8_t *digest,
		       const mpz_t signature);

310
int
311 312 313 314
rsa_sha256_sign_digest(const struct rsa_private_key *key,
		       const uint8_t *digest,
		       mpz_t s);

315 316 317 318 319 320 321
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);

322 323 324 325 326
int
rsa_sha256_verify_digest(const struct rsa_public_key *key,
			 const uint8_t *digest,
			 const mpz_t signature);

327
int
328 329 330 331
rsa_sha512_sign_digest(const struct rsa_private_key *key,
		       const uint8_t *digest,
		       mpz_t s);

332 333 334 335 336 337 338
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);

339 340 341 342 343
int
rsa_sha512_verify_digest(const struct rsa_public_key *key,
			 const uint8_t *digest,
			 const mpz_t signature);

Niels Möller's avatar
Niels Möller committed
344 345

/* RSA encryption, using PKCS#1 */
Niels Möller's avatar
Niels Möller committed
346 347
/* These functions uses the v1.5 padding. What should the v2 (OAEP)
 * functions be called? */
Niels Möller's avatar
Niels Möller committed
348 349 350 351

/* Returns 1 on success, 0 on failure, which happens if the
 * message is too long for the key. */
int
352
rsa_encrypt(const struct rsa_public_key *key,
Niels Möller's avatar
Niels Möller committed
353
	    /* For padding */
354
	    void *random_ctx, nettle_random_func *random,
355
	    size_t length, const uint8_t *cleartext,
Niels Möller's avatar
Niels Möller committed
356
	    mpz_t cipher);
Niels Möller's avatar
Niels Möller committed
357 358 359 360 361 362 363

/* 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
364
rsa_decrypt(const struct rsa_private_key *key,
365
	    size_t *length, uint8_t *cleartext,
Niels Möller's avatar
Niels Möller committed
366
	    const mpz_t ciphertext);
Niels Möller's avatar
Niels Möller committed
367

368 369 370 371 372
/* 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,	       
373
	       size_t *length, uint8_t *message,
374 375
	       const mpz_t gibberish);

Niels Möller's avatar
Niels Möller committed
376
/* Compute x, the e:th root of m. Calling it with x == m is allowed. */
Niels Möller's avatar
Niels Möller committed
377
void
378 379
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
380

381 382 383 384 385 386 387
/* 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);
388 389

/* Key generation */
390 391

/* Note that the key structs must be initialized first. */
392 393
int
rsa_generate_keypair(struct rsa_public_key *pub,
394 395
		     struct rsa_private_key *key,

396 397
		     void *random_ctx, nettle_random_func *random,
		     void *progress_ctx, nettle_progress_func *progress,
398

399 400 401 402 403 404 405
		     /* 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);

406

Niels Möller's avatar
Niels Möller committed
407 408 409 410 411 412 413 414 415
#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
416

417 418 419 420 421 422 423 424

/* 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,
425
		    const char *algorithm_name, /* NULL means "rsa" */
426 427 428
		    const struct rsa_public_key *pub,
		    const struct rsa_private_key *priv);

429 430 431 432 433
struct sexp_iterator;

int
rsa_keypair_from_sexp_alist(struct rsa_public_key *pub,
			    struct rsa_private_key *priv,
434
			    unsigned limit,
435 436
			    struct sexp_iterator *i);

437 438 439 440 441 442 443
/* 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,
444
		      unsigned limit,
445
		      size_t length, const uint8_t *expr);
446 447


448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
/* 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
467
		     size_t length, const uint8_t *data);
468

469 470 471 472 473 474
/* 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. */
475
		       const char *userid);
476

477 478 479 480 481 482
/* Internal functions. */
int
_rsa_verify(const struct rsa_public_key *key,
	    const mpz_t m,
	    const mpz_t s);

483
size_t
484 485
_rsa_check_size(mpz_t n);

486 487
/* _rsa_blind and _rsa_unblind are deprecated, unused in the library,
   and will likely be removed with the next ABI break. */
488 489
void
_rsa_blind (const struct rsa_public_key *pub,
490
	    void *random_ctx, nettle_random_func *random,
491 492 493 494
	    mpz_t c, mpz_t ri);
void
_rsa_unblind (const struct rsa_public_key *pub, mpz_t c, const mpz_t ri);

Niels Möller's avatar
Niels Möller committed
495 496 497 498
#ifdef __cplusplus
}
#endif

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