I have no brain at all. The SSH1 auth loop was trying all Pageant
[sgt/putty] / putty.h
CommitLineData
374330e2 1#ifndef PUTTY_PUTTY_H
2#define PUTTY_PUTTY_H
3
ca20bfcf 4#include <stdio.h> /* for FILENAME_MAX */
5
8df7a775 6#include "network.h"
7
374330e2 8#define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
de3df031 9#define PUTTY_REG_PARENT "Software\\SimonTatham"
10#define PUTTY_REG_PARENT_CHILD "PuTTY"
11#define PUTTY_REG_GPARENT "Software"
12#define PUTTY_REG_GPARENT_CHILD "SimonTatham"
374330e2 13
14/*
15 * Global variables. Most modules declare these `extern', but
16 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
17 * module, and so will get them properly defined.
18 */
19#ifdef PUTTY_DO_GLOBALS
20#define GLOBAL
21#else
22#define GLOBAL extern
23#endif
24
4eeb7d09 25/* Three attribute types:
26 * The ATTRs (normal attributes) are stored with the characters in the main
27 * display arrays
28 *
29 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
30 * with characters but not with normal attributes.
31 *
32 * The LATTRs (line attributes) conflict with no others and only have one
33 * value per line. But on area clears the LATTR cells are set to the erase_char
34 * (or DEFAULT_ATTR + 'E')
35 *
36 * ATTR_INVALID is an illegal colour combination.
37 */
38
39#define TATTR_ACTCURS 0x4UL /* active cursor (block) */
40#define TATTR_PASCURS 0x2UL /* passive cursor (box) */
41#define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
374330e2 42
c9def1b8 43#define LATTR_NORM 0x00000000UL
44#define LATTR_WIDE 0x01000000UL
45#define LATTR_TOP 0x02000000UL
46#define LATTR_BOT 0x03000000UL
47#define LATTR_MODE 0x03000000UL
4eeb7d09 48#define LATTR_WRAPPED 0x10000000UL
49
50#define ATTR_INVALID 0x00FF0000UL
51
52/* Like Linux use the F000 page for direct to font. */
53#define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
54#define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
55
56/* These are internal use overlapping with the UTF-16 surrogates */
57#define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
58#define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
d3cb5465 59#define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
4eeb7d09 60#define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
61#define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
62
63#define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
64#define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
65
66#define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
67#define UCSWIDE 0x303F
68
5a73255e 69#define ATTR_NARROW 0x20000000UL
4eeb7d09 70#define ATTR_WIDE 0x10000000UL
71#define ATTR_BOLD 0x01000000UL
72#define ATTR_UNDER 0x02000000UL
73#define ATTR_REVERSE 0x04000000UL
74#define ATTR_BLINK 0x08000000UL
75#define ATTR_FGMASK 0x000F0000UL
76#define ATTR_BGMASK 0x00F00000UL
77#define ATTR_COLOURS 0x00FF0000UL
78#define ATTR_FGSHIFT 16
79#define ATTR_BGSHIFT 20
80
81#define ATTR_DEFAULT 0x00980000UL
82#define ATTR_DEFFG 0x00080000UL
83#define ATTR_DEFBG 0x00900000UL
8f22582c 84#define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
374330e2 85#define ATTR_MASK 0xFFFFFF00UL
86#define CHAR_MASK 0x000000FFUL
4eeb7d09 87
88#define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
89#define ATTR_CUR_XOR 0x00BA0000UL
374330e2 90
91typedef HDC Context;
92#define SEL_NL { 13, 10 }
93
94GLOBAL int rows, cols, savelines;
95
374330e2 96GLOBAL int has_focus;
97
156686ef 98GLOBAL int in_vbell;
286c6b86 99GLOBAL unsigned long vbell_startpoint;
156686ef 100
c9def1b8 101GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
102GLOBAL int repeat_off, cr_lf_return;
374330e2 103
cabfd08c 104GLOBAL int seen_key_event;
105GLOBAL int seen_disp_event;
5a73255e 106GLOBAL int alt_pressed;
cabfd08c 107
d85548fe 108GLOBAL int session_closed;
109
4eeb7d09 110GLOBAL int big_cursor;
111
70133c0e 112GLOBAL char *help_path;
113GLOBAL int help_has_contents;
114
4eeb7d09 115GLOBAL int utf;
116GLOBAL int dbcs_screenfont;
117GLOBAL int font_codepage;
118GLOBAL int kbd_codepage;
119GLOBAL int line_codepage;
d3cb5465 120GLOBAL WCHAR unitab_scoacs[256];
4eeb7d09 121GLOBAL WCHAR unitab_line[256];
122GLOBAL WCHAR unitab_font[256];
123GLOBAL WCHAR unitab_xterm[256];
124GLOBAL WCHAR unitab_oemcp[256];
125GLOBAL unsigned char unitab_ctrl[256];
8f22582c 126#define in_utf (utf || line_codepage==CP_UTF8)
4eeb7d09 127
32874aea 128#define LGXF_OVR 1 /* existing logfile overwrite */
129#define LGXF_APN 0 /* existing logfile append */
130#define LGXF_ASK -1 /* existing logfile ask */
131#define LGTYP_NONE 0 /* logmode: no logging */
132#define LGTYP_ASCII 1 /* logmode: pure ascii */
00db133f 133#define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
134#define LGTYP_PACKETS 3 /* logmode: SSH data packets */
5fd04f07 135GLOBAL char *logfile;
136
e14a5a13 137/*
475eebf9 138 * Window handles for the dialog boxes that can be running during a
139 * PuTTY session.
140 */
141GLOBAL HWND logbox;
142
143/*
e14a5a13 144 * I've just looked in the windows standard headr files for WM_USER, there
145 * are hundreds of flags defined using the form WM_USER+123 so I've
146 * renumbered this NETEVENT value and the two in window.c
147 */
148#define WM_XUSER (WM_USER + 0x2000)
149#define WM_NETEVENT (WM_XUSER + 5)
374330e2 150
151typedef enum {
152 TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
a5f3e637 153 TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
154 TS_EOL
374330e2 155} Telnet_Special;
156
157typedef enum {
01c034ad 158 MBT_NOTHING,
159 MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */
160 MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
161 MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */
374330e2 162} Mouse_Button;
163
164typedef enum {
165 MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
166} Mouse_Action;
167
168typedef enum {
4eeb7d09 169 VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
374330e2 170} VT_Mode;
171
0965bee0 172enum {
173 /*
ca20bfcf 174 * SSH ciphers (both SSH1 and SSH2)
175 */
176 CIPHER_WARN, /* pseudo 'cipher' */
177 CIPHER_3DES,
178 CIPHER_BLOWFISH,
179 CIPHER_AES, /* (SSH 2 only) */
7f1ae1d2 180 CIPHER_DES,
ca20bfcf 181 CIPHER_MAX /* no. ciphers (inc warn) */
182};
183
184enum {
185 /*
0965bee0 186 * Line discipline option states: off, on, up to the backend.
187 */
188 LD_YES, LD_NO, LD_BACKEND
189};
190
191enum {
192 /*
193 * Line discipline options which the backend might try to control.
194 */
32874aea 195 LD_EDIT, /* local line editing */
196 LD_ECHO /* local echo */
0965bee0 197};
198
b41069ff 199enum {
200 /*
201 * Close On Exit behaviours. (cfg.close_on_exit)
202 */
32874aea 203 COE_NEVER, /* Never close the window */
204 COE_NORMAL, /* Close window on "normal" (non-error) exits only */
205 COE_ALWAYS /* Always close the window */
b41069ff 206};
207
374330e2 208typedef struct {
2184a5d9 209 char *(*init) (char *host, int port, char **realhost, int nodelay);
5471d09a 210 /* back->send() returns the current amount of buffered data. */
211 int (*send) (char *buf, int len);
212 /* back->sendbuffer() does the same thing but without attempting a send */
213 int (*sendbuffer) (void);
374330e2 214 void (*size) (void);
215 void (*special) (Telnet_Special code);
5471d09a 216 Socket(*socket) (void);
d8d6c7e5 217 int (*exitcode) (void);
8ccc75b0 218 int (*sendok) (void);
0965bee0 219 int (*ldisc) (int);
5471d09a 220 /*
221 * back->unthrottle() tells the back end that the front end
222 * buffer is clearing.
223 */
224 void (*unthrottle) (int);
97db3be4 225 int default_port;
374330e2 226} Backend;
227
228GLOBAL Backend *back;
229
297d398b 230extern struct backend_list {
89ee5268 231 int protocol;
232 char *name;
233 Backend *backend;
234} backends[];
235
374330e2 236typedef struct {
237 /* Basic options */
238 char host[512];
239 int port;
c91409da 240 enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
374330e2 241 int close_on_exit;
9ef49106 242 int warn_on_close;
32874aea 243 int ping_interval; /* in seconds */
2184a5d9 244 int tcp_nodelay;
fef97f43 245 /* SSH options */
6abbf9e3 246 char remote_cmd[512];
fd5e5847 247 char remote_cmd2[512]; /* fallback if the first fails
248 * (used internally for scp) */
32874aea 249 char *remote_cmd_ptr; /* might point to a larger command
250 * but never for loading/saving */
fd5e5847 251 char *remote_cmd_ptr2; /* might point to a larger command
252 * but never for loading/saving */
fef97f43 253 int nopty;
4ba9b64b 254 int compression;
979310f1 255 int agentfwd;
5bb641e1 256 int change_username; /* allow username switching in SSH2 */
ca20bfcf 257 int ssh_cipherlist[CIPHER_MAX];
7cca0d81 258 char keyfile[FILENAME_MAX];
32874aea 259 int sshprot; /* use v1 or v2 when both available */
260 int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */
cb4d4768 261 int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */
ccbfb941 262 int try_tis_auth;
f091e308 263 int try_ki_auth;
4a8fc3c4 264 int ssh_subsys; /* run a subsystem rather than a command */
fd5e5847 265 int ssh_subsys2; /* fallback to go with remote_cmd2 */
374330e2 266 /* Telnet options */
267 char termtype[32];
268 char termspeed[32];
32874aea 269 char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
374330e2 270 char username[32];
c91409da 271 char localusername[32];
374330e2 272 int rfc_environ;
8faa456c 273 int passive_telnet;
374330e2 274 /* Keyboard options */
275 int bksp_is_delete;
276 int rxvt_homeend;
c9def1b8 277 int funky_type;
32874aea 278 int no_applic_c; /* totally disable app cursor keys */
279 int no_applic_k; /* totally disable app keypad */
374330e2 280 int app_cursor;
281 int app_keypad;
c5e9c988 282 int nethack_keypad;
a5f3e637 283 int telnet_keyboard;
eee63b77 284 int telnet_newline;
c5e9c988 285 int alt_f4; /* is it special? */
286 int alt_space; /* is it special? */
a094ae43 287 int alt_only; /* is it special? */
0965bee0 288 int localecho;
289 int localedit;
e95edc00 290 int alwaysontop;
8f57d753 291 int fullscreenonaltenter;
c9def1b8 292 int scroll_on_key;
a094ae43 293 int scroll_on_disp;
294 int compose_key;
95bbe1ae 295 int ctrlaltkeys;
32874aea 296 char wintitle[256]; /* initial window title */
374330e2 297 /* Terminal options */
298 int savelines;
299 int dec_om;
300 int wrap_mode;
fef97f43 301 int lfhascr;
4e30ff69 302 int cursor_type; /* 0=block 1=underline 2=vertical */
c9def1b8 303 int blink_cur;
03169ad0 304 enum {
305 BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
306 } beep;
f8a28d1f 307 enum {
308 B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
309 } beep_ind;
156686ef 310 int bellovl; /* bell overload protection active? */
311 int bellovl_n; /* number of bells to cause overload */
312 int bellovl_t; /* time interval for overload (seconds) */
313 int bellovl_s; /* period of silence to re-enable bell (s) */
03169ad0 314 char bell_wavefile[FILENAME_MAX];
c9def1b8 315 int scrollbar;
a401e5f3 316 int scrollbar_in_fullscreen;
0ed2f48e 317 enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
c9def1b8 318 int bce;
319 int blinktext;
374330e2 320 int win_name_always;
321 int width, height;
322 char font[64];
323 int fontisbold;
324 int fontheight;
14963b8f 325 int fontcharset;
e1c8e0ed 326 char logfilename[FILENAME_MAX];
327 int logtype;
9f89f96e 328 int logxfovr;
554c540d 329 int hide_mouseptr;
57d08f2f 330 int sunken_edge;
5a73255e 331 int window_border;
e7fbcdd8 332 char answerback[256];
374330e2 333 /* Colour options */
334 int try_palette;
335 int bold_colour;
336 unsigned char colours[22][3];
337 /* Selection options */
338 int mouse_is_xterm;
6908fed7 339 int rect_select;
d3a22f79 340 int rawcnp;
a7419ea4 341 int rtf_paste;
b90840c3 342 int mouse_override;
374330e2 343 short wordness[256];
c9def1b8 344 /* translations */
345 VT_Mode vtmode;
8bb92a1c 346 char line_codepage[128];
a9c02454 347 int xlat_capslockcyr;
9c964e85 348 /* X11 forwarding */
349 int x11_forward;
350 char x11_display[128];
d74d141c 351 /* port forwarding */
beefa433 352 int lport_acceptall; /* accept conns from hosts other than localhost */
353 int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
d74d141c 354 char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
374330e2 355} Config;
356
e277c42d 357/*
358 * You can compile with -DSSH_DEFAULT to have ssh by default.
359 */
360#ifndef SSH_DEFAULT
361#define DEFAULT_PROTOCOL PROT_TELNET
362#define DEFAULT_PORT 23
363#else
364#define DEFAULT_PROTOCOL PROT_SSH
365#define DEFAULT_PORT 22
366#endif
367
4017be6d 368/*
369 * Some global flags denoting the type of application.
67779be7 370 *
371 * FLAG_VERBOSE is set when the user requests verbose details.
372 *
373 * FLAG_STDERR is set in command-line applications (which have a
374 * functioning stderr that it makes sense to write to) and not in
375 * GUI applications (which don't).
376 *
377 * FLAG_INTERACTIVE is set when a full interactive shell session is
378 * being run, _either_ because no remote command has been provided
379 * _or_ because the application is GUI and can't run non-
380 * interactively.
4017be6d 381 */
67779be7 382#define FLAG_VERBOSE 0x0001
383#define FLAG_STDERR 0x0002
384#define FLAG_INTERACTIVE 0x0004
4017be6d 385GLOBAL int flags;
386
374330e2 387GLOBAL Config cfg;
e277c42d 388GLOBAL int default_protocol;
389GLOBAL int default_port;
374330e2 390
4e23b276 391struct RSAKey; /* be a little careful of scope */
392
374330e2 393/*
394 * Exports from window.c.
395 */
5a73255e 396void request_resize(int, int);
32874aea 397void do_text(Context, int, int, char *, int, unsigned long, int);
4eeb7d09 398void do_cursor(Context, int, int, char *, int, unsigned long, int);
5a73255e 399int CharWidth(Context ctx, int uc);
32874aea 400void set_title(char *);
401void set_icon(char *);
402void set_sbar(int, int, int);
f67b4e85 403Context get_ctx(void);
32874aea 404void free_ctx(Context);
405void palette_set(int, int, int, int);
406void palette_reset(void);
4eeb7d09 407void write_aclip(char *, int, int);
408void write_clip(wchar_t *, int, int);
409void get_clip(wchar_t **, int *);
32874aea 410void optimised_move(int, int, int);
01c034ad 411void set_raw_mouse_mode(int);
412Mouse_Button translate_button(Mouse_Button b);
8d5de777 413void connection_fatal(char *, ...);
32874aea 414void fatalbox(char *, ...);
415void beep(int);
6f34e365 416void begin_session(void);
ec8679e9 417void sys_cursor(int x, int y);
374330e2 418#define OPTIMISE_IS_SCROLL 1
419
68f9b3d9 420void set_iconic(int iconic);
421void move_window(int x, int y);
422void set_zorder(int top);
423void refresh_window(void);
424void set_zoomed(int zoomed);
425int is_iconic(void);
426void get_window_pos(int *x, int *y);
427void get_window_pixels(int *x, int *y);
428char *get_window_title(int icon);
429
374330e2 430/*
431 * Exports from noise.c.
432 */
32874aea 433void noise_get_heavy(void (*func) (void *, int));
434void noise_get_light(void (*func) (void *, int));
7d6ee6ff 435void noise_regular(void);
374330e2 436void noise_ultralight(DWORD data);
437void random_save_seed(void);
de3df031 438void random_destroy_seed(void);
374330e2 439
440/*
441 * Exports from windlg.c.
442 */
8c3cd914 443void defuse_showwindow(void);
32874aea 444int do_config(void);
445int do_reconfig(HWND);
446void do_defaults(char *, Config *);
447void logevent(char *);
448void showeventlog(HWND);
449void showabout(HWND);
d4857987 450void verify_ssh_host_key(char *host, int port, char *keytype,
32874aea 451 char *keystr, char *fingerprint);
ca20bfcf 452void askcipher(char *ciphername, int cs);
e1c8e0ed 453int askappend(char *filename);
de3df031 454void registry_cleanup(void);
3da0b1d2 455void force_normal(HWND hwnd);
0a4aa984 456
7393a137 457GLOBAL int nsessions;
458GLOBAL char **sessions;
374330e2 459
460/*
a9422f39 461 * Exports from settings.c.
462 */
32874aea 463void save_settings(char *section, int do_host, Config * cfg);
464void load_settings(char *section, int do_host, Config * cfg);
a9422f39 465void get_sesslist(int allocate);
466
467/*
374330e2 468 * Exports from terminal.c.
469 */
470
32874aea 471void term_init(void);
472void term_size(int, int, int);
473void term_out(void);
474void term_paint(Context, int, int, int, int);
475void term_scroll(int, int);
476void term_pwron(void);
477void term_clrsb(void);
6908fed7 478void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int, int);
32874aea 479void term_deselect(void);
480void term_update(void);
374330e2 481void term_invalidate(void);
e14a5a13 482void term_blink(int set_cursor);
568dd02f 483void term_do_paste(void);
c9def1b8 484void term_paste(void);
485void term_nopaste(void);
feb7fdfe 486int term_ldisc(int option);
5471d09a 487int from_backend(int is_stderr, char *data, int len);
32874aea 488void logfopen(void);
489void logfclose(void);
bc1235d4 490void term_copyall(void);
374330e2 491
492/*
00db133f 493 * Exports from logging.c.
494 */
495void logtraffic(unsigned char c, int logmode);
496enum { PKT_INCOMING, PKT_OUTGOING };
497void log_packet(int direction, int type, char *texttype, void *data, int len);
498
499/*
5e1a8e27 500 * Exports from raw.c.
501 */
502
3d9a14c9 503extern Backend raw_backend;
5e1a8e27 504
505/*
c91409da 506 * Exports from rlogin.c.
507 */
508
509extern Backend rlogin_backend;
510
511/*
374330e2 512 * Exports from telnet.c.
513 */
514
c14776e8 515extern Backend telnet_backend;
374330e2 516
517/*
518 * Exports from ssh.c.
519 */
520
32874aea 521extern int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
522 int is_pw);
c14776e8 523extern Backend ssh_backend;
374330e2 524
525/*
5bc238bb 526 * Exports from ldisc.c.
527 */
528
760e88b2 529extern void ldisc_send(char *buf, int len, int interactive);
5bc238bb 530
531/*
374330e2 532 * Exports from sshrand.c.
533 */
534
535void random_add_noise(void *noise, int length);
536void random_init(void);
537int random_byte(void);
538void random_get_savedata(void **data, int *len);
539
540/*
541 * Exports from misc.c.
542 */
543
db9c0f86 544#include "misc.h"
374330e2 545
546/*
067a15ea 547 * Exports from version.c.
548 */
549extern char ver[];
550
551/*
b73fd1b1 552 * Exports from sizetip.c.
553 */
554void UpdateSizeTip(HWND src, int cx, int cy);
555void EnableSizeTip(int bEnable);
556
557/*
4eeb7d09 558 * Exports from unicode.c.
14963b8f 559 */
4eeb7d09 560#ifndef CP_UTF8
561#define CP_UTF8 65001
562#endif
563void init_ucs_tables(void);
760e88b2 564void lpage_send(int codepage, char *buf, int len, int interactive);
565void luni_send(wchar_t * widebuf, int len, int interactive);
a9c02454 566wchar_t xlat_uskbd2cyrllic(int ch);
4eeb7d09 567int check_compose(int first, int second);
568int decode_codepage(char *cp_name);
875b193f 569char *cp_enumerate (int index);
4eeb7d09 570char *cp_name(int codepage);
a7419ea4 571void get_unitab(int codepage, wchar_t * unitab, int ftype);
14963b8f 572
573/*
8f203108 574 * Exports from mscrypto.c
575 */
576#ifdef MSCRYPTOAPI
577int crypto_startup();
578void crypto_wrapup();
579#endif
580
581/*
5c58ad2d 582 * Exports from pageantc.c
583 */
584void agent_query(void *in, int inlen, void **out, int *outlen);
585int agent_exists(void);
586
4eb24e3a 587/*
588 * Exports from wildcard.c
589 */
590const char *wc_error(int value);
591int wc_match(const char *wildcard, const char *target);
592int wc_unescape(char *output, const char *wildcard);
374330e2 593
594#endif