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