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