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