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