[u/mdw/putty] / ssh.h

#include <string.h>

#include "puttymem.h"

/*
 * Useful thing.
 */
#ifndef lenof
#define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
#endif

#define SSH_CIPHER_IDEA		1
#define SSH_CIPHER_DES		2
#define SSH_CIPHER_3DES		3
#define SSH_CIPHER_BLOWFISH	6

#ifdef MSCRYPTOAPI
#define APIEXTRA 8
#else
#define APIEXTRA 0
#endif

#ifndef BIGNUM_INTERNAL
typedef void *Bignum;
#endif

struct RSAKey {
    int bits;
    int bytes;
#ifdef MSCRYPTOAPI
    unsigned long exponent;
    unsigned char *modulus;
#else
    Bignum modulus;
    Bignum exponent;
    Bignum private_exponent;
    Bignum p;
    Bignum q;
    Bignum iqmp;
#endif
    char *comment;
};

int makekey(unsigned char *data, struct RSAKey *result,
	    unsigned char **keystr, int order);
int makeprivate(unsigned char *data, struct RSAKey *result);
void rsaencrypt(unsigned char *data, int length, struct RSAKey *key);
Bignum rsadecrypt(Bignum input, struct RSAKey *key);
void rsasign(unsigned char *data, int length, struct RSAKey *key);
void rsasanitise(struct RSAKey *key);
int rsastr_len(struct RSAKey *key);
void rsastr_fmt(char *str, struct RSAKey *key);
void rsa_fingerprint(char *str, int len, struct RSAKey *key);
void freersakey(struct RSAKey *key);

typedef unsigned int word32;
typedef unsigned int uint32;

unsigned long crc32(const void *s, size_t len);

typedef struct {
    uint32 h[4];
} MD5_Core_State;

struct MD5Context {
#ifdef MSCRYPTOAPI
    unsigned long hHash;
#else
    MD5_Core_State core;
    unsigned char block[64];
    int blkused;
    uint32 lenhi, lenlo;
#endif
};

void MD5Init(struct MD5Context *context);
void MD5Update(struct MD5Context *context, unsigned char const *buf,
               unsigned len);
void MD5Final(unsigned char digest[16], struct MD5Context *context);

typedef struct {
    uint32 h[5];
    unsigned char block[64];
    int blkused;
    uint32 lenhi, lenlo;
} SHA_State;

void SHA_Init(SHA_State *s);
void SHA_Bytes(SHA_State *s, void *p, int len);
void SHA_Final(SHA_State *s, unsigned char *output);
void SHA_Simple(void *p, int len, unsigned char *output);

struct ssh_cipher {
    void (*sesskey)(unsigned char *key);   /* for ssh 1 */
    void (*encrypt)(unsigned char *blk, int len);
    void (*decrypt)(unsigned char *blk, int len);
    int blksize;
};

struct ssh2_cipher {
    void (*setcsiv)(unsigned char *key);   /* for ssh 2 */
    void (*setcskey)(unsigned char *key);   /* for ssh 2 */
    void (*setsciv)(unsigned char *key);   /* for ssh 2 */
    void (*setsckey)(unsigned char *key);   /* for ssh 2 */
    void (*encrypt)(unsigned char *blk, int len);
    void (*decrypt)(unsigned char *blk, int len);
    char *name;
    int blksize;
    int keylen;
};

struct ssh2_ciphers {
    int nciphers;
    const struct ssh2_cipher *const *list;
};

struct ssh_mac {
    void (*setcskey)(unsigned char *key);
    void (*setsckey)(unsigned char *key);
    void (*generate)(unsigned char *blk, int len, unsigned long seq);
    int (*verify)(unsigned char *blk, int len, unsigned long seq);
    char *name;
    int len;
};

struct ssh_kex {
    /*
     * Plugging in another KEX algorithm requires structural chaos,
     * so it's hard to abstract them into nice little structures
     * like this. Hence, for the moment, this is just a
     * placeholder. I claim justification in the fact that OpenSSH
     * does this too :-)
     */
    char *name;
};

