Fix a bug which was causing occasional failed-host-key-check
[u/mdw/putty] / putty.h
CommitLineData
374330e2 1#ifndef PUTTY_PUTTY_H
2#define PUTTY_PUTTY_H
3
8df7a775 4#include "network.h"
5
374330e2 6#define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
de3df031 7#define PUTTY_REG_PARENT "Software\\SimonTatham"
8#define PUTTY_REG_PARENT_CHILD "PuTTY"
9#define PUTTY_REG_GPARENT "Software"
10#define PUTTY_REG_GPARENT_CHILD "SimonTatham"
374330e2 11
12/*
13 * Global variables. Most modules declare these `extern', but
14 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
15 * module, and so will get them properly defined.
16 */
17#ifdef PUTTY_DO_GLOBALS
18#define GLOBAL
19#else
20#define GLOBAL extern
21#endif
22
23#define ATTR_ACTCURS 0x80000000UL /* active cursor (block) */
24#define ATTR_PASCURS 0x40000000UL /* passive cursor (box) */
25#define ATTR_INVALID 0x20000000UL
26#define ATTR_WRAPPED 0x10000000UL
27
c9def1b8 28#define LATTR_NORM 0x00000000UL
29#define LATTR_WIDE 0x01000000UL
30#define LATTR_TOP 0x02000000UL
31#define LATTR_BOT 0x03000000UL
32#define LATTR_MODE 0x03000000UL
33
374330e2 34#define ATTR_ASCII 0x00000000UL /* normal ASCII charset ESC ( B */
35#define ATTR_GBCHR 0x00100000UL /* UK variant charset ESC ( A */
36#define ATTR_LINEDRW 0x00200000UL /* line drawing charset ESC ( 0 */
37
38#define ATTR_BOLD 0x00000100UL
39#define ATTR_UNDER 0x00000200UL
40#define ATTR_REVERSE 0x00000400UL
e14a5a13 41#define ATTR_BLINK 0x00000800UL
374330e2 42#define ATTR_FGMASK 0x0000F000UL
43#define ATTR_BGMASK 0x000F0000UL
44#define ATTR_FGSHIFT 12
45#define ATTR_BGSHIFT 16
46
47#define ATTR_DEFAULT 0x00098000UL
48#define ATTR_DEFFG 0x00008000UL
49#define ATTR_DEFBG 0x00090000UL
50#define ATTR_CUR_XOR 0x000BA000UL
51#define ERASE_CHAR (ATTR_DEFAULT | ' ')
52#define ATTR_MASK 0xFFFFFF00UL
53#define CHAR_MASK 0x000000FFUL
54
55typedef HDC Context;
56#define SEL_NL { 13, 10 }
57
58GLOBAL int rows, cols, savelines;
59
60GLOBAL int font_width, font_height;
61
62#define INBUF_SIZE 2048
374330e2 63GLOBAL unsigned char inbuf[INBUF_SIZE];
c9def1b8 64GLOBAL int inbuf_head;
374330e2 65
66#define OUTBUF_SIZE 2048
67#define OUTBUF_MASK (OUTBUF_SIZE-1)
68GLOBAL unsigned char outbuf[OUTBUF_SIZE];
69GLOBAL int outbuf_head, outbuf_reap;
70
71GLOBAL int has_focus;
72
c9def1b8 73GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
74GLOBAL int repeat_off, cr_lf_return;
374330e2 75
cabfd08c 76GLOBAL int seen_key_event;
77GLOBAL int seen_disp_event;
78
d85548fe 79GLOBAL int session_closed;
80
5fd04f07 81GLOBAL char *logfile;
82
e14a5a13 83/*
84 * I've just looked in the windows standard headr files for WM_USER, there
85 * are hundreds of flags defined using the form WM_USER+123 so I've
86 * renumbered this NETEVENT value and the two in window.c
87 */
88#define WM_XUSER (WM_USER + 0x2000)
89#define WM_NETEVENT (WM_XUSER + 5)
374330e2 90
91typedef enum {
92 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
ec55b220 93 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING
374330e2 94} Telnet_Special;
95
96typedef enum {
97 MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
98} Mouse_Button;
99
100typedef enum {
101 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
102} Mouse_Action;
103
104typedef enum {
105 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
106} VT_Mode;
107
108typedef struct {
8df7a775 109 char *(*init) (char *host, int port, char **realhost);
374330e2 110 void (*send) (char *buf, int len);
111 void (*size) (void);
112 void (*special) (Telnet_Special code);
8df7a775 113 Socket (*socket) (void);
8ccc75b0 114 int (*sendok) (void);
97db3be4 115 int default_port;
374330e2 116} Backend;
117
118GLOBAL Backend *back;
119
297d398b 120extern struct backend_list {
89ee5268 121 int protocol;
122 char *name;
123 Backend *backend;
124} backends[];
125
374330e2 126typedef struct {
5bc238bb 127 void (*send) (char *buf, int len);
128} Ldisc;
129
130GLOBAL Ldisc *ldisc;
131
132typedef struct {
374330e2 133 /* Basic options */
134 char host[512];
135 int port;
5e1a8e27 136 enum { PROT_RAW, PROT_TELNET, PROT_SSH } protocol;
374330e2 137 int close_on_exit;
9ef49106 138 int warn_on_close;
ec55b220 139 int ping_interval;
fef97f43 140 /* SSH options */
6abbf9e3 141 char remote_cmd[512];
fef97f43 142 int nopty;
979310f1 143 int agentfwd;
9697bfd2 144 enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
7cca0d81 145 char keyfile[FILENAME_MAX];
adf799dd 146 int sshprot; /* use v1 or v2 when both available */
7591b9ff 147 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
ccbfb941 148 int try_tis_auth;
374330e2 149 /* Telnet options */
150 char termtype[32];
151 char termspeed[32];
37508af4 152 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2 153 char username[32];
154 int rfc_environ;
155 /* Keyboard options */
156 int bksp_is_delete;
157 int rxvt_homeend;
c9def1b8 158 int funky_type;
374330e2 159 int app_cursor;
160 int app_keypad;
c5e9c988 161 int nethack_keypad;
162 int alt_f4; /* is it special? */
163 int alt_space; /* is it special? */
a094ae43 164 int alt_only; /* is it special? */
5bc238bb 165 int ldisc_term;
c9def1b8 166 int scroll_on_key;
a094ae43 167 int scroll_on_disp;
168 int compose_key;
9ca5da42 169 char wintitle[256]; /* initial window title */
374330e2 170 /* Terminal options */
171 int savelines;
172 int dec_om;
173 int wrap_mode;
fef97f43 174 int lfhascr;
c9def1b8 175 int blink_cur;
176 int beep;
177 int scrollbar;
178 int locksize;
179 int bce;
180 int blinktext;
374330e2 181 int win_name_always;
182 int width, height;
183 char font[64];
184 int fontisbold;
185 int fontheight;
14963b8f 186 int fontcharset;
374330e2 187 /* Colour options */
188 int try_palette;
189 int bold_colour;
190 unsigned char colours[22][3];
191 /* Selection options */
192 int mouse_is_xterm;
193 short wordness[256];
c9def1b8 194 /* translations */
195 VT_Mode vtmode;
14963b8f 196 int xlat_enablekoiwin;
d3d16feb 197 int xlat_88592w1250;
b0faa571 198 int xlat_88592cp852;
14963b8f 199 int xlat_capslockcyr;
374330e2 200} Config;
201
e277c42d 202/*
203 * You can compile with -DSSH_DEFAULT to have ssh by default.
204 */
205#ifndef SSH_DEFAULT
206#define DEFAULT_PROTOCOL PROT_TELNET
207#define DEFAULT_PORT 23
208#else
209#define DEFAULT_PROTOCOL PROT_SSH
210#define DEFAULT_PORT 22
211#endif
212
4017be6d 213/*
214 * Some global flags denoting the type of application.
67779be7 215 *
216 * FLAG_VERBOSE is set when the user requests verbose details.
217 *
218 * FLAG_STDERR is set in command-line applications (which have a
219 * functioning stderr that it makes sense to write to) and not in
220 * GUI applications (which don't).
221 *
222 * FLAG_INTERACTIVE is set when a full interactive shell session is
223 * being run, _either_ because no remote command has been provided
224 * _or_ because the application is GUI and can't run non-
225 * interactively.
4017be6d 226 */
67779be7 227#define FLAG_VERBOSE 0x0001
228#define FLAG_STDERR 0x0002
229#define FLAG_INTERACTIVE 0x0004
4017be6d 230GLOBAL int flags;
231
374330e2 232GLOBAL Config cfg;
e277c42d 233GLOBAL int default_protocol;
234GLOBAL int default_port;
374330e2 235
4e23b276 236struct RSAKey; /* be a little careful of scope */
237
374330e2 238/*
239 * Exports from window.c.
240 */
e14a5a13 241void request_resize (int, int, int);
c9def1b8 242void do_text (Context, int, int, char *, int, unsigned long, int);
374330e2 243void set_title (char *);
244void set_icon (char *);
245void set_sbar (int, int, int);
f67b4e85 246Context get_ctx(void);
374330e2 247void free_ctx (Context);
248void palette_set (int, int, int, int);
249void palette_reset (void);
f0df44da 250void write_clip (void *, int, int);
374330e2 251void get_clip (void **, int *);
252void optimised_move (int, int, int);
8d5de777 253void connection_fatal(char *, ...);
374330e2 254void fatalbox (char *, ...);
c9def1b8 255void beep (int);
6f34e365 256void begin_session(void);
ec8679e9 257void sys_cursor(int x, int y);
374330e2 258#define OPTIMISE_IS_SCROLL 1
259
260/*
261 * Exports from noise.c.
262 */
263void noise_get_heavy(void (*func) (void *, int));
264void noise_get_light(void (*func) (void *, int));
265void noise_ultralight(DWORD data);
266void random_save_seed(void);
de3df031 267void random_destroy_seed(void);
374330e2 268
269/*
270 * Exports from windlg.c.
271 */
8c3cd914 272void defuse_showwindow(void);
374330e2 273int do_config (void);
274int do_reconfig (HWND);
a9422f39 275void do_defaults (char *, Config *);
c5e9c988 276void logevent (char *);
277void showeventlog (HWND);
374330e2 278void showabout (HWND);
d4857987 279void verify_ssh_host_key(char *host, int port, char *keytype,
d5859615 280 char *keystr, char *fingerprint);
de3df031 281void registry_cleanup(void);
0a4aa984 282
7393a137 283GLOBAL int nsessions;
284GLOBAL char **sessions;
374330e2 285
286/*
a9422f39 287 * Exports from settings.c.
288 */
289void save_settings (char *section, int do_host, Config *cfg);
290void load_settings (char *section, int do_host, Config *cfg);
291void get_sesslist(int allocate);
292
293/*
374330e2 294 * Exports from terminal.c.
295 */
296
297void term_init (void);
298void term_size (int, int, int);
299void term_out (void);
300void term_paint (Context, int, int, int, int);
301void term_scroll (int, int);
302void term_pwron (void);
303void term_clrsb (void);
304void term_mouse (Mouse_Button, Mouse_Action, int, int);
305void term_deselect (void);
306void term_update (void);
307void term_invalidate(void);
e14a5a13 308void term_blink(int set_cursor);
c9def1b8 309void term_paste(void);
310void term_nopaste(void);
fe50e814 311void from_backend(int is_stderr, char *data, int len);
374330e2 312
313/*
5e1a8e27 314 * Exports from raw.c.
315 */
316
3d9a14c9 317extern Backend raw_backend;
5e1a8e27 318
319/*
374330e2 320 * Exports from telnet.c.
321 */
322
c14776e8 323extern Backend telnet_backend;
374330e2 324
325/*
326 * Exports from ssh.c.
327 */
328
67779be7 329extern int (*ssh_get_password)(const char *prompt, char *str, int maxlen);
c14776e8 330extern Backend ssh_backend;
374330e2 331
332/*
5bc238bb 333 * Exports from ldisc.c.
334 */
335
336extern Ldisc ldisc_term, ldisc_simple;
337
338/*
374330e2 339 * Exports from sshrand.c.
340 */
341
342void random_add_noise(void *noise, int length);
343void random_init(void);
344int random_byte(void);
345void random_get_savedata(void **data, int *len);
346
347/*
348 * Exports from misc.c.
349 */
350
351/* #define MALLOC_LOG do this if you suspect putty of leaking memory */
352#ifdef MALLOC_LOG
353#define smalloc(z) (mlog(__FILE__,__LINE__), safemalloc(z))
354#define srealloc(y,z) (mlog(__FILE__,__LINE__), saferealloc(y,z))
355#define sfree(z) (mlog(__FILE__,__LINE__), safefree(z))
356void mlog(char *, int);
357#else
358#define smalloc safemalloc
359#define srealloc saferealloc
360#define sfree safefree
361#endif
362
363void *safemalloc(size_t);
364void *saferealloc(void *, size_t);
365void safefree(void *);
366
367/*
067a15ea 368 * Exports from version.c.
369 */
370extern char ver[];
371
372/*
b73fd1b1 373 * Exports from sizetip.c.
374 */
375void UpdateSizeTip(HWND src, int cx, int cy);
376void EnableSizeTip(int bEnable);
377
378/*
14963b8f 379 * Exports from xlat.c.
380 */
381unsigned char xlat_kbd2tty(unsigned char c);
382unsigned char xlat_tty2scr(unsigned char c);
383unsigned char xlat_latkbd2win(unsigned char c);
384
385/*
8f203108 386 * Exports from mscrypto.c
387 */
388#ifdef MSCRYPTOAPI
389int crypto_startup();
390void crypto_wrapup();
391#endif
392
393/*
5c58ad2d 394 * Exports from pageantc.c
395 */
396void agent_query(void *in, int inlen, void **out, int *outlen);
397int agent_exists(void);
398
399/*
374330e2 400 * A debug system.
401 */
402#ifdef DEBUG
403#include <stdarg.h>
404#define debug(x) (dprintf x)
405static void dprintf(char *fmt, ...) {
406 char buf[2048];
407 DWORD dw;
408 va_list ap;
409 static int gotconsole = 0;
410
411 if (!gotconsole) {
412 AllocConsole();
413 gotconsole = 1;
414 }
415
416 va_start(ap, fmt);
417 vsprintf(buf, fmt, ap);
418 WriteFile (GetStdHandle(STD_OUTPUT_HANDLE), buf, strlen(buf), &dw, NULL);
419 va_end(ap);
420}
421#else
422#define debug(x)
423#endif
424
425#endif