| 1 | #ifndef PUTTY_PUTTY_H |
| 2 | #define PUTTY_PUTTY_H |
| 3 | |
| 4 | #include "network.h" |
| 5 | |
| 6 | #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY" |
| 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" |
| 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 | #define ATTR_RIGHTCURS 0x10000000UL /* doubles as cursor-on-RHS indicator */ |
| 28 | |
| 29 | #define LATTR_NORM 0x00000000UL |
| 30 | #define LATTR_WIDE 0x01000000UL |
| 31 | #define LATTR_TOP 0x02000000UL |
| 32 | #define LATTR_BOT 0x03000000UL |
| 33 | #define LATTR_MODE 0x03000000UL |
| 34 | |
| 35 | #define ATTR_ASCII 0x00000000UL /* normal ASCII charset ESC ( B */ |
| 36 | #define ATTR_GBCHR 0x00100000UL /* UK variant charset ESC ( A */ |
| 37 | #define ATTR_LINEDRW 0x00200000UL /* line drawing charset ESC ( 0 */ |
| 38 | |
| 39 | #define ATTR_BOLD 0x00000100UL |
| 40 | #define ATTR_UNDER 0x00000200UL |
| 41 | #define ATTR_REVERSE 0x00000400UL |
| 42 | #define ATTR_BLINK 0x00000800UL |
| 43 | #define ATTR_FGMASK 0x0000F000UL |
| 44 | #define ATTR_BGMASK 0x000F0000UL |
| 45 | #define ATTR_FGSHIFT 12 |
| 46 | #define ATTR_BGSHIFT 16 |
| 47 | |
| 48 | #define ATTR_DEFAULT 0x00098000UL |
| 49 | #define ATTR_DEFFG 0x00008000UL |
| 50 | #define ATTR_DEFBG 0x00090000UL |
| 51 | #define ATTR_CUR_XOR 0x000BA000UL |
| 52 | #define ERASE_CHAR (ATTR_DEFAULT | ' ') |
| 53 | #define ATTR_MASK 0xFFFFFF00UL |
| 54 | #define CHAR_MASK 0x000000FFUL |
| 55 | #define CSET_MASK 0x00F00000UL /* mask for character set */ |
| 56 | |
| 57 | typedef HDC Context; |
| 58 | #define SEL_NL { 13, 10 } |
| 59 | |
| 60 | GLOBAL int rows, cols, savelines; |
| 61 | |
| 62 | GLOBAL int font_width, font_height; |
| 63 | |
| 64 | #define INBUF_SIZE 2048 |
| 65 | GLOBAL unsigned char inbuf[INBUF_SIZE]; |
| 66 | GLOBAL int inbuf_head; |
| 67 | |
| 68 | #define OUTBUF_SIZE 2048 |
| 69 | #define OUTBUF_MASK (OUTBUF_SIZE-1) |
| 70 | GLOBAL unsigned char outbuf[OUTBUF_SIZE]; |
| 71 | GLOBAL int outbuf_head, outbuf_reap; |
| 72 | |
| 73 | GLOBAL int has_focus; |
| 74 | |
| 75 | GLOBAL int in_vbell; |
| 76 | GLOBAL long vbell_timeout; |
| 77 | |
| 78 | GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode; |
| 79 | GLOBAL int repeat_off, cr_lf_return; |
| 80 | |
| 81 | GLOBAL int seen_key_event; |
| 82 | GLOBAL int seen_disp_event; |
| 83 | |
| 84 | GLOBAL int session_closed; |
| 85 | |
| 86 | #define LGXF_OVR 1 /* existing logfile overwrite */ |
| 87 | #define LGXF_APN 0 /* existing logfile append */ |
| 88 | #define LGXF_ASK -1 /* existing logfile ask */ |
| 89 | #define LGTYP_NONE 0 /* logmode: no logging */ |
| 90 | #define LGTYP_ASCII 1 /* logmode: pure ascii */ |
| 91 | #define LGTYP_DEBUG 2 /* logmode: all chars of taffic */ |
| 92 | GLOBAL char *logfile; |
| 93 | |
| 94 | /* |
| 95 | * Window handles for the dialog boxes that can be running during a |
| 96 | * PuTTY session. |
| 97 | */ |
| 98 | GLOBAL HWND logbox; |
| 99 | |
| 100 | /* |
| 101 | * I've just looked in the windows standard headr files for WM_USER, there |
| 102 | * are hundreds of flags defined using the form WM_USER+123 so I've |
| 103 | * renumbered this NETEVENT value and the two in window.c |
| 104 | */ |
| 105 | #define WM_XUSER (WM_USER + 0x2000) |
| 106 | #define WM_NETEVENT (WM_XUSER + 5) |
| 107 | |
| 108 | typedef enum { |
| 109 | TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT, |
| 110 | TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING |
| 111 | } Telnet_Special; |
| 112 | |
| 113 | typedef enum { |
| 114 | MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE |
| 115 | } Mouse_Button; |
| 116 | |
| 117 | typedef enum { |
| 118 | MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE |
| 119 | } Mouse_Action; |
| 120 | |
| 121 | typedef enum { |
| 122 | VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN |
| 123 | } VT_Mode; |
| 124 | |
| 125 | enum { |
| 126 | /* |
| 127 | * Line discipline option states: off, on, up to the backend. |
| 128 | */ |
| 129 | LD_YES, LD_NO, LD_BACKEND |
| 130 | }; |
| 131 | |
| 132 | enum { |
| 133 | /* |
| 134 | * Line discipline options which the backend might try to control. |
| 135 | */ |
| 136 | LD_EDIT, /* local line editing */ |
| 137 | LD_ECHO /* local echo */ |
| 138 | }; |
| 139 | |
| 140 | enum { |
| 141 | /* |
| 142 | * Close On Exit behaviours. (cfg.close_on_exit) |
| 143 | */ |
| 144 | COE_NEVER, /* Never close the window */ |
| 145 | COE_NORMAL, /* Close window on "normal" (non-error) exits only */ |
| 146 | COE_ALWAYS /* Always close the window */ |
| 147 | }; |
| 148 | |
| 149 | typedef struct { |
| 150 | char *(*init) (char *host, int port, char **realhost); |
| 151 | void (*send) (char *buf, int len); |
| 152 | void (*size) (void); |
| 153 | void (*special) (Telnet_Special code); |
| 154 | Socket (*socket) (void); |
| 155 | int (*sendok) (void); |
| 156 | int (*ldisc) (int); |
| 157 | int default_port; |
| 158 | } Backend; |
| 159 | |
| 160 | GLOBAL Backend *back; |
| 161 | |
| 162 | extern struct backend_list { |
| 163 | int protocol; |
| 164 | char *name; |
| 165 | Backend *backend; |
| 166 | } backends[]; |
| 167 | |
| 168 | typedef struct { |
| 169 | /* Basic options */ |
| 170 | char host[512]; |
| 171 | int port; |
| 172 | enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol; |
| 173 | int close_on_exit; |
| 174 | int warn_on_close; |
| 175 | int ping_interval; /* in seconds */ |
| 176 | /* SSH options */ |
| 177 | char remote_cmd[512]; |
| 178 | char *remote_cmd_ptr; /* might point to a larger command |
| 179 | * but never for loading/saving */ |
| 180 | int nopty; |
| 181 | int compression; |
| 182 | int agentfwd; |
| 183 | enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES, CIPHER_AES } cipher; |
| 184 | char keyfile[FILENAME_MAX]; |
| 185 | int sshprot; /* use v1 or v2 when both available */ |
| 186 | int buggymac; /* MAC bug commmercial <=v2.3.x SSH2 */ |
| 187 | int try_tis_auth; |
| 188 | int ssh_subsys; /* run a subsystem rather than a command */ |
| 189 | /* Telnet options */ |
| 190 | char termtype[32]; |
| 191 | char termspeed[32]; |
| 192 | char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */ |
| 193 | char username[32]; |
| 194 | char localusername[32]; |
| 195 | int rfc_environ; |
| 196 | /* Keyboard options */ |
| 197 | int bksp_is_delete; |
| 198 | int rxvt_homeend; |
| 199 | int funky_type; |
| 200 | int no_applic_c; /* totally disable app cursor keys */ |
| 201 | int no_applic_k; /* totally disable app keypad */ |
| 202 | int app_cursor; |
| 203 | int app_keypad; |
| 204 | int nethack_keypad; |
| 205 | int alt_f4; /* is it special? */ |
| 206 | int alt_space; /* is it special? */ |
| 207 | int alt_only; /* is it special? */ |
| 208 | int localecho; |
| 209 | int localedit; |
| 210 | int alwaysontop; |
| 211 | int scroll_on_key; |
| 212 | int scroll_on_disp; |
| 213 | int compose_key; |
| 214 | int ctrlaltkeys; |
| 215 | char wintitle[256]; /* initial window title */ |
| 216 | /* Terminal options */ |
| 217 | int savelines; |
| 218 | int dec_om; |
| 219 | int wrap_mode; |
| 220 | int lfhascr; |
| 221 | int cursor_type; /* 0=block 1=underline 2=vertical */ |
| 222 | int blink_cur; |
| 223 | enum { |
| 224 | BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE |
| 225 | } beep; |
| 226 | int bellovl; /* bell overload protection active? */ |
| 227 | int bellovl_n; /* number of bells to cause overload */ |
| 228 | int bellovl_t; /* time interval for overload (seconds) */ |
| 229 | int bellovl_s; /* period of silence to re-enable bell (s) */ |
| 230 | char bell_wavefile[FILENAME_MAX]; |
| 231 | int scrollbar; |
| 232 | int locksize; |
| 233 | int bce; |
| 234 | int blinktext; |
| 235 | int win_name_always; |
| 236 | int width, height; |
| 237 | char font[64]; |
| 238 | int fontisbold; |
| 239 | int fontheight; |
| 240 | int fontcharset; |
| 241 | char logfilename[FILENAME_MAX]; |
| 242 | int logtype; |
| 243 | int logxfovr; |
| 244 | int hide_mouseptr; |
| 245 | char answerback[256]; |
| 246 | /* Colour options */ |
| 247 | int try_palette; |
| 248 | int bold_colour; |
| 249 | unsigned char colours[22][3]; |
| 250 | /* Selection options */ |
| 251 | int mouse_is_xterm; |
| 252 | int rawcnp; |
| 253 | short wordness[256]; |
| 254 | /* translations */ |
| 255 | VT_Mode vtmode; |
| 256 | int xlat_enablekoiwin; |
| 257 | int xlat_88592w1250; |
| 258 | int xlat_88592cp852; |
| 259 | int xlat_capslockcyr; |
| 260 | /* X11 forwarding */ |
| 261 | int x11_forward; |
| 262 | char x11_display[128]; |
| 263 | } Config; |
| 264 | |
| 265 | /* |
| 266 | * You can compile with -DSSH_DEFAULT to have ssh by default. |
| 267 | */ |
| 268 | #ifndef SSH_DEFAULT |
| 269 | #define DEFAULT_PROTOCOL PROT_TELNET |
| 270 | #define DEFAULT_PORT 23 |
| 271 | #else |
| 272 | #define DEFAULT_PROTOCOL PROT_SSH |
| 273 | #define DEFAULT_PORT 22 |
| 274 | #endif |
| 275 | |
| 276 | /* |
| 277 | * Some global flags denoting the type of application. |
| 278 | * |
| 279 | * FLAG_VERBOSE is set when the user requests verbose details. |
| 280 | * |
| 281 | * FLAG_STDERR is set in command-line applications (which have a |
| 282 | * functioning stderr that it makes sense to write to) and not in |
| 283 | * GUI applications (which don't). |
| 284 | * |
| 285 | * FLAG_INTERACTIVE is set when a full interactive shell session is |
| 286 | * being run, _either_ because no remote command has been provided |
| 287 | * _or_ because the application is GUI and can't run non- |
| 288 | * interactively. |
| 289 | */ |
| 290 | #define FLAG_VERBOSE 0x0001 |
| 291 | #define FLAG_STDERR 0x0002 |
| 292 | #define FLAG_INTERACTIVE 0x0004 |
| 293 | GLOBAL int flags; |
| 294 | |
| 295 | GLOBAL Config cfg; |
| 296 | GLOBAL int default_protocol; |
| 297 | GLOBAL int default_port; |
| 298 | |
| 299 | struct RSAKey; /* be a little careful of scope */ |
| 300 | |
| 301 | /* |
| 302 | * Exports from window.c. |
| 303 | */ |
| 304 | void request_resize (int, int, int); |
| 305 | void do_text (Context, int, int, char *, int, unsigned long, int); |
| 306 | void set_title (char *); |
| 307 | void set_icon (char *); |
| 308 | void set_sbar (int, int, int); |
| 309 | Context get_ctx(void); |
| 310 | void free_ctx (Context); |
| 311 | void palette_set (int, int, int, int); |
| 312 | void palette_reset (void); |
| 313 | void write_clip (void *, int, int); |
| 314 | void get_clip (void **, int *); |
| 315 | void optimised_move (int, int, int); |
| 316 | void connection_fatal(char *, ...); |
| 317 | void fatalbox (char *, ...); |
| 318 | void beep (int); |
| 319 | void begin_session(void); |
| 320 | void sys_cursor(int x, int y); |
| 321 | #define OPTIMISE_IS_SCROLL 1 |
| 322 | |
| 323 | /* |
| 324 | * Exports from noise.c. |
| 325 | */ |
| 326 | void noise_get_heavy(void (*func)(void *, int)); |
| 327 | void noise_get_light(void (*func)(void *, int)); |
| 328 | void noise_regular(void); |
| 329 | void noise_ultralight(DWORD data); |
| 330 | void random_save_seed(void); |
| 331 | void random_destroy_seed(void); |
| 332 | |
| 333 | /* |
| 334 | * Exports from windlg.c. |
| 335 | */ |
| 336 | void defuse_showwindow(void); |
| 337 | int do_config (void); |
| 338 | int do_reconfig (HWND); |
| 339 | void do_defaults (char *, Config *); |
| 340 | void logevent (char *); |
| 341 | void showeventlog (HWND); |
| 342 | void showabout (HWND); |
| 343 | void verify_ssh_host_key(char *host, int port, char *keytype, |
| 344 | char *keystr, char *fingerprint); |
| 345 | int askappend(char *filename); |
| 346 | void registry_cleanup(void); |
| 347 | void force_normal(HWND hwnd); |
| 348 | |
| 349 | GLOBAL int nsessions; |
| 350 | GLOBAL char **sessions; |
| 351 | |
| 352 | /* |
| 353 | * Exports from settings.c. |
| 354 | */ |
| 355 | void save_settings (char *section, int do_host, Config *cfg); |
| 356 | void load_settings (char *section, int do_host, Config *cfg); |
| 357 | void get_sesslist(int allocate); |
| 358 | |
| 359 | /* |
| 360 | * Exports from terminal.c. |
| 361 | */ |
| 362 | |
| 363 | void term_init (void); |
| 364 | void term_size (int, int, int); |
| 365 | void term_out (void); |
| 366 | void term_paint (Context, int, int, int, int); |
| 367 | void term_scroll (int, int); |
| 368 | void term_pwron (void); |
| 369 | void term_clrsb (void); |
| 370 | void term_mouse (Mouse_Button, Mouse_Action, int, int); |
| 371 | void term_deselect (void); |
| 372 | void term_update (void); |
| 373 | void term_invalidate(void); |
| 374 | void term_blink(int set_cursor); |
| 375 | void term_paste(void); |
| 376 | void term_nopaste(void); |
| 377 | int term_ldisc(int option); |
| 378 | void from_backend(int is_stderr, char *data, int len); |
| 379 | void logfopen (void); |
| 380 | void logfclose (void); |
| 381 | void term_copyall(void); |
| 382 | |
| 383 | /* |
| 384 | * Exports from raw.c. |
| 385 | */ |
| 386 | |
| 387 | extern Backend raw_backend; |
| 388 | |
| 389 | /* |
| 390 | * Exports from rlogin.c. |
| 391 | */ |
| 392 | |
| 393 | extern Backend rlogin_backend; |
| 394 | |
| 395 | /* |
| 396 | * Exports from telnet.c. |
| 397 | */ |
| 398 | |
| 399 | extern Backend telnet_backend; |
| 400 | |
| 401 | /* |
| 402 | * Exports from ssh.c. |
| 403 | */ |
| 404 | |
| 405 | extern int (*ssh_get_line)(const char *prompt, char *str, int maxlen, |
| 406 | int is_pw); |
| 407 | extern Backend ssh_backend; |
| 408 | |
| 409 | /* |
| 410 | * Exports from ldisc.c. |
| 411 | */ |
| 412 | |
| 413 | extern void ldisc_send(char *buf, int len); |
| 414 | |
| 415 | /* |
| 416 | * Exports from sshrand.c. |
| 417 | */ |
| 418 | |
| 419 | void random_add_noise(void *noise, int length); |
| 420 | void random_init(void); |
| 421 | int random_byte(void); |
| 422 | void random_get_savedata(void **data, int *len); |
| 423 | |
| 424 | /* |
| 425 | * Exports from misc.c. |
| 426 | */ |
| 427 | |
| 428 | #include "puttymem.h" |
| 429 | |
| 430 | /* |
| 431 | * Exports from version.c. |
| 432 | */ |
| 433 | extern char ver[]; |
| 434 | |
| 435 | /* |
| 436 | * Exports from sizetip.c. |
| 437 | */ |
| 438 | void UpdateSizeTip(HWND src, int cx, int cy); |
| 439 | void EnableSizeTip(int bEnable); |
| 440 | |
| 441 | /* |
| 442 | * Exports from xlat.c. |
| 443 | */ |
| 444 | unsigned char xlat_kbd2tty(unsigned char c); |
| 445 | unsigned char xlat_tty2scr(unsigned char c); |
| 446 | unsigned char xlat_latkbd2win(unsigned char c); |
| 447 | |
| 448 | /* |
| 449 | * Exports from mscrypto.c |
| 450 | */ |
| 451 | #ifdef MSCRYPTOAPI |
| 452 | int crypto_startup(); |
| 453 | void crypto_wrapup(); |
| 454 | #endif |
| 455 | |
| 456 | /* |
| 457 | * Exports from pageantc.c |
| 458 | */ |
| 459 | void agent_query(void *in, int inlen, void **out, int *outlen); |
| 460 | int agent_exists(void); |
| 461 | |
| 462 | #ifdef DEBUG |
| 463 | void dprintf(char *fmt, ...); |
| 464 | #define debug(x) (dprintf x) |
| 465 | #else |
| 466 | #define debug(x) |
| 467 | #endif |
| 468 | |
| 469 | #endif |