ssh.h

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