struct ssh_signkey {
    void *(*newkey)(char *data, int len);
    void (*freekey)(void *key);
    char *(*fmtkey)(void *key);
    unsigned char *(*public_blob)(void *key, int *len);
    unsigned char *(*private_blob)(void *key, int *len);
    void *(*createkey)(unsigned char *pub_blob, int pub_len,
		       unsigned char *priv_blob, int priv_len);
    void *(*openssh_createkey)(unsigned char **blob, int *len);
    char *(*fingerprint)(void *key);
    int (*verifysig)(void *key, char *sig, int siglen,
		     char *data, int datalen);
    unsigned char *(*sign)(void *key, char *data, int datalen, int *siglen);
    char *name;
    char *keytype;                     /* for host key cache */
};

struct ssh_compress {
    char *name;
    void (*compress_init)(void);
    int (*compress)(unsigned char *block, int len,
		    unsigned char **outblock, int *outlen);
    void (*decompress_init)(void);
    int (*decompress)(unsigned char *block, int len,
		      unsigned char **outblock, int *outlen);
};

struct ssh2_userkey {
    const struct ssh_signkey *alg;     /* the key algorithm */
    void *data;			       /* the key data */
    char *comment;		       /* the key comment */
};

extern const struct ssh_cipher ssh_3des;
extern const struct ssh_cipher ssh_des;
extern const struct ssh_cipher ssh_blowfish_ssh1;
extern const struct ssh2_ciphers ssh2_3des;
extern const struct ssh2_ciphers ssh2_aes;
extern const struct ssh2_ciphers ssh2_blowfish;
extern const struct ssh_kex ssh_diffiehellman;
extern const struct ssh_kex ssh_diffiehellman_gex;
extern const struct ssh_signkey ssh_dss;
extern const struct ssh_signkey ssh_rsa;
extern const struct ssh_mac ssh_md5;
extern const struct ssh_mac ssh_sha1;
extern const struct ssh_mac ssh_sha1_buggy;

#ifndef MSCRYPTOAPI
void SHATransform(word32 *digest, word32 *data);
#endif

int random_byte(void);
void random_add_noise(void *noise, int length);
void random_add_heavynoise(void *noise, int length);

void logevent (char *);

Bignum copybn(Bignum b);
Bignum bn_power_2(int n);
void bn_restore_invariant(Bignum b);
Bignum bignum_from_short(unsigned short n);
void freebn(Bignum b);
Bignum modpow(Bignum base, Bignum exp, Bignum mod);
Bignum modmul(Bignum a, Bignum b, Bignum mod);
void decbn(Bignum n);
extern Bignum Zero, One;
Bignum bignum_from_bytes(unsigned char *data, int nbytes);
int ssh1_read_bignum(unsigned char *data, Bignum *result);
int ssh1_bignum_bitcount(Bignum bn);
int ssh1_bignum_length(Bignum bn);
int bignum_byte(Bignum bn, int i);
int bignum_bit(Bignum bn, int i);
void bignum_set_bit(Bignum bn, int i, int value);
int ssh1_write_bignum(void *data, Bignum bn);
Bignum biggcd(Bignum a, Bignum b);
unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
Bignum bignum_add_long(Bignum number, unsigned long addend);
Bignum bigmul(Bignum a, Bignum b);
Bignum modinv(Bignum number, Bignum modulus);
Bignum bignum_bitmask(Bignum number);
Bignum bignum_rshift(Bignum number, int shift);
int bignum_cmp(Bignum a, Bignum b);
char *bignum_decimal(Bignum x);

void dh_setup_group1(void);
void dh_setup_group(Bignum pval, Bignum gval);
void dh_cleanup(void);
Bignum dh_create_e(void);
Bignum dh_find_K(Bignum f);

int loadrsakey(char *filename, struct RSAKey *key, char *passphrase);
int rsakey_encrypted(char *filename, char **comment);

int saversakey(char *filename, struct RSAKey *key, char *passphrase);

void base64_encode_atom(unsigned char *data, int n, char *out);

/* ssh2_load_userkey can return this as an error */
extern struct ssh2_userkey ssh2_wrong_passphrase;
#define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)

int ssh2_userkey_encrypted(char *filename, char **comment);
struct ssh2_userkey *ssh2_load_userkey(char *filename, char *passphrase);
char *ssh2_userkey_loadpub(char *filename, char **algorithm, int *pub_blob_len);
int ssh2_save_userkey(char *filename, struct ssh2_userkey *key, char *passphrase);

int keyfile_version(char *filename);

void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);

/*
 * For progress updates in the key generation utility.
 */
typedef void (*progfn_t)(void *param, int phase, int progress);

