rsa.h 8.53 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1 2 3 4 5 6 7
/* rsa.h
 *
 * The RSA publickey algorithm.
 */

/* nettle, low-level cryptographics library
 *
8
 * Copyright (C) 2001, 2002 Niels Mller
Niels Möller's avatar
Niels Möller committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 *  
 * The nettle library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 * 
 * The nettle library 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 Lesser General Public
 * License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with the nettle library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */
 
#ifndef NETTLE_RSA_H_INCLUDED
#define NETTLE_RSA_H_INCLUDED

#include <gmp.h>
30
#include "nettle-types.h"
Niels Möller's avatar
Niels Möller committed
31

Niels Möller's avatar
Niels Möller committed
32 33 34
#include "md5.h"
#include "sha.h"

35 36
/* For nettle_random_func */
#include "nettle-meta.h"
Niels Möller's avatar
Niels Möller committed
37

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
/* 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
#define rsa_md5_sign nettle_rsa_md5_sign
#define rsa_md5_verify nettle_rsa_md5_verify
#define rsa_sha1_sign nettle_rsa_sha1_sign
#define rsa_sha1_verify nettle_rsa_sha1_verify
#define rsa_md5_sign_digest nettle_rsa_md5_sign_digest
#define rsa_md5_verify_digest nettle_rsa_md5_verify_digest
#define rsa_sha1_sign_digest nettle_rsa_sha1_sign_digest
#define rsa_sha1_verify_digest nettle_rsa_sha1_verify_digest
#define rsa_encrypt nettle_rsa_encrypt
#define rsa_decrypt nettle_rsa_decrypt
#define rsa_compute_root nettle_rsa_compute_root
#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
#define rsa_keypair_to_openpgp nettle_rsa_keypair_to_openpgp
#define _rsa_verify _nettle_rsa_verify
#define _rsa_check_size _nettle_rsa_check_size
Niels Möller's avatar
Niels Möller committed
63

64 65 66 67 68 69 70 71 72 73
/* For PKCS#1 to make sense, the size of the modulo, in octets, must
 * be at least 11 + the length of the DER-encoded Digest Info.
 *
 * And a DigestInfo is 34 octets for md5, and 35 octets for sha1. 46
 * octets is 368 bits, and as the upper 7 bits may be zero, the
 * smallest useful size of n is 361 bits. */

#define RSA_MINIMUM_N_OCTETS 46
#define RSA_MINIMUM_N_BITS 361

Niels Möller's avatar
Niels Möller committed
74 75
struct rsa_public_key
{
Niels Möller's avatar
Niels Möller committed
76 77 78 79 80
  /* Size of the modulo, in octets. This is also the size of all
   * signatures that are created or verified with this key. */
  unsigned size;
  
  /* Modulo */
Niels Möller's avatar
Niels Möller committed
81
  mpz_t n;
Niels Möller's avatar
Niels Möller committed
82 83

  /* Public exponent */
Niels Möller's avatar
Niels Möller committed
84 85 86 87 88
  mpz_t e;
};

struct rsa_private_key
{
89
  unsigned size;
90 91 92 93

