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