ssh.h

   1 #include <stdio.h>
   2 #include <string.h>
   3
   4 #include "puttymem.h"
   5 #include "network.h"
   6 #include "int64.h"
   7
   8 struct ssh_channel;
   9
  10 extern void sshfwd_close(struct ssh_channel *c);
  11 extern int sshfwd_write(struct ssh_channel *c, char *, int);
  12 extern void sshfwd_unthrottle(struct ssh_channel *c, int bufsize);
  13
  14 /*
  15  * Useful thing.
  16  */
  17 #ifndef lenof
  18 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
  19 #endif
  20
  21 #define SSH_CIPHER_IDEA         1
  22 #define SSH_CIPHER_DES          2
  23 #define SSH_CIPHER_3DES         3
  24 #define SSH_CIPHER_BLOWFISH     6
  25
  26 #ifdef MSCRYPTOAPI
  27 #define APIEXTRA 8
  28 #else
  29 #define APIEXTRA 0
  30 #endif
  31
  32 #ifndef BIGNUM_INTERNAL
  33 typedef void *Bignum;
  34 #endif
  35
  36 struct RSAKey {
  37     int bits;
  38     int bytes;
  39 #ifdef MSCRYPTOAPI
  40     unsigned long exponent;
  41     unsigned char *modulus;
  42 #else
  43     Bignum modulus;
  44     Bignum exponent;
  45     Bignum private_exponent;
  46     Bignum p;
  47     Bignum q;
  48     Bignum iqmp;
  49 #endif
  50     char *comment;
  51 };
  52
  53 struct dss_key {
  54     Bignum p, q, g, y, x;
  55 };
  56
  57 int makekey(unsigned char *data, struct RSAKey *result,
  58             unsigned char **keystr, int order);
  59 int makeprivate(unsigned char *data, struct RSAKey *result);
  60 void rsaencrypt(unsigned char *data, int length, struct RSAKey *key);
  61 Bignum rsadecrypt(Bignum input, struct RSAKey *key);
  62 void rsasign(unsigned char *data, int length, struct RSAKey *key);
  63 void rsasanitise(struct RSAKey *key);
  64 int rsastr_len(struct RSAKey *key);
  65 void rsastr_fmt(char *str, struct RSAKey *key);
  66 void rsa_fingerprint(char *str, int len, struct RSAKey *key);
  67 int rsa_verify(struct RSAKey *key);
  68 unsigned char *rsa_public_blob(struct RSAKey *key, int *len);
  69 int rsa_public_blob_len(void *data);
  70 void freersakey(struct RSAKey *key);
  71
  72 typedef unsigned int word32;
  73 typedef unsigned int uint32;
  74
  75 unsigned long crc32(const void *s, size_t len);
  76 unsigned long crc32_update(unsigned long crc_input, const void *s, size_t len);
  77
  78 /* SSH CRC compensation attack detector */
  79 void *crcda_make_context(void);
  80 void crcda_free_context(void *handle);
  81 int detect_attack(void *handle, unsigned char *buf, uint32 len,
  82                   unsigned char *IV);
  83
  84 typedef struct {
  85     uint32 h[4];
  86 } MD5_Core_State;
  87
  88 struct MD5Context {
  89 #ifdef MSCRYPTOAPI
  90     unsigned long hHash;
  91 #else
  92     MD5_Core_State core;
  93     unsigned char block[64];
  94     int blkused;
  95     uint32 lenhi, lenlo;
  96 #endif
  97 };
  98
  99 void MD5Init(struct MD5Context *context);
 100 void MD5Update(struct MD5Context *context, unsigned char const *buf,
 101                unsigned len);
 102 void MD5Final(unsigned char digest[16], struct MD5Context *context);
 103
 104 typedef struct {
 105     uint32 h[5];
 106     unsigned char block[64];
 107     int blkused;
 108     uint32 lenhi, lenlo;
 109 } SHA_State;
 110 void SHA_Init(SHA_State * s);
 111 void SHA_Bytes(SHA_State * s, void *p, int len);
 112 void SHA_Final(SHA_State * s, unsigned char *output);
 113 void SHA_Simple(void *p, int len, unsigned char *output);
 114
 115 void hmac_sha1_simple(void *key, int keylen, void *data, int datalen,
 116                       unsigned char *output);
 117
 118 typedef struct {
 119     uint64 h[8];
 120     unsigned char block[128];
 121     int blkused;
 122     uint32 len[4];
 123 } SHA512_State;
 124 void SHA512_Init(SHA512_State * s);
 125 void SHA512_Bytes(SHA512_State * s, const void *p, int len);
 126 void SHA512_Final(SHA512_State * s, unsigned char *output);
 127 void SHA512_Simple(const void *p, int len, unsigned char *output);
 128
 129 struct ssh_cipher {
 130     void *(*make_context)(void);
 131     void (*free_context)(void *);
 132     void (*sesskey) (void *, unsigned char *key);       /* for ssh 1 */
 133     void (*encrypt) (void *, unsigned char *blk, int len);
 134     void (*decrypt) (void *, unsigned char *blk, int len);
 135     int blksize;
 136     char *text_name;
 137 };
 138
 139 struct ssh2_cipher {
 140     void *(*make_context)(void);
 141     void (*free_context)(void *);
 142     void (*setiv) (void *, unsigned char *key); /* for ssh 2 */
 143     void (*setkey) (void *, unsigned char *key);/* for ssh 2 */
 144     void (*encrypt) (void *, unsigned char *blk, int len);
 145     void (*decrypt) (void *, unsigned char *blk, int len);
 146     char *name;
 147     int blksize;
 148     int keylen;
 149     char *text_name;
 150 };
 151
 152 struct ssh2_ciphers {
 153     int nciphers;
 154     const struct ssh2_cipher *const *list;
 155 };
 156
 157 struct ssh_mac {
 158     void *(*make_context)(void);
 159     void (*free_context)(void *);
 160     void (*setkey) (void *, unsigned char *key);
 161     void (*generate) (void *, unsigned char *blk, int len, unsigned long seq);
 162     int (*verify) (void *, unsigned char *blk, int len, unsigned long seq);
 163     char *name;
 164     int len;
 165 };
 166
 167 struct ssh_kex {
 168     /*
 169      * Plugging in another KEX algorithm requires structural chaos,
 170      * so it's hard to abstract them into nice little structures
 171      * like this. Hence, for the moment, this is just a
 172      * placeholder. I claim justification in the fact that OpenSSH
 173      * does this too :-)
 174      */
 175     char *name;
 176 };
 177
 178 struct ssh_signkey {
 179     void *(*newkey) (char *data, int len);
 180     void (*freekey) (void *key);
 181     char *(*fmtkey) (void *key);
 182     unsigned char *(*public_blob) (void *key, int *len);
 183     unsigned char *(*private_blob) (void *key, int *len);
 184     void *(*createkey) (unsigned char *pub_blob, int pub_len,
 185                         unsigned char *priv_blob, int priv_len);
 186     void *(*openssh_createkey) (unsigned char **blob, int *len);
 187     int (*openssh_fmtkey) (void *key, unsigned char *blob, int len);
 188     char *(*fingerprint) (void *key);
 189     int (*verifysig) (void *key, char *sig, int siglen,
 190                       char *data, int datalen);
 191     unsigned char *(*sign) (void *key, char *data, int datalen,
 192                             int *siglen);
 193     char *name;
 194     char *keytype;                     /* for host key cache */
 195 };
 196
 197 struct ssh_compress {
 198     char *name;
 199     void *(*compress_init) (void);
 200     void (*compress_cleanup) (void *);
 201     int (*compress) (void *, unsigned char *block, int len,
 202                      unsigned char **outblock, int *outlen);
 203     void *(*decompress_init) (void);
 204     void (*decompress_cleanup) (void *);
 205     int (*decompress) (void *, unsigned char *block, int len,
 206                        unsigned char **outblock, int *outlen);
 207     int (*disable_compression) (void *);
 208     char *text_name;
 209 };
 210
 211 struct ssh2_userkey {
 212     const struct ssh_signkey *alg;     /* the key algorithm */
 213     void *data;                        /* the key data */
 214     char *comment;                     /* the key comment */
 215 };
 216
 217 extern const struct ssh_cipher ssh_3des;
 218 extern const struct ssh_cipher ssh_des;
 219 extern const struct ssh_cipher ssh_blowfish_ssh1;
 220 extern const struct ssh2_ciphers ssh2_3des;
 221 extern const struct ssh2_ciphers ssh2_des;
 222 extern const struct ssh2_ciphers ssh2_aes;
 223 extern const struct ssh2_ciphers ssh2_blowfish;
 224 extern const struct ssh_kex ssh_diffiehellman;
 225 extern const struct ssh_kex ssh_diffiehellman_gex;
 226 extern const struct ssh_signkey ssh_dss;
 227 extern const struct ssh_signkey ssh_rsa;
 228 extern const struct ssh_mac ssh_md5;
 229 extern const struct ssh_mac ssh_sha1;
 230 extern const struct ssh_mac ssh_sha1_buggy;
 231
 232 /*
 233  * PuTTY version number formatted as an SSH version string.
 234  */
 235 extern char sshver[];
 236
 237 /*
 238  * Gross hack: pscp will try to start SFTP but fall back to scp1 if
 239  * that fails. This variable is the means by which scp.c can reach
 240  * into the SSH code and find out which one it got.
 241  */
 242 extern int ssh_fallback_cmd(void *handle);
 243
 244 #ifndef MSCRYPTOAPI
 245 void SHATransform(word32 * digest, word32 * data);
 246 #endif
 247
 248 int random_byte(void);
 249 void random_add_noise(void *noise, int length);
 250 void random_add_heavynoise(void *noise, int length);
 251
 252 void logevent(void *, char *);
 253
 254 /* Allocate and register a new channel for port forwarding */
 255 void *new_sock_channel(void *handle, Socket s);
 256 void ssh_send_port_open(void *channel, char *hostname, int port, char *org);
 257
 258 /* Exports from portfwd.c */
 259 extern char *pfd_newconnect(Socket * s, char *hostname, int port, void *c);
 260 extern char *pfd_addforward(char *desthost, int destport, char *srcaddr,
 261                             int port, void *backhandle);
 262 extern void pfd_close(Socket s);
 263 extern int pfd_send(Socket s, char *data, int len);
 264 extern void pfd_confirm(Socket s);
 265 extern void pfd_unthrottle(Socket s);
 266 extern void pfd_override_throttle(Socket s, int enable);
 267
 268 /* Exports from x11fwd.c */
 269 extern char *x11_init(Socket *, char *, void *, void *, const char *, int);
 270 extern void x11_close(Socket);
 271 extern int x11_send(Socket, char *, int);
 272 extern void *x11_invent_auth(char *, int, char *, int, int);
 273 extern void x11_unthrottle(Socket s);
 274 extern void x11_override_throttle(Socket s, int enable);
 275 extern int x11_get_screen_number(char *display);
 276 void x11_get_real_auth(void *authv, char *display);
 277
 278 /* Platfdorm-dependent X11 function */
 279 extern void platform_get_x11_auth(char *display, int *proto,
 280                                   unsigned char *data, int *datalen);
 281
 282 Bignum copybn(Bignum b);
 283 Bignum bn_power_2(int n);
 284 void bn_restore_invariant(Bignum b);
 285 Bignum bignum_from_long(unsigned long n);
 286 void freebn(Bignum b);
 287 Bignum modpow(Bignum base, Bignum exp, Bignum mod);
 288 Bignum modmul(Bignum a, Bignum b, Bignum mod);
 289 void decbn(Bignum n);
 290 extern Bignum Zero, One;
 291 Bignum bignum_from_bytes(const unsigned char *data, int nbytes);
 292 int ssh1_read_bignum(const unsigned char *data, Bignum * result);
 293 int bignum_bitcount(Bignum bn);
 294 int ssh1_bignum_length(Bignum bn);
 295 int ssh2_bignum_length(Bignum bn);
 296 int bignum_byte(Bignum bn, int i);
 297 int bignum_bit(Bignum bn, int i);
 298 void bignum_set_bit(Bignum bn, int i, int value);
 299 int ssh1_write_bignum(void *data, Bignum bn);
 300 Bignum biggcd(Bignum a, Bignum b);
 301 unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
 302 Bignum bignum_add_long(Bignum number, unsigned long addend);
 303 Bignum bigmul(Bignum a, Bignum b);
 304 Bignum bigmuladd(Bignum a, Bignum b, Bignum addend);
 305 Bignum bigdiv(Bignum a, Bignum b);
 306 Bignum bigmod(Bignum a, Bignum b);
 307 Bignum modinv(Bignum number, Bignum modulus);
 308 Bignum bignum_bitmask(Bignum number);
 309 Bignum bignum_rshift(Bignum number, int shift);
 310 int bignum_cmp(Bignum a, Bignum b);
 311 char *bignum_decimal(Bignum x);
 312
 313 void *dh_setup_group1(void);
 314 void *dh_setup_group(Bignum pval, Bignum gval);
 315 void dh_cleanup(void *);
 316 Bignum dh_create_e(void *, int nbits);
 317 Bignum dh_find_K(void *, Bignum f);
 318
 319 int loadrsakey(char *filename, struct RSAKey *key, char *passphrase);
 320 int rsakey_encrypted(char *filename, char **comment);
 321 int rsakey_pubblob(char *filename, void **blob, int *bloblen);
 322
 323 int saversakey(char *filename, struct RSAKey *key, char *passphrase);
 324
 325 extern int base64_decode_atom(char *atom, unsigned char *out);
 326 extern int base64_lines(int datalen);
 327 extern void base64_encode_atom(unsigned char *data, int n, char *out);
 328 extern void base64_encode(FILE *fp, unsigned char *data, int datalen, int cpl);
 329
 330 /* ssh2_load_userkey can return this as an error */
 331 extern struct ssh2_userkey ssh2_wrong_passphrase;
 332 #define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)
 333
 334 int ssh2_userkey_encrypted(char *filename, char **comment);
 335 struct ssh2_userkey *ssh2_load_userkey(char *filename, char *passphrase);
 336 char *ssh2_userkey_loadpub(char *filename, char **algorithm,
 337                            int *pub_blob_len);
 338 int ssh2_save_userkey(char *filename, struct ssh2_userkey *key,
 339                       char *passphrase);
 340
 341 enum {
 342     SSH_KEYTYPE_UNOPENABLE,
 343     SSH_KEYTYPE_UNKNOWN,
 344     SSH_KEYTYPE_SSH1, SSH_KEYTYPE_SSH2,
 345     SSH_KEYTYPE_OPENSSH, SSH_KEYTYPE_SSHCOM
 346 };
 347 int key_type(char *filename);
 348 char *key_type_to_str(int type);
 349
 350 int import_possible(int type);
 351 int import_target_type(int type);
 352 int import_encrypted(char *filename, int type, char **comment);
 353 int import_ssh1(char *filename, int type, struct RSAKey *key,char *passphrase);
 354 struct ssh2_userkey *import_ssh2(char *filename, int type, char *passphrase);
 355 int export_ssh1(char *filename, int type, struct RSAKey *key,char *passphrase);
 356 int export_ssh2(char *filename, int type,
 357                 struct ssh2_userkey *key, char *passphrase);
 358
 359 void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
 360 void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
 361 void des3_decrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
 362                               unsigned char *blk, int len);
 363 void des3_encrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
 364                               unsigned char *blk, int len);
 365 void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk,
 366                            int len);
 367 void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk,
 368                            int len);
 369
 370 void des_encrypt_xdmauth(unsigned char *key, unsigned char *blk, int len);
 371 void des_decrypt_xdmauth(unsigned char *key, unsigned char *blk, int len);
 372
 373 /*
 374  * For progress updates in the key generation utility.
 375  */
 376 #define PROGFN_INITIALISE 1
 377 #define PROGFN_LIN_PHASE 2
 378 #define PROGFN_EXP_PHASE 3
 379 #define PROGFN_PHASE_EXTENT 4
 380 #define PROGFN_READY 5
 381 #define PROGFN_PROGRESS 6
 382 typedef void (*progfn_t) (void *param, int action, int phase, int progress);
 383
 384 int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn,
 385                  void *pfnparam);
 386 int dsa_generate(struct dss_key *key, int bits, progfn_t pfn,
 387                  void *pfnparam);
 388 Bignum primegen(int bits, int modulus, int residue, Bignum factor,
 389                 int phase, progfn_t pfn, void *pfnparam);
 390
 391
 392 /*
 393  * zlib compression.
 394  */
 395 void *zlib_compress_init(void);
 396 void zlib_compress_cleanup(void *);
 397 void *zlib_decompress_init(void);
 398 void zlib_decompress_cleanup(void *);
 399 int zlib_compress_block(void *, unsigned char *block, int len,
 400                         unsigned char **outblock, int *outlen);
 401 int zlib_decompress_block(void *, unsigned char *block, int len,
 402                           unsigned char **outblock, int *outlen);
 403
 404 /*
 405  * SSH1 agent messages.
 406  */
 407 #define SSH1_AGENTC_REQUEST_RSA_IDENTITIES    1
 408 #define SSH1_AGENT_RSA_IDENTITIES_ANSWER      2
 409 #define SSH1_AGENTC_RSA_CHALLENGE             3
 410 #define SSH1_AGENT_RSA_RESPONSE               4
 411 #define SSH1_AGENTC_ADD_RSA_IDENTITY          7
 412 #define SSH1_AGENTC_REMOVE_RSA_IDENTITY       8
 413 #define SSH1_AGENTC_REMOVE_ALL_RSA_IDENTITIES 9 /* openssh private? */
 414
 415 /*
 416  * Messages common to SSH1 and OpenSSH's SSH2.
 417  */
 418 #define SSH_AGENT_FAILURE                    5
 419 #define SSH_AGENT_SUCCESS                    6
 420
 421 /*
 422  * OpenSSH's SSH2 agent messages.
 423  */
 424 #define SSH2_AGENTC_REQUEST_IDENTITIES          11
 425 #define SSH2_AGENT_IDENTITIES_ANSWER            12
 426 #define SSH2_AGENTC_SIGN_REQUEST                13
 427 #define SSH2_AGENT_SIGN_RESPONSE                14
 428 #define SSH2_AGENTC_ADD_IDENTITY                17
 429 #define SSH2_AGENTC_REMOVE_IDENTITY             18
 430 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES       19
 431
 432 /*
 433  * Need this to warn about support for the original SSH2 keyfile
 434  * format.
 435  */
 436 void old_keyfile_warning(void);