putty.h

   1 #ifndef PUTTY_PUTTY_H
   2 #define PUTTY_PUTTY_H
   3
   4 #include <stdio.h>                     /* for FILENAME_MAX */
   5
   6 #include "network.h"
   7
   8 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
   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"
  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
  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 */
  42
  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
  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 */
  59 #define ATTR_SCOACS  0x0000DA00UL      /* SCO Alternate charset */
  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
  69 #define ATTR_NARROW  0x20000000UL
  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
  84 #define ERASE_CHAR   (ATTR_DEFAULT | ATTR_ASCII | ' ')
  85 #define ATTR_MASK    0xFFFFFF00UL
  86 #define CHAR_MASK    0x000000FFUL
  87
  88 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
  89 #define ATTR_CUR_XOR 0x00BA0000UL
  90
  91 typedef HDC Context;
  92 #define SEL_NL { 13, 10 }
  93
  94 GLOBAL int rows, cols, savelines;
  95
  96 GLOBAL int has_focus;
  97
  98 GLOBAL int in_vbell;
  99 GLOBAL unsigned long vbell_startpoint;
 100
 101 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
 102 GLOBAL int repeat_off, cr_lf_return;
 103
 104 GLOBAL int seen_key_event;
 105 GLOBAL int seen_disp_event;
 106 GLOBAL int alt_pressed;
 107
 108 GLOBAL int session_closed;
 109
 110 GLOBAL int big_cursor;
 111
 112 GLOBAL int utf;
 113 GLOBAL int dbcs_screenfont;
 114 GLOBAL int font_codepage;
 115 GLOBAL int kbd_codepage;
 116 GLOBAL int line_codepage;
 117 GLOBAL WCHAR unitab_scoacs[256];
 118 GLOBAL WCHAR unitab_line[256];
 119 GLOBAL WCHAR unitab_font[256];
 120 GLOBAL WCHAR unitab_xterm[256];
 121 GLOBAL WCHAR unitab_oemcp[256];
 122 GLOBAL unsigned char unitab_ctrl[256];
 123 #define in_utf (utf || line_codepage==CP_UTF8)
 124
 125 #define LGXF_OVR  1                    /* existing logfile overwrite */
 126 #define LGXF_APN  0                    /* existing logfile append */
 127 #define LGXF_ASK -1                    /* existing logfile ask */
 128 #define LGTYP_NONE  0                  /* logmode: no logging */
 129 #define LGTYP_ASCII 1                  /* logmode: pure ascii */
 130 #define LGTYP_DEBUG 2                  /* logmode: all chars of taffic */
 131 GLOBAL char *logfile;
 132
 133 /*
 134  * Window handles for the dialog boxes that can be running during a
 135  * PuTTY session.
 136  */
 137 GLOBAL HWND logbox;
 138
 139 /*
 140  * I've just looked in the windows standard headr files for WM_USER, there
 141  * are hundreds of flags defined using the form WM_USER+123 so I've
 142  * renumbered this NETEVENT value and the two in window.c
 143  */
 144 #define WM_XUSER     (WM_USER + 0x2000)
 145 #define WM_NETEVENT  (WM_XUSER + 5)
 146
 147 typedef enum {
 148     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
 149     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
 150     TS_EOL
 151 } Telnet_Special;
 152
 153 typedef enum {
 154     MBT_NOTHING,
 155     MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
 156     MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
 157     MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
 158 } Mouse_Button;
 159
 160 typedef enum {
 161     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
 162 } Mouse_Action;
 163
 164 typedef enum {
 165     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
 166 } VT_Mode;
 167
 168 enum {
 169     /*
 170      * SSH ciphers (both SSH1 and SSH2)
 171      */
 172     CIPHER_WARN,                       /* pseudo 'cipher' */
 173     CIPHER_3DES,
 174     CIPHER_BLOWFISH,
 175     CIPHER_AES,                        /* (SSH 2 only) */
 176     CIPHER_DES,                        /* (SSH 1 only) */
 177     CIPHER_MAX                         /* no. ciphers (inc warn) */
 178 };
 179
 180 enum {
 181     /*
 182      * Line discipline option states: off, on, up to the backend.
 183      */
 184     LD_YES, LD_NO, LD_BACKEND
 185 };
 186
 187 enum {
 188     /*
 189      * Line discipline options which the backend might try to control.
 190      */
 191     LD_EDIT,                           /* local line editing */
 192     LD_ECHO                            /* local echo */
 193 };
 194
 195 enum {
 196     /*
 197      * Close On Exit behaviours. (cfg.close_on_exit)
 198      */
 199     COE_NEVER,                         /* Never close the window */
 200     COE_NORMAL,                        /* Close window on "normal" (non-error) exits only */
 201     COE_ALWAYS                         /* Always close the window */
 202 };
 203
 204 typedef struct {
 205     char *(*init) (char *host, int port, char **realhost);
 206     /* back->send() returns the current amount of buffered data. */
 207     int (*send) (char *buf, int len);
 208     /* back->sendbuffer() does the same thing but without attempting a send */
 209     int (*sendbuffer) (void);
 210     void (*size) (void);
 211     void (*special) (Telnet_Special code);
 212     Socket(*socket) (void);
 213     int (*sendok) (void);
 214     int (*ldisc) (int);
 215     /*
 216      * back->unthrottle() tells the back end that the front end
 217      * buffer is clearing.
 218      */
 219     void (*unthrottle) (int);
 220     int default_port;
 221 } Backend;
 222
 223 GLOBAL Backend *back;
 224
 225 extern struct backend_list {
 226     int protocol;
 227     char *name;
 228     Backend *backend;
 229 } backends[];
 230
 231 typedef struct {
 232     /* Basic options */
 233     char host[512];
 234     int port;
 235     enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
 236     int close_on_exit;
 237     int warn_on_close;
 238     int ping_interval;                 /* in seconds */
 239     /* SSH options */
 240     char remote_cmd[512];
 241     char remote_cmd2[512];             /* fallback if the first fails
 242                                         * (used internally for scp) */
 243     char *remote_cmd_ptr;              /* might point to a larger command
 244                                         * but never for loading/saving */
 245     char *remote_cmd_ptr2;             /* might point to a larger command
 246                                         * but never for loading/saving */
 247     int nopty;
 248     int compression;
 249     int agentfwd;
 250     int ssh_cipherlist[CIPHER_MAX];
 251     char keyfile[FILENAME_MAX];
 252     int sshprot;                       /* use v1 or v2 when both available */
 253     int buggymac;                      /* MAC bug commmercial <=v2.3.x SSH2 */
 254     int try_tis_auth;
 255     int ssh_subsys;                    /* run a subsystem rather than a command */
 256     int ssh_subsys2;                   /* fallback to go with remote_cmd2 */
 257     /* Telnet options */
 258     char termtype[32];
 259     char termspeed[32];
 260     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
 261     char username[32];
 262     char localusername[32];
 263     int rfc_environ;
 264     int passive_telnet;
 265     /* Keyboard options */
 266     int bksp_is_delete;
 267     int rxvt_homeend;
 268     int funky_type;
 269     int no_applic_c;                   /* totally disable app cursor keys */
 270     int no_applic_k;                   /* totally disable app keypad */
 271     int app_cursor;
 272     int app_keypad;
 273     int nethack_keypad;
 274     int telnet_keyboard;
 275     int alt_f4;                        /* is it special? */
 276     int alt_space;                     /* is it special? */
 277     int alt_only;                      /* is it special? */
 278     int localecho;
 279     int localedit;
 280     int alwaysontop;
 281     int fullscreenonaltenter;
 282     int scroll_on_key;
 283     int scroll_on_disp;
 284     int compose_key;
 285     int ctrlaltkeys;
 286     char wintitle[256];                /* initial window title */
 287     /* Terminal options */
 288     int savelines;
 289     int dec_om;
 290     int wrap_mode;
 291     int lfhascr;
 292     int cursor_type;                   /* 0=block 1=underline 2=vertical */
 293     int blink_cur;
 294     enum {
 295         BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
 296     } beep;
 297     enum {
 298         B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
 299     } beep_ind;
 300     int bellovl;                       /* bell overload protection active? */
 301     int bellovl_n;                     /* number of bells to cause overload */
 302     int bellovl_t;                     /* time interval for overload (seconds) */
 303     int bellovl_s;                     /* period of silence to re-enable bell (s) */
 304     char bell_wavefile[FILENAME_MAX];
 305     int scrollbar;
 306     int scrollbar_in_fullscreen;
 307     enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT } resize_action;
 308     int bce;
 309     int blinktext;
 310     int win_name_always;
 311     int width, height;
 312     char font[64];
 313     int fontisbold;
 314     int fontheight;
 315     int fontcharset;
 316     char logfilename[FILENAME_MAX];
 317     int logtype;
 318     int logxfovr;
 319     int hide_mouseptr;
 320     int sunken_edge;
 321     int window_border;
 322     char answerback[256];
 323     /* Colour options */
 324     int try_palette;
 325     int bold_colour;
 326     unsigned char colours[22][3];
 327     /* Selection options */
 328     int mouse_is_xterm;
 329     int rect_select;
 330     int rawcnp;
 331     int mouse_override;
 332     short wordness[256];
 333     /* translations */
 334     VT_Mode vtmode;
 335     char line_codepage[128];
 336     int xlat_capslockcyr;
 337     /* X11 forwarding */
 338     int x11_forward;
 339     char x11_display[128];
 340     /* port forwarding */
 341     int lport_acceptall; /* accepts connection from hosts other than localhost */
 342     char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
 343 } Config;
 344
 345 /*
 346  * You can compile with -DSSH_DEFAULT to have ssh by default.
 347  */
 348 #ifndef SSH_DEFAULT
 349 #define DEFAULT_PROTOCOL PROT_TELNET
 350 #define DEFAULT_PORT 23
 351 #else
 352 #define DEFAULT_PROTOCOL PROT_SSH
 353 #define DEFAULT_PORT 22
 354 #endif
 355
 356 /*
 357  * Some global flags denoting the type of application.
 358  *
 359  * FLAG_VERBOSE is set when the user requests verbose details.
 360  *
 361  * FLAG_STDERR is set in command-line applications (which have a
 362  * functioning stderr that it makes sense to write to) and not in
 363  * GUI applications (which don't).
 364  *
 365  * FLAG_INTERACTIVE is set when a full interactive shell session is
 366  * being run, _either_ because no remote command has been provided
 367  * _or_ because the application is GUI and can't run non-
 368  * interactively.
 369  */
 370 #define FLAG_VERBOSE     0x0001
 371 #define FLAG_STDERR      0x0002
 372 #define FLAG_INTERACTIVE 0x0004
 373 GLOBAL int flags;
 374
 375 GLOBAL Config cfg;
 376 GLOBAL int default_protocol;
 377 GLOBAL int default_port;
 378
 379 struct RSAKey;                         /* be a little careful of scope */
 380
 381 /*
 382  * Exports from window.c.
 383  */
 384 void request_resize(int, int);
 385 void do_text(Context, int, int, char *, int, unsigned long, int);
 386 void do_cursor(Context, int, int, char *, int, unsigned long, int);
 387 int CharWidth(Context ctx, int uc);
 388 void set_title(char *);
 389 void set_icon(char *);
 390 void set_sbar(int, int, int);
 391 Context get_ctx(void);
 392 void free_ctx(Context);
 393 void palette_set(int, int, int, int);
 394 void palette_reset(void);
 395 void write_aclip(char *, int, int);
 396 void write_clip(wchar_t *, int, int);
 397 void get_clip(wchar_t **, int *);
 398 void optimised_move(int, int, int);
 399 void set_raw_mouse_mode(int);
 400 Mouse_Button translate_button(Mouse_Button b);
 401 void connection_fatal(char *, ...);
 402 void fatalbox(char *, ...);
 403 void beep(int);
 404 void begin_session(void);
 405 void sys_cursor(int x, int y);
 406 #define OPTIMISE_IS_SCROLL 1
 407
 408 /*
 409  * Exports from noise.c.
 410  */
 411 void noise_get_heavy(void (*func) (void *, int));
 412 void noise_get_light(void (*func) (void *, int));
 413 void noise_regular(void);
 414 void noise_ultralight(DWORD data);
 415 void random_save_seed(void);
 416 void random_destroy_seed(void);
 417
 418 /*
 419  * Exports from windlg.c.
 420  */
 421 void defuse_showwindow(void);
 422 int do_config(void);
 423 int do_reconfig(HWND);
 424 void do_defaults(char *, Config *);
 425 void logevent(char *);
 426 void showeventlog(HWND);
 427 void showabout(HWND);
 428 void verify_ssh_host_key(char *host, int port, char *keytype,
 429                          char *keystr, char *fingerprint);
 430 void askcipher(char *ciphername, int cs);
 431 int askappend(char *filename);
 432 void registry_cleanup(void);
 433 void force_normal(HWND hwnd);
 434
 435 GLOBAL int nsessions;
 436 GLOBAL char **sessions;
 437
 438 /*
 439  * Exports from settings.c.
 440  */
 441 void save_settings(char *section, int do_host, Config * cfg);
 442 void load_settings(char *section, int do_host, Config * cfg);
 443 void get_sesslist(int allocate);
 444
 445 /*
 446  * Exports from terminal.c.
 447  */
 448
 449 void term_init(void);
 450 void term_size(int, int, int);
 451 void term_out(void);
 452 void term_paint(Context, int, int, int, int);
 453 void term_scroll(int, int);
 454 void term_pwron(void);
 455 void term_clrsb(void);
 456 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int, int);
 457 void term_deselect(void);
 458 void term_update(void);
 459 void term_invalidate(void);
 460 void term_blink(int set_cursor);
 461 void term_do_paste(void);
 462 void term_paste(void);
 463 void term_nopaste(void);
 464 int term_ldisc(int option);
 465 int from_backend(int is_stderr, char *data, int len);
 466 void logfopen(void);
 467 void logfclose(void);
 468 void term_copyall(void);
 469
 470 /*
 471  * Exports from raw.c.
 472  */
 473
 474 extern Backend raw_backend;
 475
 476 /*
 477  * Exports from rlogin.c.
 478  */
 479
 480 extern Backend rlogin_backend;
 481
 482 /*
 483  * Exports from telnet.c.
 484  */
 485
 486 extern Backend telnet_backend;
 487
 488 /*
 489  * Exports from ssh.c.
 490  */
 491
 492 extern int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
 493                             int is_pw);
 494 extern Backend ssh_backend;
 495
 496 /*
 497  * Exports from ldisc.c.
 498  */
 499
 500 extern void ldisc_send(char *buf, int len, int interactive);
 501
 502 /*
 503  * Exports from sshrand.c.
 504  */
 505
 506 void random_add_noise(void *noise, int length);
 507 void random_init(void);
 508 int random_byte(void);
 509 void random_get_savedata(void **data, int *len);
 510
 511 /*
 512  * Exports from misc.c.
 513  */
 514
 515 #include "misc.h"
 516
 517 /*
 518  * Exports from version.c.
 519  */
 520 extern char ver[];
 521
 522 /*
 523  * Exports from sizetip.c.
 524  */
 525 void UpdateSizeTip(HWND src, int cx, int cy);
 526 void EnableSizeTip(int bEnable);
 527
 528 /*
 529  * Exports from unicode.c.
 530  */
 531 #ifndef CP_UTF8
 532 #define CP_UTF8 65001
 533 #endif
 534 void init_ucs_tables(void);
 535 void lpage_send(int codepage, char *buf, int len, int interactive);
 536 void luni_send(wchar_t * widebuf, int len, int interactive);
 537 wchar_t xlat_uskbd2cyrllic(int ch);
 538 int check_compose(int first, int second);
 539 int decode_codepage(char *cp_name);
 540 char *cp_enumerate (int index);
 541 char *cp_name(int codepage);
 542
 543 /*
 544  * Exports from mscrypto.c
 545  */
 546 #ifdef MSCRYPTOAPI
 547 int crypto_startup();
 548 void crypto_wrapup();
 549 #endif
 550
 551 /*
 552  * Exports from pageantc.c
 553  */
 554 void agent_query(void *in, int inlen, void **out, int *outlen);
 555 int agent_exists(void);
 556
 557 /*
 558  * Exports from wildcard.c
 559  */
 560 const char *wc_error(int value);
 561 int wc_match(const char *wildcard, const char *target);
 562 int wc_unescape(char *output, const char *wildcard);
 563
 564 #endif