Refactored: Replace 'count' parameter of CGit::GetLogCmd() with CFilterData::m_Number...
[TortoiseGit.git] / src / TortoisePlink / SSH.H
blob5a69ef8b40ef38979947fdb7867b21d009f51670
1 #include <stdio.h>\r
2 #include <string.h>\r
3 \r
4 #include "puttymem.h"\r
5 #include "tree234.h"\r
6 #include "network.h"\r
7 #include "int64.h"\r
8 #include "misc.h"\r
9 \r
10 struct ssh_channel;\r
11 typedef struct ssh_tag *Ssh;\r
13 extern int sshfwd_write(struct ssh_channel *c, char *, int);\r
14 extern void sshfwd_write_eof(struct ssh_channel *c);\r
15 extern void sshfwd_unclean_close(struct ssh_channel *c, const char *err);\r
16 extern void sshfwd_unthrottle(struct ssh_channel *c, int bufsize);\r
17 Conf *sshfwd_get_conf(struct ssh_channel *c);\r
18 void sshfwd_x11_sharing_handover(struct ssh_channel *c,\r
19                                  void *share_cs, void *share_chan,\r
20                                  const char *peer_addr, int peer_port,\r
21                                  int endian, int protomajor, int protominor,\r
22                                  const void *initial_data, int initial_len);\r
23 void sshfwd_x11_is_local(struct ssh_channel *c);\r
25 extern Socket ssh_connection_sharing_init(const char *host, int port,\r
26                                           Conf *conf, Ssh ssh, void **state);\r
27 void share_got_pkt_from_server(void *ctx, int type,\r
28                                unsigned char *pkt, int pktlen);\r
29 void share_activate(void *state, const char *server_verstring);\r
30 void sharestate_free(void *state);\r
31 int share_ndownstreams(void *state);\r
33 void ssh_connshare_log(Ssh ssh, int event, const char *logtext,\r
34                        const char *ds_err, const char *us_err);\r
35 unsigned ssh_alloc_sharing_channel(Ssh ssh, void *sharing_ctx);\r
36 void ssh_delete_sharing_channel(Ssh ssh, unsigned localid);\r
37 int ssh_alloc_sharing_rportfwd(Ssh ssh, const char *shost, int sport,\r
38                                void *share_ctx);\r
39 void ssh_sharing_queue_global_request(Ssh ssh, void *share_ctx);\r
40 struct X11FakeAuth *ssh_sharing_add_x11_display(Ssh ssh, int authtype,\r
41                                                 void *share_cs,\r
42                                                 void *share_chan);\r
43 void ssh_sharing_remove_x11_display(Ssh ssh, struct X11FakeAuth *auth);\r
44 void ssh_send_packet_from_downstream(Ssh ssh, unsigned id, int type,\r
45                                      const void *pkt, int pktlen,\r
46                                      const char *additional_log_text);\r
47 void ssh_sharing_downstream_connected(Ssh ssh, unsigned id,\r
48                                       const char *peerinfo);\r
49 void ssh_sharing_downstream_disconnected(Ssh ssh, unsigned id);\r
50 void ssh_sharing_logf(Ssh ssh, unsigned id, const char *logfmt, ...);\r
51 int ssh_agent_forwarding_permitted(Ssh ssh);\r
52 void share_setup_x11_channel(void *csv, void *chanv,\r
53                              unsigned upstream_id, unsigned server_id,\r
54                              unsigned server_currwin, unsigned server_maxpkt,\r
55                              unsigned client_adjusted_window,\r
56                              const char *peer_addr, int peer_port, int endian,\r
57                              int protomajor, int protominor,\r
58                              const void *initial_data, int initial_len);\r
60 /*\r
61  * Useful thing.\r
62  */\r
63 #ifndef lenof\r
64 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))\r
65 #endif\r
67 #define SSH_CIPHER_IDEA         1\r
68 #define SSH_CIPHER_DES          2\r
69 #define SSH_CIPHER_3DES         3\r
70 #define SSH_CIPHER_BLOWFISH     6\r
72 #ifdef MSCRYPTOAPI\r
73 #define APIEXTRA 8\r
74 #else\r
75 #define APIEXTRA 0\r
76 #endif\r
78 #ifndef BIGNUM_INTERNAL\r
79 typedef void *Bignum;\r
80 #endif\r
82 struct RSAKey {\r
83     int bits;\r
84     int bytes;\r
85 #ifdef MSCRYPTOAPI\r
86     unsigned long exponent;\r
87     unsigned char *modulus;\r
88 #else\r
89     Bignum modulus;\r
90     Bignum exponent;\r
91     Bignum private_exponent;\r
92     Bignum p;\r
93     Bignum q;\r
94     Bignum iqmp;\r
95 #endif\r
96     char *comment;\r
97 };\r
99 struct dss_key {\r
100     Bignum p, q, g, y, x;\r
101 };\r
103 int makekey(unsigned char *data, int len, struct RSAKey *result,\r
104             unsigned char **keystr, int order);\r
105 int makeprivate(unsigned char *data, int len, struct RSAKey *result);\r
106 int rsaencrypt(unsigned char *data, int length, struct RSAKey *key);\r
107 Bignum rsadecrypt(Bignum input, struct RSAKey *key);\r
108 void rsasign(unsigned char *data, int length, struct RSAKey *key);\r
109 void rsasanitise(struct RSAKey *key);\r
110 int rsastr_len(struct RSAKey *key);\r
111 void rsastr_fmt(char *str, struct RSAKey *key);\r
112 void rsa_fingerprint(char *str, int len, struct RSAKey *key);\r
113 int rsa_verify(struct RSAKey *key);\r
114 unsigned char *rsa_public_blob(struct RSAKey *key, int *len);\r
115 int rsa_public_blob_len(void *data, int maxlen);\r
116 void freersakey(struct RSAKey *key);\r
118 #ifndef PUTTY_UINT32_DEFINED\r
119 /* This makes assumptions about the int type. */\r
120 typedef unsigned int uint32;\r
121 #define PUTTY_UINT32_DEFINED\r
122 #endif\r
123 typedef uint32 word32;\r
125 unsigned long crc32_compute(const void *s, size_t len);\r
126 unsigned long crc32_update(unsigned long crc_input, const void *s, size_t len);\r
128 /* SSH CRC compensation attack detector */\r
129 void *crcda_make_context(void);\r
130 void crcda_free_context(void *handle);\r
131 int detect_attack(void *handle, unsigned char *buf, uint32 len,\r
132                   unsigned char *IV);\r
134 /*\r
135  * SSH2 RSA key exchange functions\r
136  */\r
137 struct ssh_hash;\r
138 void *ssh_rsakex_newkey(char *data, int len);\r
139 void ssh_rsakex_freekey(void *key);\r
140 int ssh_rsakex_klen(void *key);\r
141 void ssh_rsakex_encrypt(const struct ssh_hash *h, unsigned char *in, int inlen,\r
142                         unsigned char *out, int outlen,\r
143                         void *key);\r
145 typedef struct {\r
146     uint32 h[4];\r
147 } MD5_Core_State;\r
149 struct MD5Context {\r
150 #ifdef MSCRYPTOAPI\r
151     unsigned long hHash;\r
152 #else\r
153     MD5_Core_State core;\r
154     unsigned char block[64];\r
155     int blkused;\r
156     uint32 lenhi, lenlo;\r
157 #endif\r
158 };\r
160 void MD5Init(struct MD5Context *context);\r
161 void MD5Update(struct MD5Context *context, unsigned char const *buf,\r
162                unsigned len);\r
163 void MD5Final(unsigned char digest[16], struct MD5Context *context);\r
164 void MD5Simple(void const *p, unsigned len, unsigned char output[16]);\r
166 void *hmacmd5_make_context(void);\r
167 void hmacmd5_free_context(void *handle);\r
168 void hmacmd5_key(void *handle, void const *key, int len);\r
169 void hmacmd5_do_hmac(void *handle, unsigned char const *blk, int len,\r
170                      unsigned char *hmac);\r
172 typedef struct {\r
173     uint32 h[5];\r
174     unsigned char block[64];\r
175     int blkused;\r
176     uint32 lenhi, lenlo;\r
177 } SHA_State;\r
178 void SHA_Init(SHA_State * s);\r
179 void SHA_Bytes(SHA_State * s, const void *p, int len);\r
180 void SHA_Final(SHA_State * s, unsigned char *output);\r
181 void SHA_Simple(const void *p, int len, unsigned char *output);\r
183 void hmac_sha1_simple(void *key, int keylen, void *data, int datalen,\r
184                       unsigned char *output);\r
185 typedef struct {\r
186     uint32 h[8];\r
187     unsigned char block[64];\r
188     int blkused;\r
189     uint32 lenhi, lenlo;\r
190 } SHA256_State;\r
191 void SHA256_Init(SHA256_State * s);\r
192 void SHA256_Bytes(SHA256_State * s, const void *p, int len);\r
193 void SHA256_Final(SHA256_State * s, unsigned char *output);\r
194 void SHA256_Simple(const void *p, int len, unsigned char *output);\r
196 typedef struct {\r
197     uint64 h[8];\r
198     unsigned char block[128];\r
199     int blkused;\r
200     uint32 len[4];\r
201 } SHA512_State;\r
202 void SHA512_Init(SHA512_State * s);\r
203 void SHA512_Bytes(SHA512_State * s, const void *p, int len);\r
204 void SHA512_Final(SHA512_State * s, unsigned char *output);\r
205 void SHA512_Simple(const void *p, int len, unsigned char *output);\r
207 struct ssh_cipher {\r
208     void *(*make_context)(void);\r
209     void (*free_context)(void *);\r
210     void (*sesskey) (void *, unsigned char *key);       /* for SSH-1 */\r
211     void (*encrypt) (void *, unsigned char *blk, int len);\r
212     void (*decrypt) (void *, unsigned char *blk, int len);\r
213     int blksize;\r
214     char *text_name;\r
215 };\r
217 struct ssh2_cipher {\r
218     void *(*make_context)(void);\r
219     void (*free_context)(void *);\r
220     void (*setiv) (void *, unsigned char *key); /* for SSH-2 */\r
221     void (*setkey) (void *, unsigned char *key);/* for SSH-2 */\r
222     void (*encrypt) (void *, unsigned char *blk, int len);\r
223     void (*decrypt) (void *, unsigned char *blk, int len);\r
224     char *name;\r
225     int blksize;\r
226     int keylen;\r
227     unsigned int flags;\r
228 #define SSH_CIPHER_IS_CBC       1\r
229     char *text_name;\r
230 };\r
232 struct ssh2_ciphers {\r
233     int nciphers;\r
234     const struct ssh2_cipher *const *list;\r
235 };\r
237 struct ssh_mac {\r
238     void *(*make_context)(void);\r
239     void (*free_context)(void *);\r
240     void (*setkey) (void *, unsigned char *key);\r
241     /* whole-packet operations */\r
242     void (*generate) (void *, unsigned char *blk, int len, unsigned long seq);\r
243     int (*verify) (void *, unsigned char *blk, int len, unsigned long seq);\r
244     /* partial-packet operations */\r
245     void (*start) (void *);\r
246     void (*bytes) (void *, unsigned char const *, int);\r
247     void (*genresult) (void *, unsigned char *);\r
248     int (*verresult) (void *, unsigned char const *);\r
249     char *name;\r
250     int len;\r
251     char *text_name;\r
252 };\r
254 struct ssh_hash {\r
255     void *(*init)(void); /* also allocates context */\r
256     void (*bytes)(void *, void *, int);\r
257     void (*final)(void *, unsigned char *); /* also frees context */\r
258     int hlen; /* output length in bytes */\r
259     char *text_name;\r
260 };   \r
262 struct ssh_kex {\r
263     char *name, *groupname;\r
264     enum { KEXTYPE_DH, KEXTYPE_RSA } main_type;\r
265     /* For DH */\r
266     const unsigned char *pdata, *gdata; /* NULL means group exchange */\r
267     int plen, glen;\r
268     const struct ssh_hash *hash;\r
269 };\r
271 struct ssh_kexes {\r
272     int nkexes;\r
273     const struct ssh_kex *const *list;\r
274 };\r
276 struct ssh_signkey {\r
277     void *(*newkey) (char *data, int len);\r
278     void (*freekey) (void *key);\r
279     char *(*fmtkey) (void *key);\r
280     unsigned char *(*public_blob) (void *key, int *len);\r
281     unsigned char *(*private_blob) (void *key, int *len);\r
282     void *(*createkey) (unsigned char *pub_blob, int pub_len,\r
283                         unsigned char *priv_blob, int priv_len);\r
284     void *(*openssh_createkey) (unsigned char **blob, int *len);\r
285     int (*openssh_fmtkey) (void *key, unsigned char *blob, int len);\r
286     int (*pubkey_bits) (void *blob, int len);\r
287     char *(*fingerprint) (void *key);\r
288     int (*verifysig) (void *key, char *sig, int siglen,\r
289                       char *data, int datalen);\r
290     unsigned char *(*sign) (void *key, char *data, int datalen,\r
291                             int *siglen);\r
292     char *name;\r
293     char *keytype;                     /* for host key cache */\r
294 };\r
296 struct ssh_compress {\r
297     char *name;\r
298     /* For zlib@openssh.com: if non-NULL, this name will be considered once\r
299      * userauth has completed successfully. */\r
300     char *delayed_name;\r
301     void *(*compress_init) (void);\r
302     void (*compress_cleanup) (void *);\r
303     int (*compress) (void *, unsigned char *block, int len,\r
304                      unsigned char **outblock, int *outlen);\r
305     void *(*decompress_init) (void);\r
306     void (*decompress_cleanup) (void *);\r
307     int (*decompress) (void *, unsigned char *block, int len,\r
308                        unsigned char **outblock, int *outlen);\r
309     int (*disable_compression) (void *);\r
310     char *text_name;\r
311 };\r
313 struct ssh2_userkey {\r
314     const struct ssh_signkey *alg;     /* the key algorithm */\r
315     void *data;                        /* the key data */\r
316     char *comment;                     /* the key comment */\r
317 };\r
319 /* The maximum length of any hash algorithm used in kex. (bytes) */\r
320 #define SSH2_KEX_MAX_HASH_LEN (32) /* SHA-256 */\r
322 extern const struct ssh_cipher ssh_3des;\r
323 extern const struct ssh_cipher ssh_des;\r
324 extern const struct ssh_cipher ssh_blowfish_ssh1;\r
325 extern const struct ssh2_ciphers ssh2_3des;\r
326 extern const struct ssh2_ciphers ssh2_des;\r
327 extern const struct ssh2_ciphers ssh2_aes;\r
328 extern const struct ssh2_ciphers ssh2_blowfish;\r
329 extern const struct ssh2_ciphers ssh2_arcfour;\r
330 extern const struct ssh_hash ssh_sha1;\r
331 extern const struct ssh_hash ssh_sha256;\r
332 extern const struct ssh_kexes ssh_diffiehellman_group1;\r
333 extern const struct ssh_kexes ssh_diffiehellman_group14;\r
334 extern const struct ssh_kexes ssh_diffiehellman_gex;\r
335 extern const struct ssh_kexes ssh_rsa_kex;\r
336 extern const struct ssh_signkey ssh_dss;\r
337 extern const struct ssh_signkey ssh_rsa;\r
338 extern const struct ssh_mac ssh_hmac_md5;\r
339 extern const struct ssh_mac ssh_hmac_sha1;\r
340 extern const struct ssh_mac ssh_hmac_sha1_buggy;\r
341 extern const struct ssh_mac ssh_hmac_sha1_96;\r
342 extern const struct ssh_mac ssh_hmac_sha1_96_buggy;\r
343 extern const struct ssh_mac ssh_hmac_sha256;\r
345 void *aes_make_context(void);\r
346 void aes_free_context(void *handle);\r
347 void aes128_key(void *handle, unsigned char *key);\r
348 void aes192_key(void *handle, unsigned char *key);\r
349 void aes256_key(void *handle, unsigned char *key);\r
350 void aes_iv(void *handle, unsigned char *iv);\r
351 void aes_ssh2_encrypt_blk(void *handle, unsigned char *blk, int len);\r
352 void aes_ssh2_decrypt_blk(void *handle, unsigned char *blk, int len);\r
354 /*\r
355  * PuTTY version number formatted as an SSH version string. \r
356  */\r
357 extern char sshver[];\r
359 /*\r
360  * Gross hack: pscp will try to start SFTP but fall back to scp1 if\r
361  * that fails. This variable is the means by which scp.c can reach\r
362  * into the SSH code and find out which one it got.\r
363  */\r
364 extern int ssh_fallback_cmd(void *handle);\r
366 #ifndef MSCRYPTOAPI\r
367 void SHATransform(word32 * digest, word32 * data);\r
368 #endif\r
370 int random_byte(void);\r
371 void random_add_noise(void *noise, int length);\r
372 void random_add_heavynoise(void *noise, int length);\r
374 void logevent(void *, const char *);\r
376 struct PortForwarding;\r
378 /* Allocate and register a new channel for port forwarding */\r
379 void *new_sock_channel(void *handle, struct PortForwarding *pf);\r
380 void ssh_send_port_open(void *channel, char *hostname, int port, char *org);\r
382 /* Exports from portfwd.c */\r
383 extern char *pfd_connect(struct PortForwarding **pf, char *hostname, int port,\r
384                          void *c, Conf *conf, int addressfamily);\r
385 extern void pfd_close(struct PortForwarding *);\r
386 extern int pfd_send(struct PortForwarding *, char *data, int len);\r
387 extern void pfd_send_eof(struct PortForwarding *);\r
388 extern void pfd_confirm(struct PortForwarding *);\r
389 extern void pfd_unthrottle(struct PortForwarding *);\r
390 extern void pfd_override_throttle(struct PortForwarding *, int enable);\r
391 struct PortListener;\r
392 /* desthost == NULL indicates dynamic (SOCKS) port forwarding */\r
393 extern char *pfl_listen(char *desthost, int destport, char *srcaddr,\r
394                         int port, void *backhandle, Conf *conf,\r
395                         struct PortListener **pl, int address_family);\r
396 extern void pfl_terminate(struct PortListener *);\r
398 /* Exports from x11fwd.c */\r
399 enum {\r
400     X11_TRANS_IPV4 = 0, X11_TRANS_IPV6 = 6, X11_TRANS_UNIX = 256\r
401 };\r
402 struct X11Display {\r
403     /* Broken-down components of the display name itself */\r
404     int unixdomain;\r
405     char *hostname;\r
406     int displaynum;\r
407     int screennum;\r
408     /* OSX sometimes replaces all the above with a full Unix-socket pathname */\r
409     char *unixsocketpath;\r
411     /* PuTTY networking SockAddr to connect to the display, and associated\r
412      * gubbins */\r
413     SockAddr addr;\r
414     int port;\r
415     char *realhost;\r
417     /* Our local auth details for talking to the real X display. */\r
418     int localauthproto;\r
419     unsigned char *localauthdata;\r
420     int localauthdatalen;\r
421 };\r
422 struct X11FakeAuth {\r
423     /* Auth details we invented for a virtual display on the SSH server. */\r
424     int proto;\r
425     unsigned char *data;\r
426     int datalen;\r
427     char *protoname;\r
428     char *datastring;\r
430     /* The encrypted form of the first block, in XDM-AUTHORIZATION-1.\r
431      * Used as part of the key when these structures are organised\r
432      * into a tree. See x11_invent_fake_auth for explanation. */\r
433     unsigned char *xa1_firstblock;\r
435     /*\r
436      * Used inside x11fwd.c to remember recently seen\r
437      * XDM-AUTHORIZATION-1 strings, to avoid replay attacks.\r
438      */\r
439     tree234 *xdmseen;\r
441     /*\r
442      * What to do with an X connection matching this auth data.\r
443      */\r
444     struct X11Display *disp;\r
445     void *share_cs, *share_chan;\r
446 };\r
447 void *x11_make_greeting(int endian, int protomajor, int protominor,\r
448                         int auth_proto, const void *auth_data, int auth_len,\r
449                         const char *peer_ip, int peer_port,\r
450                         int *outlen);\r
451 int x11_authcmp(void *av, void *bv); /* for putting X11FakeAuth in a tree234 */\r
452 /*\r
453  * x11_setup_display() parses the display variable and fills in an\r
454  * X11Display structure. Some remote auth details are invented;\r
455  * the supplied authtype parameter configures the preferred\r
456  * authorisation protocol to use at the remote end. The local auth\r
457  * details are looked up by calling platform_get_x11_auth.\r
458  */\r
459 extern struct X11Display *x11_setup_display(char *display, Conf *);\r
460 void x11_free_display(struct X11Display *disp);\r
461 struct X11FakeAuth *x11_invent_fake_auth(tree234 *t, int authtype);\r
462 void x11_free_fake_auth(struct X11FakeAuth *auth);\r
463 struct X11Connection;                  /* opaque outside x11fwd.c */\r
464 struct X11Connection *x11_init(tree234 *authtree, void *, const char *, int);\r
465 extern void x11_close(struct X11Connection *);\r
466 extern int x11_send(struct X11Connection *, char *, int);\r
467 extern void x11_send_eof(struct X11Connection *s);\r
468 extern void x11_unthrottle(struct X11Connection *s);\r
469 extern void x11_override_throttle(struct X11Connection *s, int enable);\r
470 char *x11_display(const char *display);\r
471 /* Platform-dependent X11 functions */\r
472 extern void platform_get_x11_auth(struct X11Display *display, Conf *);\r
473     /* examine a mostly-filled-in X11Display and fill in localauth* */\r
474 extern const int platform_uses_x11_unix_by_default;\r
475     /* choose default X transport in the absence of a specified one */\r
476 SockAddr platform_get_x11_unix_address(const char *path, int displaynum);\r
477     /* make up a SockAddr naming the address for displaynum */\r
478 char *platform_get_x_display(void);\r
479     /* allocated local X display string, if any */\r
480 /* Callbacks in x11.c usable _by_ platform X11 functions */\r
481 /*\r
482  * This function does the job of platform_get_x11_auth, provided\r
483  * it is told where to find a normally formatted .Xauthority file:\r
484  * it opens that file, parses it to find an auth record which\r
485  * matches the display details in "display", and fills in the\r
486  * localauth fields.\r
487  *\r
488  * It is expected that most implementations of\r
489  * platform_get_x11_auth() will work by finding their system's\r
490  * .Xauthority file, adjusting the display details if necessary\r
491  * for local oddities like Unix-domain socket transport, and\r
492  * calling this function to do the rest of the work.\r
493  */\r
494 void x11_get_auth_from_authfile(struct X11Display *display,\r
495                                 const char *authfilename);\r
496 int x11_identify_auth_proto(const char *proto);\r
497 void *x11_dehexify(const char *hex, int *outlen);\r
499 Bignum copybn(Bignum b);\r
500 Bignum bn_power_2(int n);\r
501 void bn_restore_invariant(Bignum b);\r
502 Bignum bignum_from_long(unsigned long n);\r
503 void freebn(Bignum b);\r
504 Bignum modpow(Bignum base, Bignum exp, Bignum mod);\r
505 Bignum modmul(Bignum a, Bignum b, Bignum mod);\r
506 void decbn(Bignum n);\r
507 extern Bignum Zero, One;\r
508 Bignum bignum_from_bytes(const unsigned char *data, int nbytes);\r
509 int ssh1_read_bignum(const unsigned char *data, int len, Bignum * result);\r
510 int bignum_bitcount(Bignum bn);\r
511 int ssh1_bignum_length(Bignum bn);\r
512 int ssh2_bignum_length(Bignum bn);\r
513 int bignum_byte(Bignum bn, int i);\r
514 int bignum_bit(Bignum bn, int i);\r
515 void bignum_set_bit(Bignum bn, int i, int value);\r
516 int ssh1_write_bignum(void *data, Bignum bn);\r
517 Bignum biggcd(Bignum a, Bignum b);\r
518 unsigned short bignum_mod_short(Bignum number, unsigned short modulus);\r
519 Bignum bignum_add_long(Bignum number, unsigned long addend);\r
520 Bignum bigadd(Bignum a, Bignum b);\r
521 Bignum bigsub(Bignum a, Bignum b);\r
522 Bignum bigmul(Bignum a, Bignum b);\r
523 Bignum bigmuladd(Bignum a, Bignum b, Bignum addend);\r
524 Bignum bigdiv(Bignum a, Bignum b);\r
525 Bignum bigmod(Bignum a, Bignum b);\r
526 Bignum modinv(Bignum number, Bignum modulus);\r
527 Bignum bignum_bitmask(Bignum number);\r
528 Bignum bignum_rshift(Bignum number, int shift);\r
529 int bignum_cmp(Bignum a, Bignum b);\r
530 char *bignum_decimal(Bignum x);\r
532 #ifdef DEBUG\r
533 void diagbn(char *prefix, Bignum md);\r
534 #endif\r
536 void *dh_setup_group(const struct ssh_kex *kex);\r
537 void *dh_setup_gex(Bignum pval, Bignum gval);\r
538 void dh_cleanup(void *);\r
539 Bignum dh_create_e(void *, int nbits);\r
540 const char *dh_validate_f(void *handle, Bignum f);\r
541 Bignum dh_find_K(void *, Bignum f);\r
543 int loadrsakey(const Filename *filename, struct RSAKey *key,\r
544                char *passphrase, const char **errorstr);\r
545 int rsakey_encrypted(const Filename *filename, char **comment);\r
546 int rsakey_pubblob(const Filename *filename, void **blob, int *bloblen,\r
547                    char **commentptr, const char **errorstr);\r
549 int saversakey(const Filename *filename, struct RSAKey *key, char *passphrase);\r
551 extern int base64_decode_atom(char *atom, unsigned char *out);\r
552 extern int base64_lines(int datalen);\r
553 extern void base64_encode_atom(unsigned char *data, int n, char *out);\r
554 extern void base64_encode(FILE *fp, unsigned char *data, int datalen, int cpl);\r
556 /* ssh2_load_userkey can return this as an error */\r
557 extern struct ssh2_userkey ssh2_wrong_passphrase;\r
558 #define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)\r
560 int ssh2_userkey_encrypted(const Filename *filename, char **comment);\r
561 struct ssh2_userkey *ssh2_load_userkey(const Filename *filename,\r
562                                        char *passphrase, const char **errorstr);\r
563 unsigned char *ssh2_userkey_loadpub(const Filename *filename, char **algorithm,\r
564                                     int *pub_blob_len, char **commentptr,\r
565                                     const char **errorstr);\r
566 int ssh2_save_userkey(const Filename *filename, struct ssh2_userkey *key,\r
567                       char *passphrase);\r
568 const struct ssh_signkey *find_pubkey_alg(const char *name);\r
570 enum {\r
571     SSH_KEYTYPE_UNOPENABLE,\r
572     SSH_KEYTYPE_UNKNOWN,\r
573     SSH_KEYTYPE_SSH1, SSH_KEYTYPE_SSH2,\r
574     SSH_KEYTYPE_OPENSSH, SSH_KEYTYPE_SSHCOM\r
575 };\r
576 int key_type(const Filename *filename);\r
577 char *key_type_to_str(int type);\r
579 int import_possible(int type);\r
580 int import_target_type(int type);\r
581 int import_encrypted(const Filename *filename, int type, char **comment);\r
582 int import_ssh1(const Filename *filename, int type,\r
583                 struct RSAKey *key, char *passphrase, const char **errmsg_p);\r
584 struct ssh2_userkey *import_ssh2(const Filename *filename, int type,\r
585                                  char *passphrase, const char **errmsg_p);\r
586 int export_ssh1(const Filename *filename, int type,\r
587                 struct RSAKey *key, char *passphrase);\r
588 int export_ssh2(const Filename *filename, int type,\r
589                 struct ssh2_userkey *key, char *passphrase);\r
591 void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);\r
592 void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);\r
593 void des3_decrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,\r
594                               unsigned char *blk, int len);\r
595 void des3_encrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,\r
596                               unsigned char *blk, int len);\r
597 void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk,\r
598                            int len);\r
599 void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk,\r
600                            int len);\r
602 void des_encrypt_xdmauth(const unsigned char *key,\r
603                          unsigned char *blk, int len);\r
604 void des_decrypt_xdmauth(const unsigned char *key,\r
605                          unsigned char *blk, int len);\r
607 /*\r
608  * For progress updates in the key generation utility.\r
609  */\r
610 #define PROGFN_INITIALISE 1\r
611 #define PROGFN_LIN_PHASE 2\r
612 #define PROGFN_EXP_PHASE 3\r
613 #define PROGFN_PHASE_EXTENT 4\r
614 #define PROGFN_READY 5\r
615 #define PROGFN_PROGRESS 6\r
616 typedef void (*progfn_t) (void *param, int action, int phase, int progress);\r
618 int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn,\r
619                  void *pfnparam);\r
620 int dsa_generate(struct dss_key *key, int bits, progfn_t pfn,\r
621                  void *pfnparam);\r
622 Bignum primegen(int bits, int modulus, int residue, Bignum factor,\r
623                 int phase, progfn_t pfn, void *pfnparam, unsigned firstbits);\r
624 void invent_firstbits(unsigned *one, unsigned *two);\r
627 /*\r
628  * zlib compression.\r
629  */\r
630 void *zlib_compress_init(void);\r
631 void zlib_compress_cleanup(void *);\r
632 void *zlib_decompress_init(void);\r
633 void zlib_decompress_cleanup(void *);\r
634 int zlib_compress_block(void *, unsigned char *block, int len,\r
635                         unsigned char **outblock, int *outlen);\r
636 int zlib_decompress_block(void *, unsigned char *block, int len,\r
637                           unsigned char **outblock, int *outlen);\r
639 /*\r
640  * Connection-sharing API provided by platforms. This function must\r
641  * either:\r
642  *  - return SHARE_NONE and do nothing\r
643  *  - return SHARE_DOWNSTREAM and set *sock to a Socket connected to\r
644  *    downplug\r
645  *  - return SHARE_UPSTREAM and set *sock to a Socket connected to\r
646  *    upplug.\r
647  */\r
648 enum { SHARE_NONE, SHARE_DOWNSTREAM, SHARE_UPSTREAM };\r
649 int platform_ssh_share(const char *name, Conf *conf,\r
650                        Plug downplug, Plug upplug, Socket *sock,\r
651                        char **logtext, char **ds_err, char **us_err,\r
652                        int can_upstream, int can_downstream);\r
653 void platform_ssh_share_cleanup(const char *name);\r
655 /*\r
656  * SSH-1 message type codes.\r
657  */\r
658 #define SSH1_MSG_DISCONNECT                       1     /* 0x1 */\r
659 #define SSH1_SMSG_PUBLIC_KEY                      2     /* 0x2 */\r
660 #define SSH1_CMSG_SESSION_KEY                     3     /* 0x3 */\r
661 #define SSH1_CMSG_USER                            4     /* 0x4 */\r
662 #define SSH1_CMSG_AUTH_RSA                        6     /* 0x6 */\r
663 #define SSH1_SMSG_AUTH_RSA_CHALLENGE              7     /* 0x7 */\r
664 #define SSH1_CMSG_AUTH_RSA_RESPONSE               8     /* 0x8 */\r
665 #define SSH1_CMSG_AUTH_PASSWORD                   9     /* 0x9 */\r
666 #define SSH1_CMSG_REQUEST_PTY                     10    /* 0xa */\r
667 #define SSH1_CMSG_WINDOW_SIZE                     11    /* 0xb */\r
668 #define SSH1_CMSG_EXEC_SHELL                      12    /* 0xc */\r
669 #define SSH1_CMSG_EXEC_CMD                        13    /* 0xd */\r
670 #define SSH1_SMSG_SUCCESS                         14    /* 0xe */\r
671 #define SSH1_SMSG_FAILURE                         15    /* 0xf */\r
672 #define SSH1_CMSG_STDIN_DATA                      16    /* 0x10 */\r
673 #define SSH1_SMSG_STDOUT_DATA                     17    /* 0x11 */\r
674 #define SSH1_SMSG_STDERR_DATA                     18    /* 0x12 */\r
675 #define SSH1_CMSG_EOF                             19    /* 0x13 */\r
676 #define SSH1_SMSG_EXIT_STATUS                     20    /* 0x14 */\r
677 #define SSH1_MSG_CHANNEL_OPEN_CONFIRMATION        21    /* 0x15 */\r
678 #define SSH1_MSG_CHANNEL_OPEN_FAILURE             22    /* 0x16 */\r
679 #define SSH1_MSG_CHANNEL_DATA                     23    /* 0x17 */\r
680 #define SSH1_MSG_CHANNEL_CLOSE                    24    /* 0x18 */\r
681 #define SSH1_MSG_CHANNEL_CLOSE_CONFIRMATION       25    /* 0x19 */\r
682 #define SSH1_SMSG_X11_OPEN                        27    /* 0x1b */\r
683 #define SSH1_CMSG_PORT_FORWARD_REQUEST            28    /* 0x1c */\r
684 #define SSH1_MSG_PORT_OPEN                        29    /* 0x1d */\r
685 #define SSH1_CMSG_AGENT_REQUEST_FORWARDING        30    /* 0x1e */\r
686 #define SSH1_SMSG_AGENT_OPEN                      31    /* 0x1f */\r
687 #define SSH1_MSG_IGNORE                           32    /* 0x20 */\r
688 #define SSH1_CMSG_EXIT_CONFIRMATION               33    /* 0x21 */\r
689 #define SSH1_CMSG_X11_REQUEST_FORWARDING          34    /* 0x22 */\r
690 #define SSH1_CMSG_AUTH_RHOSTS_RSA                 35    /* 0x23 */\r
691 #define SSH1_MSG_DEBUG                            36    /* 0x24 */\r
692 #define SSH1_CMSG_REQUEST_COMPRESSION             37    /* 0x25 */\r
693 #define SSH1_CMSG_AUTH_TIS                        39    /* 0x27 */\r
694 #define SSH1_SMSG_AUTH_TIS_CHALLENGE              40    /* 0x28 */\r
695 #define SSH1_CMSG_AUTH_TIS_RESPONSE               41    /* 0x29 */\r
696 #define SSH1_CMSG_AUTH_CCARD                      70    /* 0x46 */\r
697 #define SSH1_SMSG_AUTH_CCARD_CHALLENGE            71    /* 0x47 */\r
698 #define SSH1_CMSG_AUTH_CCARD_RESPONSE             72    /* 0x48 */\r
700 #define SSH1_AUTH_RHOSTS                          1     /* 0x1 */\r
701 #define SSH1_AUTH_RSA                             2     /* 0x2 */\r
702 #define SSH1_AUTH_PASSWORD                        3     /* 0x3 */\r
703 #define SSH1_AUTH_RHOSTS_RSA                      4     /* 0x4 */\r
704 #define SSH1_AUTH_TIS                             5     /* 0x5 */\r
705 #define SSH1_AUTH_CCARD                           16    /* 0x10 */\r
707 #define SSH1_PROTOFLAG_SCREEN_NUMBER              1     /* 0x1 */\r
708 /* Mask for protoflags we will echo back to server if seen */\r
709 #define SSH1_PROTOFLAGS_SUPPORTED                 0     /* 0x1 */\r
711 /*\r
712  * SSH-2 message type codes.\r
713  */\r
714 #define SSH2_MSG_DISCONNECT                       1     /* 0x1 */\r
715 #define SSH2_MSG_IGNORE                           2     /* 0x2 */\r
716 #define SSH2_MSG_UNIMPLEMENTED                    3     /* 0x3 */\r
717 #define SSH2_MSG_DEBUG                            4     /* 0x4 */\r
718 #define SSH2_MSG_SERVICE_REQUEST                  5     /* 0x5 */\r
719 #define SSH2_MSG_SERVICE_ACCEPT                   6     /* 0x6 */\r
720 #define SSH2_MSG_KEXINIT                          20    /* 0x14 */\r
721 #define SSH2_MSG_NEWKEYS                          21    /* 0x15 */\r
722 #define SSH2_MSG_KEXDH_INIT                       30    /* 0x1e */\r
723 #define SSH2_MSG_KEXDH_REPLY                      31    /* 0x1f */\r
724 #define SSH2_MSG_KEX_DH_GEX_REQUEST_OLD           30    /* 0x1e */\r
725 #define SSH2_MSG_KEX_DH_GEX_REQUEST               34    /* 0x22 */\r
726 #define SSH2_MSG_KEX_DH_GEX_GROUP                 31    /* 0x1f */\r
727 #define SSH2_MSG_KEX_DH_GEX_INIT                  32    /* 0x20 */\r
728 #define SSH2_MSG_KEX_DH_GEX_REPLY                 33    /* 0x21 */\r
729 #define SSH2_MSG_KEXRSA_PUBKEY                    30    /* 0x1e */\r
730 #define SSH2_MSG_KEXRSA_SECRET                    31    /* 0x1f */\r
731 #define SSH2_MSG_KEXRSA_DONE                      32    /* 0x20 */\r
732 #define SSH2_MSG_USERAUTH_REQUEST                 50    /* 0x32 */\r
733 #define SSH2_MSG_USERAUTH_FAILURE                 51    /* 0x33 */\r
734 #define SSH2_MSG_USERAUTH_SUCCESS                 52    /* 0x34 */\r
735 #define SSH2_MSG_USERAUTH_BANNER                  53    /* 0x35 */\r
736 #define SSH2_MSG_USERAUTH_PK_OK                   60    /* 0x3c */\r
737 #define SSH2_MSG_USERAUTH_PASSWD_CHANGEREQ        60    /* 0x3c */\r
738 #define SSH2_MSG_USERAUTH_INFO_REQUEST            60    /* 0x3c */\r
739 #define SSH2_MSG_USERAUTH_INFO_RESPONSE           61    /* 0x3d */\r
740 #define SSH2_MSG_GLOBAL_REQUEST                   80    /* 0x50 */\r
741 #define SSH2_MSG_REQUEST_SUCCESS                  81    /* 0x51 */\r
742 #define SSH2_MSG_REQUEST_FAILURE                  82    /* 0x52 */\r
743 #define SSH2_MSG_CHANNEL_OPEN                     90    /* 0x5a */\r
744 #define SSH2_MSG_CHANNEL_OPEN_CONFIRMATION        91    /* 0x5b */\r
745 #define SSH2_MSG_CHANNEL_OPEN_FAILURE             92    /* 0x5c */\r
746 #define SSH2_MSG_CHANNEL_WINDOW_ADJUST            93    /* 0x5d */\r
747 #define SSH2_MSG_CHANNEL_DATA                     94    /* 0x5e */\r
748 #define SSH2_MSG_CHANNEL_EXTENDED_DATA            95    /* 0x5f */\r
749 #define SSH2_MSG_CHANNEL_EOF                      96    /* 0x60 */\r
750 #define SSH2_MSG_CHANNEL_CLOSE                    97    /* 0x61 */\r
751 #define SSH2_MSG_CHANNEL_REQUEST                  98    /* 0x62 */\r
752 #define SSH2_MSG_CHANNEL_SUCCESS                  99    /* 0x63 */\r
753 #define SSH2_MSG_CHANNEL_FAILURE                  100   /* 0x64 */\r
754 #define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE               60\r
755 #define SSH2_MSG_USERAUTH_GSSAPI_TOKEN                  61\r
756 #define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE      63\r
757 #define SSH2_MSG_USERAUTH_GSSAPI_ERROR                  64\r
758 #define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK                 65\r
759 #define SSH2_MSG_USERAUTH_GSSAPI_MIC                    66\r
761 /*\r
762  * SSH-1 agent messages.\r
763  */\r
764 #define SSH1_AGENTC_REQUEST_RSA_IDENTITIES    1\r
765 #define SSH1_AGENT_RSA_IDENTITIES_ANSWER      2\r
766 #define SSH1_AGENTC_RSA_CHALLENGE             3\r
767 #define SSH1_AGENT_RSA_RESPONSE               4\r
768 #define SSH1_AGENTC_ADD_RSA_IDENTITY          7\r
769 #define SSH1_AGENTC_REMOVE_RSA_IDENTITY       8\r
770 #define SSH1_AGENTC_REMOVE_ALL_RSA_IDENTITIES 9 /* openssh private? */\r
772 /*\r
773  * Messages common to SSH-1 and OpenSSH's SSH-2.\r
774  */\r
775 #define SSH_AGENT_FAILURE                    5\r
776 #define SSH_AGENT_SUCCESS                    6\r
778 /*\r
779  * OpenSSH's SSH-2 agent messages.\r
780  */\r
781 #define SSH2_AGENTC_REQUEST_IDENTITIES          11\r
782 #define SSH2_AGENT_IDENTITIES_ANSWER            12\r
783 #define SSH2_AGENTC_SIGN_REQUEST                13\r
784 #define SSH2_AGENT_SIGN_RESPONSE                14\r
785 #define SSH2_AGENTC_ADD_IDENTITY                17\r
786 #define SSH2_AGENTC_REMOVE_IDENTITY             18\r
787 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES       19\r
789 /*\r
790  * Assorted other SSH-related enumerations.\r
791  */\r
792 #define SSH2_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT 1   /* 0x1 */\r
793 #define SSH2_DISCONNECT_PROTOCOL_ERROR            2     /* 0x2 */\r
794 #define SSH2_DISCONNECT_KEY_EXCHANGE_FAILED       3     /* 0x3 */\r
795 #define SSH2_DISCONNECT_HOST_AUTHENTICATION_FAILED 4    /* 0x4 */\r
796 #define SSH2_DISCONNECT_MAC_ERROR                 5     /* 0x5 */\r
797 #define SSH2_DISCONNECT_COMPRESSION_ERROR         6     /* 0x6 */\r
798 #define SSH2_DISCONNECT_SERVICE_NOT_AVAILABLE     7     /* 0x7 */\r
799 #define SSH2_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED 8        /* 0x8 */\r
800 #define SSH2_DISCONNECT_HOST_KEY_NOT_VERIFIABLE   9     /* 0x9 */\r
801 #define SSH2_DISCONNECT_CONNECTION_LOST           10    /* 0xa */\r
802 #define SSH2_DISCONNECT_BY_APPLICATION            11    /* 0xb */\r
803 #define SSH2_DISCONNECT_TOO_MANY_CONNECTIONS      12    /* 0xc */\r
804 #define SSH2_DISCONNECT_AUTH_CANCELLED_BY_USER    13    /* 0xd */\r
805 #define SSH2_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE 14       /* 0xe */\r
806 #define SSH2_DISCONNECT_ILLEGAL_USER_NAME         15    /* 0xf */\r
808 #define SSH2_OPEN_ADMINISTRATIVELY_PROHIBITED     1     /* 0x1 */\r
809 #define SSH2_OPEN_CONNECT_FAILED                  2     /* 0x2 */\r
810 #define SSH2_OPEN_UNKNOWN_CHANNEL_TYPE            3     /* 0x3 */\r
811 #define SSH2_OPEN_RESOURCE_SHORTAGE               4     /* 0x4 */\r
813 #define SSH2_EXTENDED_DATA_STDERR                 1     /* 0x1 */\r
815 /*\r
816  * Need this to warn about support for the original SSH-2 keyfile\r
817  * format.\r
818  */\r
819 void old_keyfile_warning(void);\r