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