Avoid freeing the backend in notify_remote_exit(), since that's
[u/mdw/putty] / ssh.h
CommitLineData
df3c4460 1#include <stdio.h>
37508af4 2#include <string.h>
3
dcbde236 4#include "puttymem.h"
d74d141c 5#include "network.h"
5c72ca61 6#include "int64.h"
9a30e26b 7#include "misc.h"
dcbde236 8
2871113a 9struct ssh_channel;
10
5471d09a 11extern void sshfwd_close(struct ssh_channel *c);
12extern int sshfwd_write(struct ssh_channel *c, char *, int);
13extern void sshfwd_unthrottle(struct ssh_channel *c, int bufsize);
14
e5574168 15/*
16 * Useful thing.
17 */
18#ifndef lenof
19#define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
20#endif
21
bea1ef5f 22#define SSH_CIPHER_IDEA 1
9697bfd2 23#define SSH_CIPHER_DES 2
bea1ef5f 24#define SSH_CIPHER_3DES 3
25#define SSH_CIPHER_BLOWFISH 6
26
e5574168 27#ifdef MSCRYPTOAPI
28#define APIEXTRA 8
29#else
30#define APIEXTRA 0
31#endif
32
3709bfe9 33#ifndef BIGNUM_INTERNAL
34typedef void *Bignum;
35#endif
7cca0d81 36
374330e2 37struct RSAKey {
38 int bits;
39 int bytes;
8f203108 40#ifdef MSCRYPTOAPI
41 unsigned long exponent;
42 unsigned char *modulus;
43#else
7cca0d81 44 Bignum modulus;
45 Bignum exponent;
46 Bignum private_exponent;
9400cf6f 47 Bignum p;
48 Bignum q;
49 Bignum iqmp;
65a22376 50#endif
51 char *comment;
9400cf6f 52};
53
5c72ca61 54struct dss_key {
55 Bignum p, q, g, y, x;
56};
57
0016d70b 58int makekey(unsigned char *data, int len, struct RSAKey *result,
7cca0d81 59 unsigned char **keystr, int order);
0016d70b 60int makeprivate(unsigned char *data, int len, struct RSAKey *result);
61int rsaencrypt(unsigned char *data, int length, struct RSAKey *key);
7cca0d81 62Bignum rsadecrypt(Bignum input, struct RSAKey *key);
63void rsasign(unsigned char *data, int length, struct RSAKey *key);
64void rsasanitise(struct RSAKey *key);
374330e2 65int rsastr_len(struct RSAKey *key);
66void rsastr_fmt(char *str, struct RSAKey *key);
1c2a93c4 67void rsa_fingerprint(char *str, int len, struct RSAKey *key);
014970c8 68int rsa_verify(struct RSAKey *key);
3f2d010c 69unsigned char *rsa_public_blob(struct RSAKey *key, int *len);
0016d70b 70int rsa_public_blob_len(void *data, int maxlen);
5c58ad2d 71void freersakey(struct RSAKey *key);
374330e2 72
73typedef unsigned int word32;
74typedef unsigned int uint32;
75
71bedafe 76unsigned long crc32_compute(const void *s, size_t len);
9a3a93a5 77unsigned long crc32_update(unsigned long crc_input, const void *s, size_t len);
78
79/* SSH CRC compensation attack detector */
0183b242 80void *crcda_make_context(void);
81void crcda_free_context(void *handle);
82int detect_attack(void *handle, unsigned char *buf, uint32 len,
83 unsigned char *IV);
374330e2 84
fae1a71b 85/*
86 * SSH2 RSA key exchange functions
87 */
88struct ssh_hash;
89void *ssh_rsakex_newkey(char *data, int len);
90void ssh_rsakex_freekey(void *key);
91int ssh_rsakex_klen(void *key);
92void ssh_rsakex_encrypt(const struct ssh_hash *h, unsigned char *in, int inlen,
93 unsigned char *out, int outlen,
94 void *key);
95
48672163 96typedef struct {
97 uint32 h[4];
98} MD5_Core_State;
99
374330e2 100struct MD5Context {
8f203108 101#ifdef MSCRYPTOAPI
102 unsigned long hHash;
103#else
48672163 104 MD5_Core_State core;
bb093ca7 105 unsigned char block[64];
48672163 106 int blkused;
107 uint32 lenhi, lenlo;
8f203108 108#endif
374330e2 109};
110
111void MD5Init(struct MD5Context *context);
112void MD5Update(struct MD5Context *context, unsigned char const *buf,
32874aea 113 unsigned len);
374330e2 114void MD5Final(unsigned char digest[16], struct MD5Context *context);
f33ba69e 115void MD5Simple(void const *p, unsigned len, unsigned char output[16]);
116
117void *hmacmd5_make_context(void);
118void hmacmd5_free_context(void *handle);
447f7a7b 119void hmacmd5_key(void *handle, void const *key, int len);
f33ba69e 120void hmacmd5_do_hmac(void *handle, unsigned char const *blk, int len,
121 unsigned char *hmac);
374330e2 122
e5574168 123typedef struct {
124 uint32 h[5];
125 unsigned char block[64];
126 int blkused;
127 uint32 lenhi, lenlo;
128} SHA_State;
32874aea 129void SHA_Init(SHA_State * s);
130void SHA_Bytes(SHA_State * s, void *p, int len);
131void SHA_Final(SHA_State * s, unsigned char *output);
7cca0d81 132void SHA_Simple(void *p, int len, unsigned char *output);
e5574168 133
5c72ca61 134void hmac_sha1_simple(void *key, int keylen, void *data, int datalen,
135 unsigned char *output);
062e5811 136typedef struct {
137 uint32 h[8];
138 unsigned char block[64];
139 int blkused;
140 uint32 lenhi, lenlo;
141} SHA256_State;
142void SHA256_Init(SHA256_State * s);
143void SHA256_Bytes(SHA256_State * s, const void *p, int len);
144void SHA256_Final(SHA256_State * s, unsigned char *output);
145void SHA256_Simple(const void *p, int len, unsigned char *output);
5c72ca61 146
147typedef struct {
148 uint64 h[8];
149 unsigned char block[128];
150 int blkused;
151 uint32 len[4];
152} SHA512_State;
153void SHA512_Init(SHA512_State * s);
154void SHA512_Bytes(SHA512_State * s, const void *p, int len);
155void SHA512_Final(SHA512_State * s, unsigned char *output);
156void SHA512_Simple(const void *p, int len, unsigned char *output);
157
374330e2 158struct ssh_cipher {
371e569c 159 void *(*make_context)(void);
160 void (*free_context)(void *);
2e85c969 161 void (*sesskey) (void *, unsigned char *key); /* for SSH-1 */
371e569c 162 void (*encrypt) (void *, unsigned char *blk, int len);
163 void (*decrypt) (void *, unsigned char *blk, int len);
0a3f1d48 164 int blksize;
371e569c 165 char *text_name;
0a3f1d48 166};
167
168struct ssh2_cipher {
371e569c 169 void *(*make_context)(void);
170 void (*free_context)(void *);
2e85c969 171 void (*setiv) (void *, unsigned char *key); /* for SSH-2 */
172 void (*setkey) (void *, unsigned char *key);/* for SSH-2 */
371e569c 173 void (*encrypt) (void *, unsigned char *blk, int len);
174 void (*decrypt) (void *, unsigned char *blk, int len);
e5574168 175 char *name;
176 int blksize;
d2a0e0be 177 int keylen;
97ab28d7 178 unsigned int flags;
179#define SSH_CIPHER_IS_CBC 1
371e569c 180 char *text_name;
e5574168 181};
182
0a3f1d48 183struct ssh2_ciphers {
184 int nciphers;
65a22376 185 const struct ssh2_cipher *const *list;
0a3f1d48 186};
187
e5574168 188struct ssh_mac {
e0e1a00d 189 void *(*make_context)(void);
190 void (*free_context)(void *);
191 void (*setkey) (void *, unsigned char *key);
192 void (*generate) (void *, unsigned char *blk, int len, unsigned long seq);
193 int (*verify) (void *, unsigned char *blk, int len, unsigned long seq);
e5574168 194 char *name;
195 int len;
6c135243 196 char *text_name;
e5574168 197};
198
b672f405 199struct ssh_hash {
200 void *(*init)(void); /* also allocates context */
201 void (*bytes)(void *, void *, int);
202 void (*final)(void *, unsigned char *); /* also frees context */
203 int hlen; /* output length in bytes */
c6daaa1a 204 char *text_name;
b672f405 205};
206
e5574168 207struct ssh_kex {
d1aaf71d 208 char *name, *groupname;
fae1a71b 209 enum { KEXTYPE_DH, KEXTYPE_RSA } main_type;
210 /* For DH */
211 const unsigned char *pdata, *gdata; /* NULL means group exchange */
d1aaf71d 212 int plen, glen;
b672f405 213 const struct ssh_hash *hash;
e5574168 214};
215
34557659 216struct ssh_kexes {
217 int nkexes;
218 const struct ssh_kex *const *list;
219};
220
e055a386 221struct ssh_signkey {
32874aea 222 void *(*newkey) (char *data, int len);
223 void (*freekey) (void *key);
224 char *(*fmtkey) (void *key);
225 unsigned char *(*public_blob) (void *key, int *len);
226 unsigned char *(*private_blob) (void *key, int *len);
227 void *(*createkey) (unsigned char *pub_blob, int pub_len,
228 unsigned char *priv_blob, int priv_len);
229 void *(*openssh_createkey) (unsigned char **blob, int *len);
230 int (*openssh_fmtkey) (void *key, unsigned char *blob, int len);
47a6b94c 231 int (*pubkey_bits) (void *blob, int len);
32874aea 232 char *(*fingerprint) (void *key);
233 int (*verifysig) (void *key, char *sig, int siglen,
234 char *data, int datalen);
235 unsigned char *(*sign) (void *key, char *data, int datalen,
236 int *siglen);
e5574168 237 char *name;
32874aea 238 char *keytype; /* for host key cache */
e5574168 239};
240
241struct ssh_compress {
242 char *name;
5366aed8 243 void *(*compress_init) (void);
244 void (*compress_cleanup) (void *);
245 int (*compress) (void *, unsigned char *block, int len,
32874aea 246 unsigned char **outblock, int *outlen);
5366aed8 247 void *(*decompress_init) (void);
248 void (*decompress_cleanup) (void *);
249 int (*decompress) (void *, unsigned char *block, int len,
32874aea 250 unsigned char **outblock, int *outlen);
5366aed8 251 int (*disable_compression) (void *);
252 char *text_name;
374330e2 253};
254
65a22376 255struct ssh2_userkey {
256 const struct ssh_signkey *alg; /* the key algorithm */
257 void *data; /* the key data */
258 char *comment; /* the key comment */
259};
260
754c0df9 261/* The maximum length of any hash algorithm used in kex. (bytes) */
262#define SSH2_KEX_MAX_HASH_LEN (32) /* SHA-256 */
263
65a22376 264extern const struct ssh_cipher ssh_3des;
265extern const struct ssh_cipher ssh_des;
266extern const struct ssh_cipher ssh_blowfish_ssh1;
267extern const struct ssh2_ciphers ssh2_3des;
0d7c43a6 268extern const struct ssh2_ciphers ssh2_des;
65a22376 269extern const struct ssh2_ciphers ssh2_aes;
270extern const struct ssh2_ciphers ssh2_blowfish;
a2add208 271extern const struct ssh2_ciphers ssh2_arcfour;
b672f405 272extern const struct ssh_hash ssh_sha1;
062e5811 273extern const struct ssh_hash ssh_sha256;
34557659 274extern const struct ssh_kexes ssh_diffiehellman_group1;
275extern const struct ssh_kexes ssh_diffiehellman_group14;
276extern const struct ssh_kexes ssh_diffiehellman_gex;
fae1a71b 277extern const struct ssh_kexes ssh_rsa_kex;
65a22376 278extern const struct ssh_signkey ssh_dss;
279extern const struct ssh_signkey ssh_rsa;
1993f323 280extern const struct ssh_mac ssh_hmac_md5;
281extern const struct ssh_mac ssh_hmac_sha1;
282extern const struct ssh_mac ssh_hmac_sha1_buggy;
6668a75e 283extern const struct ssh_mac ssh_hmac_sha1_96;
284extern const struct ssh_mac ssh_hmac_sha1_96_buggy;
1993f323 285
65a22376 286
900a4ee6 287/*
288 * PuTTY version number formatted as an SSH version string.
289 */
290extern char sshver[];
291
fd5e5847 292/*
293 * Gross hack: pscp will try to start SFTP but fall back to scp1 if
294 * that fails. This variable is the means by which scp.c can reach
295 * into the SSH code and find out which one it got.
296 */
51470298 297extern int ssh_fallback_cmd(void *handle);
fd5e5847 298
8f203108 299#ifndef MSCRYPTOAPI
32874aea 300void SHATransform(word32 * digest, word32 * data);
8f203108 301#endif
374330e2 302
303int random_byte(void);
304void random_add_noise(void *noise, int length);
6e522441 305void random_add_heavynoise(void *noise, int length);
c5e9c988 306
cbe2d68f 307void logevent(void *, const char *);
51470298 308
309/* Allocate and register a new channel for port forwarding */
310void *new_sock_channel(void *handle, Socket s);
6b78788a 311void ssh_send_port_open(void *channel, char *hostname, int port, char *org);
e5574168 312
322d09a8 313/* Exports from portfwd.c */
cbe2d68f 314extern const char *pfd_newconnect(Socket * s, char *hostname, int port,
05581745 315 void *c, const Config *cfg,
316 int addressfamily);
820ebe3b 317/* desthost == NULL indicates dynamic (SOCKS) port forwarding */
cbe2d68f 318extern const char *pfd_addforward(char *desthost, int destport, char *srcaddr,
319 int port, void *backhandle,
05581745 320 const Config *cfg, void **sockdata,
321 int address_family);
322d09a8 322extern void pfd_close(Socket s);
fda2feb1 323extern void pfd_terminate(void *sockdata);
322d09a8 324extern int pfd_send(Socket s, char *data, int len);
325extern void pfd_confirm(Socket s);
326extern void pfd_unthrottle(Socket s);
327extern void pfd_override_throttle(Socket s, int enable);
328
329/* Exports from x11fwd.c */
cbe2d68f 330extern const char *x11_init(Socket *, char *, void *, void *, const char *,
331 int, const Config *);
322d09a8 332extern void x11_close(Socket);
333extern int x11_send(Socket, char *, int);
b3ebaa28 334extern void *x11_invent_auth(char *, int, char *, int, int);
fabd1805 335extern void x11_free_auth(void *);
322d09a8 336extern void x11_unthrottle(Socket s);
337extern void x11_override_throttle(Socket s, int enable);
338extern int x11_get_screen_number(char *display);
e0e7dff8 339void x11_get_real_auth(void *authv, char *display);
fc0f17db 340char *x11_display(const char *display);
322d09a8 341
fc0f17db 342/* Platform-dependent X11 functions */
9bee6826 343extern void platform_get_x11_auth(char *display, int *proto,
344 unsigned char *data, int *datalen);
fc0f17db 345extern const char platform_x11_best_transport[];
346/* best X11 hostname for this platform if none specified */
48806a46 347SockAddr platform_get_x11_unix_address(const char *display, int displaynum,
348 char **canonicalname);
fc0f17db 349/* make up a SockAddr naming the address for displaynum */
46ed7b64 350char *platform_get_x_display(void);
351/* allocated local X display string, if any */
9bee6826 352
7cca0d81 353Bignum copybn(Bignum b);
3709bfe9 354Bignum bn_power_2(int n);
355void bn_restore_invariant(Bignum b);
5c72ca61 356Bignum bignum_from_long(unsigned long n);
e5574168 357void freebn(Bignum b);
59600f67 358Bignum modpow(Bignum base, Bignum exp, Bignum mod);
359Bignum modmul(Bignum a, Bignum b, Bignum mod);
7cca0d81 360void decbn(Bignum n);
361extern Bignum Zero, One;
27cd7fc2 362Bignum bignum_from_bytes(const unsigned char *data, int nbytes);
0016d70b 363int ssh1_read_bignum(const unsigned char *data, int len, Bignum * result);
ddecd643 364int bignum_bitcount(Bignum bn);
5c58ad2d 365int ssh1_bignum_length(Bignum bn);
260f3dec 366int ssh2_bignum_length(Bignum bn);
5c58ad2d 367int bignum_byte(Bignum bn, int i);
9400cf6f 368int bignum_bit(Bignum bn, int i);
369void bignum_set_bit(Bignum bn, int i, int value);
5c58ad2d 370int ssh1_write_bignum(void *data, Bignum bn);
9400cf6f 371Bignum biggcd(Bignum a, Bignum b);
372unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
373Bignum bignum_add_long(Bignum number, unsigned long addend);
374Bignum bigmul(Bignum a, Bignum b);
5c72ca61 375Bignum bigmuladd(Bignum a, Bignum b, Bignum addend);
376Bignum bigdiv(Bignum a, Bignum b);
377Bignum bigmod(Bignum a, Bignum b);
9400cf6f 378Bignum modinv(Bignum number, Bignum modulus);
3709bfe9 379Bignum bignum_bitmask(Bignum number);
9400cf6f 380Bignum bignum_rshift(Bignum number, int shift);
8c3cd914 381int bignum_cmp(Bignum a, Bignum b);
6e522441 382char *bignum_decimal(Bignum x);
e5574168 383
a3412f52 384#ifdef DEBUG
385void diagbn(char *prefix, Bignum md);
386#endif
387
d1aaf71d 388void *dh_setup_group(const struct ssh_kex *kex);
389void *dh_setup_gex(Bignum pval, Bignum gval);
27cd7fc2 390void dh_cleanup(void *);
391Bignum dh_create_e(void *, int nbits);
392Bignum dh_find_K(void *, Bignum f);
7cca0d81 393
9a30e26b 394int loadrsakey(const Filename *filename, struct RSAKey *key,
222d54dc 395 char *passphrase, const char **errorstr);
9a30e26b 396int rsakey_encrypted(const Filename *filename, char **comment);
222d54dc 397int rsakey_pubblob(const Filename *filename, void **blob, int *bloblen,
4bcf919e 398 char **commentptr, const char **errorstr);
7cca0d81 399
9a30e26b 400int saversakey(const Filename *filename, struct RSAKey *key, char *passphrase);
65a22376 401
df3c4460 402extern int base64_decode_atom(char *atom, unsigned char *out);
403extern int base64_lines(int datalen);
404extern void base64_encode_atom(unsigned char *data, int n, char *out);
405extern void base64_encode(FILE *fp, unsigned char *data, int datalen, int cpl);
65a22376 406
407/* ssh2_load_userkey can return this as an error */
408extern struct ssh2_userkey ssh2_wrong_passphrase;
409#define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)
410
9a30e26b 411int ssh2_userkey_encrypted(const Filename *filename, char **comment);
412struct ssh2_userkey *ssh2_load_userkey(const Filename *filename,
222d54dc 413 char *passphrase, const char **errorstr);
8a9977e5 414unsigned char *ssh2_userkey_loadpub(const Filename *filename, char **algorithm,
415 int *pub_blob_len, char **commentptr,
416 const char **errorstr);
9a30e26b 417int ssh2_save_userkey(const Filename *filename, struct ssh2_userkey *key,
32874aea 418 char *passphrase);
47a6b94c 419const struct ssh_signkey *find_pubkey_alg(const char *name);
65a22376 420
231ee168 421enum {
422 SSH_KEYTYPE_UNOPENABLE,
423 SSH_KEYTYPE_UNKNOWN,
424 SSH_KEYTYPE_SSH1, SSH_KEYTYPE_SSH2,
425 SSH_KEYTYPE_OPENSSH, SSH_KEYTYPE_SSHCOM
426};
9a30e26b 427int key_type(const Filename *filename);
231ee168 428char *key_type_to_str(int type);
6e522441 429
9dda6459 430int import_possible(int type);
431int import_target_type(int type);
9a30e26b 432int import_encrypted(const Filename *filename, int type, char **comment);
433int import_ssh1(const Filename *filename, int type,
1e87cce5 434 struct RSAKey *key, char *passphrase, const char **errmsg_p);
9a30e26b 435struct ssh2_userkey *import_ssh2(const Filename *filename, int type,
1e87cce5 436 char *passphrase, const char **errmsg_p);
9a30e26b 437int export_ssh1(const Filename *filename, int type,
438 struct RSAKey *key, char *passphrase);
439int export_ssh2(const Filename *filename, int type,
4801c01c 440 struct ssh2_userkey *key, char *passphrase);
9dda6459 441
65a22376 442void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
443void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
9dda6459 444void des3_decrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
445 unsigned char *blk, int len);
446void des3_encrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
447 unsigned char *blk, int len);
32874aea 448void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk,
449 int len);
450void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk,
451 int len);
9400cf6f 452
2f92b717 453void des_encrypt_xdmauth(unsigned char *key, unsigned char *blk, int len);
b3ebaa28 454void des_decrypt_xdmauth(unsigned char *key, unsigned char *blk, int len);
2f92b717 455
9400cf6f 456/*
457 * For progress updates in the key generation utility.
458 */
7c7f6893 459#define PROGFN_INITIALISE 1
460#define PROGFN_LIN_PHASE 2
461#define PROGFN_EXP_PHASE 3
462#define PROGFN_PHASE_EXTENT 4
463#define PROGFN_READY 5
464#define PROGFN_PROGRESS 6
5c72ca61 465typedef void (*progfn_t) (void *param, int action, int phase, int progress);
9400cf6f 466
32874aea 467int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn,
468 void *pfnparam);
5c72ca61 469int dsa_generate(struct dss_key *key, int bits, progfn_t pfn,
470 void *pfnparam);
471Bignum primegen(int bits, int modulus, int residue, Bignum factor,
472 int phase, progfn_t pfn, void *pfnparam);
4ba9b64b 473
d74d141c 474
4ba9b64b 475/*
476 * zlib compression.
477 */
5366aed8 478void *zlib_compress_init(void);
479void zlib_compress_cleanup(void *);
480void *zlib_decompress_init(void);
481void zlib_decompress_cleanup(void *);
482int zlib_compress_block(void *, unsigned char *block, int len,
4ba9b64b 483 unsigned char **outblock, int *outlen);
5366aed8 484int zlib_decompress_block(void *, unsigned char *block, int len,
4ba9b64b 485 unsigned char **outblock, int *outlen);
1983e559 486
487/*
2e85c969 488 * SSH-1 agent messages.
1983e559 489 */
490#define SSH1_AGENTC_REQUEST_RSA_IDENTITIES 1
491#define SSH1_AGENT_RSA_IDENTITIES_ANSWER 2
492#define SSH1_AGENTC_RSA_CHALLENGE 3
493#define SSH1_AGENT_RSA_RESPONSE 4
494#define SSH1_AGENTC_ADD_RSA_IDENTITY 7
495#define SSH1_AGENTC_REMOVE_RSA_IDENTITY 8
32874aea 496#define SSH1_AGENTC_REMOVE_ALL_RSA_IDENTITIES 9 /* openssh private? */
1983e559 497
498/*
2e85c969 499 * Messages common to SSH-1 and OpenSSH's SSH-2.
1983e559 500 */
501#define SSH_AGENT_FAILURE 5
502#define SSH_AGENT_SUCCESS 6
503
504/*
2e85c969 505 * OpenSSH's SSH-2 agent messages.
1983e559 506 */
507#define SSH2_AGENTC_REQUEST_IDENTITIES 11
508#define SSH2_AGENT_IDENTITIES_ANSWER 12
509#define SSH2_AGENTC_SIGN_REQUEST 13
510#define SSH2_AGENT_SIGN_RESPONSE 14
511#define SSH2_AGENTC_ADD_IDENTITY 17
512#define SSH2_AGENTC_REMOVE_IDENTITY 18
513#define SSH2_AGENTC_REMOVE_ALL_IDENTITIES 19
7bedb13c 514
515/*
2e85c969 516 * Need this to warn about support for the original SSH-2 keyfile
7bedb13c 517 * format.
518 */
519void old_keyfile_warning(void);