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