putty.h

   1 #ifndef PUTTY_PUTTY_H
   2 #define PUTTY_PUTTY_H
   3
   4 #include <stdio.h>                     /* for FILENAME_MAX */
   5
   6 /*
   7  * Global variables. Most modules declare these `extern', but
   8  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
   9  * module, and so will get them properly defined.
  10  */
  11 #ifndef GLOBAL
  12 #ifdef PUTTY_DO_GLOBALS
  13 #define GLOBAL
  14 #else
  15 #define GLOBAL extern
  16 #endif
  17 #endif
  18
  19 typedef struct config_tag Config;
  20 typedef struct backend_tag Backend;
  21
  22 #include "puttyps.h"
  23 #include "network.h"
  24
  25 /*
  26  * Global variables. Most modules declare these `extern', but
  27  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
  28  * module, and so will get them properly defined.
  29  */
  30 #ifdef PUTTY_DO_GLOBALS
  31 #define GLOBAL
  32 #else
  33 #define GLOBAL extern
  34 #endif
  35
  36 /* Three attribute types:
  37  * The ATTRs (normal attributes) are stored with the characters in the main
  38  * display arrays
  39  *
  40  * The TATTRs (temporary attributes) are generated on the fly, they can overlap
  41  * with characters but not with normal attributes.
  42  *
  43  * The LATTRs (line attributes) conflict with no others and only have one
  44  * value per line. But on area clears the LATTR cells are set to the erase_char
  45  * (or DEFAULT_ATTR + 'E')
  46  *
  47  * ATTR_INVALID is an illegal colour combination.
  48  */
  49
  50 #define TATTR_ACTCURS       0x4UL      /* active cursor (block) */
  51 #define TATTR_PASCURS       0x2UL      /* passive cursor (box) */
  52 #define TATTR_RIGHTCURS     0x1UL      /* cursor-on-RHS */
  53
  54 #define LATTR_NORM   0x00000000UL
  55 #define LATTR_WIDE   0x01000000UL
  56 #define LATTR_TOP    0x02000000UL
  57 #define LATTR_BOT    0x03000000UL
  58 #define LATTR_MODE   0x03000000UL
  59 #define LATTR_WRAPPED 0x10000000UL
  60
  61 #define ATTR_INVALID 0x00FF0000UL
  62
  63 /* Like Linux use the F000 page for direct to font. */
  64 #define ATTR_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
  65 #define ATTR_ACP     0x0000F100UL      /* Ansi Codepage DTF */
  66
  67 /* These are internal use overlapping with the UTF-16 surrogates */
  68 #define ATTR_ASCII   0x0000D800UL      /* normal ASCII charset ESC ( B */
  69 #define ATTR_LINEDRW 0x0000D900UL      /* line drawing charset ESC ( 0 */
  70 #define ATTR_SCOACS  0x0000DA00UL      /* SCO Alternate charset */
  71 #define ATTR_GBCHR   0x0000DB00UL      /* UK variant   charset ESC ( A */
  72 #define CSET_MASK    0x0000FF00UL      /* Character set mask; MUST be 0xFF00 */
  73
  74 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
  75 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
  76
  77 #define UCSERR       (ATTR_LINEDRW|'a') /* UCS Format error character. */
  78 #define UCSWIDE      0x303F
  79
  80 #define ATTR_NARROW  0x20000000UL
  81 #define ATTR_WIDE    0x10000000UL
  82 #define ATTR_BOLD    0x01000000UL
  83 #define ATTR_UNDER   0x02000000UL
  84 #define ATTR_REVERSE 0x04000000UL
  85 #define ATTR_BLINK   0x08000000UL
  86 #define ATTR_FGMASK  0x000F0000UL
  87 #define ATTR_BGMASK  0x00F00000UL
  88 #define ATTR_COLOURS 0x00FF0000UL
  89 #define ATTR_FGSHIFT 16
  90 #define ATTR_BGSHIFT 20
  91
  92 #define ATTR_DEFAULT 0x00980000UL
  93 #define ATTR_DEFFG   0x00080000UL
  94 #define ATTR_DEFBG   0x00900000UL
  95 #define ERASE_CHAR   (ATTR_DEFAULT | ATTR_ASCII | ' ')
  96 #define ATTR_MASK    0xFFFFFF00UL
  97 #define CHAR_MASK    0x000000FFUL
  98
  99 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
 100 #define ATTR_CUR_XOR 0x00BA0000UL
 101
 102 GLOBAL int rows, cols, savelines;
 103
 104 GLOBAL int has_focus;
 105
 106 GLOBAL int in_vbell;
 107 GLOBAL unsigned long vbell_startpoint;
 108
 109 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
 110 GLOBAL int repeat_off, cr_lf_return;
 111
 112 GLOBAL int seen_key_event;
 113 GLOBAL int seen_disp_event;
 114 GLOBAL int alt_pressed;
 115
 116 GLOBAL int session_closed;
 117
 118 GLOBAL int big_cursor;
 119
 120 GLOBAL char *help_path;
 121 GLOBAL int help_has_contents;
 122
 123 GLOBAL int nsessions;
 124 GLOBAL char **sessions;
 125
 126 GLOBAL int utf;
 127 GLOBAL int dbcs_screenfont;
 128 GLOBAL int font_codepage;
 129 GLOBAL int kbd_codepage;
 130 GLOBAL int line_codepage;
 131 GLOBAL wchar_t unitab_scoacs[256];
 132 GLOBAL wchar_t unitab_line[256];
 133 GLOBAL wchar_t unitab_font[256];
 134 GLOBAL wchar_t unitab_xterm[256];
 135 GLOBAL wchar_t unitab_oemcp[256];
 136 GLOBAL unsigned char unitab_ctrl[256];
 137 #define in_utf (utf || line_codepage==CP_UTF8)
 138
 139 #define LGXF_OVR  1                    /* existing logfile overwrite */
 140 #define LGXF_APN  0                    /* existing logfile append */
 141 #define LGXF_ASK -1                    /* existing logfile ask */
 142 #define LGTYP_NONE  0                  /* logmode: no logging */
 143 #define LGTYP_ASCII 1                  /* logmode: pure ascii */
 144 #define LGTYP_DEBUG 2                  /* logmode: all chars of traffic */
 145 #define LGTYP_PACKETS 3                /* logmode: SSH data packets */
 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,
 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 struct backend_tag {
 205     char *(*init) (char *host, int port, char **realhost, int nodelay);
 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 (*exitcode) (void);
 214     int (*sendok) (void);
 215     int (*ldisc) (int);
 216     /*
 217      * back->unthrottle() tells the back end that the front end
 218      * buffer is clearing.
 219      */
 220     void (*unthrottle) (int);
 221     int default_port;
 222 };
 223
 224 GLOBAL Backend *back;
 225
 226 extern struct backend_list {
 227     int protocol;
 228     char *name;
 229     Backend *backend;
 230 } backends[];
 231
 232 struct config_tag {
 233     /* Basic options */
 234     char host[512];
 235     int port;
 236     enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
 237     int close_on_exit;
 238     int warn_on_close;
 239     int ping_interval;                 /* in seconds */
 240     int tcp_nodelay;
 241     /* Proxy options */
 242     char proxy_exclude_list[512];
 243     enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
 244     char proxy_host[512];
 245     int proxy_port;
 246     char proxy_username[32];
 247     char proxy_password[32];
 248     char proxy_telnet_command[512];
 249     int proxy_socks_version;
 250     /* SSH options */
 251     char remote_cmd[512];
 252     char remote_cmd2[512];             /* fallback if the first fails
 253                                         * (used internally for scp) */
 254     char *remote_cmd_ptr;              /* might point to a larger command
 255                                         * but never for loading/saving */
 256     char *remote_cmd_ptr2;             /* might point to a larger command
 257                                         * but never for loading/saving */
 258     int nopty;
 259     int compression;
 260     int agentfwd;
 261     int change_username;               /* allow username switching in SSH2 */
 262     int ssh_cipherlist[CIPHER_MAX];
 263     char keyfile[FILENAME_MAX];
 264     int sshprot;                       /* use v1 or v2 when both available */
 265     int ssh2_des_cbc;                  /* "des-cbc" nonstandard SSH2 cipher */
 266     int try_tis_auth;
 267     int try_ki_auth;
 268     int ssh_subsys;                    /* run a subsystem rather than a command */
 269     int ssh_subsys2;                   /* fallback to go with remote_cmd2 */
 270     /* Telnet options */
 271     char termtype[32];
 272     char termspeed[32];
 273     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
 274     char username[100];
 275     char localusername[100];
 276     int rfc_environ;
 277     int passive_telnet;
 278     /* Keyboard options */
 279     int bksp_is_delete;
 280     int rxvt_homeend;
 281     int funky_type;
 282     int no_applic_c;                   /* totally disable app cursor keys */
 283     int no_applic_k;                   /* totally disable app keypad */
 284     int no_mouse_rep;                  /* totally disable mouse reporting */
 285     int no_remote_resize;              /* disable remote resizing */
 286     int no_alt_screen;                 /* disable alternate screen */
 287     int no_remote_wintitle;            /* disable remote retitling */
 288     int no_dbackspace;                 /* disable destructive backspace */
 289     int no_remote_charset;             /* disable remote charset config */
 290     int app_cursor;
 291     int app_keypad;
 292     int nethack_keypad;
 293     int telnet_keyboard;
 294     int telnet_newline;
 295     int alt_f4;                        /* is it special? */
 296     int alt_space;                     /* is it special? */
 297     int alt_only;                      /* is it special? */
 298     int localecho;
 299     int localedit;
 300     int alwaysontop;
 301     int fullscreenonaltenter;
 302     int scroll_on_key;
 303     int scroll_on_disp;
 304     int compose_key;
 305     int ctrlaltkeys;
 306     char wintitle[256];                /* initial window title */
 307     /* Terminal options */
 308     int savelines;
 309     int dec_om;
 310     int wrap_mode;
 311     int lfhascr;
 312     int cursor_type;                   /* 0=block 1=underline 2=vertical */
 313     int blink_cur;
 314     enum {
 315         BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
 316     } beep;
 317     enum {
 318         B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
 319     } beep_ind;
 320     int bellovl;                       /* bell overload protection active? */
 321     int bellovl_n;                     /* number of bells to cause overload */
 322     int bellovl_t;                     /* time interval for overload (seconds) */
 323     int bellovl_s;                     /* period of silence to re-enable bell (s) */
 324     char bell_wavefile[FILENAME_MAX];
 325     int scrollbar;
 326     int scrollbar_in_fullscreen;
 327     enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
 328     int bce;
 329     int blinktext;
 330     int win_name_always;
 331     int width, height;
 332     char font[64];
 333     int fontisbold;
 334     int fontheight;
 335     int fontcharset;
 336     char logfilename[FILENAME_MAX];
 337     int logtype;
 338     int logxfovr;
 339     int hide_mouseptr;
 340     int sunken_edge;
 341     int window_border;
 342     char answerback[256];
 343     char printer[128];
 344     /* Colour options */
 345     int try_palette;
 346     int bold_colour;
 347     unsigned char colours[22][3];
 348     /* Selection options */
 349     int mouse_is_xterm;
 350     int rect_select;
 351     int rawcnp;
 352     int rtf_paste;
 353     int mouse_override;
 354     short wordness[256];
 355     /* translations */
 356     VT_Mode vtmode;
 357     char line_codepage[128];
 358     int xlat_capslockcyr;
 359     /* X11 forwarding */
 360     int x11_forward;
 361     char x11_display[128];
 362     /* port forwarding */
 363     int lport_acceptall; /* accept conns from hosts other than localhost */
 364     int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
 365     char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
 366     /* SSH bug compatibility modes */
 367     enum {
 368         BUG_AUTO, BUG_OFF, BUG_ON
 369     } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
 370         sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
 371         sshbug_dhgex2;
 372     /* Options for pterm. Should split out into platform-dependent part. */
 373     int stamp_utmp;
 374     int login_shell;
 375     int scrollbar_on_left;
 376     char boldfont[64];
 377 };
 378
 379 /*
 380  * You can compile with -DSSH_DEFAULT to have ssh by default.
 381  */
 382 #ifndef SSH_DEFAULT
 383 #define DEFAULT_PROTOCOL PROT_TELNET
 384 #define DEFAULT_PORT 23
 385 #else
 386 #define DEFAULT_PROTOCOL PROT_SSH
 387 #define DEFAULT_PORT 22
 388 #endif
 389
 390 /*
 391  * Some global flags denoting the type of application.
 392  *
 393  * FLAG_VERBOSE is set when the user requests verbose details.
 394  *
 395  * FLAG_STDERR is set in command-line applications (which have a
 396  * functioning stderr that it makes sense to write to) and not in
 397  * GUI applications (which don't).
 398  *
 399  * FLAG_INTERACTIVE is set when a full interactive shell session is
 400  * being run, _either_ because no remote command has been provided
 401  * _or_ because the application is GUI and can't run non-
 402  * interactively.
 403  */
 404 #define FLAG_VERBOSE     0x0001
 405 #define FLAG_STDERR      0x0002
 406 #define FLAG_INTERACTIVE 0x0004
 407 GLOBAL int flags;
 408
 409 GLOBAL Config cfg;
 410 GLOBAL int default_protocol;
 411 GLOBAL int default_port;
 412
 413 struct RSAKey;                         /* be a little careful of scope */
 414
 415 /*
 416  * Exports from window.c.
 417  */
 418 void request_resize(int, int);
 419 void do_text(Context, int, int, char *, int, unsigned long, int);
 420 void do_cursor(Context, int, int, char *, int, unsigned long, int);
 421 int CharWidth(Context ctx, int uc);
 422 void set_title(char *);
 423 void set_icon(char *);
 424 void set_sbar(int, int, int);
 425 Context get_ctx(void);
 426 void free_ctx(Context);
 427 void palette_set(int, int, int, int);
 428 void palette_reset(void);
 429 void write_aclip(char *, int, int);
 430 void write_clip(wchar_t *, int, int);
 431 void get_clip(wchar_t **, int *);
 432 void optimised_move(int, int, int);
 433 void set_raw_mouse_mode(int);
 434 Mouse_Button translate_button(Mouse_Button b);
 435 void connection_fatal(char *, ...);
 436 void fatalbox(char *, ...);
 437 void modalfatalbox(char *, ...);
 438 void beep(int);
 439 void begin_session(void);
 440 void sys_cursor(int x, int y);
 441 void request_paste(void);
 442 #define OPTIMISE_IS_SCROLL 1
 443
 444 void set_iconic(int iconic);
 445 void move_window(int x, int y);
 446 void set_zorder(int top);
 447 void refresh_window(void);
 448 void set_zoomed(int zoomed);
 449 int is_iconic(void);
 450 void get_window_pos(int *x, int *y);
 451 void get_window_pixels(int *x, int *y);
 452 char *get_window_title(int icon);
 453
 454 void cleanup_exit(int);
 455
 456 /*
 457  * Exports from noise.c.
 458  */
 459 void noise_get_heavy(void (*func) (void *, int));
 460 void noise_get_light(void (*func) (void *, int));
 461 void noise_regular(void);
 462 void noise_ultralight(unsigned long data);
 463 void random_save_seed(void);
 464 void random_destroy_seed(void);
 465
 466 /*
 467  * Exports from settings.c.
 468  */
 469 void save_settings(char *section, int do_host, Config * cfg);
 470 void load_settings(char *section, int do_host, Config * cfg);
 471 void get_sesslist(int allocate);
 472 void do_defaults(char *, Config *);
 473 void registry_cleanup(void);
 474
 475 /*
 476  * Exports from terminal.c.
 477  */
 478
 479 void term_init(void);
 480 void term_size(int, int, int);
 481 void term_out(void);
 482 void term_paint(Context, int, int, int, int);
 483 void term_scroll(int, int);
 484 void term_pwron(void);
 485 void term_clrsb(void);
 486 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int, int);
 487 void term_deselect(void);
 488 void term_update(void);
 489 void term_invalidate(void);
 490 void term_blink(int set_cursor);
 491 void term_do_paste(void);
 492 int term_paste_pending(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_eventlog(char *string);
 508 void log_packet(int direction, int type, char *texttype, void *data, int len);
 509
 510 /*
 511  * Exports from raw.c.
 512  */
 513
 514 extern Backend raw_backend;
 515
 516 /*
 517  * Exports from rlogin.c.
 518  */
 519
 520 extern Backend rlogin_backend;
 521
 522 /*
 523  * Exports from telnet.c.
 524  */
 525
 526 extern Backend telnet_backend;
 527
 528 /*
 529  * Exports from ssh.c. (NB the getline variables have to be GLOBAL
 530  * so that PuTTYtel will still compile - otherwise it would depend
 531  * on ssh.c.)
 532  */
 533
 534 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
 535                             int is_pw);
 536 GLOBAL int ssh_getline_pw_only;
 537 extern Backend ssh_backend;
 538
 539 /*
 540  * Exports from ldisc.c.
 541  */
 542
 543 extern void ldisc_send(char *buf, int len, int interactive);
 544
 545 /*
 546  * Exports from sshrand.c.
 547  */
 548
 549 void random_add_noise(void *noise, int length);
 550 void random_init(void);
 551 int random_byte(void);
 552 void random_get_savedata(void **data, int *len);
 553 extern int random_active;
 554
 555 /*
 556  * Exports from misc.c.
 557  */
 558
 559 #include "misc.h"
 560
 561 /*
 562  * Exports from version.c.
 563  */
 564 extern char ver[];
 565
 566 /*
 567  * Exports from unicode.c.
 568  */
 569 #ifndef CP_UTF8
 570 #define CP_UTF8 65001
 571 #endif
 572 void init_ucs_tables(void);
 573 void lpage_send(int codepage, char *buf, int len, int interactive);
 574 void luni_send(wchar_t * widebuf, int len, int interactive);
 575 wchar_t xlat_uskbd2cyrllic(int ch);
 576 int check_compose(int first, int second);
 577 int decode_codepage(char *cp_name);
 578 char *cp_enumerate (int index);
 579 char *cp_name(int codepage);
 580 void get_unitab(int codepage, wchar_t * unitab, int ftype);
 581
 582 /*
 583  * Exports from mscrypto.c
 584  */
 585 #ifdef MSCRYPTOAPI
 586 int crypto_startup();
 587 void crypto_wrapup();
 588 #endif
 589
 590 /*
 591  * Exports from pageantc.c
 592  */
 593 void agent_query(void *in, int inlen, void **out, int *outlen);
 594 int agent_exists(void);
 595
 596 /*
 597  * Exports from wildcard.c
 598  */
 599 const char *wc_error(int value);
 600 int wc_match(const char *wildcard, const char *target);
 601 int wc_unescape(char *output, const char *wildcard);
 602
 603 /*
 604  * Exports from windlg.c
 605  */
 606 void logevent(char *);
 607 void verify_ssh_host_key(char *host, int port, char *keytype,
 608                          char *keystr, char *fingerprint);
 609 void askcipher(char *ciphername, int cs);
 610 int askappend(char *filename);
 611
 612 /*
 613  * Exports from console.c (that aren't equivalents to things in
 614  * windlg.c).
 615  */
 616 extern int console_batch_mode;
 617 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
 618
 619 /*
 620  * Exports from printing.c.
 621  */
 622 typedef struct printer_enum_tag printer_enum;
 623 typedef struct printer_job_tag printer_job;
 624 printer_enum *printer_start_enum(int *nprinters);
 625 char *printer_get_name(printer_enum *, int);
 626 void printer_finish_enum(printer_enum *);
 627 printer_job *printer_start_job(char *printer);
 628 void printer_job_data(printer_job *, void *, int);
 629 void printer_finish_job(printer_job *);
 630
 631 /*
 632  * Exports from cmdline.c (and also cmdline_error(), which is
 633  * defined differently in various places and required _by_
 634  * cmdline.c).
 635  */
 636 int cmdline_process_param(char *, char *, int);
 637 void cmdline_run_saved(void);
 638 extern char *cmdline_password;
 639 #define TOOLTYPE_FILETRANSFER 1
 640 extern int cmdline_tooltype;
 641
 642 void cmdline_error(char *, ...);
 643
 644 #endif