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