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