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