ssh.h

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