ssh.h

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