git.distorted.org.uk Git - u/mdw/putty/blob - ssh.h

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