rsa.h 4.85 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1
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
/* rsa.h
 *
 * The RSA publickey algorithm.
 */

/* nettle, low-level cryptographics library
 *
 * Copyright (C) 2001 Niels Mller
 *  
 * 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 <inttypes.h>
#include <gmp.h>

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

35
36
37
38
39
40
41
42
43
44
/* 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
45
46
struct rsa_public_key
{
Niels Möller's avatar
Niels Möller committed
47
48
49
50
51
  /* 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
52
  mpz_t n;
Niels Möller's avatar
Niels Möller committed
53
54

  /* Public exponent */
Niels Möller's avatar
Niels Möller committed
55
56
57
58
59
  mpz_t e;
};

struct rsa_private_key
{
60
  unsigned size;
61
62
63
64

  /* 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
65
  
Niels Möller's avatar
Niels Möller committed
66
67
68
69
70
71
72
73
74
75
76
  /* 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
77
78
};

Niels Möller's avatar
Niels Möller committed
79
80
81
82
/* Signing a message works as follows:
 *
 * Store the private key in a rsa_private_key struct.
 *
83
 * Call rsa_prepare_private_key. This initializes the size attribute
Niels Möller's avatar
Niels Möller committed
84
85
86
87
88
89
90
91
 * to the length of a signature.
 *
 * Initialize a hashing context, by callling
 *   md5_init
 *
 * Hash the message by calling
 *   md5_update
 *
92
 * Create the signature by calling
Niels Möller's avatar
Niels Möller committed
93
94
 *   rsa_md5_sign
 *
95
96
97
 * The signature is represented as a mpz_t bignum. This call also
 * resets the hashing context.
 *
98
99
 * When done with the key and signature, don't forget to call
 * mpz_clear.
Niels Möller's avatar
Niels Möller committed
100
101
 */

102
103
104
105
106
107
108
109
/* Calls mpz_init to initialize bignum storage. */
void
rsa_init_public_key(struct rsa_public_key *key);

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

Niels Möller's avatar
Niels Möller committed
110
int
111
rsa_prepare_public_key(struct rsa_public_key *key);
Niels Möller's avatar
Niels Möller committed
112

113
114
115
116
117
118
119
120
/* Calls mpz_init to initialize bignum storage. */
void
rsa_init_private_key(struct rsa_private_key *key);

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

Niels Möller's avatar
Niels Möller committed
121
int
122
rsa_prepare_private_key(struct rsa_private_key *key);
Niels Möller's avatar
Niels Möller committed
123

124

Niels Möller's avatar
Niels Möller committed
125
126
127
128
/* PKCS#1 style signatures */
void
rsa_md5_sign(struct rsa_private_key *key,
             struct md5_ctx *hash,
129
             mpz_t signature);
Niels Möller's avatar
Niels Möller committed
130
131
132
133
134


int
rsa_md5_verify(struct rsa_public_key *key,
               struct md5_ctx *hash,
135
	       const mpz_t signature);
Niels Möller's avatar
Niels Möller committed
136
137
138
139

void
rsa_sha1_sign(struct rsa_private_key *key,
              struct sha1_ctx *hash,
140
              mpz_t signature);
Niels Möller's avatar
Niels Möller committed
141
142
143
144

int
rsa_sha1_verify(struct rsa_public_key *key,
                struct sha1_ctx *hash,
145
		const mpz_t signature);
Niels Möller's avatar
Niels Möller committed
146

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

151
152

/* Key generation */
153
154
155
156
157
158
159
160
161
162
163

/* Randomness function. This typedef doesn't really belong here, but
 * so far it's used only by the rsa key generator. */
typedef void (*nettle_random_func)(void *ctx,
				   unsigned length, uint8_t *dst);

/* Progress report function. */
typedef void (*nettle_progress_func)(void *ctx,
				     int c);

/* Note that the key structs must be initialized first. */
164
165
int
rsa_generate_keypair(struct rsa_public_key *pub,
166
167
168
169
170
		     struct rsa_private_key *key,

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

171
172
173
174
175
176
177
		     /* 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);

178

Niels Möller's avatar
Niels Möller committed
179
180
181
182
183
184
185
186
187
#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
188

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