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