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