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