]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - ssh.h
Giant const-correctness patch of doom!
[PuTTY.git] / ssh.h
1 #include <stdio.h>
2 #include <string.h>
3
4 #include "puttymem.h"
5 #include "tree234.h"
6 #include "network.h"
7 #include "int64.h"
8 #include "misc.h"
9
10 struct ssh_channel;
11 typedef struct ssh_tag *Ssh;
12
13 extern int sshfwd_write(struct ssh_channel *c, char *, int);
14 extern void sshfwd_write_eof(struct ssh_channel *c);
15 extern void sshfwd_unclean_close(struct ssh_channel *c, const char *err);
16 extern void sshfwd_unthrottle(struct ssh_channel *c, int bufsize);
17 Conf *sshfwd_get_conf(struct ssh_channel *c);
18 void sshfwd_x11_sharing_handover(struct ssh_channel *c,
19                                  void *share_cs, void *share_chan,
20                                  const char *peer_addr, int peer_port,
21                                  int endian, int protomajor, int protominor,
22                                  const void *initial_data, int initial_len);
23 void sshfwd_x11_is_local(struct ssh_channel *c);
24
25 extern Socket ssh_connection_sharing_init(const char *host, int port,
26                                           Conf *conf, Ssh ssh, void **state);
27 void share_got_pkt_from_server(void *ctx, int type,
28                                unsigned char *pkt, int pktlen);
29 void share_activate(void *state, const char *server_verstring);
30 void sharestate_free(void *state);
31 int share_ndownstreams(void *state);
32
33 void ssh_connshare_log(Ssh ssh, int event, const char *logtext,
34                        const char *ds_err, const char *us_err);
35 unsigned ssh_alloc_sharing_channel(Ssh ssh, void *sharing_ctx);
36 void ssh_delete_sharing_channel(Ssh ssh, unsigned localid);
37 int ssh_alloc_sharing_rportfwd(Ssh ssh, const char *shost, int sport,
38                                void *share_ctx);
39 void ssh_sharing_queue_global_request(Ssh ssh, void *share_ctx);
40 struct X11FakeAuth *ssh_sharing_add_x11_display(Ssh ssh, int authtype,
41                                                 void *share_cs,
42                                                 void *share_chan);
43 void ssh_sharing_remove_x11_display(Ssh ssh, struct X11FakeAuth *auth);
44 void ssh_send_packet_from_downstream(Ssh ssh, unsigned id, int type,
45                                      const void *pkt, int pktlen,
46                                      const char *additional_log_text);
47 void ssh_sharing_downstream_connected(Ssh ssh, unsigned id);
48 void ssh_sharing_downstream_disconnected(Ssh ssh, unsigned id);
49 void ssh_sharing_logf(Ssh ssh, unsigned id, const char *logfmt, ...);
50 int ssh_agent_forwarding_permitted(Ssh ssh);
51 void share_setup_x11_channel(void *csv, void *chanv,
52                              unsigned upstream_id, unsigned server_id,
53                              unsigned server_currwin, unsigned server_maxpkt,
54                              unsigned client_adjusted_window,
55                              const char *peer_addr, int peer_port, int endian,
56                              int protomajor, int protominor,
57                              const void *initial_data, int initial_len);
58
59 /*
60  * Useful thing.
61  */
62 #ifndef lenof
63 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
64 #endif
65
66 #define SSH_CIPHER_IDEA         1
67 #define SSH_CIPHER_DES          2
68 #define SSH_CIPHER_3DES         3
69 #define SSH_CIPHER_BLOWFISH     6
70
71 #ifdef MSCRYPTOAPI
72 #define APIEXTRA 8
73 #else
74 #define APIEXTRA 0
75 #endif
76
77 #ifndef BIGNUM_INTERNAL
78 typedef void *Bignum;
79 #endif
80
81 struct RSAKey {
82     int bits;
83     int bytes;
84 #ifdef MSCRYPTOAPI
85     unsigned long exponent;
86     unsigned char *modulus;
87 #else
88     Bignum modulus;
89     Bignum exponent;
90     Bignum private_exponent;
91     Bignum p;
92     Bignum q;
93     Bignum iqmp;
94 #endif
95     char *comment;
96 };
97
98 struct dss_key {
99     Bignum p, q, g, y, x;
100 };
101
102 struct ec_curve;
103
104 struct ec_point {
105     const struct ec_curve *curve;
106     Bignum x, y;
107     Bignum z;  /* Jacobian denominator */
108     unsigned char infinity;
109 };
110
111 void ec_point_free(struct ec_point *point);
112
113 /* Weierstrass form curve */
114 struct ec_wcurve
115 {
116     Bignum a, b, n;
117     struct ec_point G;
118 };
119
120 /* Montgomery form curve */
121 struct ec_mcurve
122 {
123     Bignum a, b;
124     struct ec_point G;
125 };
126
127 /* Edwards form curve */
128 struct ec_ecurve
129 {
130     Bignum l, d;
131     struct ec_point B;
132 };
133
134 struct ec_curve {
135     enum { EC_WEIERSTRASS, EC_MONTGOMERY, EC_EDWARDS } type;
136     const char *name;
137     unsigned int fieldBits;
138     Bignum p;
139     union {
140         struct ec_wcurve w;
141         struct ec_mcurve m;
142         struct ec_ecurve e;
143     };
144 };
145
146 const struct ssh_signkey *ec_alg_by_oid(int len, const void *oid,
147                                         const struct ec_curve **curve);
148 const unsigned char *ec_alg_oid(const struct ssh_signkey *alg, int *oidlen);
149 const int ec_nist_alg_and_curve_by_bits(int bits,
150                                         const struct ec_curve **curve,
151                                         const struct ssh_signkey **alg);
152 const int ec_ed_alg_and_curve_by_bits(int bits,
153                                       const struct ec_curve **curve,
154                                       const struct ssh_signkey **alg);
155
156 struct ssh_signkey;
157
158 struct ec_key {
159     const struct ssh_signkey *signalg;
160     struct ec_point publicKey;
161     Bignum privateKey;
162 };
163
164 struct ec_point *ec_public(const Bignum privateKey, const struct ec_curve *curve);
165
166 int makekey(const unsigned char *data, int len, struct RSAKey *result,
167             const unsigned char **keystr, int order);
168 int makeprivate(const unsigned char *data, int len, struct RSAKey *result);
169 int rsaencrypt(unsigned char *data, int length, struct RSAKey *key);
170 Bignum rsadecrypt(Bignum input, struct RSAKey *key);
171 void rsasign(unsigned char *data, int length, struct RSAKey *key);
172 void rsasanitise(struct RSAKey *key);
173 int rsastr_len(struct RSAKey *key);
174 void rsastr_fmt(char *str, struct RSAKey *key);
175 void rsa_fingerprint(char *str, int len, struct RSAKey *key);
176 int rsa_verify(struct RSAKey *key);
177 unsigned char *rsa_public_blob(struct RSAKey *key, int *len);
178 int rsa_public_blob_len(void *data, int maxlen);
179 void freersakey(struct RSAKey *key);
180
181 #ifndef PUTTY_UINT32_DEFINED
182 /* This makes assumptions about the int type. */
183 typedef unsigned int uint32;
184 #define PUTTY_UINT32_DEFINED
185 #endif
186 typedef uint32 word32;
187
188 unsigned long crc32_compute(const void *s, size_t len);
189 unsigned long crc32_update(unsigned long crc_input, const void *s, size_t len);
190
191 /* SSH CRC compensation attack detector */
192 void *crcda_make_context(void);
193 void crcda_free_context(void *handle);
194 int detect_attack(void *handle, unsigned char *buf, uint32 len,
195                   unsigned char *IV);
196
197 /*
198  * SSH2 RSA key exchange functions
199  */
200 struct ssh_hash;
201 void *ssh_rsakex_newkey(char *data, int len);
202 void ssh_rsakex_freekey(void *key);
203 int ssh_rsakex_klen(void *key);
204 void ssh_rsakex_encrypt(const struct ssh_hash *h, unsigned char *in, int inlen,
205                         unsigned char *out, int outlen,
206                         void *key);
207
208 /*
209  * SSH2 ECDH key exchange functions
210  */
211 struct ssh_kex;
212 void *ssh_ecdhkex_newkey(const struct ssh_kex *kex);
213 void ssh_ecdhkex_freekey(void *key);
214 char *ssh_ecdhkex_getpublic(void *key, int *len);
215 Bignum ssh_ecdhkex_getkey(void *key, char *remoteKey, int remoteKeyLen);
216
217 /*
218  * Helper function for k generation in DSA, reused in ECDSA
219  */
220 Bignum *dss_gen_k(const char *id_string, Bignum modulus, Bignum private_key,
221                   unsigned char *digest, int digest_len);
222
223 typedef struct {
224     uint32 h[4];
225 } MD5_Core_State;
226
227 struct MD5Context {
228 #ifdef MSCRYPTOAPI
229     unsigned long hHash;
230 #else
231     MD5_Core_State core;
232     unsigned char block[64];
233     int blkused;
234     uint32 lenhi, lenlo;
235 #endif
236 };
237
238 void MD5Init(struct MD5Context *context);
239 void MD5Update(struct MD5Context *context, unsigned char const *buf,
240                unsigned len);
241 void MD5Final(unsigned char digest[16], struct MD5Context *context);
242 void MD5Simple(void const *p, unsigned len, unsigned char output[16]);
243
244 void *hmacmd5_make_context(void);
245 void hmacmd5_free_context(void *handle);
246 void hmacmd5_key(void *handle, void const *key, int len);
247 void hmacmd5_do_hmac(void *handle, unsigned char const *blk, int len,
248                      unsigned char *hmac);
249
250 typedef struct {
251     uint32 h[5];
252     unsigned char block[64];
253     int blkused;
254     uint32 lenhi, lenlo;
255 } SHA_State;
256 void SHA_Init(SHA_State * s);
257 void SHA_Bytes(SHA_State * s, const void *p, int len);
258 void SHA_Final(SHA_State * s, unsigned char *output);
259 void SHA_Simple(const void *p, int len, unsigned char *output);
260
261 void hmac_sha1_simple(void *key, int keylen, void *data, int datalen,
262                       unsigned char *output);
263 typedef struct {
264     uint32 h[8];
265     unsigned char block[64];
266     int blkused;
267     uint32 lenhi, lenlo;
268 } SHA256_State;
269 void SHA256_Init(SHA256_State * s);
270 void SHA256_Bytes(SHA256_State * s, const void *p, int len);
271 void SHA256_Final(SHA256_State * s, unsigned char *output);
272 void SHA256_Simple(const void *p, int len, unsigned char *output);
273
274 typedef struct {
275     uint64 h[8];
276     unsigned char block[128];
277     int blkused;
278     uint32 len[4];
279 } SHA512_State;
280 #define SHA384_State SHA512_State
281 void SHA512_Init(SHA512_State * s);
282 void SHA512_Bytes(SHA512_State * s, const void *p, int len);
283 void SHA512_Final(SHA512_State * s, unsigned char *output);
284 void SHA512_Simple(const void *p, int len, unsigned char *output);
285 void SHA384_Init(SHA384_State * s);
286 #define SHA384_Bytes(s, p, len) SHA512_Bytes(s, p, len)
287 void SHA384_Final(SHA384_State * s, unsigned char *output);
288 void SHA384_Simple(const void *p, int len, unsigned char *output);
289
290 struct ssh_cipher {
291     void *(*make_context)(void);
292     void (*free_context)(void *);
293     void (*sesskey) (void *, unsigned char *key);       /* for SSH-1 */
294     void (*encrypt) (void *, unsigned char *blk, int len);
295     void (*decrypt) (void *, unsigned char *blk, int len);
296     int blksize;
297     const char *text_name;
298 };
299
300 struct ssh2_cipher {
301     void *(*make_context)(void);
302     void (*free_context)(void *);
303     void (*setiv) (void *, unsigned char *key); /* for SSH-2 */
304     void (*setkey) (void *, unsigned char *key);/* for SSH-2 */
305     void (*encrypt) (void *, unsigned char *blk, int len);
306     void (*decrypt) (void *, unsigned char *blk, int len);
307     const char *name;
308     int blksize;
309     int keylen;
310     unsigned int flags;
311 #define SSH_CIPHER_IS_CBC       1
312     const char *text_name;
313 };
314
315 struct ssh2_ciphers {
316     int nciphers;
317     const struct ssh2_cipher *const *list;
318 };
319
320 struct ssh_mac {
321     void *(*make_context)(void);
322     void (*free_context)(void *);
323     void (*setkey) (void *, unsigned char *key);
324     /* whole-packet operations */
325     void (*generate) (void *, unsigned char *blk, int len, unsigned long seq);
326     int (*verify) (void *, unsigned char *blk, int len, unsigned long seq);
327     /* partial-packet operations */
328     void (*start) (void *);
329     void (*bytes) (void *, unsigned char const *, int);
330     void (*genresult) (void *, unsigned char *);
331     int (*verresult) (void *, unsigned char const *);
332     const char *name, *etm_name;
333     int len;
334     const char *text_name;
335 };
336
337 struct ssh_hash {
338     void *(*init)(void); /* also allocates context */
339     void (*bytes)(void *, const void *, int);
340     void (*final)(void *, unsigned char *); /* also frees context */
341     int hlen; /* output length in bytes */
342     const char *text_name;
343 };   
344
345 struct ssh_kex {
346     const char *name, *groupname;
347     enum { KEXTYPE_DH, KEXTYPE_RSA, KEXTYPE_ECDH } main_type;
348     const struct ssh_hash *hash;
349     const void *extra;                 /* private to the kex methods */
350 };
351
352 struct ssh_kexes {
353     int nkexes;
354     const struct ssh_kex *const *list;
355 };
356
357 struct ssh_signkey {
358     void *(*newkey) (const struct ssh_signkey *self,
359                      const char *data, int len);
360     void (*freekey) (void *key);
361     char *(*fmtkey) (void *key);
362     unsigned char *(*public_blob) (void *key, int *len);
363     unsigned char *(*private_blob) (void *key, int *len);
364     void *(*createkey) (const struct ssh_signkey *self,
365                         const unsigned char *pub_blob, int pub_len,
366                         const unsigned char *priv_blob, int priv_len);
367     void *(*openssh_createkey) (const struct ssh_signkey *self,
368                                 const unsigned char **blob, int *len);
369     int (*openssh_fmtkey) (void *key, unsigned char *blob, int len);
370     /* OpenSSH private key blobs, as created by openssh_fmtkey and
371      * consumed by openssh_createkey, always (at least so far...) take
372      * the form of a number of SSH-2 strings / mpints concatenated
373      * end-to-end. Because the new-style OpenSSH private key format
374      * stores those blobs without a containing string wrapper, we need
375      * to know how many strings each one consists of, so that we can
376      * skip over the right number to find the next key in the file.
377      * openssh_private_npieces gives that information. */
378     int openssh_private_npieces;
379     int (*pubkey_bits) (const struct ssh_signkey *self,
380                         const void *blob, int len);
381     int (*verifysig) (void *key, const char *sig, int siglen,
382                       const char *data, int datalen);
383     unsigned char *(*sign) (void *key, const char *data, int datalen,
384                             int *siglen);
385     const char *name;
386     const char *keytype;               /* for host key cache */
387     const void *extra;                 /* private to the public key methods */
388 };
389
390 struct ssh_compress {
391     const char *name;
392     /* For zlib@openssh.com: if non-NULL, this name will be considered once
393      * userauth has completed successfully. */
394     const char *delayed_name;
395     void *(*compress_init) (void);
396     void (*compress_cleanup) (void *);
397     int (*compress) (void *, unsigned char *block, int len,
398                      unsigned char **outblock, int *outlen);
399     void *(*decompress_init) (void);
400     void (*decompress_cleanup) (void *);
401     int (*decompress) (void *, unsigned char *block, int len,
402                        unsigned char **outblock, int *outlen);
403     int (*disable_compression) (void *);
404     const char *text_name;
405 };
406
407 struct ssh2_userkey {
408     const struct ssh_signkey *alg;     /* the key algorithm */
409     void *data;                        /* the key data */
410     char *comment;                     /* the key comment */
411 };
412
413 /* The maximum length of any hash algorithm used in kex. (bytes) */
414 #define SSH2_KEX_MAX_HASH_LEN (64) /* SHA-512 */
415
416 extern const struct ssh_cipher ssh_3des;
417 extern const struct ssh_cipher ssh_des;
418 extern const struct ssh_cipher ssh_blowfish_ssh1;
419 extern const struct ssh2_ciphers ssh2_3des;
420 extern const struct ssh2_ciphers ssh2_des;
421 extern const struct ssh2_ciphers ssh2_aes;
422 extern const struct ssh2_ciphers ssh2_blowfish;
423 extern const struct ssh2_ciphers ssh2_arcfour;
424 extern const struct ssh_hash ssh_sha1;
425 extern const struct ssh_hash ssh_sha256;
426 extern const struct ssh_hash ssh_sha384;
427 extern const struct ssh_hash ssh_sha512;
428 extern const struct ssh_kexes ssh_diffiehellman_group1;
429 extern const struct ssh_kexes ssh_diffiehellman_group14;
430 extern const struct ssh_kexes ssh_diffiehellman_gex;
431 extern const struct ssh_kexes ssh_rsa_kex;
432 extern const struct ssh_kexes ssh_ecdh_kex;
433 extern const struct ssh_signkey ssh_dss;
434 extern const struct ssh_signkey ssh_rsa;
435 extern const struct ssh_signkey ssh_ecdsa_ed25519;
436 extern const struct ssh_signkey ssh_ecdsa_nistp256;
437 extern const struct ssh_signkey ssh_ecdsa_nistp384;
438 extern const struct ssh_signkey ssh_ecdsa_nistp521;
439 extern const struct ssh_mac ssh_hmac_md5;
440 extern const struct ssh_mac ssh_hmac_sha1;
441 extern const struct ssh_mac ssh_hmac_sha1_buggy;
442 extern const struct ssh_mac ssh_hmac_sha1_96;
443 extern const struct ssh_mac ssh_hmac_sha1_96_buggy;
444 extern const struct ssh_mac ssh_hmac_sha256;
445
446 void *aes_make_context(void);
447 void aes_free_context(void *handle);
448 void aes128_key(void *handle, unsigned char *key);
449 void aes192_key(void *handle, unsigned char *key);
450 void aes256_key(void *handle, unsigned char *key);
451 void aes_iv(void *handle, unsigned char *iv);
452 void aes_ssh2_encrypt_blk(void *handle, unsigned char *blk, int len);
453 void aes_ssh2_decrypt_blk(void *handle, unsigned char *blk, int len);
454
455 /*
456  * PuTTY version number formatted as an SSH version string. 
457  */
458 extern char sshver[];
459
460 /*
461  * Gross hack: pscp will try to start SFTP but fall back to scp1 if
462  * that fails. This variable is the means by which scp.c can reach
463  * into the SSH code and find out which one it got.
464  */
465 extern int ssh_fallback_cmd(void *handle);
466
467 #ifndef MSCRYPTOAPI
468 void SHATransform(word32 * digest, word32 * data);
469 #endif
470
471 int random_byte(void);
472 void random_add_noise(void *noise, int length);
473 void random_add_heavynoise(void *noise, int length);
474
475 void logevent(void *, const char *);
476
477 struct PortForwarding;
478
479 /* Allocate and register a new channel for port forwarding */
480 void *new_sock_channel(void *handle, struct PortForwarding *pf);
481 void ssh_send_port_open(void *channel, const char *hostname, int port,
482                         const char *org);
483
484 /* Exports from portfwd.c */
485 extern char *pfd_connect(struct PortForwarding **pf, char *hostname, int port,
486                          void *c, Conf *conf, int addressfamily);
487 extern void pfd_close(struct PortForwarding *);
488 extern int pfd_send(struct PortForwarding *, char *data, int len);
489 extern void pfd_send_eof(struct PortForwarding *);
490 extern void pfd_confirm(struct PortForwarding *);
491 extern void pfd_unthrottle(struct PortForwarding *);
492 extern void pfd_override_throttle(struct PortForwarding *, int enable);
493 struct PortListener;
494 /* desthost == NULL indicates dynamic (SOCKS) port forwarding */
495 extern char *pfl_listen(char *desthost, int destport, char *srcaddr,
496                         int port, void *backhandle, Conf *conf,
497                         struct PortListener **pl, int address_family);
498 extern void pfl_terminate(struct PortListener *);
499
500 /* Exports from x11fwd.c */
501 enum {
502     X11_TRANS_IPV4 = 0, X11_TRANS_IPV6 = 6, X11_TRANS_UNIX = 256
503 };
504 struct X11Display {
505     /* Broken-down components of the display name itself */
506     int unixdomain;
507     char *hostname;
508     int displaynum;
509     int screennum;
510     /* OSX sometimes replaces all the above with a full Unix-socket pathname */
511     char *unixsocketpath;
512
513     /* PuTTY networking SockAddr to connect to the display, and associated
514      * gubbins */
515     SockAddr addr;
516     int port;
517     char *realhost;
518
519     /* Our local auth details for talking to the real X display. */
520     int localauthproto;
521     unsigned char *localauthdata;
522     int localauthdatalen;
523 };
524 struct X11FakeAuth {
525     /* Auth details we invented for a virtual display on the SSH server. */
526     int proto;
527     unsigned char *data;
528     int datalen;
529     char *protoname;
530     char *datastring;
531
532     /* The encrypted form of the first block, in XDM-AUTHORIZATION-1.
533      * Used as part of the key when these structures are organised
534      * into a tree. See x11_invent_fake_auth for explanation. */
535     unsigned char *xa1_firstblock;
536
537     /*
538      * Used inside x11fwd.c to remember recently seen
539      * XDM-AUTHORIZATION-1 strings, to avoid replay attacks.
540      */
541     tree234 *xdmseen;
542
543     /*
544      * What to do with an X connection matching this auth data.
545      */
546     struct X11Display *disp;
547     void *share_cs, *share_chan;
548 };
549 void *x11_make_greeting(int endian, int protomajor, int protominor,
550                         int auth_proto, const void *auth_data, int auth_len,
551                         const char *peer_ip, int peer_port,
552                         int *outlen);
553 int x11_authcmp(void *av, void *bv); /* for putting X11FakeAuth in a tree234 */
554 /*
555  * x11_setup_display() parses the display variable and fills in an
556  * X11Display structure. Some remote auth details are invented;
557  * the supplied authtype parameter configures the preferred
558  * authorisation protocol to use at the remote end. The local auth
559  * details are looked up by calling platform_get_x11_auth.
560  */
561 extern struct X11Display *x11_setup_display(const char *display, Conf *);
562 void x11_free_display(struct X11Display *disp);
563 struct X11FakeAuth *x11_invent_fake_auth(tree234 *t, int authtype);
564 void x11_free_fake_auth(struct X11FakeAuth *auth);
565 struct X11Connection;                  /* opaque outside x11fwd.c */
566 struct X11Connection *x11_init(tree234 *authtree, void *, const char *, int);
567 extern void x11_close(struct X11Connection *);
568 extern int x11_send(struct X11Connection *, char *, int);
569 extern void x11_send_eof(struct X11Connection *s);
570 extern void x11_unthrottle(struct X11Connection *s);
571 extern void x11_override_throttle(struct X11Connection *s, int enable);
572 char *x11_display(const char *display);
573 /* Platform-dependent X11 functions */
574 extern void platform_get_x11_auth(struct X11Display *display, Conf *);
575     /* examine a mostly-filled-in X11Display and fill in localauth* */
576 extern const int platform_uses_x11_unix_by_default;
577     /* choose default X transport in the absence of a specified one */
578 SockAddr platform_get_x11_unix_address(const char *path, int displaynum);
579     /* make up a SockAddr naming the address for displaynum */
580 char *platform_get_x_display(void);
581     /* allocated local X display string, if any */
582 /* Callbacks in x11.c usable _by_ platform X11 functions */
583 /*
584  * This function does the job of platform_get_x11_auth, provided
585  * it is told where to find a normally formatted .Xauthority file:
586  * it opens that file, parses it to find an auth record which
587  * matches the display details in "display", and fills in the
588  * localauth fields.
589  *
590  * It is expected that most implementations of
591  * platform_get_x11_auth() will work by finding their system's
592  * .Xauthority file, adjusting the display details if necessary
593  * for local oddities like Unix-domain socket transport, and
594  * calling this function to do the rest of the work.
595  */
596 void x11_get_auth_from_authfile(struct X11Display *display,
597                                 const char *authfilename);
598 int x11_identify_auth_proto(const char *proto);
599 void *x11_dehexify(const char *hex, int *outlen);
600
601 Bignum copybn(Bignum b);
602 Bignum bn_power_2(int n);
603 void bn_restore_invariant(Bignum b);
604 Bignum bignum_from_long(unsigned long n);
605 void freebn(Bignum b);
606 Bignum modpow(Bignum base, Bignum exp, Bignum mod);
607 Bignum modmul(Bignum a, Bignum b, Bignum mod);
608 Bignum modsub(const Bignum a, const Bignum b, const Bignum n);
609 void decbn(Bignum n);
610 extern Bignum Zero, One;
611 Bignum bignum_from_bytes(const unsigned char *data, int nbytes);
612 Bignum bignum_from_bytes_le(const unsigned char *data, int nbytes);
613 Bignum bignum_random_in_range(const Bignum lower, const Bignum upper);
614 int ssh1_read_bignum(const unsigned char *data, int len, Bignum * result);
615 int bignum_bitcount(Bignum bn);
616 int ssh1_bignum_length(Bignum bn);
617 int ssh2_bignum_length(Bignum bn);
618 int bignum_byte(Bignum bn, int i);
619 int bignum_bit(Bignum bn, int i);
620 void bignum_set_bit(Bignum bn, int i, int value);
621 int ssh1_write_bignum(void *data, Bignum bn);
622 Bignum biggcd(Bignum a, Bignum b);
623 unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
624 Bignum bignum_add_long(Bignum number, unsigned long addend);
625 Bignum bigadd(Bignum a, Bignum b);
626 Bignum bigsub(Bignum a, Bignum b);
627 Bignum bigmul(Bignum a, Bignum b);
628 Bignum bigmuladd(Bignum a, Bignum b, Bignum addend);
629 Bignum bigdiv(Bignum a, Bignum b);
630 Bignum bigmod(Bignum a, Bignum b);
631 Bignum modinv(Bignum number, Bignum modulus);
632 Bignum bignum_bitmask(Bignum number);
633 Bignum bignum_rshift(Bignum number, int shift);
634 Bignum bignum_lshift(Bignum number, int shift);
635 int bignum_cmp(Bignum a, Bignum b);
636 char *bignum_decimal(Bignum x);
637 Bignum bignum_from_decimal(const char *decimal);
638
639 #ifdef DEBUG
640 void diagbn(char *prefix, Bignum md);
641 #endif
642
643 int dh_is_gex(const struct ssh_kex *kex);
644 void *dh_setup_group(const struct ssh_kex *kex);
645 void *dh_setup_gex(Bignum pval, Bignum gval);
646 void dh_cleanup(void *);
647 Bignum dh_create_e(void *, int nbits);
648 const char *dh_validate_f(void *handle, Bignum f);
649 Bignum dh_find_K(void *, Bignum f);
650
651 int loadrsakey(const Filename *filename, struct RSAKey *key,
652                const char *passphrase, const char **errorstr);
653 int rsakey_encrypted(const Filename *filename, char **comment);
654 int rsakey_pubblob(const Filename *filename, void **blob, int *bloblen,
655                    char **commentptr, const char **errorstr);
656
657 int saversakey(const Filename *filename, struct RSAKey *key, char *passphrase);
658
659 extern int base64_decode_atom(const char *atom, unsigned char *out);
660 extern int base64_lines(int datalen);
661 extern void base64_encode_atom(const unsigned char *data, int n, char *out);
662 extern void base64_encode(FILE *fp, const unsigned char *data, int datalen,
663                           int cpl);
664
665 /* ssh2_load_userkey can return this as an error */
666 extern struct ssh2_userkey ssh2_wrong_passphrase;
667 #define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)
668
669 int ssh2_userkey_encrypted(const Filename *filename, char **comment);
670 struct ssh2_userkey *ssh2_load_userkey(const Filename *filename,
671                                        const char *passphrase,
672                                        const char **errorstr);
673 unsigned char *ssh2_userkey_loadpub(const Filename *filename, char **algorithm,
674                                     int *pub_blob_len, char **commentptr,
675                                     const char **errorstr);
676 int ssh2_save_userkey(const Filename *filename, struct ssh2_userkey *key,
677                       char *passphrase);
678 const struct ssh_signkey *find_pubkey_alg(const char *name);
679 const struct ssh_signkey *find_pubkey_alg_len(int namelen, const char *name);
680
681 enum {
682     SSH_KEYTYPE_UNOPENABLE,
683     SSH_KEYTYPE_UNKNOWN,
684     SSH_KEYTYPE_SSH1, SSH_KEYTYPE_SSH2,
685     /*
686      * The OpenSSH key types deserve a little explanation. OpenSSH has
687      * two physical formats for private key storage: an old PEM-based
688      * one largely dictated by their use of OpenSSL and full of ASN.1,
689      * and a new one using the same private key formats used over the
690      * wire for talking to ssh-agent. The old format can only support
691      * a subset of the key types, because it needs redesign for each
692      * key type, and after a while they decided to move to the new
693      * format so as not to have to do that.
694      *
695      * On input, key files are identified as either
696      * SSH_KEYTYPE_OPENSSH_PEM or SSH_KEYTYPE_OPENSSH_NEW, describing
697      * accurately which actual format the keys are stored in.
698      *
699      * On output, however, we default to following OpenSSH's own
700      * policy of writing out PEM-style keys for maximum backwards
701      * compatibility if the key type supports it, and otherwise
702      * switching to the new format. So the formats you can select for
703      * output are SSH_KEYTYPE_OPENSSH_NEW (forcing the new format for
704      * any key type), and SSH_KEYTYPE_OPENSSH_AUTO to use the oldest
705      * format supported by whatever key type you're writing out.
706      *
707      * So we have three type codes, but only two of them usable in any
708      * given circumstance. An input key file will never be identified
709      * as AUTO, only PEM or NEW; key export UIs should not be able to
710      * select PEM, only AUTO or NEW.
711      */
712     SSH_KEYTYPE_OPENSSH_AUTO,
713     SSH_KEYTYPE_OPENSSH_PEM,
714     SSH_KEYTYPE_OPENSSH_NEW,
715     SSH_KEYTYPE_SSHCOM,
716     /*
717      * Public-key-only formats, which we still want to be able to read
718      * for various purposes.
719      */
720     SSH_KEYTYPE_SSH1_PUBLIC,
721     SSH_KEYTYPE_SSH2_PUBLIC_RFC4716,
722     SSH_KEYTYPE_SSH2_PUBLIC_OPENSSH
723 };
724 char *ssh1_pubkey_str(struct RSAKey *ssh1key);
725 void ssh1_write_pubkey(FILE *fp, struct RSAKey *ssh1key);
726 char *ssh2_pubkey_openssh_str(struct ssh2_userkey *key);
727 void ssh2_write_pubkey(FILE *fp, const char *comment,
728                        const void *v_pub_blob, int pub_len,
729                        int keytype);
730 char *ssh2_fingerprint_blob(const void *blob, int bloblen);
731 char *ssh2_fingerprint(const struct ssh_signkey *alg, void *data);
732 int key_type(const Filename *filename);
733 const char *key_type_to_str(int type);
734
735 int import_possible(int type);
736 int import_target_type(int type);
737 int import_encrypted(const Filename *filename, int type, char **comment);
738 int import_ssh1(const Filename *filename, int type,
739                 struct RSAKey *key, char *passphrase, const char **errmsg_p);
740 struct ssh2_userkey *import_ssh2(const Filename *filename, int type,
741                                  char *passphrase, const char **errmsg_p);
742 int export_ssh1(const Filename *filename, int type,
743                 struct RSAKey *key, char *passphrase);
744 int export_ssh2(const Filename *filename, int type,
745                 struct ssh2_userkey *key, char *passphrase);
746
747 void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
748 void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
749 void des3_decrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
750                               unsigned char *blk, int len);
751 void des3_encrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
752                               unsigned char *blk, int len);
753 void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk,
754                            int len);
755 void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk,
756                            int len);
757
758 void des_encrypt_xdmauth(const unsigned char *key,
759                          unsigned char *blk, int len);
760 void des_decrypt_xdmauth(const unsigned char *key,
761                          unsigned char *blk, int len);
762
763 void openssh_bcrypt(const char *passphrase,
764                     const unsigned char *salt, int saltbytes,
765                     int rounds, unsigned char *out, int outbytes);
766
767 /*
768  * For progress updates in the key generation utility.
769  */
770 #define PROGFN_INITIALISE 1
771 #define PROGFN_LIN_PHASE 2
772 #define PROGFN_EXP_PHASE 3
773 #define PROGFN_PHASE_EXTENT 4
774 #define PROGFN_READY 5
775 #define PROGFN_PROGRESS 6
776 typedef void (*progfn_t) (void *param, int action, int phase, int progress);
777
778 int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn,
779                  void *pfnparam);
780 int dsa_generate(struct dss_key *key, int bits, progfn_t pfn,
781                  void *pfnparam);
782 int ec_generate(struct ec_key *key, int bits, progfn_t pfn,
783                 void *pfnparam);
784 int ec_edgenerate(struct ec_key *key, int bits, progfn_t pfn,
785                   void *pfnparam);
786 Bignum primegen(int bits, int modulus, int residue, Bignum factor,
787                 int phase, progfn_t pfn, void *pfnparam, unsigned firstbits);
788 void invent_firstbits(unsigned *one, unsigned *two);
789
790
791 /*
792  * zlib compression.
793  */
794 void *zlib_compress_init(void);
795 void zlib_compress_cleanup(void *);
796 void *zlib_decompress_init(void);
797 void zlib_decompress_cleanup(void *);
798 int zlib_compress_block(void *, unsigned char *block, int len,
799                         unsigned char **outblock, int *outlen);
800 int zlib_decompress_block(void *, unsigned char *block, int len,
801                           unsigned char **outblock, int *outlen);
802
803 /*
804  * Connection-sharing API provided by platforms. This function must
805  * either:
806  *  - return SHARE_NONE and do nothing
807  *  - return SHARE_DOWNSTREAM and set *sock to a Socket connected to
808  *    downplug
809  *  - return SHARE_UPSTREAM and set *sock to a Socket connected to
810  *    upplug.
811  */
812 enum { SHARE_NONE, SHARE_DOWNSTREAM, SHARE_UPSTREAM };
813 int platform_ssh_share(const char *name, Conf *conf,
814                        Plug downplug, Plug upplug, Socket *sock,
815                        char **logtext, char **ds_err, char **us_err,
816                        int can_upstream, int can_downstream);
817 void platform_ssh_share_cleanup(const char *name);
818
819 /*
820  * SSH-1 message type codes.
821  */
822 #define SSH1_MSG_DISCONNECT                       1     /* 0x1 */
823 #define SSH1_SMSG_PUBLIC_KEY                      2     /* 0x2 */
824 #define SSH1_CMSG_SESSION_KEY                     3     /* 0x3 */
825 #define SSH1_CMSG_USER                            4     /* 0x4 */
826 #define SSH1_CMSG_AUTH_RSA                        6     /* 0x6 */
827 #define SSH1_SMSG_AUTH_RSA_CHALLENGE              7     /* 0x7 */
828 #define SSH1_CMSG_AUTH_RSA_RESPONSE               8     /* 0x8 */
829 #define SSH1_CMSG_AUTH_PASSWORD                   9     /* 0x9 */
830 #define SSH1_CMSG_REQUEST_PTY                     10    /* 0xa */
831 #define SSH1_CMSG_WINDOW_SIZE                     11    /* 0xb */
832 #define SSH1_CMSG_EXEC_SHELL                      12    /* 0xc */
833 #define SSH1_CMSG_EXEC_CMD                        13    /* 0xd */
834 #define SSH1_SMSG_SUCCESS                         14    /* 0xe */
835 #define SSH1_SMSG_FAILURE                         15    /* 0xf */
836 #define SSH1_CMSG_STDIN_DATA                      16    /* 0x10 */
837 #define SSH1_SMSG_STDOUT_DATA                     17    /* 0x11 */
838 #define SSH1_SMSG_STDERR_DATA                     18    /* 0x12 */
839 #define SSH1_CMSG_EOF                             19    /* 0x13 */
840 #define SSH1_SMSG_EXIT_STATUS                     20    /* 0x14 */
841 #define SSH1_MSG_CHANNEL_OPEN_CONFIRMATION        21    /* 0x15 */
842 #define SSH1_MSG_CHANNEL_OPEN_FAILURE             22    /* 0x16 */
843 #define SSH1_MSG_CHANNEL_DATA                     23    /* 0x17 */
844 #define SSH1_MSG_CHANNEL_CLOSE                    24    /* 0x18 */
845 #define SSH1_MSG_CHANNEL_CLOSE_CONFIRMATION       25    /* 0x19 */
846 #define SSH1_SMSG_X11_OPEN                        27    /* 0x1b */
847 #define SSH1_CMSG_PORT_FORWARD_REQUEST            28    /* 0x1c */
848 #define SSH1_MSG_PORT_OPEN                        29    /* 0x1d */
849 #define SSH1_CMSG_AGENT_REQUEST_FORWARDING        30    /* 0x1e */
850 #define SSH1_SMSG_AGENT_OPEN                      31    /* 0x1f */
851 #define SSH1_MSG_IGNORE                           32    /* 0x20 */
852 #define SSH1_CMSG_EXIT_CONFIRMATION               33    /* 0x21 */
853 #define SSH1_CMSG_X11_REQUEST_FORWARDING          34    /* 0x22 */
854 #define SSH1_CMSG_AUTH_RHOSTS_RSA                 35    /* 0x23 */
855 #define SSH1_MSG_DEBUG                            36    /* 0x24 */
856 #define SSH1_CMSG_REQUEST_COMPRESSION             37    /* 0x25 */
857 #define SSH1_CMSG_AUTH_TIS                        39    /* 0x27 */
858 #define SSH1_SMSG_AUTH_TIS_CHALLENGE              40    /* 0x28 */
859 #define SSH1_CMSG_AUTH_TIS_RESPONSE               41    /* 0x29 */
860 #define SSH1_CMSG_AUTH_CCARD                      70    /* 0x46 */
861 #define SSH1_SMSG_AUTH_CCARD_CHALLENGE            71    /* 0x47 */
862 #define SSH1_CMSG_AUTH_CCARD_RESPONSE             72    /* 0x48 */
863
864 #define SSH1_AUTH_RHOSTS                          1     /* 0x1 */
865 #define SSH1_AUTH_RSA                             2     /* 0x2 */
866 #define SSH1_AUTH_PASSWORD                        3     /* 0x3 */
867 #define SSH1_AUTH_RHOSTS_RSA                      4     /* 0x4 */
868 #define SSH1_AUTH_TIS                             5     /* 0x5 */
869 #define SSH1_AUTH_CCARD                           16    /* 0x10 */
870
871 #define SSH1_PROTOFLAG_SCREEN_NUMBER              1     /* 0x1 */
872 /* Mask for protoflags we will echo back to server if seen */
873 #define SSH1_PROTOFLAGS_SUPPORTED                 0     /* 0x1 */
874
875 /*
876  * SSH-2 message type codes.
877  */
878 #define SSH2_MSG_DISCONNECT                       1     /* 0x1 */
879 #define SSH2_MSG_IGNORE                           2     /* 0x2 */
880 #define SSH2_MSG_UNIMPLEMENTED                    3     /* 0x3 */
881 #define SSH2_MSG_DEBUG                            4     /* 0x4 */
882 #define SSH2_MSG_SERVICE_REQUEST                  5     /* 0x5 */
883 #define SSH2_MSG_SERVICE_ACCEPT                   6     /* 0x6 */
884 #define SSH2_MSG_KEXINIT                          20    /* 0x14 */
885 #define SSH2_MSG_NEWKEYS                          21    /* 0x15 */
886 #define SSH2_MSG_KEXDH_INIT                       30    /* 0x1e */
887 #define SSH2_MSG_KEXDH_REPLY                      31    /* 0x1f */
888 #define SSH2_MSG_KEX_DH_GEX_REQUEST_OLD           30    /* 0x1e */
889 #define SSH2_MSG_KEX_DH_GEX_REQUEST               34    /* 0x22 */
890 #define SSH2_MSG_KEX_DH_GEX_GROUP                 31    /* 0x1f */
891 #define SSH2_MSG_KEX_DH_GEX_INIT                  32    /* 0x20 */
892 #define SSH2_MSG_KEX_DH_GEX_REPLY                 33    /* 0x21 */
893 #define SSH2_MSG_KEXRSA_PUBKEY                    30    /* 0x1e */
894 #define SSH2_MSG_KEXRSA_SECRET                    31    /* 0x1f */
895 #define SSH2_MSG_KEXRSA_DONE                      32    /* 0x20 */
896 #define SSH2_MSG_KEX_ECDH_INIT                    30    /* 0x1e */
897 #define SSH2_MSG_KEX_ECDH_REPLY                   31    /* 0x1f */
898 #define SSH2_MSG_KEX_ECMQV_INIT                   30    /* 0x1e */
899 #define SSH2_MSG_KEX_ECMQV_REPLY                  31    /* 0x1f */
900 #define SSH2_MSG_USERAUTH_REQUEST                 50    /* 0x32 */
901 #define SSH2_MSG_USERAUTH_FAILURE                 51    /* 0x33 */
902 #define SSH2_MSG_USERAUTH_SUCCESS                 52    /* 0x34 */
903 #define SSH2_MSG_USERAUTH_BANNER                  53    /* 0x35 */
904 #define SSH2_MSG_USERAUTH_PK_OK                   60    /* 0x3c */
905 #define SSH2_MSG_USERAUTH_PASSWD_CHANGEREQ        60    /* 0x3c */
906 #define SSH2_MSG_USERAUTH_INFO_REQUEST            60    /* 0x3c */
907 #define SSH2_MSG_USERAUTH_INFO_RESPONSE           61    /* 0x3d */
908 #define SSH2_MSG_GLOBAL_REQUEST                   80    /* 0x50 */
909 #define SSH2_MSG_REQUEST_SUCCESS                  81    /* 0x51 */
910 #define SSH2_MSG_REQUEST_FAILURE                  82    /* 0x52 */
911 #define SSH2_MSG_CHANNEL_OPEN                     90    /* 0x5a */
912 #define SSH2_MSG_CHANNEL_OPEN_CONFIRMATION        91    /* 0x5b */
913 #define SSH2_MSG_CHANNEL_OPEN_FAILURE             92    /* 0x5c */
914 #define SSH2_MSG_CHANNEL_WINDOW_ADJUST            93    /* 0x5d */
915 #define SSH2_MSG_CHANNEL_DATA                     94    /* 0x5e */
916 #define SSH2_MSG_CHANNEL_EXTENDED_DATA            95    /* 0x5f */
917 #define SSH2_MSG_CHANNEL_EOF                      96    /* 0x60 */
918 #define SSH2_MSG_CHANNEL_CLOSE                    97    /* 0x61 */
919 #define SSH2_MSG_CHANNEL_REQUEST                  98    /* 0x62 */
920 #define SSH2_MSG_CHANNEL_SUCCESS                  99    /* 0x63 */
921 #define SSH2_MSG_CHANNEL_FAILURE                  100   /* 0x64 */
922 #define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE               60
923 #define SSH2_MSG_USERAUTH_GSSAPI_TOKEN                  61
924 #define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE      63
925 #define SSH2_MSG_USERAUTH_GSSAPI_ERROR                  64
926 #define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK                 65
927 #define SSH2_MSG_USERAUTH_GSSAPI_MIC                    66
928
929 /*
930  * SSH-1 agent messages.
931  */
932 #define SSH1_AGENTC_REQUEST_RSA_IDENTITIES    1
933 #define SSH1_AGENT_RSA_IDENTITIES_ANSWER      2
934 #define SSH1_AGENTC_RSA_CHALLENGE             3
935 #define SSH1_AGENT_RSA_RESPONSE               4
936 #define SSH1_AGENTC_ADD_RSA_IDENTITY          7
937 #define SSH1_AGENTC_REMOVE_RSA_IDENTITY       8
938 #define SSH1_AGENTC_REMOVE_ALL_RSA_IDENTITIES 9 /* openssh private? */
939
940 /*
941  * Messages common to SSH-1 and OpenSSH's SSH-2.
942  */
943 #define SSH_AGENT_FAILURE                    5
944 #define SSH_AGENT_SUCCESS                    6
945
946 /*
947  * OpenSSH's SSH-2 agent messages.
948  */
949 #define SSH2_AGENTC_REQUEST_IDENTITIES          11
950 #define SSH2_AGENT_IDENTITIES_ANSWER            12
951 #define SSH2_AGENTC_SIGN_REQUEST                13
952 #define SSH2_AGENT_SIGN_RESPONSE                14
953 #define SSH2_AGENTC_ADD_IDENTITY                17
954 #define SSH2_AGENTC_REMOVE_IDENTITY             18
955 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES       19
956
957 /*
958  * Assorted other SSH-related enumerations.
959  */
960 #define SSH2_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT 1   /* 0x1 */
961 #define SSH2_DISCONNECT_PROTOCOL_ERROR            2     /* 0x2 */
962 #define SSH2_DISCONNECT_KEY_EXCHANGE_FAILED       3     /* 0x3 */
963 #define SSH2_DISCONNECT_HOST_AUTHENTICATION_FAILED 4    /* 0x4 */
964 #define SSH2_DISCONNECT_MAC_ERROR                 5     /* 0x5 */
965 #define SSH2_DISCONNECT_COMPRESSION_ERROR         6     /* 0x6 */
966 #define SSH2_DISCONNECT_SERVICE_NOT_AVAILABLE     7     /* 0x7 */
967 #define SSH2_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED 8        /* 0x8 */
968 #define SSH2_DISCONNECT_HOST_KEY_NOT_VERIFIABLE   9     /* 0x9 */
969 #define SSH2_DISCONNECT_CONNECTION_LOST           10    /* 0xa */
970 #define SSH2_DISCONNECT_BY_APPLICATION            11    /* 0xb */
971 #define SSH2_DISCONNECT_TOO_MANY_CONNECTIONS      12    /* 0xc */
972 #define SSH2_DISCONNECT_AUTH_CANCELLED_BY_USER    13    /* 0xd */
973 #define SSH2_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE 14       /* 0xe */
974 #define SSH2_DISCONNECT_ILLEGAL_USER_NAME         15    /* 0xf */
975
976 #define SSH2_OPEN_ADMINISTRATIVELY_PROHIBITED     1     /* 0x1 */
977 #define SSH2_OPEN_CONNECT_FAILED                  2     /* 0x2 */
978 #define SSH2_OPEN_UNKNOWN_CHANNEL_TYPE            3     /* 0x3 */
979 #define SSH2_OPEN_RESOURCE_SHORTAGE               4     /* 0x4 */
980
981 #define SSH2_EXTENDED_DATA_STDERR                 1     /* 0x1 */
982
983 /*
984  * Need this to warn about support for the original SSH-2 keyfile
985  * format.
986  */
987 void old_keyfile_warning(void);