Add support for the OpenSSH SSH2 agent protocol.
[u/mdw/putty] / ssh.h
1 #include <string.h>
2
3 #include "puttymem.h"
4
5 /*
6 * Useful thing.
7 */
8 #ifndef lenof
9 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
10 #endif
11
12 #define SSH_CIPHER_IDEA 1
13 #define SSH_CIPHER_DES 2
14 #define SSH_CIPHER_3DES 3
15 #define SSH_CIPHER_BLOWFISH 6
16
17 #ifdef MSCRYPTOAPI
18 #define APIEXTRA 8
19 #else
20 #define APIEXTRA 0
21 #endif
22
23 #ifndef BIGNUM_INTERNAL
24 typedef void *Bignum;
25 #endif
26
27 struct RSAKey {
28 int bits;
29 int bytes;
30 #ifdef MSCRYPTOAPI
31 unsigned long exponent;
32 unsigned char *modulus;
33 #else
34 Bignum modulus;
35 Bignum exponent;
36 Bignum private_exponent;
37 Bignum p;
38 Bignum q;
39 Bignum iqmp;
40 #endif
41 char *comment;
42 };
43
44 int makekey(unsigned char *data, struct RSAKey *result,
45 unsigned char **keystr, int order);
46 int makeprivate(unsigned char *data, struct RSAKey *result);
47 void rsaencrypt(unsigned char *data, int length, struct RSAKey *key);
48 Bignum rsadecrypt(Bignum input, struct RSAKey *key);
49 void rsasign(unsigned char *data, int length, struct RSAKey *key);
50 void rsasanitise(struct RSAKey *key);
51 int rsastr_len(struct RSAKey *key);
52 void rsastr_fmt(char *str, struct RSAKey *key);
53 void rsa_fingerprint(char *str, int len, struct RSAKey *key);
54 void freersakey(struct RSAKey *key);
55
56 typedef unsigned int word32;
57 typedef unsigned int uint32;
58
59 unsigned long crc32(const void *s, size_t len);
60
61 typedef struct {
62 uint32 h[4];
63 } MD5_Core_State;
64
65 struct MD5Context {
66 #ifdef MSCRYPTOAPI
67 unsigned long hHash;
68 #else
69 MD5_Core_State core;
70 unsigned char block[64];
71 int blkused;
72 uint32 lenhi, lenlo;
73 #endif
74 };
75
76 void MD5Init(struct MD5Context *context);
77 void MD5Update(struct MD5Context *context, unsigned char const *buf,
78 unsigned len);
79 void MD5Final(unsigned char digest[16], struct MD5Context *context);
80
81 typedef struct {
82 uint32 h[5];
83 unsigned char block[64];
84 int blkused;
85 uint32 lenhi, lenlo;
86 } SHA_State;
87
88 void SHA_Init(SHA_State *s);
89 void SHA_Bytes(SHA_State *s, void *p, int len);
90 void SHA_Final(SHA_State *s, unsigned char *output);
91 void SHA_Simple(void *p, int len, unsigned char *output);
92
93 struct ssh_cipher {
94 void (*sesskey)(unsigned char *key); /* for ssh 1 */
95 void (*encrypt)(unsigned char *blk, int len);
96 void (*decrypt)(unsigned char *blk, int len);
97 int blksize;
98 };
99
100 struct ssh2_cipher {
101 void (*setcsiv)(unsigned char *key); /* for ssh 2 */
102 void (*setcskey)(unsigned char *key); /* for ssh 2 */
103 void (*setsciv)(unsigned char *key); /* for ssh 2 */
104 void (*setsckey)(unsigned char *key); /* for ssh 2 */
105 void (*encrypt)(unsigned char *blk, int len);
106 void (*decrypt)(unsigned char *blk, int len);
107 char *name;
108 int blksize;
109 int keylen;
110 };
111
112 struct ssh2_ciphers {
113 int nciphers;
114 const struct ssh2_cipher *const *list;
115 };
116
117 struct ssh_mac {
118 void (*setcskey)(unsigned char *key);
119 void (*setsckey)(unsigned char *key);
120 void (*generate)(unsigned char *blk, int len, unsigned long seq);
121 int (*verify)(unsigned char *blk, int len, unsigned long seq);
122 char *name;
123 int len;
124 };
125
126 struct ssh_kex {
127 /*
128 * Plugging in another KEX algorithm requires structural chaos,
129 * so it's hard to abstract them into nice little structures
130 * like this. Hence, for the moment, this is just a
131 * placeholder. I claim justification in the fact that OpenSSH
132 * does this too :-)
133 */
134 char *name;
135 };
136
137 struct ssh_signkey {
138 void *(*newkey)(char *data, int len);
139 void (*freekey)(void *key);
140 char *(*fmtkey)(void *key);
141 unsigned char *(*public_blob)(void *key, int *len);
142 unsigned char *(*private_blob)(void *key, int *len);
143 void *(*createkey)(unsigned char *pub_blob, int pub_len,
144 unsigned char *priv_blob, int priv_len);
145 void *(*openssh_createkey)(unsigned char **blob, int *len);
146 char *(*fingerprint)(void *key);
147 int (*verifysig)(void *key, char *sig, int siglen,
148 char *data, int datalen);
149 unsigned char *(*sign)(void *key, char *data, int datalen, int *siglen);
150 char *name;
151 char *keytype; /* for host key cache */
152 };
153
154 struct ssh_compress {
155 char *name;
156 void (*compress_init)(void);
157 int (*compress)(unsigned char *block, int len,
158 unsigned char **outblock, int *outlen);
159 void (*decompress_init)(void);
160 int (*decompress)(unsigned char *block, int len,
161 unsigned char **outblock, int *outlen);
162 };
163
164 struct ssh2_userkey {
165 const struct ssh_signkey *alg; /* the key algorithm */
166 void *data; /* the key data */
167 char *comment; /* the key comment */
168 };
169
170 extern const struct ssh_cipher ssh_3des;
171 extern const struct ssh_cipher ssh_des;
172 extern const struct ssh_cipher ssh_blowfish_ssh1;
173 extern const struct ssh2_ciphers ssh2_3des;
174 extern const struct ssh2_ciphers ssh2_aes;
175 extern const struct ssh2_ciphers ssh2_blowfish;
176 extern const struct ssh_kex ssh_diffiehellman;
177 extern const struct ssh_kex ssh_diffiehellman_gex;
178 extern const struct ssh_signkey ssh_dss;
179 extern const struct ssh_signkey ssh_rsa;
180 extern const struct ssh_mac ssh_md5;
181 extern const struct ssh_mac ssh_sha1;
182 extern const struct ssh_mac ssh_sha1_buggy;
183
184 #ifndef MSCRYPTOAPI
185 void SHATransform(word32 *digest, word32 *data);
186 #endif
187
188 int random_byte(void);
189 void random_add_noise(void *noise, int length);
190 void random_add_heavynoise(void *noise, int length);
191
192 void logevent (char *);
193
194 Bignum copybn(Bignum b);
195 Bignum bn_power_2(int n);
196 void bn_restore_invariant(Bignum b);
197 Bignum bignum_from_short(unsigned short n);
198 void freebn(Bignum b);
199 Bignum modpow(Bignum base, Bignum exp, Bignum mod);
200 Bignum modmul(Bignum a, Bignum b, Bignum mod);
201 void decbn(Bignum n);
202 extern Bignum Zero, One;
203 Bignum bignum_from_bytes(unsigned char *data, int nbytes);
204 int ssh1_read_bignum(unsigned char *data, Bignum *result);
205 int ssh1_bignum_bitcount(Bignum bn);
206 int ssh1_bignum_length(Bignum bn);
207 int bignum_byte(Bignum bn, int i);
208 int bignum_bit(Bignum bn, int i);
209 void bignum_set_bit(Bignum bn, int i, int value);
210 int ssh1_write_bignum(void *data, Bignum bn);
211 Bignum biggcd(Bignum a, Bignum b);
212 unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
213 Bignum bignum_add_long(Bignum number, unsigned long addend);
214 Bignum bigmul(Bignum a, Bignum b);
215 Bignum modinv(Bignum number, Bignum modulus);
216 Bignum bignum_bitmask(Bignum number);
217 Bignum bignum_rshift(Bignum number, int shift);
218 int bignum_cmp(Bignum a, Bignum b);
219 char *bignum_decimal(Bignum x);
220
221 void dh_setup_group1(void);
222 void dh_setup_group(Bignum pval, Bignum gval);
223 void dh_cleanup(void);
224 Bignum dh_create_e(void);
225 Bignum dh_find_K(Bignum f);
226
227 int loadrsakey(char *filename, struct RSAKey *key, char *passphrase);
228 int rsakey_encrypted(char *filename, char **comment);
229
230 int saversakey(char *filename, struct RSAKey *key, char *passphrase);
231
232 void base64_encode_atom(unsigned char *data, int n, char *out);
233
234 /* ssh2_load_userkey can return this as an error */
235 extern struct ssh2_userkey ssh2_wrong_passphrase;
236 #define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)
237
238 int ssh2_userkey_encrypted(char *filename, char **comment);
239 struct ssh2_userkey *ssh2_load_userkey(char *filename, char *passphrase);
240 char *ssh2_userkey_loadpub(char *filename, char **algorithm, int *pub_blob_len);
241 int ssh2_save_userkey(char *filename, struct ssh2_userkey *key, char *passphrase);
242
243 int keyfile_version(char *filename);
244
245 void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
246 void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
247 void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
248 void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
249
250 /*
251 * For progress updates in the key generation utility.
252 */
253 typedef void (*progfn_t)(void *param, int phase, int progress);
254
255 int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn, void *pfnparam);
256 Bignum primegen(int bits, int modulus, int residue,
257 int phase, progfn_t pfn, void *pfnparam);
258
259 /*
260 * zlib compression.
261 */
262 void zlib_compress_init(void);
263 void zlib_decompress_init(void);
264 int zlib_compress_block(unsigned char *block, int len,
265 unsigned char **outblock, int *outlen);
266 int zlib_decompress_block(unsigned char *block, int len,
267 unsigned char **outblock, int *outlen);