rsa.h 4.11 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"

Niels Möller's avatar
Niels Möller committed
35
36
struct rsa_public_key
{
Niels Möller's avatar
Niels Möller committed
37
38
39
40
41
  /* 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
42
  mpz_t n;
Niels Möller's avatar
Niels Möller committed
43
44

  /* Public exponent */
Niels Möller's avatar
Niels Möller committed
45
46
47
48
49
  mpz_t e;
};

struct rsa_private_key
{
50
  unsigned size;
51
52
53
54

  /* 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
55
  
Niels Möller's avatar
Niels Möller committed
56
57
58
59
60
61
62
63
64
65
66
  /* 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
67
68
};

Niels Möller's avatar
Niels Möller committed
69
70
71
72
/* Signing a message works as follows:
 *
 * Store the private key in a rsa_private_key struct.
 *
73
 * Call rsa_prepare_private_key. This initializes the size attribute
Niels Möller's avatar
Niels Möller committed
74
75
76
77
78
79
80
81
 * to the length of a signature.
 *
 * Initialize a hashing context, by callling
 *   md5_init
 *
 * Hash the message by calling
 *   md5_update
 *
82
 * Create the signature by calling
Niels Möller's avatar
Niels Möller committed
83
84
 *   rsa_md5_sign
 *
85
86
87
 * The signature is represented as a mpz_t bignum. This call also
 * resets the hashing context.
 *
88
89
 * When done with the key and signature, don't forget to call
 * mpz_clear.
Niels Möller's avatar
Niels Möller committed
90
91
 */

92
93
94
95
96
97
98
99
/* 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
100
int
101
rsa_prepare_public_key(struct rsa_public_key *key);
Niels Möller's avatar
Niels Möller committed
102

103
104
105
106
107
108
109
110
/* 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
111
int
112
rsa_prepare_private_key(struct rsa_private_key *key);
Niels Möller's avatar
Niels Möller committed
113

114

Niels Möller's avatar
Niels Möller committed
115
116
117
118
/* PKCS#1 style signatures */
void
rsa_md5_sign(struct rsa_private_key *key,
             struct md5_ctx *hash,
119
             mpz_t signature);
Niels Möller's avatar
Niels Möller committed
120
121
122
123
124


int
rsa_md5_verify(struct rsa_public_key *key,
               struct md5_ctx *hash,
125
	       const mpz_t signature);
Niels Möller's avatar
Niels Möller committed
126
127
128
129

void
rsa_sha1_sign(struct rsa_private_key *key,
              struct sha1_ctx *hash,
130
              mpz_t signature);
Niels Möller's avatar
Niels Möller committed
131
132
133
134

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

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

141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

/* Key generation */
int
rsa_generate_keypair(struct rsa_public_key *pub,
		     struct rsa_public_key *key,
		     void *random_ctx,
		     void (*random)(void *ctx, unsigned length, uint8_t *dst),
		     
		     /* 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);

Niels Möller's avatar
Niels Möller committed
156
157
158
159
160
161
162
163
164
#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
165

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