int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn, void *pfnparam);
Bignum primegen(int bits, int modulus, int residue,
                int phase, progfn_t pfn, void *pfnparam);

/*
 * zlib compression.
 */
void zlib_compress_init(void);
void zlib_decompress_init(void);
int zlib_compress_block(unsigned char *block, int len,
			unsigned char **outblock, int *outlen);
int zlib_decompress_block(unsigned char *block, int len,
			  unsigned char **outblock, int *outlen);
Commit	Line	Data
37508af4	1	#include <string.h>
37508af4	2
dcbde236	3	#include "puttymem.h"
dcbde236	4
e5574168	5	/*
	6	* Useful thing.
	7	*/
	8	#ifndef lenof
	9	#define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
	10	#endif
	11
bea1ef5f	12	#define SSH_CIPHER_IDEA 1
9697bfd2	13	#define SSH_CIPHER_DES 2
bea1ef5f	14	#define SSH_CIPHER_3DES 3
	15	#define SSH_CIPHER_BLOWFISH 6
	16
e5574168	17	#ifdef MSCRYPTOAPI
	18	#define APIEXTRA 8
	19	#else
	20	#define APIEXTRA 0
	21	#endif
	22
3709bfe9	23	#ifndef BIGNUM_INTERNAL
	24	typedef void *Bignum;
	25	#endif
7cca0d81	26
374330e2	27	struct RSAKey {
	28	int bits;
	29	int bytes;
8f203108	30	#ifdef MSCRYPTOAPI
	31	unsigned long exponent;
	32	unsigned char *modulus;
	33	#else
7cca0d81	34	Bignum modulus;
	35	Bignum exponent;
	36	Bignum private_exponent;
9400cf6f	37	Bignum p;
	38	Bignum q;
	39	Bignum iqmp;
65a22376	40	#endif
65a22376	41	char *comment;
9400cf6f	42	};
9400cf6f	43
374330e2	44	int makekey(unsigned char data, struct RSAKey result,
7cca0d81	45	unsigned char **keystr, int order);
7cca0d81	46	int makeprivate(unsigned char data, struct RSAKey result);
374330e2	47	void rsaencrypt(unsigned char data, int length, struct RSAKey key);
7cca0d81	48	Bignum rsadecrypt(Bignum input, struct RSAKey *key);
	49	void rsasign(unsigned char data, int length, struct RSAKey key);
	50	void rsasanitise(struct RSAKey *key);
374330e2	51	int rsastr_len(struct RSAKey *key);
374330e2	52	void rsastr_fmt(char str, struct RSAKey key);
1c2a93c4	53	void rsa_fingerprint(char str, int len, struct RSAKey key);
5c58ad2d	54	void freersakey(struct RSAKey *key);
374330e2	55
	56	typedef unsigned int word32;
	57	typedef unsigned int uint32;
	58
8160fbfc	59	unsigned long crc32(const void *s, size_t len);
374330e2	60
48672163	61	typedef struct {
	62	uint32 h[4];
	63	} MD5_Core_State;
	64
374330e2	65	struct MD5Context {
8f203108	66	#ifdef MSCRYPTOAPI
	67	unsigned long hHash;
	68	#else
48672163	69	MD5_Core_State core;
bb093ca7	70	unsigned char block[64];
48672163	71	int blkused;
48672163	72	uint32 lenhi, lenlo;
8f203108	73	#endif
374330e2	74	};
	75
	76	void MD5Init(struct MD5Context *context);
	77	void MD5Update(struct MD5Context context, unsigned char const buf,
	78	unsigned len);
	79	void MD5Final(unsigned char digest[16], struct MD5Context *context);
	80
e5574168	81	typedef struct {
	82	uint32 h[5];
	83	unsigned char block[64];
	84	int blkused;
	85	uint32 lenhi, lenlo;
	86	} SHA_State;
	87
	88	void SHA_Init(SHA_State *s);
	89	void SHA_Bytes(SHA_State s, void p, int len);
	90	void SHA_Final(SHA_State s, unsigned char output);
