Log the text message in SSH_MSG_DISCONNECT (both protocols) so that
[u/mdw/putty] / ssh.h
CommitLineData
37508af4 1#include <string.h>
2
dcbde236 3#include "puttymem.h"
4
e5574168 5/*
6 * Useful thing.
7 */
8#ifndef lenof
9#define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
10#endif
11
bea1ef5f 12#define SSH_CIPHER_IDEA 1
9697bfd2 13#define SSH_CIPHER_DES 2
bea1ef5f 14#define SSH_CIPHER_3DES 3
15#define SSH_CIPHER_BLOWFISH 6
16
e5574168 17#ifdef MSCRYPTOAPI
18#define APIEXTRA 8
19#else
20#define APIEXTRA 0
21#endif
22
3709bfe9 23#ifndef BIGNUM_INTERNAL
24typedef void *Bignum;
25#endif
7cca0d81 26
374330e2 27struct RSAKey {
28 int bits;
29 int bytes;
8f203108 30#ifdef MSCRYPTOAPI
31 unsigned long exponent;
32 unsigned char *modulus;
33#else
7cca0d81 34 Bignum modulus;
35 Bignum exponent;
36 Bignum private_exponent;
9400cf6f 37 Bignum p;
38 Bignum q;
39 Bignum iqmp;
65a22376 40#endif
41 char *comment;
9400cf6f 42};
43
374330e2 44int makekey(unsigned char *data, struct RSAKey *result,
7cca0d81 45 unsigned char **keystr, int order);
46int makeprivate(unsigned char *data, struct RSAKey *result);
374330e2 47void rsaencrypt(unsigned char *data, int length, struct RSAKey *key);
7cca0d81 48Bignum rsadecrypt(Bignum input, struct RSAKey *key);
49void rsasign(unsigned char *data, int length, struct RSAKey *key);
50void rsasanitise(struct RSAKey *key);
374330e2 51int rsastr_len(struct RSAKey *key);
52void rsastr_fmt(char *str, struct RSAKey *key);
1c2a93c4 53void rsa_fingerprint(char *str, int len, struct RSAKey *key);
014970c8 54int rsa_verify(struct RSAKey *key);
5c58ad2d 55void freersakey(struct RSAKey *key);
374330e2 56
57typedef unsigned int word32;
58typedef unsigned int uint32;
59
8160fbfc 60unsigned long crc32(const void *s, size_t len);
374330e2 61
48672163 62typedef struct {
63 uint32 h[4];
64} MD5_Core_State;
65
374330e2 66struct MD5Context {
8f203108 67#ifdef MSCRYPTOAPI
68 unsigned long hHash;
69#else
48672163 70 MD5_Core_State core;
bb093ca7 71 unsigned char block[64];
48672163 72 int blkused;
73 uint32 lenhi, lenlo;
8f203108 74#endif
374330e2 75};
76
77void MD5Init(struct MD5Context *context);
78void MD5Update(struct MD5Context *context, unsigned char const *buf,
79 unsigned len);
80void MD5Final(unsigned char digest[16], struct MD5Context *context);
81
e5574168 82typedef struct {
83 uint32 h[5];
84 unsigned char block[64];
85 int blkused;
86 uint32 lenhi, lenlo;
87} SHA_State;
88
89void SHA_Init(SHA_State *s);
90void SHA_Bytes(SHA_State *s, void *p, int len);
91void SHA_Final(SHA_State *s, unsigned char *output);
7cca0d81 92void SHA_Simple(void *p, int len, unsigned char *output);
e5574168 93
374330e2 94struct ssh_cipher {
d39f364a 95 void (*sesskey)(unsigned char *key); /* for ssh 1 */
0a3f1d48 96 void (*encrypt)(unsigned char *blk, int len);
97 void (*decrypt)(unsigned char *blk, int len);
98 int blksize;
99};
100
101struct ssh2_cipher {
d39f364a 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 */
374330e2 106 void (*encrypt)(unsigned char *blk, int len);
107 void (*decrypt)(unsigned char *blk, int len);
e5574168 108 char *name;
109 int blksize;
d2a0e0be 110 int keylen;
e5574168 111};
112
0a3f1d48 113struct ssh2_ciphers {
114 int nciphers;
65a22376 115 const struct ssh2_cipher *const *list;
0a3f1d48 116};
117
e5574168 118struct ssh_mac {
d39f364a 119 void (*setcskey)(unsigned char *key);
120 void (*setsckey)(unsigned char *key);
e5574168 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
127struct ssh_kex {
7cca0d81 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 */
e5574168 135 char *name;
136};
137
e055a386 138struct ssh_signkey {
139 void *(*newkey)(char *data, int len);
140 void (*freekey)(void *key);
141 char *(*fmtkey)(void *key);
65a22376 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);
45cebe79 146 void *(*openssh_createkey)(unsigned char **blob, int *len);
e055a386 147 char *(*fingerprint)(void *key);
148 int (*verifysig)(void *key, char *sig, int siglen,
149 char *data, int datalen);
65a22376 150 unsigned char *(*sign)(void *key, char *data, int datalen, int *siglen);
e5574168 151 char *name;
d5859615 152 char *keytype; /* for host key cache */
e5574168 153};
154
155struct ssh_compress {
156 char *name;
4ba9b64b 157 void (*compress_init)(void);
158 int (*compress)(unsigned char *block, int len,
159 unsigned char **outblock, int *outlen);
160 void (*decompress_init)(void);
161 int (*decompress)(unsigned char *block, int len,
162 unsigned char **outblock, int *outlen);
6e9e9520 163 int (*disable_compression)(void);
374330e2 164};
165
65a22376 166struct ssh2_userkey {
167 const struct ssh_signkey *alg; /* the key algorithm */
168 void *data; /* the key data */
169 char *comment; /* the key comment */
170};
171
172extern const struct ssh_cipher ssh_3des;
173extern const struct ssh_cipher ssh_des;
174extern const struct ssh_cipher ssh_blowfish_ssh1;
175extern const struct ssh2_ciphers ssh2_3des;
176extern const struct ssh2_ciphers ssh2_aes;
177extern const struct ssh2_ciphers ssh2_blowfish;
178extern const struct ssh_kex ssh_diffiehellman;
179extern const struct ssh_kex ssh_diffiehellman_gex;
180extern const struct ssh_signkey ssh_dss;
181extern const struct ssh_signkey ssh_rsa;
182extern const struct ssh_mac ssh_md5;
183extern const struct ssh_mac ssh_sha1;
184extern const struct ssh_mac ssh_sha1_buggy;
185
900a4ee6 186/*
187 * PuTTY version number formatted as an SSH version string.
188 */
189extern char sshver[];
190
8f203108 191#ifndef MSCRYPTOAPI
374330e2 192void SHATransform(word32 *digest, word32 *data);
8f203108 193#endif
374330e2 194
195int random_byte(void);
196void random_add_noise(void *noise, int length);
6e522441 197void random_add_heavynoise(void *noise, int length);
c5e9c988 198
199void logevent (char *);
e5574168 200
7cca0d81 201Bignum copybn(Bignum b);
3709bfe9 202Bignum bn_power_2(int n);
203void bn_restore_invariant(Bignum b);
9400cf6f 204Bignum bignum_from_short(unsigned short n);
e5574168 205void freebn(Bignum b);
59600f67 206Bignum modpow(Bignum base, Bignum exp, Bignum mod);
207Bignum modmul(Bignum a, Bignum b, Bignum mod);
7cca0d81 208void decbn(Bignum n);
209extern Bignum Zero, One;
3709bfe9 210Bignum bignum_from_bytes(unsigned char *data, int nbytes);
7cca0d81 211int ssh1_read_bignum(unsigned char *data, Bignum *result);
5c58ad2d 212int ssh1_bignum_bitcount(Bignum bn);
213int ssh1_bignum_length(Bignum bn);
214int bignum_byte(Bignum bn, int i);
9400cf6f 215int bignum_bit(Bignum bn, int i);
216void bignum_set_bit(Bignum bn, int i, int value);
5c58ad2d 217int ssh1_write_bignum(void *data, Bignum bn);
9400cf6f 218Bignum biggcd(Bignum a, Bignum b);
219unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
220Bignum bignum_add_long(Bignum number, unsigned long addend);
221Bignum bigmul(Bignum a, Bignum b);
222Bignum modinv(Bignum number, Bignum modulus);
3709bfe9 223Bignum bignum_bitmask(Bignum number);
9400cf6f 224Bignum bignum_rshift(Bignum number, int shift);
8c3cd914 225int bignum_cmp(Bignum a, Bignum b);
6e522441 226char *bignum_decimal(Bignum x);
e5574168 227
3709bfe9 228void dh_setup_group1(void);
a92dd380 229void dh_setup_group(Bignum pval, Bignum gval);
3709bfe9 230void dh_cleanup(void);
7bd5a860 231Bignum dh_create_e(int nbits);
e5574168 232Bignum dh_find_K(Bignum f);
7cca0d81 233
65a22376 234int loadrsakey(char *filename, struct RSAKey *key, char *passphrase);
a52f067e 235int rsakey_encrypted(char *filename, char **comment);
7cca0d81 236
65a22376 237int saversakey(char *filename, struct RSAKey *key, char *passphrase);
238
239void base64_encode_atom(unsigned char *data, int n, char *out);
240
241/* ssh2_load_userkey can return this as an error */
242extern struct ssh2_userkey ssh2_wrong_passphrase;
243#define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)
244
245int ssh2_userkey_encrypted(char *filename, char **comment);
246struct ssh2_userkey *ssh2_load_userkey(char *filename, char *passphrase);
247char *ssh2_userkey_loadpub(char *filename, char **algorithm, int *pub_blob_len);
248int ssh2_save_userkey(char *filename, struct ssh2_userkey *key, char *passphrase);
249
250int keyfile_version(char *filename);
6e522441 251
65a22376 252void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
253void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
254void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
255void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
9400cf6f 256
257/*
258 * For progress updates in the key generation utility.
259 */
260typedef void (*progfn_t)(void *param, int phase, int progress);
261
65a22376 262int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn, void *pfnparam);
9400cf6f 263Bignum primegen(int bits, int modulus, int residue,
264 int phase, progfn_t pfn, void *pfnparam);
4ba9b64b 265
266/*
267 * zlib compression.
268 */
269void zlib_compress_init(void);
270void zlib_decompress_init(void);
271int zlib_compress_block(unsigned char *block, int len,
272 unsigned char **outblock, int *outlen);
273int zlib_decompress_block(unsigned char *block, int len,
274 unsigned char **outblock, int *outlen);
1983e559 275
276/*
277 * SSH1 agent messages.
278 */
279#define SSH1_AGENTC_REQUEST_RSA_IDENTITIES 1
280#define SSH1_AGENT_RSA_IDENTITIES_ANSWER 2
281#define SSH1_AGENTC_RSA_CHALLENGE 3
282#define SSH1_AGENT_RSA_RESPONSE 4
283#define SSH1_AGENTC_ADD_RSA_IDENTITY 7
284#define SSH1_AGENTC_REMOVE_RSA_IDENTITY 8
285#define SSH1_AGENTC_REMOVE_ALL_RSA_IDENTITIES 9 /* openssh private? */
286
287/*
288 * Messages common to SSH1 and OpenSSH's SSH2.
289 */
290#define SSH_AGENT_FAILURE 5
291#define SSH_AGENT_SUCCESS 6
292
293/*
294 * OpenSSH's SSH2 agent messages.
295 */
296#define SSH2_AGENTC_REQUEST_IDENTITIES 11
297#define SSH2_AGENT_IDENTITIES_ANSWER 12
298#define SSH2_AGENTC_SIGN_REQUEST 13
299#define SSH2_AGENT_SIGN_RESPONSE 14
300#define SSH2_AGENTC_ADD_IDENTITY 17
301#define SSH2_AGENTC_REMOVE_IDENTITY 18
302#define SSH2_AGENTC_REMOVE_ALL_IDENTITIES 19