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