Having now compiled the last few days' changes with MSVC, it's turned
[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 int rsa_verify(struct RSAKey *key);
55 void freersakey(struct RSAKey *key);
56
57 typedef unsigned int word32;
58 typedef unsigned int uint32;
59
60 unsigned long crc32(const void *s, size_t len);
61
62 typedef struct {
63 uint32 h[4];
64 } MD5_Core_State;
65
66 struct MD5Context {
67 #ifdef MSCRYPTOAPI
68 unsigned long hHash;
69 #else
70 MD5_Core_State core;
71 unsigned char block[64];
72 int blkused;
73 uint32 lenhi, lenlo;
74 #endif
75 };
76
77 void MD5Init(struct MD5Context *context);
78 void MD5Update(struct MD5Context *context, unsigned char const *buf,
79 unsigned len);
80 void MD5Final(unsigned char digest[16], struct MD5Context *context);
81
82 typedef struct {
83 uint32 h[5];
84 unsigned char block[64];
85 int blkused;
86 uint32 lenhi, lenlo;
87 } SHA_State;
88
89 void SHA_Init(SHA_State *s);
90 void SHA_Bytes(SHA_State *s, void *p, int len);
91 void SHA_Final(SHA_State *s, unsigned char *output);
92 void SHA_Simple(void *p, int len, unsigned char *output);
93
94 struct ssh_cipher {
95 void (*sesskey)(unsigned char *key); /* for ssh 1 */
96 void (*encrypt)(unsigned char *blk, int len);
97 void (*decrypt)(unsigned char *blk, int len);
98 int blksize;
99 };
100
101 struct ssh2_cipher {
102 void (*setcsiv)(unsigned char *key); /* for ssh 2 */
103 void (*setcskey)(unsigned char *key); /* for ssh 2 */
104 void (*setsciv)(unsigned char *key); /* for ssh 2 */
105 void (*setsckey)(unsigned char *key); /* for ssh 2 */
106 void (*encrypt)(unsigned char *blk, int len);
107 void (*decrypt)(unsigned char *blk, int len);
108 char *name;
109 int blksize;
110 int keylen;
111 };
112
113 struct ssh2_ciphers {
114 int nciphers;
115 const struct ssh2_cipher *const *list;
116 };
117
118 struct ssh_mac {
119 void (*setcskey)(unsigned char *key);
120 void (*setsckey)(unsigned char *key);
121 void (*generate)(unsigned char *blk, int len, unsigned long seq);
122 int (*verify)(unsigned char *blk, int len, unsigned long seq);
123 char *name;
124 int len;
125 };
126
127 struct ssh_kex {
128 /*
129 * Plugging in another KEX algorithm requires structural chaos,
130 * so it's hard to abstract them into nice little structures
131 * like this. Hence, for the moment, this is just a
132 * placeholder. I claim justification in the fact that OpenSSH
133 * does this too :-)
134 */
135 char *name;
136 };
137
138 struct ssh_signkey {
139 void *(*newkey)(char *data, int len);
140 void (*freekey)(void *key);
141 char *(*fmtkey)(void *key);
142 unsigned char *(*public_blob)(void *key, int *len);
143 unsigned char *(*private_blob)(void *key, int *len);
144 void *(*createkey)(unsigned char *pub_blob, int pub_len,
145 unsigned char *priv_blob, int priv_len);
146 void *(*openssh_createkey)(unsigned char **blob, int *len);
147 int (*openssh_fmtkey)(void *key, unsigned char *blob, int len);
148 char *(*fingerprint)(void *key);
149 int (*verifysig)(void *key, char *sig, int siglen,
150 char *data, int datalen);
151 unsigned char *(*sign)(void *key, char *data, int datalen, int *siglen);
152 char *name;
153 char *keytype; /* for host key cache */
154 };
155
156 struct ssh_compress {
157 char *name;
158 void (*compress_init)(void);
159 int (*compress)(unsigned char *block, int len,
160 unsigned char **outblock, int *outlen);
161 void (*decompress_init)(void);
162 int (*decompress)(unsigned char *block, int len,
163 unsigned char **outblock, int *outlen);
164 int (*disable_compression)(void);
165 };
166
167 struct ssh2_userkey {
168 const struct ssh_signkey *alg; /* the key algorithm */
169 void *data; /* the key data */
170 char *comment; /* the key comment */
171 };
172
173 extern const struct ssh_cipher ssh_3des;
174 extern const struct ssh_cipher ssh_des;
175 extern const struct ssh_cipher ssh_blowfish_ssh1;
176 extern const struct ssh2_ciphers ssh2_3des;
177 extern const struct ssh2_ciphers ssh2_aes;
178 extern const struct ssh2_ciphers ssh2_blowfish;
179 extern const struct ssh_kex ssh_diffiehellman;
180 extern const struct ssh_kex ssh_diffiehellman_gex;
181 extern const struct ssh_signkey ssh_dss;
182 extern const struct ssh_signkey ssh_rsa;
183 extern const struct ssh_mac ssh_md5;
184 extern const struct ssh_mac ssh_sha1;
185 extern const struct ssh_mac ssh_sha1_buggy;
186
187 /*
188 * PuTTY version number formatted as an SSH version string.
189 */
190 extern char sshver[];
191
192 #ifndef MSCRYPTOAPI
193 void SHATransform(word32 *digest, word32 *data);
194 #endif
195
196 int random_byte(void);
197 void random_add_noise(void *noise, int length);
198 void random_add_heavynoise(void *noise, int length);
199
200 void logevent (char *);
201
202 Bignum copybn(Bignum b);
203 Bignum bn_power_2(int n);
204 void bn_restore_invariant(Bignum b);
205 Bignum bignum_from_short(unsigned short n);
206 void freebn(Bignum b);
207 Bignum modpow(Bignum base, Bignum exp, Bignum mod);
208 Bignum modmul(Bignum a, Bignum b, Bignum mod);
209 void decbn(Bignum n);
210 extern Bignum Zero, One;
211 Bignum bignum_from_bytes(unsigned char *data, int nbytes);
212 int ssh1_read_bignum(unsigned char *data, Bignum *result);
213 int bignum_bitcount(Bignum bn);
214 int ssh1_bignum_length(Bignum bn);
215 int ssh2_bignum_length(Bignum bn);
216 int bignum_byte(Bignum bn, int i);
217 int bignum_bit(Bignum bn, int i);
218 void bignum_set_bit(Bignum bn, int i, int value);
219 int ssh1_write_bignum(void *data, Bignum bn);
220 Bignum biggcd(Bignum a, Bignum b);
221 unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
222 Bignum bignum_add_long(Bignum number, unsigned long addend);
223 Bignum bigmul(Bignum a, Bignum b);
224 Bignum modinv(Bignum number, Bignum modulus);
225 Bignum bignum_bitmask(Bignum number);
226 Bignum bignum_rshift(Bignum number, int shift);
227 int bignum_cmp(Bignum a, Bignum b);
228 char *bignum_decimal(Bignum x);
229
230 void dh_setup_group1(void);
231 void dh_setup_group(Bignum pval, Bignum gval);
232 void dh_cleanup(void);
233 Bignum dh_create_e(int nbits);
234 Bignum dh_find_K(Bignum f);
235
236 int loadrsakey(char *filename, struct RSAKey *key, char *passphrase);
237 int rsakey_encrypted(char *filename, char **comment);
238
239 int saversakey(char *filename, struct RSAKey *key, char *passphrase);
240
241 void base64_encode_atom(unsigned char *data, int n, char *out);
242
243 /* ssh2_load_userkey can return this as an error */
244 extern struct ssh2_userkey ssh2_wrong_passphrase;
245 #define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)
246
247 int ssh2_userkey_encrypted(char *filename, char **comment);
248 struct ssh2_userkey *ssh2_load_userkey(char *filename, char *passphrase);
249 char *ssh2_userkey_loadpub(char *filename, char **algorithm, int *pub_blob_len);
250 int ssh2_save_userkey(char *filename, struct ssh2_userkey *key, char *passphrase);
251
252 int keyfile_version(char *filename);
253
254 void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
255 void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
256 void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
257 void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
258
259 /*
260 * For progress updates in the key generation utility.
261 */
262 typedef void (*progfn_t)(void *param, int phase, int progress);
263
264 int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn, void *pfnparam);
265 Bignum primegen(int bits, int modulus, int residue,
266 int phase, progfn_t pfn, void *pfnparam);
267
268 /*
269 * zlib compression.
270 */
271 void zlib_compress_init(void);
272 void zlib_decompress_init(void);
273 int zlib_compress_block(unsigned char *block, int len,
274 unsigned char **outblock, int *outlen);
275 int zlib_decompress_block(unsigned char *block, int len,
276 unsigned char **outblock, int *outlen);
277
278 /*
279 * SSH1 agent messages.
280 */
281 #define SSH1_AGENTC_REQUEST_RSA_IDENTITIES 1
282 #define SSH1_AGENT_RSA_IDENTITIES_ANSWER 2
283 #define SSH1_AGENTC_RSA_CHALLENGE 3
284 #define SSH1_AGENT_RSA_RESPONSE 4
285 #define SSH1_AGENTC_ADD_RSA_IDENTITY 7
286 #define SSH1_AGENTC_REMOVE_RSA_IDENTITY 8
287 #define SSH1_AGENTC_REMOVE_ALL_RSA_IDENTITIES 9 /* openssh private? */
288
289 /*
290 * Messages common to SSH1 and OpenSSH's SSH2.
291 */
292 #define SSH_AGENT_FAILURE 5
293 #define SSH_AGENT_SUCCESS 6
294
295 /*
296 * OpenSSH's SSH2 agent messages.
297 */
298 #define SSH2_AGENTC_REQUEST_IDENTITIES 11
299 #define SSH2_AGENT_IDENTITIES_ANSWER 12
300 #define SSH2_AGENTC_SIGN_REQUEST 13
301 #define SSH2_AGENT_SIGN_RESPONSE 14
302 #define SSH2_AGENTC_ADD_IDENTITY 17
303 #define SSH2_AGENTC_REMOVE_IDENTITY 18
304 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES 19