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 (*setcskey) (unsigned char *key);
 155     void (*setsckey) (unsigned char *key);
 156     void (*generate) (unsigned char *blk, int len, unsigned long seq);
 157     int (*verify) (unsigned char *blk, int len, unsigned long seq);
 158     char *name;
 159     int len;
 160 };
 161
 162 struct ssh_kex {
 163     /*
 164      * Plugging in another KEX algorithm requires structural chaos,
 165      * so it's hard to abstract them into nice little structures
 166      * like this. Hence, for the moment, this is just a
 167      * placeholder. I claim justification in the fact that OpenSSH
 168      * does this too :-)
 169      */
 170     char *name;
 171 };
 172
 173 struct ssh_signkey {
 174     void *(*newkey) (char *data, int len);
 175     void (*freekey) (void *key);
 176     char *(*fmtkey) (void *key);
 177     unsigned char *(*public_blob) (void *key, int *len);
 178     unsigned char *(*private_blob) (void *key, int *len);
 179     void *(*createkey) (unsigned char *pub_blob, int pub_len,
 180                         unsigned char *priv_blob, int priv_len);
 181     void *(*openssh_createkey) (unsigned char **blob, int *len);
 182     int (*openssh_fmtkey) (void *key, unsigned char *blob, int len);
 183     char *(*fingerprint) (void *key);
 184     int (*verifysig) (void *key, char *sig, int siglen,
 185                       char *data, int datalen);
 186     unsigned char *(*sign) (void *key, char *data, int datalen,
 187                             int *siglen);
 188     char *name;
 189     char *keytype;                     /* for host key cache */
 190 };
 191
 192 struct ssh_compress {
 193     char *name;
 194     void (*compress_init) (void);
 195     int (*compress) (unsigned char *block, int len,
 196                      unsigned char **outblock, int *outlen);
 197     void (*decompress_init) (void);
 198     int (*decompress) (unsigned char *block, int len,
 199                        unsigned char **outblock, int *outlen);
 200     int (*disable_compression) (void);
 201 };
 202
 203 struct ssh2_userkey {
 204     const struct ssh_signkey *alg;     /* the key algorithm */
 205     void *data;                        /* the key data */
 206     char *comment;                     /* the key comment */
 207 };
 208
 209 extern const struct ssh_cipher ssh_3des;
 210 extern const struct ssh_cipher ssh_des;
 211 extern const struct ssh_cipher ssh_blowfish_ssh1;
 212 extern const struct ssh2_ciphers ssh2_3des;
 213 extern const struct ssh2_ciphers ssh2_des;
 214 extern const struct ssh2_ciphers ssh2_aes;
 215 extern const struct ssh2_ciphers ssh2_blowfish;
 216 extern const struct ssh_kex ssh_diffiehellman;
 217 extern const struct ssh_kex ssh_diffiehellman_gex;
 218 extern const struct ssh_signkey ssh_dss;
 219 extern const struct ssh_signkey ssh_rsa;
 220 extern const struct ssh_mac ssh_md5;
 221 extern const struct ssh_mac ssh_sha1;
 222 extern const struct ssh_mac ssh_sha1_buggy;
 223
 224 /*
 225  * PuTTY version number formatted as an SSH version string.
 226  */
 227 extern char sshver[];
 228
 229 /*
 230  * Gross hack: pscp will try to start SFTP but fall back to scp1 if
 231  * that fails. This variable is the means by which scp.c can reach
 232  * into the SSH code and find out which one it got.
 233  */
 234 extern int ssh_fallback_cmd(void *handle);
 235
 236 #ifndef MSCRYPTOAPI
 237 void SHATransform(word32 * digest, word32 * data);
 238 #endif
 239
 240 int random_byte(void);
 241 void random_add_noise(void *noise, int length);
 242 void random_add_heavynoise(void *noise, int length);
 243
 244 void logevent(char *);
 245
 246 /* Allocate and register a new channel for port forwarding */
 247 void *new_sock_channel(void *handle, Socket s);
 248 void ssh_send_port_open(void *handle, void *channel,
 249                         char *hostname, int port, char *org);
 250
 251 Bignum copybn(Bignum b);
 252 Bignum bn_power_2(int n);
 253 void bn_restore_invariant(Bignum b);
 254 Bignum bignum_from_long(unsigned long n);
 255 void freebn(Bignum b);
 256 Bignum modpow(Bignum base, Bignum exp, Bignum mod);
 257 Bignum modmul(Bignum a, Bignum b, Bignum mod);
 258 void decbn(Bignum n);
 259 extern Bignum Zero, One;
 260 Bignum bignum_from_bytes(unsigned char *data, int nbytes);
 261 int ssh1_read_bignum(unsigned char *data, Bignum * result);
 262 int bignum_bitcount(Bignum bn);
 263 int ssh1_bignum_length(Bignum bn);
 264 int ssh2_bignum_length(Bignum bn);
 265 int bignum_byte(Bignum bn, int i);
 266 int bignum_bit(Bignum bn, int i);
 267 void bignum_set_bit(Bignum bn, int i, int value);
 268 int ssh1_write_bignum(void *data, Bignum bn);
 269 Bignum biggcd(Bignum a, Bignum b);
 270 unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
 271 Bignum bignum_add_long(Bignum number, unsigned long addend);
 272 Bignum bigmul(Bignum a, Bignum b);
 273 Bignum bigmuladd(Bignum a, Bignum b, Bignum addend);
 274 Bignum bigdiv(Bignum a, Bignum b);
 275 Bignum bigmod(Bignum a, Bignum b);
 276 Bignum modinv(Bignum number, Bignum modulus);
 277 Bignum bignum_bitmask(Bignum number);
 278 Bignum bignum_rshift(Bignum number, int shift);
 279 int bignum_cmp(Bignum a, Bignum b);
 280 char *bignum_decimal(Bignum x);
 281
 282 void dh_setup_group1(void);
 283 void dh_setup_group(Bignum pval, Bignum gval);
 284 void dh_cleanup(void);
 285 Bignum dh_create_e(int nbits);
 286 Bignum dh_find_K(Bignum f);
 287
 288 int loadrsakey(char *filename, struct RSAKey *key, char *passphrase);
 289 int rsakey_encrypted(char *filename, char **comment);
 290 int rsakey_pubblob(char *filename, void **blob, int *bloblen);
 291
 292 int saversakey(char *filename, struct RSAKey *key, char *passphrase);
 293
 294 void base64_encode_atom(unsigned char *data, int n, char *out);
 295
 296 /* ssh2_load_userkey can return this as an error */
 297 extern struct ssh2_userkey ssh2_wrong_passphrase;
 298 #define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)
 299
 300 int ssh2_userkey_encrypted(char *filename, char **comment);
 301 struct ssh2_userkey *ssh2_load_userkey(char *filename, char *passphrase);
 302 char *ssh2_userkey_loadpub(char *filename, char **algorithm,
 303                            int *pub_blob_len);
 304 int ssh2_save_userkey(char *filename, struct ssh2_userkey *key,
 305                       char *passphrase);
 306
 307 enum {
 308     SSH_KEYTYPE_UNOPENABLE,
 309     SSH_KEYTYPE_UNKNOWN,
 310     SSH_KEYTYPE_SSH1, SSH_KEYTYPE_SSH2,
 311     SSH_KEYTYPE_OPENSSH, SSH_KEYTYPE_SSHCOM
 312 };
 313 int key_type(char *filename);
 314 char *key_type_to_str(int type);
 315
 316 int import_possible(int type);
 317 int import_target_type(int type);
 318 int import_encrypted(char *filename, int type, char **comment);
 319 int import_ssh1(char *filename, int type, struct RSAKey *key,char *passphrase);
 320 struct ssh2_userkey *import_ssh2(char *filename, int type, char *passphrase);
 321 int export_ssh1(char *filename, int type, struct RSAKey *key,char *passphrase);
 322 int export_ssh2(char *filename, int type,
 323                 struct ssh2_userkey *key, char *passphrase);
 324
 325 void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
 326 void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
 327 void des3_decrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
 328                               unsigned char *blk, int len);
 329 void des3_encrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
 330                               unsigned char *blk, int len);
 331 void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk,
 332                            int len);
 333 void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk,
 334                            int len);
 335
 336 /*
 337  * For progress updates in the key generation utility.
 338  */
 339 #define PROGFN_INITIALISE 1
 340 #define PROGFN_LIN_PHASE 2
 341 #define PROGFN_EXP_PHASE 3
 342 #define PROGFN_PHASE_EXTENT 4
 343 #define PROGFN_READY 5
 344 #define PROGFN_PROGRESS 6
 345 typedef void (*progfn_t) (void *param, int action, int phase, int progress);
 346
 347 int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn,
 348                  void *pfnparam);
 349 int dsa_generate(struct dss_key *key, int bits, progfn_t pfn,
 350                  void *pfnparam);
 351 Bignum primegen(int bits, int modulus, int residue, Bignum factor,
 352                 int phase, progfn_t pfn, void *pfnparam);
 353
 354
 355 /*
 356  * zlib compression.
 357  */
 358 void zlib_compress_init(void);
 359 void zlib_decompress_init(void);
 360 int zlib_compress_block(unsigned char *block, int len,
 361                         unsigned char **outblock, int *outlen);
 362 int zlib_decompress_block(unsigned char *block, int len,
 363                           unsigned char **outblock, int *outlen);
 364
 365 /*
 366  * SSH1 agent messages.
 367  */
 368 #define SSH1_AGENTC_REQUEST_RSA_IDENTITIES    1
 369 #define SSH1_AGENT_RSA_IDENTITIES_ANSWER      2
 370 #define SSH1_AGENTC_RSA_CHALLENGE             3
 371 #define SSH1_AGENT_RSA_RESPONSE               4
 372 #define SSH1_AGENTC_ADD_RSA_IDENTITY          7
 373 #define SSH1_AGENTC_REMOVE_RSA_IDENTITY       8
 374 #define SSH1_AGENTC_REMOVE_ALL_RSA_IDENTITIES 9 /* openssh private? */
 375
 376 /*
 377  * Messages common to SSH1 and OpenSSH's SSH2.
 378  */
 379 #define SSH_AGENT_FAILURE                    5
 380 #define SSH_AGENT_SUCCESS                    6
 381
 382 /*
 383  * OpenSSH's SSH2 agent messages.
 384  */
 385 #define SSH2_AGENTC_REQUEST_IDENTITIES          11
 386 #define SSH2_AGENT_IDENTITIES_ANSWER            12
 387 #define SSH2_AGENTC_SIGN_REQUEST                13
 388 #define SSH2_AGENT_SIGN_RESPONSE                14
 389 #define SSH2_AGENTC_ADD_IDENTITY                17
 390 #define SSH2_AGENTC_REMOVE_IDENTITY             18
 391 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES       19
 392
 393 /*
 394  * Need this to warn about support for the original SSH2 keyfile
 395  * format.
 396  */
 397 void old_keyfile_warning(void);