putty.h

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