  /* 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
94
  
Niels Möller's avatar
Niels Möller committed
95 96 97 98 99 100 101 102 103 104 105
  /* 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
106 107
};

Niels Möller's avatar
Niels Möller committed
108 109 110 111
/* 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
112
 * Call rsa_private_key_prepare. This initializes the size attribute
Niels Möller's avatar
Niels Möller committed
113 114 115 116 117 118 119 120
 * to the length of a signature.
 *
 * Initialize a hashing context, by callling
 *   md5_init
 *
 * Hash the message by calling
 *   md5_update
 *
121
 * Create the signature by calling
Niels Möller's avatar
Niels Möller committed
122 123
 *   rsa_md5_sign
 *
124 125 126
 * The signature is represented as a mpz_t bignum. This call also
 * resets the hashing context.
 *
127 128
 * When done with the key and signature, don't forget to call
 * mpz_clear.
Niels Möller's avatar
Niels Möller committed
129
 */
130
 
131 132
/* Calls mpz_init to initialize bignum storage. */
void
133
rsa_public_key_init(struct rsa_public_key *key);
134 135 136

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

Niels Möller's avatar
Niels Möller committed
139
int
140
rsa_public_key_prepare(struct rsa_public_key *key);
Niels Möller's avatar
Niels Möller committed
141

142 143
/* Calls mpz_init to initialize bignum storage. */
void
144
rsa_private_key_init(struct rsa_private_key *key);
145 146 147

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

Niels Möller's avatar
Niels Möller committed
150
int
151
rsa_private_key_prepare(struct rsa_private_key *key);
Niels Möller's avatar
Niels Möller committed
152

153

Niels Möller's avatar
Niels Möller committed
154 155
/* PKCS#1 style signatures */
void
156
rsa_md5_sign(const struct rsa_private_key *key,
Niels Möller's avatar
Niels Möller committed
157
             struct md5_ctx *hash,
158
             mpz_t signature);
Niels Möller's avatar
Niels Möller committed
159 160 161


int
162
rsa_md5_verify(const struct rsa_public_key *key,
Niels Möller's avatar
Niels Möller committed
163
               struct md5_ctx *hash,
164
	       const mpz_t signature);
Niels Möller's avatar
Niels Möller committed
165 166

void
167
rsa_sha1_sign(const struct rsa_private_key *key,
Niels Möller's avatar
Niels Möller committed
168
              struct sha1_ctx *hash,
169
              mpz_t signature);
Niels Möller's avatar
Niels Möller committed
170 171

int
172
rsa_sha1_verify(const struct rsa_public_key *key,
Niels Möller's avatar
Niels Möller committed
173
                struct sha1_ctx *hash,
174
		const mpz_t signature);
Niels Möller's avatar
Niels Möller committed
175

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
/* Variants taking the digest as argument. */
void
rsa_md5_sign_digest(const struct rsa_private_key *key,
		    const uint8_t *digest,
		    mpz_t s);

int
rsa_md5_verify_digest(const struct rsa_public_key *key,
		      const uint8_t *digest,
		      const mpz_t signature);

void
rsa_sha1_sign_digest(const struct rsa_private_key *key,
		     const uint8_t *digest,
		     mpz_t s);

int
rsa_sha1_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
197 198 199 200 201 202 203 204

/* RSA encryption, using PKCS#1 */
/* FIXME: These functions uses the v1.5 padding. What should the v2
 * (OAEP) functions be called? */

/* Returns 1 on success, 0 on failure, which happens if the
 * message is too long for the key. */
int
205
rsa_encrypt(const struct rsa_public_key *key,
Niels Möller's avatar
Niels Möller committed
206 207
	    /* For padding */
	    void *random_ctx, nettle_random_func random,
Niels Möller's avatar
Niels Möller committed
208 209
	    unsigned length, const uint8_t *cleartext,
	    mpz_t cipher);
Niels Möller's avatar
Niels Möller committed
210 211 212 213 214 215 216

/* 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
217
rsa_decrypt(const struct rsa_private_key *key,
Niels Möller's avatar
Niels Möller committed
218 219
	    unsigned *length, uint8_t *cleartext,
	    const mpz_t ciphertext);
Niels Möller's avatar
Niels Möller committed
220

Niels Möller's avatar
Niels Möller committed
221
/* Compute x, the e:th root of m. Calling it with x == m is allowed. */
Niels Möller's avatar
Niels Möller committed
222
void
223 224
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
225

226 227

/* Key generation */
228 229

/* Note that the key structs must be initialized first. */
230 231
int
rsa_generate_keypair(struct rsa_public_key *pub,
232 233 234 235 236
		     struct rsa_private_key *key,

		     void *random_ctx, nettle_random_func random,
		     void *progress_ctx, nettle_progress_func progress,

237 238 239 240 241 242 243
		     /* 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);

244

Niels Möller's avatar
Niels Möller committed
245 246 247 248 249 250 251 252 253
#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
254

255 256 257 258 259 260 261 262

/* 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,
263
		    const char *algorithm_name, /* NULL means "rsa" */
264 265 266
		    const struct rsa_public_key *pub,
		    const struct rsa_private_key *priv);

267 268 269 270 271
struct sexp_iterator;

int
rsa_keypair_from_sexp_alist(struct rsa_public_key *pub,
			    struct rsa_private_key *priv,
272
			    unsigned limit,
273 274
			    struct sexp_iterator *i);

275 276 277 278 279 280 281
/* 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,
282
		      unsigned limit,
283 284 285
		      unsigned length, const uint8_t *expr);


286 287 288 289 290 291
/* 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. */
292
		       const char *userid);
293

294 295 296 297 298 299 300 301 302
/* Internal functions. */
int
_rsa_verify(const struct rsa_public_key *key,
	    const mpz_t m,
	    const mpz_t s);

unsigned
_rsa_check_size(mpz_t n);

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