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 traffic */
 134 #define LGTYP_PACKETS 3                /* logmode: SSH data packets */
 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      * SSH ciphers (both SSH1 and SSH2)
 175      */
 176     CIPHER_WARN,                       /* pseudo 'cipher' */
 177     CIPHER_3DES,
 178     CIPHER_BLOWFISH,
 179     CIPHER_AES,                        /* (SSH 2 only) */
 180     CIPHER_DES,
 181     CIPHER_MAX                         /* no. ciphers (inc warn) */
 182 };
 183
 184 enum {
 185     /*
 186      * Line discipline option states: off, on, up to the backend.
 187      */
 188     LD_YES, LD_NO, LD_BACKEND
 189 };
 190
 191 enum {
 192     /*
 193      * Line discipline options which the backend might try to control.
 194      */
 195     LD_EDIT,                           /* local line editing */
 196     LD_ECHO                            /* local echo */
 197 };
 198
 199 enum {
 200     /*
 201      * Close On Exit behaviours. (cfg.close_on_exit)
 202      */
 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 */
 206 };
 207
 208 typedef struct {
 209     char *(*init) (char *host, int port, char **realhost, int nodelay);
 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);
 214     void (*size) (void);
 215     void (*special) (Telnet_Special code);
 216     Socket(*socket) (void);
 217     int (*exitcode) (void);
 218     int (*sendok) (void);
 219     int (*ldisc) (int);
 220     /*
 221      * back->unthrottle() tells the back end that the front end
 222      * buffer is clearing.
 223      */
 224     void (*unthrottle) (int);
 225     int default_port;
 226 } Backend;
 227
 228 GLOBAL Backend *back;
 229
 230 extern struct backend_list {
 231     int protocol;
 232     char *name;
 233     Backend *backend;
 234 } backends[];
 235
 236 typedef struct {
 237     /* Basic options */
 238     char host[512];
 239     int port;
 240     enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
 241     int close_on_exit;
 242     int warn_on_close;
 243     int ping_interval;                 /* in seconds */
 244     int tcp_nodelay;
 245     /* SSH options */
 246     char remote_cmd[512];
 247     char remote_cmd2[512];             /* fallback if the first fails
 248                                         * (used internally for scp) */
 249     char *remote_cmd_ptr;              /* might point to a larger command
 250                                         * but never for loading/saving */
 251     char *remote_cmd_ptr2;             /* might point to a larger command
 252                                         * but never for loading/saving */
 253     int nopty;
 254     int compression;
 255     int agentfwd;
 256     int change_username;               /* allow username switching in SSH2 */
 257     int ssh_cipherlist[CIPHER_MAX];
 258     char keyfile[FILENAME_MAX];
 259     int sshprot;                       /* use v1 or v2 when both available */
 260     int buggymac;                      /* MAC bug commmercial <=v2.3.x SSH2 */
 261     int ssh2_des_cbc;                  /* "des-cbc" nonstandard SSH2 cipher */
 262     int try_tis_auth;
 263     int try_ki_auth;
 264     int ssh_subsys;                    /* run a subsystem rather than a command */
 265     int ssh_subsys2;                   /* fallback to go with remote_cmd2 */
 266     /* Telnet options */
 267     char termtype[32];
 268     char termspeed[32];
 269     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
 270     char username[32];
 271     char localusername[32];
 272     int rfc_environ;
 273     int passive_telnet;
 274     /* Keyboard options */
 275     int bksp_is_delete;
 276     int rxvt_homeend;
 277     int funky_type;
 278     int no_applic_c;                   /* totally disable app cursor keys */
 279     int no_applic_k;                   /* totally disable app keypad */
 280     int no_mouse_rep;                  /* totally disable mouse reporting */
 281     int no_remote_resize;              /* disable remote resizing */
 282     int no_alt_screen;                 /* disable alternate screen */
 283     int no_remote_wintitle;            /* disable remote retitling */
 284     int no_dbackspace;                 /* disable destructive backspace */
 285     int no_remote_charset;             /* disable remote charset config */
 286     int app_cursor;
 287     int app_keypad;
 288     int nethack_keypad;
 289     int telnet_keyboard;
 290     int telnet_newline;
 291     int alt_f4;                        /* is it special? */
 292     int alt_space;                     /* is it special? */
 293     int alt_only;                      /* is it special? */
 294     int localecho;
 295     int localedit;
 296     int alwaysontop;
 297     int fullscreenonaltenter;
 298     int scroll_on_key;
 299     int scroll_on_disp;
 300     int compose_key;
 301     int ctrlaltkeys;
 302     char wintitle[256];                /* initial window title */
 303     /* Terminal options */
 304     int savelines;
 305     int dec_om;
 306     int wrap_mode;
 307     int lfhascr;
 308     int cursor_type;                   /* 0=block 1=underline 2=vertical */
 309     int blink_cur;
 310     enum {
 311         BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
 312     } beep;
 313     enum {
 314         B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
 315     } beep_ind;
 316     int bellovl;                       /* bell overload protection active? */
 317     int bellovl_n;                     /* number of bells to cause overload */
 318     int bellovl_t;                     /* time interval for overload (seconds) */
 319     int bellovl_s;                     /* period of silence to re-enable bell (s) */
 320     char bell_wavefile[FILENAME_MAX];
 321     int scrollbar;
 322     int scrollbar_in_fullscreen;
 323     enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
 324     int bce;
 325     int blinktext;
 326     int win_name_always;
 327     int width, height;
 328     char font[64];
 329     int fontisbold;
 330     int fontheight;
 331     int fontcharset;
 332     char logfilename[FILENAME_MAX];
 333     int logtype;
 334     int logxfovr;
 335     int hide_mouseptr;
 336     int sunken_edge;
 337     int window_border;
 338     char answerback[256];
 339     char printer[128];
 340     /* Colour options */
 341     int try_palette;
 342     int bold_colour;
 343     unsigned char colours[22][3];
 344     /* Selection options */
 345     int mouse_is_xterm;
 346     int rect_select;
 347     int rawcnp;
 348     int rtf_paste;
 349     int mouse_override;
 350     short wordness[256];
 351     /* translations */
 352     VT_Mode vtmode;
 353     char line_codepage[128];
 354     int xlat_capslockcyr;
 355     /* X11 forwarding */
 356     int x11_forward;
 357     char x11_display[128];
 358     /* port forwarding */
 359     int lport_acceptall; /* accept conns from hosts other than localhost */
 360     int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
 361     char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
 362 } Config;
 363
 364 /*
 365  * You can compile with -DSSH_DEFAULT to have ssh by default.
 366  */
 367 #ifndef SSH_DEFAULT
 368 #define DEFAULT_PROTOCOL PROT_TELNET
 369 #define DEFAULT_PORT 23
 370 #else
 371 #define DEFAULT_PROTOCOL PROT_SSH
 372 #define DEFAULT_PORT 22
 373 #endif
 374
 375 /*
 376  * Some global flags denoting the type of application.
 377  *
 378  * FLAG_VERBOSE is set when the user requests verbose details.
 379  *
 380  * FLAG_STDERR is set in command-line applications (which have a
 381  * functioning stderr that it makes sense to write to) and not in
 382  * GUI applications (which don't).
 383  *
 384  * FLAG_INTERACTIVE is set when a full interactive shell session is
 385  * being run, _either_ because no remote command has been provided
 386  * _or_ because the application is GUI and can't run non-
 387  * interactively.
 388  */
 389 #define FLAG_VERBOSE     0x0001
 390 #define FLAG_STDERR      0x0002
 391 #define FLAG_INTERACTIVE 0x0004
 392 GLOBAL int flags;
 393
 394 GLOBAL Config cfg;
 395 GLOBAL int default_protocol;
 396 GLOBAL int default_port;
 397
 398 struct RSAKey;                         /* be a little careful of scope */
 399
 400 /*
 401  * Exports from window.c.
 402  */
 403 void request_resize(int, int);
 404 void do_text(Context, int, int, char *, int, unsigned long, int);
 405 void do_cursor(Context, int, int, char *, int, unsigned long, int);
 406 int CharWidth(Context ctx, int uc);
 407 void set_title(char *);
 408 void set_icon(char *);
 409 void set_sbar(int, int, int);
 410 Context get_ctx(void);
 411 void free_ctx(Context);
 412 void palette_set(int, int, int, int);
 413 void palette_reset(void);
 414 void write_aclip(char *, int, int);
 415 void write_clip(wchar_t *, int, int);
 416 void get_clip(wchar_t **, int *);
 417 void optimised_move(int, int, int);
 418 void set_raw_mouse_mode(int);
 419 Mouse_Button translate_button(Mouse_Button b);
 420 void connection_fatal(char *, ...);
 421 void fatalbox(char *, ...);
 422 void beep(int);
 423 void begin_session(void);
 424 void sys_cursor(int x, int y);
 425 #define OPTIMISE_IS_SCROLL 1
 426
 427 void set_iconic(int iconic);
 428 void move_window(int x, int y);
 429 void set_zorder(int top);
 430 void refresh_window(void);
 431 void set_zoomed(int zoomed);
 432 int is_iconic(void);
 433 void get_window_pos(int *x, int *y);
 434 void get_window_pixels(int *x, int *y);
 435 char *get_window_title(int icon);
 436
 437 void cleanup_exit(int);
 438
 439 /*
 440  * Exports from noise.c.
 441  */
 442 void noise_get_heavy(void (*func) (void *, int));
 443 void noise_get_light(void (*func) (void *, int));
 444 void noise_regular(void);
 445 void noise_ultralight(DWORD data);
 446 void random_save_seed(void);
 447 void random_destroy_seed(void);
 448
 449 /*
 450  * Exports from windlg.c.
 451  */
 452 void defuse_showwindow(void);
 453 int do_config(void);
 454 int do_reconfig(HWND);
 455 void do_defaults(char *, Config *);
 456 void logevent(char *);
 457 void showeventlog(HWND);
 458 void showabout(HWND);
 459 void verify_ssh_host_key(char *host, int port, char *keytype,
 460                          char *keystr, char *fingerprint);
 461 void askcipher(char *ciphername, int cs);
 462 int askappend(char *filename);
 463 void registry_cleanup(void);
 464 void force_normal(HWND hwnd);
 465
 466 GLOBAL int nsessions;
 467 GLOBAL char **sessions;
 468
 469 /*
 470  * Exports from settings.c.
 471  */
 472 void save_settings(char *section, int do_host, Config * cfg);
 473 void load_settings(char *section, int do_host, Config * cfg);
 474 void get_sesslist(int allocate);
 475
 476 /*
 477  * Exports from terminal.c.
 478  */
 479
 480 void term_init(void);
 481 void term_size(int, int, int);
 482 void term_out(void);
 483 void term_paint(Context, int, int, int, int);
 484 void term_scroll(int, int);
 485 void term_pwron(void);
 486 void term_clrsb(void);
 487 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int, int);
 488 void term_deselect(void);
 489 void term_update(void);
 490 void term_invalidate(void);
 491 void term_blink(int set_cursor);
 492 void term_do_paste(void);
 493 void term_paste(void);
 494 void term_nopaste(void);
 495 int term_ldisc(int option);
 496 int from_backend(int is_stderr, char *data, int len);
 497 void logfopen(void);
 498 void logfclose(void);
 499 void term_copyall(void);
 500 void term_reconfig(void);
 501
 502 /*
 503  * Exports from logging.c.
 504  */
 505 void logtraffic(unsigned char c, int logmode);
 506 enum { PKT_INCOMING, PKT_OUTGOING };
 507 void log_packet(int direction, int type, char *texttype, void *data, int len);
 508
 509 /*
 510  * Exports from raw.c.
 511  */
 512
 513 extern Backend raw_backend;
 514
 515 /*
 516  * Exports from rlogin.c.
 517  */
 518
 519 extern Backend rlogin_backend;
 520
 521 /*
 522  * Exports from telnet.c.
 523  */
 524
 525 extern Backend telnet_backend;
 526
 527 /*
 528  * Exports from ssh.c.
 529  */
 530
 531 extern int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
 532                             int is_pw);
 533 extern Backend ssh_backend;
 534
 535 /*
 536  * Exports from ldisc.c.
 537  */
 538
 539 extern void ldisc_send(char *buf, int len, int interactive);
 540
 541 /*
 542  * Exports from sshrand.c.
 543  */
 544
 545 void random_add_noise(void *noise, int length);
 546 void random_init(void);
 547 int random_byte(void);
 548 void random_get_savedata(void **data, int *len);
 549 extern int random_active;
 550
 551 /*
 552  * Exports from misc.c.
 553  */
 554
 555 #include "misc.h"
 556
 557 /*
 558  * Exports from version.c.
 559  */
 560 extern char ver[];
 561
 562 /*
 563  * Exports from sizetip.c.
 564  */
 565 void UpdateSizeTip(HWND src, int cx, int cy);
 566 void EnableSizeTip(int bEnable);
 567
 568 /*
 569  * Exports from unicode.c.
 570  */
 571 #ifndef CP_UTF8
 572 #define CP_UTF8 65001
 573 #endif
 574 void init_ucs_tables(void);
 575 void lpage_send(int codepage, char *buf, int len, int interactive);
 576 void luni_send(wchar_t * widebuf, int len, int interactive);
 577 wchar_t xlat_uskbd2cyrllic(int ch);
 578 int check_compose(int first, int second);
 579 int decode_codepage(char *cp_name);
 580 char *cp_enumerate (int index);
 581 char *cp_name(int codepage);
 582 void get_unitab(int codepage, wchar_t * unitab, int ftype);
 583
 584 /*
 585  * Exports from mscrypto.c
 586  */
 587 #ifdef MSCRYPTOAPI
 588 int crypto_startup();
 589 void crypto_wrapup();
 590 #endif
 591
 592 /*
 593  * Exports from pageantc.c
 594  */
 595 void agent_query(void *in, int inlen, void **out, int *outlen);
 596 int agent_exists(void);
 597
 598 /*
 599  * Exports from wildcard.c
 600  */
 601 const char *wc_error(int value);
 602 int wc_match(const char *wildcard, const char *target);
 603 int wc_unescape(char *output, const char *wildcard);
 604
 605 /*
 606  * Exports from console.c (that aren't equivalents to things in
 607  * windlg.c).
 608  */
 609 extern int console_batch_mode;
 610 extern char *console_password;
 611 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
 612
 613 /*
 614  * Exports from printing.c.
 615  */
 616 typedef struct printer_enum_tag printer_enum;
 617 typedef struct printer_job_tag printer_job;
 618 printer_enum *printer_start_enum(int *nprinters);
 619 char *printer_get_name(printer_enum *, int);
 620 void printer_finish_enum(printer_enum *);
 621 printer_job *printer_start_job(char *printer);
 622 void printer_job_data(printer_job *, void *, int);
 623 void printer_finish_job(printer_job *);
 624
 625 #endif