PSCP now uses the modern SFTP protocol if it can, and falls back to
[u/mdw/putty] / ssh.h
1 #include <string.h>
2
3 #include "puttymem.h"
4 #include "network.h"
5
6 extern void sshfwd_close(struct ssh_channel *c);
7 extern int sshfwd_write(struct ssh_channel *c, char *, int);
8 extern void sshfwd_unthrottle(struct ssh_channel *c, int bufsize);
9
10 /*
11 * Useful thing.
12 */
13 #ifndef lenof
14 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
15 #endif
16
17 #define SSH_CIPHER_IDEA 1
18 #define SSH_CIPHER_DES 2
19 #define SSH_CIPHER_3DES 3
20 #define SSH_CIPHER_BLOWFISH 6
21
22 #ifdef MSCRYPTOAPI
23 #define APIEXTRA 8
24 #else
25 #define APIEXTRA 0
26 #endif
27
28 #ifndef BIGNUM_INTERNAL
29 typedef void *Bignum;
30 #endif
31
32 struct RSAKey {
33 int bits;
34 int bytes;
35 #ifdef MSCRYPTOAPI
36 unsigned long exponent;
37 unsigned char *modulus;
38 #else
39 Bignum modulus;
40 Bignum exponent;
41 Bignum private_exponent;
42 Bignum p;
43 Bignum q;
44 Bignum iqmp;
45 #endif
46 char *comment;
47 };
48
49 int makekey(unsigned char *data, struct RSAKey *result,
50 unsigned char **keystr, int order);
51 int makeprivate(unsigned char *data, struct RSAKey *result);
52 void rsaencrypt(unsigned char *data, int length, struct RSAKey *key);
53 Bignum rsadecrypt(Bignum input, struct RSAKey *key);
54 void rsasign(unsigned char *data, int length, struct RSAKey *key);
55 void rsasanitise(struct RSAKey *key);
56 int rsastr_len(struct RSAKey *key);
57 void rsastr_fmt(char *str, struct RSAKey *key);
58 void rsa_fingerprint(char *str, int len, struct RSAKey *key);
59 int rsa_verify(struct RSAKey *key);
60 void freersakey(struct RSAKey *key);
61
62 typedef unsigned int word32;
63 typedef unsigned int uint32;
64
65 unsigned long crc32(const void *s, size_t len);
66
67 typedef struct {
68 uint32 h[4];
69 } MD5_Core_State;
70
71 struct MD5Context {
72 #ifdef MSCRYPTOAPI
73 unsigned long hHash;
74 #else
75 MD5_Core_State core;
76 unsigned char block[64];
77 int blkused;
78 uint32 lenhi, lenlo;
79 #endif
80 };
81
82 void MD5Init(struct MD5Context *context);
83 void MD5Update(struct MD5Context *context, unsigned char const *buf,
84 unsigned len);
85 void MD5Final(unsigned char digest[16], struct MD5Context *context);
86
87 typedef struct {
88 uint32 h[5];
89 unsigned char block[64];
90 int blkused;
91 uint32 lenhi, lenlo;
92 } SHA_State;
93
94 void SHA_Init(SHA_State * s);
95 void SHA_Bytes(SHA_State * s, void *p, int len);
96 void SHA_Final(SHA_State * s, unsigned char *output);
97 void SHA_Simple(void *p, int len, unsigned char *output);
98
99 struct ssh_cipher {
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);
103 int blksize;
104 };
105
106 struct ssh2_cipher {
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);
113 char *name;
114 int blksize;
115 int keylen;
116 };
117
118 struct ssh2_ciphers {
119 int nciphers;
120 const struct ssh2_cipher *const *list;
121 };
122
123 struct ssh_mac {
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);
128 char *name;
129 int len;
130 };
131
132 struct ssh_kex {
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 */
140 char *name;
141 };
142
143 struct ssh_signkey {
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);
158 char *name;
159 char *keytype; /* for host key cache */
160 };
161
162 struct ssh_compress {
163 char *name;
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);
171 };
172
173 struct 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
179 extern const struct ssh_cipher ssh_3des;
180 extern const struct ssh_cipher ssh_des;
181 extern const struct ssh_cipher ssh_blowfish_ssh1;
182 extern const struct ssh2_ciphers ssh2_3des;
183 extern const struct ssh2_ciphers ssh2_aes;
184 extern const struct ssh2_ciphers ssh2_blowfish;
185 extern const struct ssh_kex ssh_diffiehellman;
186 extern const struct ssh_kex ssh_diffiehellman_gex;
187 extern const struct ssh_signkey ssh_dss;
188 extern const struct ssh_signkey ssh_rsa;
189 extern const struct ssh_mac ssh_md5;
190 extern const struct ssh_mac ssh_sha1;
191 extern const struct ssh_mac ssh_sha1_buggy;
192
193 /*
194 * PuTTY version number formatted as an SSH version string.
195 */
196 extern char sshver[];
197
198 /*
199 * Gross hack: pscp will try to start SFTP but fall back to scp1 if
200 * that fails. This variable is the means by which scp.c can reach
201 * into the SSH code and find out which one it got.
202 */
203 extern int ssh_fallback_cmd;
204
205 #ifndef MSCRYPTOAPI
206 void SHATransform(word32 * digest, word32 * data);
207 #endif
208
209 int random_byte(void);
210 void random_add_noise(void *noise, int length);
211 void random_add_heavynoise(void *noise, int length);
212
213 void logevent(char *);
214 void *new_sock_channel(Socket s); // allocates and register a new channel for port forwarding
215 void ssh_send_port_open(void *channel, char *hostname, int port, char *org);
216
217 Bignum copybn(Bignum b);
218 Bignum bn_power_2(int n);
219 void bn_restore_invariant(Bignum b);
220 Bignum bignum_from_short(unsigned short n);
221 void freebn(Bignum b);
222 Bignum modpow(Bignum base, Bignum exp, Bignum mod);
223 Bignum modmul(Bignum a, Bignum b, Bignum mod);
224 void decbn(Bignum n);
225 extern Bignum Zero, One;
226 Bignum bignum_from_bytes(unsigned char *data, int nbytes);
227 int ssh1_read_bignum(unsigned char *data, Bignum * result);
228 int bignum_bitcount(Bignum bn);
229 int ssh1_bignum_length(Bignum bn);
230 int ssh2_bignum_length(Bignum bn);
231 int bignum_byte(Bignum bn, int i);
232 int bignum_bit(Bignum bn, int i);
233 void bignum_set_bit(Bignum bn, int i, int value);
234 int ssh1_write_bignum(void *data, Bignum bn);
235 Bignum biggcd(Bignum a, Bignum b);
236 unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
237 Bignum bignum_add_long(Bignum number, unsigned long addend);
238 Bignum bigmul(Bignum a, Bignum b);
239 Bignum modinv(Bignum number, Bignum modulus);
240 Bignum bignum_bitmask(Bignum number);
241 Bignum bignum_rshift(Bignum number, int shift);
242 int bignum_cmp(Bignum a, Bignum b);
243 char *bignum_decimal(Bignum x);
244
245 void dh_setup_group1(void);
246 void dh_setup_group(Bignum pval, Bignum gval);
247 void dh_cleanup(void);
248 Bignum dh_create_e(int nbits);
249 Bignum dh_find_K(Bignum f);
250
251 int loadrsakey(char *filename, struct RSAKey *key, char *passphrase);
252 int rsakey_encrypted(char *filename, char **comment);
253
254 int saversakey(char *filename, struct RSAKey *key, char *passphrase);
255
256 void base64_encode_atom(unsigned char *data, int n, char *out);
257
258 /* ssh2_load_userkey can return this as an error */
259 extern struct ssh2_userkey ssh2_wrong_passphrase;
260 #define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)
261
262 int ssh2_userkey_encrypted(char *filename, char **comment);
263 struct ssh2_userkey *ssh2_load_userkey(char *filename, char *passphrase);
264 char *ssh2_userkey_loadpub(char *filename, char **algorithm,
265 int *pub_blob_len);
266 int ssh2_save_userkey(char *filename, struct ssh2_userkey *key,
267 char *passphrase);
268
269 int keyfile_version(char *filename);
270
271 void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
272 void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
273 void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk,
274 int len);
275 void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk,
276 int len);
277
278 /*
279 * For progress updates in the key generation utility.
280 */
281 typedef void (*progfn_t) (void *param, int phase, int progress);
282
283 int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn,
284 void *pfnparam);
285 Bignum primegen(int bits, int modulus, int residue, int phase,
286 progfn_t pfn, void *pfnparam);
287
288
289 /*
290 * zlib compression.
291 */
292 void zlib_compress_init(void);
293 void zlib_decompress_init(void);
294 int zlib_compress_block(unsigned char *block, int len,
295 unsigned char **outblock, int *outlen);
296 int zlib_decompress_block(unsigned char *block, int len,
297 unsigned char **outblock, int *outlen);
298
299 /*
300 * SSH1 agent messages.
301 */
302 #define SSH1_AGENTC_REQUEST_RSA_IDENTITIES 1
303 #define SSH1_AGENT_RSA_IDENTITIES_ANSWER 2
304 #define SSH1_AGENTC_RSA_CHALLENGE 3
305 #define SSH1_AGENT_RSA_RESPONSE 4
306 #define SSH1_AGENTC_ADD_RSA_IDENTITY 7
307 #define SSH1_AGENTC_REMOVE_RSA_IDENTITY 8
308 #define SSH1_AGENTC_REMOVE_ALL_RSA_IDENTITIES 9 /* openssh private? */
309
310 /*
311 * Messages common to SSH1 and OpenSSH's SSH2.
312 */
313 #define SSH_AGENT_FAILURE 5
314 #define SSH_AGENT_SUCCESS 6
315
316 /*
317 * OpenSSH's SSH2 agent messages.
318 */
319 #define SSH2_AGENTC_REQUEST_IDENTITIES 11
320 #define SSH2_AGENT_IDENTITIES_ANSWER 12
321 #define SSH2_AGENTC_SIGN_REQUEST 13
322 #define SSH2_AGENT_SIGN_RESPONSE 14
323 #define SSH2_AGENTC_ADD_IDENTITY 17
324 #define SSH2_AGENTC_REMOVE_IDENTITY 18
325 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES 19