7cca0d81	91	void SHA_Simple(void p, int len, unsigned char output);
e5574168	92
374330e2	93	struct ssh_cipher {
d39f364a	94	void (sesskey)(unsigned char key); /* for ssh 1 */
0a3f1d48	95	void (encrypt)(unsigned char blk, int len);
	96	void (decrypt)(unsigned char blk, int len);
	97	int blksize;
	98	};
	99
	100	struct ssh2_cipher {
d39f364a	101	void (setcsiv)(unsigned char key); /* for ssh 2 */
	102	void (setcskey)(unsigned char key); /* for ssh 2 */
	103	void (setsciv)(unsigned char key); /* for ssh 2 */
	104	void (setsckey)(unsigned char key); /* for ssh 2 */
374330e2	105	void (encrypt)(unsigned char blk, int len);
374330e2	106	void (decrypt)(unsigned char blk, int len);
e5574168	107	char *name;
e5574168	108	int blksize;
d2a0e0be	109	int keylen;
e5574168	110	};
e5574168	111
0a3f1d48	112	struct ssh2_ciphers {
0a3f1d48	113	int nciphers;
65a22376	114	const struct ssh2_cipher const list;
0a3f1d48	115	};
0a3f1d48	116
e5574168	117	struct ssh_mac {
d39f364a	118	void (setcskey)(unsigned char key);
d39f364a	119	void (setsckey)(unsigned char key);
e5574168	120	void (generate)(unsigned char blk, int len, unsigned long seq);
	121	int (verify)(unsigned char blk, int len, unsigned long seq);
	122	char *name;
	123	int len;
	124	};
	125
	126	struct ssh_kex {
7cca0d81	127	/*
	128	* Plugging in another KEX algorithm requires structural chaos,
	129	* so it's hard to abstract them into nice little structures
	130	* like this. Hence, for the moment, this is just a
	131	* placeholder. I claim justification in the fact that OpenSSH
	132	* does this too :-)
	133	*/
e5574168	134	char *name;
	135	};
	136
e055a386	137	struct ssh_signkey {
	138	void (newkey)(char *data, int len);
	139	void (freekey)(void key);
	140	char (fmtkey)(void *key);
65a22376	141	unsigned char (public_blob)(void key, int len);
	142	unsigned char (private_blob)(void key, int len);
	143	void (createkey)(unsigned char *pub_blob, int pub_len,
	144	unsigned char *priv_blob, int priv_len);
45cebe79	145	void (openssh_createkey)(unsigned char *blob, int len);
e055a386	146	char (fingerprint)(void *key);
	147	int (verifysig)(void key, char *sig, int siglen,
	148	char *data, int datalen);
65a22376	149	unsigned char (sign)(void key, char data, int datalen, int *siglen);
e5574168	150	char *name;
d5859615	151	char keytype; / for host key cache */
e5574168	152	};
	153
	154	struct ssh_compress {
	155	char *name;
4ba9b64b	156	void (*compress_init)(void);
	157	int (compress)(unsigned char block, int len,
	158	unsigned char *outblock, int outlen);
	159	void (*decompress_init)(void);
	160	int (decompress)(unsigned char block, int len,
	161	unsigned char *outblock, int outlen);
374330e2	162	};
374330e2	163
65a22376	164	struct ssh2_userkey {
	165	const struct ssh_signkey alg; / the key algorithm */
	166	void data; / the key data */
	167	char comment; / the key comment */
	168	};
	169
	170	extern const struct ssh_cipher ssh_3des;
	171	extern const struct ssh_cipher ssh_des;
	172	extern const struct ssh_cipher ssh_blowfish_ssh1;
	173	extern const struct ssh2_ciphers ssh2_3des;
	174	extern const struct ssh2_ciphers ssh2_aes;
	175	extern const struct ssh2_ciphers ssh2_blowfish;
	176	extern const struct ssh_kex ssh_diffiehellman;
	177	extern const struct ssh_kex ssh_diffiehellman_gex;
	178	extern const struct ssh_signkey ssh_dss;
	179	extern const struct ssh_signkey ssh_rsa;
	180	extern const struct ssh_mac ssh_md5;
	181	extern const struct ssh_mac ssh_sha1;
	182	extern const struct ssh_mac ssh_sha1_buggy;
	183
8f203108	184	#ifndef MSCRYPTOAPI
374330e2	185	void SHATransform(word32 digest, word32 data);
8f203108	186	#endif
374330e2	187
	188	int random_byte(void);
	189	void random_add_noise(void *noise, int length);
