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