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);
300 void *(*make_context)(void);
301 void (*free_context)(void *);
302 void (*sesskey) (void *, unsigned char *key); /* for SSH-1 */
303 void (*encrypt) (void *, unsigned char *blk, int len);
304 void (*decrypt) (void *, unsigned char *blk, int len);
306 const char *text_name;
310 void *(*make_context)(void);
311 void (*free_context)(void *);
312 void (*setiv) (void *, unsigned char *key); /* for SSH-2 */
313 void (*setkey) (void *, unsigned char *key);/* for SSH-2 */
314 void (*encrypt) (void *, unsigned char *blk, int len);
315 void (*decrypt) (void *, unsigned char *blk, int len);
320 #define SSH_CIPHER_IS_CBC 1
321 const char *text_name;
324 struct ssh2_ciphers {
326 const struct ssh2_cipher *const *list;
330 void *(*make_context)(void);
331 void (*free_context)(void *);
332 void (*setkey) (void *, unsigned char *key);
333 /* whole-packet operations */
334 void (*generate) (void *, unsigned char *blk, int len, unsigned long seq);
335 int (*verify) (void *, unsigned char *blk, int len, unsigned long seq);
336 /* partial-packet operations */
337 void (*start) (void *);
338 void (*bytes) (void *, unsigned char const *, int);
339 void (*genresult) (void *, unsigned char *);
340 int (*verresult) (void *, unsigned char const *);
341 const char *name, *etm_name;
343 const char *text_name;
347 void *(*init)(void); /* also allocates context */
348 void (*bytes)(void *, const void *, int);
349 void (*final)(void *, unsigned char *); /* also frees context */
350 int hlen; /* output length in bytes */
351 const char *text_name;
355 const char *name, *groupname;
356 enum { KEXTYPE_DH, KEXTYPE_RSA, KEXTYPE_ECDH } main_type;
357 const struct ssh_hash *hash;
358 const void *extra; /* private to the kex methods */
363 const struct ssh_kex *const *list;
367 void *(*newkey) (const struct ssh_signkey *self,
368 const char *data, int len);
369 void (*freekey) (void *key);
370 char *(*fmtkey) (void *key);
371 unsigned char *(*public_blob) (void *key, int *len);
372 unsigned char *(*private_blob) (void *key, int *len);
373 void *(*createkey) (const struct ssh_signkey *self,
374 const unsigned char *pub_blob, int pub_len,
375 const unsigned char *priv_blob, int priv_len);
376 void *(*openssh_createkey) (const struct ssh_signkey *self,
377 const unsigned char **blob, int *len);
378 int (*openssh_fmtkey) (void *key, unsigned char *blob, int len);
379 /* OpenSSH private key blobs, as created by openssh_fmtkey and
380 * consumed by openssh_createkey, always (at least so far...) take
381 * the form of a number of SSH-2 strings / mpints concatenated
382 * end-to-end. Because the new-style OpenSSH private key format
383 * stores those blobs without a containing string wrapper, we need
384 * to know how many strings each one consists of, so that we can
385 * skip over the right number to find the next key in the file.
386 * openssh_private_npieces gives that information. */
387 int openssh_private_npieces;
388 int (*pubkey_bits) (const struct ssh_signkey *self,
389 const void *blob, int len);
390 int (*verifysig) (void *key, const char *sig, int siglen,
391 const char *data, int datalen);
392 unsigned char *(*sign) (void *key, const char *data, int datalen,
395 const char *keytype; /* for host key cache */
396 const void *extra; /* private to the public key methods */
399 struct ssh_compress {
401 /* For zlib@openssh.com: if non-NULL, this name will be considered once
402 * userauth has completed successfully. */
403 const char *delayed_name;
404 void *(*compress_init) (void);
405 void (*compress_cleanup) (void *);
406 int (*compress) (void *, unsigned char *block, int len,
407 unsigned char **outblock, int *outlen);
408 void *(*decompress_init) (void);
409 void (*decompress_cleanup) (void *);
410 int (*decompress) (void *, unsigned char *block, int len,
411 unsigned char **outblock, int *outlen);
412 int (*disable_compression) (void *);
413 const char *text_name;
416 struct ssh2_userkey {
417 const struct ssh_signkey *alg; /* the key algorithm */
418 void *data; /* the key data */
419 char *comment; /* the key comment */
422 /* The maximum length of any hash algorithm used in kex. (bytes) */
423 #define SSH2_KEX_MAX_HASH_LEN (64) /* SHA-512 */
425 extern const struct ssh_cipher ssh_3des;
426 extern const struct ssh_cipher ssh_des;
427 extern const struct ssh_cipher ssh_blowfish_ssh1;
428 extern const struct ssh2_ciphers ssh2_3des;
429 extern const struct ssh2_ciphers ssh2_des;
430 extern const struct ssh2_ciphers ssh2_aes;
431 extern const struct ssh2_ciphers ssh2_blowfish;
432 extern const struct ssh2_ciphers ssh2_arcfour;
433 extern const struct ssh_hash ssh_sha1;
434 extern const struct ssh_hash ssh_sha256;
435 extern const struct ssh_hash ssh_sha384;
436 extern const struct ssh_hash ssh_sha512;
437 extern const struct ssh_kexes ssh_diffiehellman_group1;
438 extern const struct ssh_kexes ssh_diffiehellman_group14;
439 extern const struct ssh_kexes ssh_diffiehellman_gex;
440 extern const struct ssh_kexes ssh_rsa_kex;
441 extern const struct ssh_kexes ssh_ecdh_kex;
442 extern const struct ssh_signkey ssh_dss;
443 extern const struct ssh_signkey ssh_rsa;
444 extern const struct ssh_signkey ssh_ecdsa_ed25519;
445 extern const struct ssh_signkey ssh_ecdsa_nistp256;
446 extern const struct ssh_signkey ssh_ecdsa_nistp384;
447 extern const struct ssh_signkey ssh_ecdsa_nistp521;
448 extern const struct ssh_mac ssh_hmac_md5;
449 extern const struct ssh_mac ssh_hmac_sha1;
450 extern const struct ssh_mac ssh_hmac_sha1_buggy;
451 extern const struct ssh_mac ssh_hmac_sha1_96;
452 extern const struct ssh_mac ssh_hmac_sha1_96_buggy;
453 extern const struct ssh_mac ssh_hmac_sha256;
455 void *aes_make_context(void);
456 void aes_free_context(void *handle);
457 void aes128_key(void *handle, unsigned char *key);
458 void aes192_key(void *handle, unsigned char *key);
459 void aes256_key(void *handle, unsigned char *key);
460 void aes_iv(void *handle, unsigned char *iv);
461 void aes_ssh2_encrypt_blk(void *handle, unsigned char *blk, int len);
462 void aes_ssh2_decrypt_blk(void *handle, unsigned char *blk, int len);
465 * PuTTY version number formatted as an SSH version string.
467 extern char sshver[];
470 * Gross hack: pscp will try to start SFTP but fall back to scp1 if
471 * that fails. This variable is the means by which scp.c can reach
472 * into the SSH code and find out which one it got.
474 extern int ssh_fallback_cmd(void *handle);
477 void SHATransform(word32 * digest, word32 * data);
480 int random_byte(void);
481 void random_add_noise(void *noise, int length);
482 void random_add_heavynoise(void *noise, int length);
484 void logevent(void *, const char *);
486 struct PortForwarding;
488 /* Allocate and register a new channel for port forwarding */
489 void *new_sock_channel(void *handle, struct PortForwarding *pf);
490 void ssh_send_port_open(void *channel, const char *hostname, int port,
493 /* Exports from portfwd.c */
494 extern char *pfd_connect(struct PortForwarding **pf, char *hostname, int port,
495 void *c, Conf *conf, int addressfamily);
496 extern void pfd_close(struct PortForwarding *);
497 extern int pfd_send(struct PortForwarding *, char *data, int len);
498 extern void pfd_send_eof(struct PortForwarding *);
499 extern void pfd_confirm(struct PortForwarding *);
500 extern void pfd_unthrottle(struct PortForwarding *);
501 extern void pfd_override_throttle(struct PortForwarding *, int enable);
503 /* desthost == NULL indicates dynamic (SOCKS) port forwarding */
504 extern char *pfl_listen(char *desthost, int destport, char *srcaddr,
505 int port, void *backhandle, Conf *conf,
506 struct PortListener **pl, int address_family);
507 extern void pfl_terminate(struct PortListener *);
509 /* Exports from x11fwd.c */
511 X11_TRANS_IPV4 = 0, X11_TRANS_IPV6 = 6, X11_TRANS_UNIX = 256
514 /* Broken-down components of the display name itself */
519 /* OSX sometimes replaces all the above with a full Unix-socket pathname */
520 char *unixsocketpath;
522 /* PuTTY networking SockAddr to connect to the display, and associated
528 /* Our local auth details for talking to the real X display. */
530 unsigned char *localauthdata;
531 int localauthdatalen;
534 /* Auth details we invented for a virtual display on the SSH server. */
541 /* The encrypted form of the first block, in XDM-AUTHORIZATION-1.
542 * Used as part of the key when these structures are organised
543 * into a tree. See x11_invent_fake_auth for explanation. */
544 unsigned char *xa1_firstblock;
547 * Used inside x11fwd.c to remember recently seen
548 * XDM-AUTHORIZATION-1 strings, to avoid replay attacks.
553 * What to do with an X connection matching this auth data.
555 struct X11Display *disp;
556 void *share_cs, *share_chan;
558 void *x11_make_greeting(int endian, int protomajor, int protominor,
559 int auth_proto, const void *auth_data, int auth_len,
560 const char *peer_ip, int peer_port,
562 int x11_authcmp(void *av, void *bv); /* for putting X11FakeAuth in a tree234 */
564 * x11_setup_display() parses the display variable and fills in an
565 * X11Display structure. Some remote auth details are invented;
566 * the supplied authtype parameter configures the preferred
567 * authorisation protocol to use at the remote end. The local auth
568 * details are looked up by calling platform_get_x11_auth.
570 extern struct X11Display *x11_setup_display(const char *display, Conf *);
571 void x11_free_display(struct X11Display *disp);
572 struct X11FakeAuth *x11_invent_fake_auth(tree234 *t, int authtype);
573 void x11_free_fake_auth(struct X11FakeAuth *auth);
574 struct X11Connection; /* opaque outside x11fwd.c */
575 struct X11Connection *x11_init(tree234 *authtree, void *, const char *, int);
576 extern void x11_close(struct X11Connection *);
577 extern int x11_send(struct X11Connection *, char *, int);
578 extern void x11_send_eof(struct X11Connection *s);
579 extern void x11_unthrottle(struct X11Connection *s);
580 extern void x11_override_throttle(struct X11Connection *s, int enable);
581 char *x11_display(const char *display);
582 /* Platform-dependent X11 functions */
583 extern void platform_get_x11_auth(struct X11Display *display, Conf *);
584 /* examine a mostly-filled-in X11Display and fill in localauth* */
585 extern const int platform_uses_x11_unix_by_default;
586 /* choose default X transport in the absence of a specified one */
587 SockAddr platform_get_x11_unix_address(const char *path, int displaynum);
588 /* make up a SockAddr naming the address for displaynum */
589 char *platform_get_x_display(void);
590 /* allocated local X display string, if any */
591 /* Callbacks in x11.c usable _by_ platform X11 functions */
593 * This function does the job of platform_get_x11_auth, provided
594 * it is told where to find a normally formatted .Xauthority file:
595 * it opens that file, parses it to find an auth record which
596 * matches the display details in "display", and fills in the
599 * It is expected that most implementations of
600 * platform_get_x11_auth() will work by finding their system's
601 * .Xauthority file, adjusting the display details if necessary
602 * for local oddities like Unix-domain socket transport, and
603 * calling this function to do the rest of the work.
605 void x11_get_auth_from_authfile(struct X11Display *display,
606 const char *authfilename);
607 int x11_identify_auth_proto(const char *proto);
608 void *x11_dehexify(const char *hex, int *outlen);
610 Bignum copybn(Bignum b);
611 Bignum bn_power_2(int n);
612 void bn_restore_invariant(Bignum b);
613 Bignum bignum_from_long(unsigned long n);
614 void freebn(Bignum b);
615 Bignum modpow(Bignum base, Bignum exp, Bignum mod);
616 Bignum modmul(Bignum a, Bignum b, Bignum mod);
617 Bignum modsub(const Bignum a, const Bignum b, const Bignum n);
618 void decbn(Bignum n);
619 extern Bignum Zero, One;
620 Bignum bignum_from_bytes(const unsigned char *data, int nbytes);
621 Bignum bignum_from_bytes_le(const unsigned char *data, int nbytes);
622 Bignum bignum_random_in_range(const Bignum lower, const Bignum upper);
623 int ssh1_read_bignum(const unsigned char *data, int len, Bignum * result);
624 int bignum_bitcount(Bignum bn);
625 int ssh1_bignum_length(Bignum bn);
626 int ssh2_bignum_length(Bignum bn);
627 int bignum_byte(Bignum bn, int i);
628 int bignum_bit(Bignum bn, int i);
629 void bignum_set_bit(Bignum bn, int i, int value);
630 int ssh1_write_bignum(void *data, Bignum bn);
631 Bignum biggcd(Bignum a, Bignum b);
632 unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
633 Bignum bignum_add_long(Bignum number, unsigned long addend);
634 Bignum bigadd(Bignum a, Bignum b);
635 Bignum bigsub(Bignum a, Bignum b);
636 Bignum bigmul(Bignum a, Bignum b);
637 Bignum bigmuladd(Bignum a, Bignum b, Bignum addend);
638 Bignum bigdiv(Bignum a, Bignum b);
639 Bignum bigmod(Bignum a, Bignum b);
640 Bignum modinv(Bignum number, Bignum modulus);
641 Bignum bignum_bitmask(Bignum number);
642 Bignum bignum_rshift(Bignum number, int shift);
643 Bignum bignum_lshift(Bignum number, int shift);
644 int bignum_cmp(Bignum a, Bignum b);
645 char *bignum_decimal(Bignum x);
646 Bignum bignum_from_decimal(const char *decimal);
649 void diagbn(char *prefix, Bignum md);
652 int dh_is_gex(const struct ssh_kex *kex);
653 void *dh_setup_group(const struct ssh_kex *kex);
654 void *dh_setup_gex(Bignum pval, Bignum gval);
655 void dh_cleanup(void *);
656 Bignum dh_create_e(void *, int nbits);
657 const char *dh_validate_f(void *handle, Bignum f);
658 Bignum dh_find_K(void *, Bignum f);
660 int loadrsakey(const Filename *filename, struct RSAKey *key,
661 const char *passphrase, const char **errorstr);
662 int rsakey_encrypted(const Filename *filename, char **comment);
663 int rsakey_pubblob(const Filename *filename, void **blob, int *bloblen,
664 char **commentptr, const char **errorstr);
666 int saversakey(const Filename *filename, struct RSAKey *key, char *passphrase);
668 extern int base64_decode_atom(const char *atom, unsigned char *out);
669 extern int base64_lines(int datalen);
670 extern void base64_encode_atom(const unsigned char *data, int n, char *out);
671 extern void base64_encode(FILE *fp, const unsigned char *data, int datalen,
674 /* ssh2_load_userkey can return this as an error */
675 extern struct ssh2_userkey ssh2_wrong_passphrase;
676 #define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)
678 int ssh2_userkey_encrypted(const Filename *filename, char **comment);
679 struct ssh2_userkey *ssh2_load_userkey(const Filename *filename,
680 const char *passphrase,
681 const char **errorstr);
682 unsigned char *ssh2_userkey_loadpub(const Filename *filename, char **algorithm,
683 int *pub_blob_len, char **commentptr,
684 const char **errorstr);
685 int ssh2_save_userkey(const Filename *filename, struct ssh2_userkey *key,
687 const struct ssh_signkey *find_pubkey_alg(const char *name);
688 const struct ssh_signkey *find_pubkey_alg_len(int namelen, const char *name);
691 SSH_KEYTYPE_UNOPENABLE,
693 SSH_KEYTYPE_SSH1, SSH_KEYTYPE_SSH2,
695 * The OpenSSH key types deserve a little explanation. OpenSSH has
696 * two physical formats for private key storage: an old PEM-based
697 * one largely dictated by their use of OpenSSL and full of ASN.1,
698 * and a new one using the same private key formats used over the
699 * wire for talking to ssh-agent. The old format can only support
700 * a subset of the key types, because it needs redesign for each
701 * key type, and after a while they decided to move to the new
702 * format so as not to have to do that.
704 * On input, key files are identified as either
705 * SSH_KEYTYPE_OPENSSH_PEM or SSH_KEYTYPE_OPENSSH_NEW, describing
706 * accurately which actual format the keys are stored in.
708 * On output, however, we default to following OpenSSH's own
709 * policy of writing out PEM-style keys for maximum backwards
710 * compatibility if the key type supports it, and otherwise
711 * switching to the new format. So the formats you can select for
712 * output are SSH_KEYTYPE_OPENSSH_NEW (forcing the new format for
713 * any key type), and SSH_KEYTYPE_OPENSSH_AUTO to use the oldest
714 * format supported by whatever key type you're writing out.
716 * So we have three type codes, but only two of them usable in any
717 * given circumstance. An input key file will never be identified
718 * as AUTO, only PEM or NEW; key export UIs should not be able to
719 * select PEM, only AUTO or NEW.
721 SSH_KEYTYPE_OPENSSH_AUTO,
722 SSH_KEYTYPE_OPENSSH_PEM,
723 SSH_KEYTYPE_OPENSSH_NEW,
726 * Public-key-only formats, which we still want to be able to read
727 * for various purposes.
729 SSH_KEYTYPE_SSH1_PUBLIC,
730 SSH_KEYTYPE_SSH2_PUBLIC_RFC4716,
731 SSH_KEYTYPE_SSH2_PUBLIC_OPENSSH
733 char *ssh1_pubkey_str(struct RSAKey *ssh1key);
734 void ssh1_write_pubkey(FILE *fp, struct RSAKey *ssh1key);
735 char *ssh2_pubkey_openssh_str(struct ssh2_userkey *key);
736 void ssh2_write_pubkey(FILE *fp, const char *comment,
737 const void *v_pub_blob, int pub_len,
739 char *ssh2_fingerprint_blob(const void *blob, int bloblen);
740 char *ssh2_fingerprint(const struct ssh_signkey *alg, void *data);
741 int key_type(const Filename *filename);
742 const char *key_type_to_str(int type);
744 int import_possible(int type);
745 int import_target_type(int type);
746 int import_encrypted(const Filename *filename, int type, char **comment);
747 int import_ssh1(const Filename *filename, int type,
748 struct RSAKey *key, char *passphrase, const char **errmsg_p);
749 struct ssh2_userkey *import_ssh2(const Filename *filename, int type,
750 char *passphrase, const char **errmsg_p);
751 int export_ssh1(const Filename *filename, int type,
752 struct RSAKey *key, char *passphrase);
753 int export_ssh2(const Filename *filename, int type,
754 struct ssh2_userkey *key, char *passphrase);
756 void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
757 void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
758 void des3_decrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
759 unsigned char *blk, int len);
760 void des3_encrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
761 unsigned char *blk, int len);
762 void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk,
764 void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk,
767 void des_encrypt_xdmauth(const unsigned char *key,
768 unsigned char *blk, int len);
769 void des_decrypt_xdmauth(const unsigned char *key,
770 unsigned char *blk, int len);
772 void openssh_bcrypt(const char *passphrase,
773 const unsigned char *salt, int saltbytes,
774 int rounds, unsigned char *out, int outbytes);
777 * For progress updates in the key generation utility.
779 #define PROGFN_INITIALISE 1
780 #define PROGFN_LIN_PHASE 2
781 #define PROGFN_EXP_PHASE 3
782 #define PROGFN_PHASE_EXTENT 4
783 #define PROGFN_READY 5
784 #define PROGFN_PROGRESS 6
785 typedef void (*progfn_t) (void *param, int action, int phase, int progress);
787 int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn,
789 int dsa_generate(struct dss_key *key, int bits, progfn_t pfn,
791 int ec_generate(struct ec_key *key, int bits, progfn_t pfn,
793 int ec_edgenerate(struct ec_key *key, int bits, progfn_t pfn,
795 Bignum primegen(int bits, int modulus, int residue, Bignum factor,
796 int phase, progfn_t pfn, void *pfnparam, unsigned firstbits);
797 void invent_firstbits(unsigned *one, unsigned *two);
803 void *zlib_compress_init(void);
804 void zlib_compress_cleanup(void *);
805 void *zlib_decompress_init(void);
806 void zlib_decompress_cleanup(void *);
807 int zlib_compress_block(void *, unsigned char *block, int len,
808 unsigned char **outblock, int *outlen);
809 int zlib_decompress_block(void *, unsigned char *block, int len,
810 unsigned char **outblock, int *outlen);
813 * Connection-sharing API provided by platforms. This function must
815 * - return SHARE_NONE and do nothing
816 * - return SHARE_DOWNSTREAM and set *sock to a Socket connected to
818 * - return SHARE_UPSTREAM and set *sock to a Socket connected to
821 enum { SHARE_NONE, SHARE_DOWNSTREAM, SHARE_UPSTREAM };
822 int platform_ssh_share(const char *name, Conf *conf,
823 Plug downplug, Plug upplug, Socket *sock,
824 char **logtext, char **ds_err, char **us_err,
825 int can_upstream, int can_downstream);
826 void platform_ssh_share_cleanup(const char *name);
829 * SSH-1 message type codes.
831 #define SSH1_MSG_DISCONNECT 1 /* 0x1 */
832 #define SSH1_SMSG_PUBLIC_KEY 2 /* 0x2 */
833 #define SSH1_CMSG_SESSION_KEY 3 /* 0x3 */
834 #define SSH1_CMSG_USER 4 /* 0x4 */
835 #define SSH1_CMSG_AUTH_RSA 6 /* 0x6 */
836 #define SSH1_SMSG_AUTH_RSA_CHALLENGE 7 /* 0x7 */
837 #define SSH1_CMSG_AUTH_RSA_RESPONSE 8 /* 0x8 */
838 #define SSH1_CMSG_AUTH_PASSWORD 9 /* 0x9 */
839 #define SSH1_CMSG_REQUEST_PTY 10 /* 0xa */
840 #define SSH1_CMSG_WINDOW_SIZE 11 /* 0xb */
841 #define SSH1_CMSG_EXEC_SHELL 12 /* 0xc */
842 #define SSH1_CMSG_EXEC_CMD 13 /* 0xd */
843 #define SSH1_SMSG_SUCCESS 14 /* 0xe */
844 #define SSH1_SMSG_FAILURE 15 /* 0xf */
845 #define SSH1_CMSG_STDIN_DATA 16 /* 0x10 */
846 #define SSH1_SMSG_STDOUT_DATA 17 /* 0x11 */
847 #define SSH1_SMSG_STDERR_DATA 18 /* 0x12 */
848 #define SSH1_CMSG_EOF 19 /* 0x13 */
849 #define SSH1_SMSG_EXIT_STATUS 20 /* 0x14 */
850 #define SSH1_MSG_CHANNEL_OPEN_CONFIRMATION 21 /* 0x15 */
851 #define SSH1_MSG_CHANNEL_OPEN_FAILURE 22 /* 0x16 */
852 #define SSH1_MSG_CHANNEL_DATA 23 /* 0x17 */
853 #define SSH1_MSG_CHANNEL_CLOSE 24 /* 0x18 */
854 #define SSH1_MSG_CHANNEL_CLOSE_CONFIRMATION 25 /* 0x19 */
855 #define SSH1_SMSG_X11_OPEN 27 /* 0x1b */
856 #define SSH1_CMSG_PORT_FORWARD_REQUEST 28 /* 0x1c */
857 #define SSH1_MSG_PORT_OPEN 29 /* 0x1d */
858 #define SSH1_CMSG_AGENT_REQUEST_FORWARDING 30 /* 0x1e */
859 #define SSH1_SMSG_AGENT_OPEN 31 /* 0x1f */
860 #define SSH1_MSG_IGNORE 32 /* 0x20 */
861 #define SSH1_CMSG_EXIT_CONFIRMATION 33 /* 0x21 */
862 #define SSH1_CMSG_X11_REQUEST_FORWARDING 34 /* 0x22 */
863 #define SSH1_CMSG_AUTH_RHOSTS_RSA 35 /* 0x23 */
864 #define SSH1_MSG_DEBUG 36 /* 0x24 */
865 #define SSH1_CMSG_REQUEST_COMPRESSION 37 /* 0x25 */
866 #define SSH1_CMSG_AUTH_TIS 39 /* 0x27 */
867 #define SSH1_SMSG_AUTH_TIS_CHALLENGE 40 /* 0x28 */
868 #define SSH1_CMSG_AUTH_TIS_RESPONSE 41 /* 0x29 */
869 #define SSH1_CMSG_AUTH_CCARD 70 /* 0x46 */
870 #define SSH1_SMSG_AUTH_CCARD_CHALLENGE 71 /* 0x47 */
871 #define SSH1_CMSG_AUTH_CCARD_RESPONSE 72 /* 0x48 */
873 #define SSH1_AUTH_RHOSTS 1 /* 0x1 */
874 #define SSH1_AUTH_RSA 2 /* 0x2 */
875 #define SSH1_AUTH_PASSWORD 3 /* 0x3 */
876 #define SSH1_AUTH_RHOSTS_RSA 4 /* 0x4 */
877 #define SSH1_AUTH_TIS 5 /* 0x5 */
878 #define SSH1_AUTH_CCARD 16 /* 0x10 */
880 #define SSH1_PROTOFLAG_SCREEN_NUMBER 1 /* 0x1 */
881 /* Mask for protoflags we will echo back to server if seen */
882 #define SSH1_PROTOFLAGS_SUPPORTED 0 /* 0x1 */
885 * SSH-2 message type codes.
887 #define SSH2_MSG_DISCONNECT 1 /* 0x1 */
888 #define SSH2_MSG_IGNORE 2 /* 0x2 */
889 #define SSH2_MSG_UNIMPLEMENTED 3 /* 0x3 */
890 #define SSH2_MSG_DEBUG 4 /* 0x4 */
891 #define SSH2_MSG_SERVICE_REQUEST 5 /* 0x5 */
892 #define SSH2_MSG_SERVICE_ACCEPT 6 /* 0x6 */
893 #define SSH2_MSG_KEXINIT 20 /* 0x14 */
894 #define SSH2_MSG_NEWKEYS 21 /* 0x15 */
895 #define SSH2_MSG_KEXDH_INIT 30 /* 0x1e */
896 #define SSH2_MSG_KEXDH_REPLY 31 /* 0x1f */
897 #define SSH2_MSG_KEX_DH_GEX_REQUEST_OLD 30 /* 0x1e */
898 #define SSH2_MSG_KEX_DH_GEX_REQUEST 34 /* 0x22 */
899 #define SSH2_MSG_KEX_DH_GEX_GROUP 31 /* 0x1f */
900 #define SSH2_MSG_KEX_DH_GEX_INIT 32 /* 0x20 */
901 #define SSH2_MSG_KEX_DH_GEX_REPLY 33 /* 0x21 */
902 #define SSH2_MSG_KEXRSA_PUBKEY 30 /* 0x1e */
903 #define SSH2_MSG_KEXRSA_SECRET 31 /* 0x1f */
904 #define SSH2_MSG_KEXRSA_DONE 32 /* 0x20 */
905 #define SSH2_MSG_KEX_ECDH_INIT 30 /* 0x1e */
906 #define SSH2_MSG_KEX_ECDH_REPLY 31 /* 0x1f */
907 #define SSH2_MSG_KEX_ECMQV_INIT 30 /* 0x1e */
908 #define SSH2_MSG_KEX_ECMQV_REPLY 31 /* 0x1f */
909 #define SSH2_MSG_USERAUTH_REQUEST 50 /* 0x32 */
910 #define SSH2_MSG_USERAUTH_FAILURE 51 /* 0x33 */
911 #define SSH2_MSG_USERAUTH_SUCCESS 52 /* 0x34 */
912 #define SSH2_MSG_USERAUTH_BANNER 53 /* 0x35 */
913 #define SSH2_MSG_USERAUTH_PK_OK 60 /* 0x3c */
914 #define SSH2_MSG_USERAUTH_PASSWD_CHANGEREQ 60 /* 0x3c */
915 #define SSH2_MSG_USERAUTH_INFO_REQUEST 60 /* 0x3c */
916 #define SSH2_MSG_USERAUTH_INFO_RESPONSE 61 /* 0x3d */
917 #define SSH2_MSG_GLOBAL_REQUEST 80 /* 0x50 */
918 #define SSH2_MSG_REQUEST_SUCCESS 81 /* 0x51 */
919 #define SSH2_MSG_REQUEST_FAILURE 82 /* 0x52 */
920 #define SSH2_MSG_CHANNEL_OPEN 90 /* 0x5a */
921 #define SSH2_MSG_CHANNEL_OPEN_CONFIRMATION 91 /* 0x5b */
922 #define SSH2_MSG_CHANNEL_OPEN_FAILURE 92 /* 0x5c */
923 #define SSH2_MSG_CHANNEL_WINDOW_ADJUST 93 /* 0x5d */
924 #define SSH2_MSG_CHANNEL_DATA 94 /* 0x5e */
925 #define SSH2_MSG_CHANNEL_EXTENDED_DATA 95 /* 0x5f */
926 #define SSH2_MSG_CHANNEL_EOF 96 /* 0x60 */
927 #define SSH2_MSG_CHANNEL_CLOSE 97 /* 0x61 */
928 #define SSH2_MSG_CHANNEL_REQUEST 98 /* 0x62 */
929 #define SSH2_MSG_CHANNEL_SUCCESS 99 /* 0x63 */
930 #define SSH2_MSG_CHANNEL_FAILURE 100 /* 0x64 */
931 #define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE 60
932 #define SSH2_MSG_USERAUTH_GSSAPI_TOKEN 61
933 #define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE 63
934 #define SSH2_MSG_USERAUTH_GSSAPI_ERROR 64
935 #define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK 65
936 #define SSH2_MSG_USERAUTH_GSSAPI_MIC 66
939 * SSH-1 agent messages.
941 #define SSH1_AGENTC_REQUEST_RSA_IDENTITIES 1
942 #define SSH1_AGENT_RSA_IDENTITIES_ANSWER 2
943 #define SSH1_AGENTC_RSA_CHALLENGE 3
944 #define SSH1_AGENT_RSA_RESPONSE 4
945 #define SSH1_AGENTC_ADD_RSA_IDENTITY 7
946 #define SSH1_AGENTC_REMOVE_RSA_IDENTITY 8
947 #define SSH1_AGENTC_REMOVE_ALL_RSA_IDENTITIES 9 /* openssh private? */
950 * Messages common to SSH-1 and OpenSSH's SSH-2.
952 #define SSH_AGENT_FAILURE 5
953 #define SSH_AGENT_SUCCESS 6
956 * OpenSSH's SSH-2 agent messages.
958 #define SSH2_AGENTC_REQUEST_IDENTITIES 11
959 #define SSH2_AGENT_IDENTITIES_ANSWER 12
960 #define SSH2_AGENTC_SIGN_REQUEST 13
961 #define SSH2_AGENT_SIGN_RESPONSE 14
962 #define SSH2_AGENTC_ADD_IDENTITY 17
963 #define SSH2_AGENTC_REMOVE_IDENTITY 18
964 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES 19
967 * Assorted other SSH-related enumerations.
969 #define SSH2_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT 1 /* 0x1 */
970 #define SSH2_DISCONNECT_PROTOCOL_ERROR 2 /* 0x2 */
971 #define SSH2_DISCONNECT_KEY_EXCHANGE_FAILED 3 /* 0x3 */
972 #define SSH2_DISCONNECT_HOST_AUTHENTICATION_FAILED 4 /* 0x4 */
973 #define SSH2_DISCONNECT_MAC_ERROR 5 /* 0x5 */
974 #define SSH2_DISCONNECT_COMPRESSION_ERROR 6 /* 0x6 */
975 #define SSH2_DISCONNECT_SERVICE_NOT_AVAILABLE 7 /* 0x7 */
976 #define SSH2_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED 8 /* 0x8 */
977 #define SSH2_DISCONNECT_HOST_KEY_NOT_VERIFIABLE 9 /* 0x9 */
978 #define SSH2_DISCONNECT_CONNECTION_LOST 10 /* 0xa */
979 #define SSH2_DISCONNECT_BY_APPLICATION 11 /* 0xb */
980 #define SSH2_DISCONNECT_TOO_MANY_CONNECTIONS 12 /* 0xc */
981 #define SSH2_DISCONNECT_AUTH_CANCELLED_BY_USER 13 /* 0xd */
982 #define SSH2_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE 14 /* 0xe */
983 #define SSH2_DISCONNECT_ILLEGAL_USER_NAME 15 /* 0xf */
985 #define SSH2_OPEN_ADMINISTRATIVELY_PROHIBITED 1 /* 0x1 */
986 #define SSH2_OPEN_CONNECT_FAILED 2 /* 0x2 */
987 #define SSH2_OPEN_UNKNOWN_CHANNEL_TYPE 3 /* 0x3 */
988 #define SSH2_OPEN_RESOURCE_SHORTAGE 4 /* 0x4 */
990 #define SSH2_EXTENDED_DATA_STDERR 1 /* 0x1 */
993 * Need this to warn about support for the original SSH-2 keyfile
996 void old_keyfile_warning(void);