6e522441	190	void random_add_heavynoise(void *noise, int length);
c5e9c988	191
c5e9c988	192	void logevent (char *);
e5574168	193
7cca0d81	194	Bignum copybn(Bignum b);
3709bfe9	195	Bignum bn_power_2(int n);
3709bfe9	196	void bn_restore_invariant(Bignum b);
9400cf6f	197	Bignum bignum_from_short(unsigned short n);
e5574168	198	void freebn(Bignum b);
59600f67	199	Bignum modpow(Bignum base, Bignum exp, Bignum mod);
59600f67	200	Bignum modmul(Bignum a, Bignum b, Bignum mod);
7cca0d81	201	void decbn(Bignum n);
7cca0d81	202	extern Bignum Zero, One;
3709bfe9	203	Bignum bignum_from_bytes(unsigned char *data, int nbytes);
7cca0d81	204	int ssh1_read_bignum(unsigned char data, Bignum result);
5c58ad2d	205	int ssh1_bignum_bitcount(Bignum bn);
	206	int ssh1_bignum_length(Bignum bn);
	207	int bignum_byte(Bignum bn, int i);
9400cf6f	208	int bignum_bit(Bignum bn, int i);
9400cf6f	209	void bignum_set_bit(Bignum bn, int i, int value);
5c58ad2d	210	int ssh1_write_bignum(void *data, Bignum bn);
9400cf6f	211	Bignum biggcd(Bignum a, Bignum b);
	212	unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
	213	Bignum bignum_add_long(Bignum number, unsigned long addend);
	214	Bignum bigmul(Bignum a, Bignum b);
	215	Bignum modinv(Bignum number, Bignum modulus);
3709bfe9	216	Bignum bignum_bitmask(Bignum number);
9400cf6f	217	Bignum bignum_rshift(Bignum number, int shift);
8c3cd914	218	int bignum_cmp(Bignum a, Bignum b);
6e522441	219	char *bignum_decimal(Bignum x);
e5574168	220
3709bfe9	221	void dh_setup_group1(void);
a92dd380	222	void dh_setup_group(Bignum pval, Bignum gval);
3709bfe9	223	void dh_cleanup(void);
e5574168	224	Bignum dh_create_e(void);
e5574168	225	Bignum dh_find_K(Bignum f);
7cca0d81	226
65a22376	227	int loadrsakey(char filename, struct RSAKey key, char *passphrase);
a52f067e	228	int rsakey_encrypted(char filename, char *comment);
7cca0d81	229
65a22376	230	int saversakey(char filename, struct RSAKey key, char *passphrase);
	231
	232	void base64_encode_atom(unsigned char data, int n, char out);
	233
	234	/* ssh2_load_userkey can return this as an error */
	235	extern struct ssh2_userkey ssh2_wrong_passphrase;
	236	#define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)
	237
	238	int ssh2_userkey_encrypted(char filename, char *comment);
	239	struct ssh2_userkey ssh2_load_userkey(char filename, char *passphrase);
	240	char ssh2_userkey_loadpub(char filename, char *algorithm, int pub_blob_len);
	241	int ssh2_save_userkey(char filename, struct ssh2_userkey key, char *passphrase);
	242
	243	int keyfile_version(char *filename);
6e522441	244
65a22376	245	void des3_decrypt_pubkey(unsigned char key, unsigned char blk, int len);
	246	void des3_encrypt_pubkey(unsigned char key, unsigned char blk, int len);
	247	void aes256_encrypt_pubkey(unsigned char key, unsigned char blk, int len);
	248	void aes256_decrypt_pubkey(unsigned char key, unsigned char blk, int len);
9400cf6f	249
	250	/*
	251	* For progress updates in the key generation utility.
	252	*/
	253	typedef void (progfn_t)(void param, int phase, int progress);
	254
65a22376	255	int rsa_generate(struct RSAKey key, int bits, progfn_t pfn, void pfnparam);
9400cf6f	256	Bignum primegen(int bits, int modulus, int residue,
9400cf6f	257	int phase, progfn_t pfn, void *pfnparam);
4ba9b64b	258
	259	/*
	260	* zlib compression.
	261	*/
	262	void zlib_compress_init(void);
	263	void zlib_decompress_init(void);
	264	int zlib_compress_block(unsigned char *block, int len,
	265	unsigned char *outblock, int outlen);
	266	int zlib_decompress_block(unsigned char *block, int len,
	267	unsigned char *outblock, int outlen);