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 #define SEL_NL { 13, 10 }
 103
 104 GLOBAL int rows, cols, savelines;
 105
 106 GLOBAL int has_focus;
 107
 108 GLOBAL int in_vbell;
 109 GLOBAL unsigned long vbell_startpoint;
 110
 111 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
 112 GLOBAL int repeat_off, cr_lf_return;
 113
 114 GLOBAL int seen_key_event;
 115 GLOBAL int seen_disp_event;
 116 GLOBAL int alt_pressed;
 117
 118 GLOBAL int session_closed;
 119
 120 GLOBAL int big_cursor;
 121
 122 GLOBAL char *help_path;
 123 GLOBAL int help_has_contents;
 124
 125 GLOBAL int nsessions;
 126 GLOBAL char **sessions;
 127
 128 GLOBAL int utf;
 129 GLOBAL int dbcs_screenfont;
 130 GLOBAL int font_codepage;
 131 GLOBAL int kbd_codepage;
 132 GLOBAL int line_codepage;
 133 GLOBAL wchar_t unitab_scoacs[256];
 134 GLOBAL wchar_t unitab_line[256];
 135 GLOBAL wchar_t unitab_font[256];
 136 GLOBAL wchar_t unitab_xterm[256];
 137 GLOBAL wchar_t unitab_oemcp[256];
 138 GLOBAL unsigned char unitab_ctrl[256];
 139 #define in_utf (utf || line_codepage==CP_UTF8)
 140
 141 #define LGXF_OVR  1                    /* existing logfile overwrite */
 142 #define LGXF_APN  0                    /* existing logfile append */
 143 #define LGXF_ASK -1                    /* existing logfile ask */
 144 #define LGTYP_NONE  0                  /* logmode: no logging */
 145 #define LGTYP_ASCII 1                  /* logmode: pure ascii */
 146 #define LGTYP_DEBUG 2                  /* logmode: all chars of traffic */
 147 #define LGTYP_PACKETS 3                /* logmode: SSH data packets */
 148
 149 typedef enum {
 150     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
 151     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
 152     TS_EOL
 153 } Telnet_Special;
 154
 155 typedef enum {
 156     MBT_NOTHING,
 157     MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
 158     MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
 159     MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
 160 } Mouse_Button;
 161
 162 typedef enum {
 163     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
 164 } Mouse_Action;
 165
 166 typedef enum {
 167     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
 168 } VT_Mode;
 169
 170 enum {
 171     /*
 172      * SSH ciphers (both SSH1 and SSH2)
 173      */
 174     CIPHER_WARN,                       /* pseudo 'cipher' */
 175     CIPHER_3DES,
 176     CIPHER_BLOWFISH,
 177     CIPHER_AES,                        /* (SSH 2 only) */
 178     CIPHER_DES,
 179     CIPHER_MAX                         /* no. ciphers (inc warn) */
 180 };
 181
 182 enum {
 183     /*
 184      * Line discipline option states: off, on, up to the backend.
 185      */
 186     LD_YES, LD_NO, LD_BACKEND
 187 };
 188
 189 enum {
 190     /*
 191      * Line discipline options which the backend might try to control.
 192      */
 193     LD_EDIT,                           /* local line editing */
 194     LD_ECHO                            /* local echo */
 195 };
 196
 197 enum {
 198     /*
 199      * Close On Exit behaviours. (cfg.close_on_exit)
 200      */
 201     COE_NEVER,                         /* Never close the window */
 202     COE_NORMAL,                        /* Close window on "normal" (non-error) exits only */
 203     COE_ALWAYS                         /* Always close the window */
 204 };
 205
 206 struct backend_tag {
 207     char *(*init) (char *host, int port, char **realhost, int nodelay);
 208     /* back->send() returns the current amount of buffered data. */
 209     int (*send) (char *buf, int len);
 210     /* back->sendbuffer() does the same thing but without attempting a send */
 211     int (*sendbuffer) (void);
 212     void (*size) (void);
 213     void (*special) (Telnet_Special code);
 214     Socket(*socket) (void);
 215     int (*exitcode) (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 };
 225
 226 GLOBAL Backend *back;
 227
 228 extern struct backend_list {
 229     int protocol;
 230     char *name;
 231     Backend *backend;
 232 } backends[];
 233
 234 struct config_tag {
 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     /* Proxy options */
 244     char proxy_exclude_list[512];
 245     enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type;
 246     char proxy_host[512];
 247     int proxy_port;
 248     char proxy_username[32];
 249     char proxy_password[32];
 250     char proxy_telnet_command[512];
 251     int proxy_socks_version;
 252     /* SSH options */
 253     char remote_cmd[512];
 254     char remote_cmd2[512];             /* fallback if the first fails
 255                                         * (used internally for scp) */
 256     char *remote_cmd_ptr;              /* might point to a larger command
 257                                         * but never for loading/saving */
 258     char *remote_cmd_ptr2;             /* might point to a larger command
 259                                         * but never for loading/saving */
 260     int nopty;
 261     int compression;
 262     int agentfwd;
 263     int change_username;               /* allow username switching in SSH2 */
 264     int ssh_cipherlist[CIPHER_MAX];
 265     char keyfile[FILENAME_MAX];
 266     int sshprot;                       /* use v1 or v2 when both available */
 267     int ssh2_des_cbc;                  /* "des-cbc" nonstandard SSH2 cipher */
 268     int try_tis_auth;
 269     int try_ki_auth;
 270     int ssh_subsys;                    /* run a subsystem rather than a command */
 271     int ssh_subsys2;                   /* fallback to go with remote_cmd2 */
 272     /* Telnet options */
 273     char termtype[32];
 274     char termspeed[32];
 275     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
 276     char username[100];
 277     char localusername[100];
 278     int rfc_environ;
 279     int passive_telnet;
 280     /* Keyboard options */
 281     int bksp_is_delete;
 282     int rxvt_homeend;
 283     int funky_type;
 284     int no_applic_c;                   /* totally disable app cursor keys */
 285     int no_applic_k;                   /* totally disable app keypad */
 286     int no_mouse_rep;                  /* totally disable mouse reporting */
 287     int no_remote_resize;              /* disable remote resizing */
 288     int no_alt_screen;                 /* disable alternate screen */
 289     int no_remote_wintitle;            /* disable remote retitling */
 290     int no_dbackspace;                 /* disable destructive backspace */
 291     int no_remote_charset;             /* disable remote charset config */
 292     int app_cursor;
 293     int app_keypad;
 294     int nethack_keypad;
 295     int telnet_keyboard;
 296     int telnet_newline;
 297     int alt_f4;                        /* is it special? */
 298     int alt_space;                     /* is it special? */
 299     int alt_only;                      /* is it special? */
 300     int localecho;
 301     int localedit;
 302     int alwaysontop;
 303     int fullscreenonaltenter;
 304     int scroll_on_key;
 305     int scroll_on_disp;
 306     int compose_key;
 307     int ctrlaltkeys;
 308     char wintitle[256];                /* initial window title */
 309     /* Terminal options */
 310     int savelines;
 311     int dec_om;
 312     int wrap_mode;
 313     int lfhascr;
 314     int cursor_type;                   /* 0=block 1=underline 2=vertical */
 315     int blink_cur;
 316     enum {
 317         BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
 318     } beep;
 319     enum {
 320         B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
 321     } beep_ind;
 322     int bellovl;                       /* bell overload protection active? */
 323     int bellovl_n;                     /* number of bells to cause overload */
 324     int bellovl_t;                     /* time interval for overload (seconds) */
 325     int bellovl_s;                     /* period of silence to re-enable bell (s) */
 326     char bell_wavefile[FILENAME_MAX];
 327     int scrollbar;
 328     int scrollbar_in_fullscreen;
 329     enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action;
 330     int bce;
 331     int blinktext;
 332     int win_name_always;
 333     int width, height;
 334     char font[64];
 335     int fontisbold;
 336     int fontheight;
 337     int fontcharset;
 338     char logfilename[FILENAME_MAX];
 339     int logtype;
 340     int logxfovr;
 341     int hide_mouseptr;
 342     int sunken_edge;
 343     int window_border;
 344     char answerback[256];
 345     char printer[128];
 346     /* Colour options */
 347     int try_palette;
 348     int bold_colour;
 349     unsigned char colours[22][3];
 350     /* Selection options */
 351     int mouse_is_xterm;
 352     int rect_select;
 353     int rawcnp;
 354     int rtf_paste;
 355     int mouse_override;
 356     short wordness[256];
 357     /* translations */
 358     VT_Mode vtmode;
 359     char line_codepage[128];
 360     int xlat_capslockcyr;
 361     /* X11 forwarding */
 362     int x11_forward;
 363     char x11_display[128];
 364     /* port forwarding */
 365     int lport_acceptall; /* accept conns from hosts other than localhost */
 366     int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */
 367     char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
 368     /* SSH bug compatibility modes */
 369     enum {
 370         BUG_AUTO, BUG_OFF, BUG_ON
 371     } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
 372         sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
 373         sshbug_dhgex2;
 374 };
 375
 376 /*
 377  * You can compile with -DSSH_DEFAULT to have ssh by default.
 378  */
 379 #ifndef SSH_DEFAULT
 380 #define DEFAULT_PROTOCOL PROT_TELNET
 381 #define DEFAULT_PORT 23
 382 #else
 383 #define DEFAULT_PROTOCOL PROT_SSH
 384 #define DEFAULT_PORT 22
 385 #endif
 386
 387 /*
 388  * Some global flags denoting the type of application.
 389  *
 390  * FLAG_VERBOSE is set when the user requests verbose details.
 391  *
 392  * FLAG_STDERR is set in command-line applications (which have a
 393  * functioning stderr that it makes sense to write to) and not in
 394  * GUI applications (which don't).
 395  *
 396  * FLAG_INTERACTIVE is set when a full interactive shell session is
 397  * being run, _either_ because no remote command has been provided
 398  * _or_ because the application is GUI and can't run non-
 399  * interactively.
 400  */
 401 #define FLAG_VERBOSE     0x0001
 402 #define FLAG_STDERR      0x0002
 403 #define FLAG_INTERACTIVE 0x0004
 404 GLOBAL int flags;
 405
 406 GLOBAL Config cfg;
 407 GLOBAL int default_protocol;
 408 GLOBAL int default_port;
 409
 410 struct RSAKey;                         /* be a little careful of scope */
 411
 412 /*
 413  * Exports from window.c.
 414  */
 415 void request_resize(int, int);
 416 void do_text(Context, int, int, char *, int, unsigned long, int);
 417 void do_cursor(Context, int, int, char *, int, unsigned long, int);
 418 int CharWidth(Context ctx, int uc);
 419 void set_title(char *);
 420 void set_icon(char *);
 421 void set_sbar(int, int, int);
 422 Context get_ctx(void);
 423 void free_ctx(Context);
 424 void palette_set(int, int, int, int);
 425 void palette_reset(void);
 426 void write_aclip(char *, int, int);
 427 void write_clip(wchar_t *, int, int);
 428 void get_clip(wchar_t **, int *);
 429 void optimised_move(int, int, int);
 430 void set_raw_mouse_mode(int);
 431 Mouse_Button translate_button(Mouse_Button b);
 432 void connection_fatal(char *, ...);
 433 void fatalbox(char *, ...);
 434 void modalfatalbox(char *, ...);
 435 void beep(int);
 436 void begin_session(void);
 437 void sys_cursor(int x, int y);
 438 #define OPTIMISE_IS_SCROLL 1
 439
 440 void set_iconic(int iconic);
 441 void move_window(int x, int y);
 442 void set_zorder(int top);
 443 void refresh_window(void);
 444 void set_zoomed(int zoomed);
 445 int is_iconic(void);
 446 void get_window_pos(int *x, int *y);
 447 void get_window_pixels(int *x, int *y);
 448 char *get_window_title(int icon);
 449
 450 void cleanup_exit(int);
 451
 452 /*
 453  * Exports from noise.c.
 454  */
 455 void noise_get_heavy(void (*func) (void *, int));
 456 void noise_get_light(void (*func) (void *, int));
 457 void noise_regular(void);
 458 void noise_ultralight(unsigned long data);
 459 void random_save_seed(void);
 460 void random_destroy_seed(void);
 461
 462 /*
 463  * Exports from settings.c.
 464  */
 465 void save_settings(char *section, int do_host, Config * cfg);
 466 void load_settings(char *section, int do_host, Config * cfg);
 467 void get_sesslist(int allocate);
 468 void do_defaults(char *, Config *);
 469 void registry_cleanup(void);
 470
 471 /*
 472  * Exports from terminal.c.
 473  */
 474
 475 void term_init(void);
 476 void term_size(int, int, int);
 477 void term_out(void);
 478 void term_paint(Context, int, int, int, int);
 479 void term_scroll(int, int);
 480 void term_pwron(void);
 481 void term_clrsb(void);
 482 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int, int);
 483 void term_deselect(void);
 484 void term_update(void);
 485 void term_invalidate(void);
 486 void term_blink(int set_cursor);
 487 void term_do_paste(void);
 488 void term_paste(void);
 489 void term_nopaste(void);
 490 int term_ldisc(int option);
 491 int from_backend(int is_stderr, char *data, int len);
 492 void logfopen(void);
 493 void logfclose(void);
 494 void term_copyall(void);
 495 void term_reconfig(void);
 496
 497 /*
 498  * Exports from logging.c.
 499  */
 500 void logtraffic(unsigned char c, int logmode);
 501 enum { PKT_INCOMING, PKT_OUTGOING };
 502 void log_eventlog(char *string);
 503 void log_packet(int direction, int type, char *texttype, void *data, int len);
 504
 505 /*
 506  * Exports from raw.c.
 507  */
 508
 509 extern Backend raw_backend;
 510
 511 /*
 512  * Exports from rlogin.c.
 513  */
 514
 515 extern Backend rlogin_backend;
 516
 517 /*
 518  * Exports from telnet.c.
 519  */
 520
 521 extern Backend telnet_backend;
 522
 523 /*
 524  * Exports from ssh.c. (NB the getline variables have to be GLOBAL
 525  * so that PuTTYtel will still compile - otherwise it would depend
 526  * on ssh.c.)
 527  */
 528
 529 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
 530                             int is_pw);
 531 GLOBAL int ssh_getline_pw_only;
 532 extern Backend ssh_backend;
 533
 534 /*
 535  * Exports from ldisc.c.
 536  */
 537
 538 extern void ldisc_send(char *buf, int len, int interactive);
 539
 540 /*
 541  * Exports from sshrand.c.
 542  */
 543
 544 void random_add_noise(void *noise, int length);
 545 void random_init(void);
 546 int random_byte(void);
 547 void random_get_savedata(void **data, int *len);
 548 extern int random_active;
 549
 550 /*
 551  * Exports from misc.c.
 552  */
 553
 554 #include "misc.h"
 555
 556 /*
 557  * Exports from version.c.
 558  */
 559 extern char ver[];
 560
 561 /*
 562  * Exports from unicode.c.
 563  */
 564 #ifndef CP_UTF8
 565 #define CP_UTF8 65001
 566 #endif
 567 void init_ucs_tables(void);
 568 void lpage_send(int codepage, char *buf, int len, int interactive);
 569 void luni_send(wchar_t * widebuf, int len, int interactive);
 570 wchar_t xlat_uskbd2cyrllic(int ch);
 571 int check_compose(int first, int second);
 572 int decode_codepage(char *cp_name);
 573 char *cp_enumerate (int index);
 574 char *cp_name(int codepage);
 575 void get_unitab(int codepage, wchar_t * unitab, int ftype);
 576
 577 /*
 578  * Exports from mscrypto.c
 579  */
 580 #ifdef MSCRYPTOAPI
 581 int crypto_startup();
 582 void crypto_wrapup();
 583 #endif
 584
 585 /*
 586  * Exports from pageantc.c
 587  */
 588 void agent_query(void *in, int inlen, void **out, int *outlen);
 589 int agent_exists(void);
 590
 591 /*
 592  * Exports from wildcard.c
 593  */
 594 const char *wc_error(int value);
 595 int wc_match(const char *wildcard, const char *target);
 596 int wc_unescape(char *output, const char *wildcard);
 597
 598 /*
 599  * Exports from windlg.c
 600  */
 601 void logevent(char *);
 602 void verify_ssh_host_key(char *host, int port, char *keytype,
 603                          char *keystr, char *fingerprint);
 604 void askcipher(char *ciphername, int cs);
 605 int askappend(char *filename);
 606
 607 /*
 608  * Exports from console.c (that aren't equivalents to things in
 609  * windlg.c).
 610  */
 611 extern int console_batch_mode;
 612 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
 613
 614 /*
 615  * Exports from printing.c.
 616  */
 617 typedef struct printer_enum_tag printer_enum;
 618 typedef struct printer_job_tag printer_job;
 619 printer_enum *printer_start_enum(int *nprinters);
 620 char *printer_get_name(printer_enum *, int);
 621 void printer_finish_enum(printer_enum *);
 622 printer_job *printer_start_job(char *printer);
 623 void printer_job_data(printer_job *, void *, int);
 624 void printer_finish_job(printer_job *);
 625
 626 /*
 627  * Exports from cmdline.c (and also cmdline_error(), which is
 628  * defined differently in various places and required _by_
 629  * cmdline.c).
 630  */
 631 int cmdline_process_param(char *, char *, int);
 632 void cmdline_run_saved(void);
 633 extern char *cmdline_password;
 634 #define TOOLTYPE_FILETRANSFER 1
 635 extern int cmdline_tooltype;
 636
 637 void cmdline_error(char *, ...);
 638
 639 #endif