putty.h

   1 #ifndef PUTTY_PUTTY_H
   2 #define PUTTY_PUTTY_H
   3
   4 #include "network.h"
   5
   6 #define PUTTY_REG_POS "Software\\SimonTatham\\PuTTY"
   7 #define PUTTY_REG_PARENT "Software\\SimonTatham"
   8 #define PUTTY_REG_PARENT_CHILD "PuTTY"
   9 #define PUTTY_REG_GPARENT "Software"
  10 #define PUTTY_REG_GPARENT_CHILD "SimonTatham"
  11
  12 /*
  13  * Global variables. Most modules declare these `extern', but
  14  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
  15  * module, and so will get them properly defined.
  16  */
  17 #ifdef PUTTY_DO_GLOBALS
  18 #define GLOBAL
  19 #else
  20 #define GLOBAL extern
  21 #endif
  22
  23 #define ATTR_ACTCURS 0x80000000UL      /* active cursor (block) */
  24 #define ATTR_PASCURS 0x40000000UL      /* passive cursor (box) */
  25 #define ATTR_INVALID 0x20000000UL
  26 #define ATTR_WRAPPED 0x10000000UL
  27 #define ATTR_RIGHTCURS 0x10000000UL    /* doubles as cursor-on-RHS indicator */
  28
  29 #define LATTR_NORM   0x00000000UL
  30 #define LATTR_WIDE   0x01000000UL
  31 #define LATTR_TOP    0x02000000UL
  32 #define LATTR_BOT    0x03000000UL
  33 #define LATTR_MODE   0x03000000UL
  34
  35 #define ATTR_ASCII   0x00000000UL      /* normal ASCII charset ESC ( B */
  36 #define ATTR_GBCHR   0x00100000UL      /* UK variant   charset ESC ( A */
  37 #define ATTR_LINEDRW 0x00200000UL      /* line drawing charset ESC ( 0 */
  38
  39 #define ATTR_BOLD    0x00000100UL
  40 #define ATTR_UNDER   0x00000200UL
  41 #define ATTR_REVERSE 0x00000400UL
  42 #define ATTR_BLINK   0x00000800UL
  43 #define ATTR_FGMASK  0x0000F000UL
  44 #define ATTR_BGMASK  0x000F0000UL
  45 #define ATTR_FGSHIFT 12
  46 #define ATTR_BGSHIFT 16
  47
  48 #define ATTR_DEFAULT 0x00098000UL
  49 #define ATTR_DEFFG   0x00008000UL
  50 #define ATTR_DEFBG   0x00090000UL
  51 #define ATTR_CUR_XOR 0x000BA000UL
  52 #define ERASE_CHAR   (ATTR_DEFAULT | ' ')
  53 #define ATTR_MASK    0xFFFFFF00UL
  54 #define CHAR_MASK    0x000000FFUL
  55 #define CSET_MASK    0x00F00000UL      /* mask for character set */
  56
  57 typedef HDC Context;
  58 #define SEL_NL { 13, 10 }
  59
  60 GLOBAL int rows, cols, savelines;
  61
  62 GLOBAL int font_width, font_height;
  63
  64 #define INBUF_SIZE 2048
  65 GLOBAL unsigned char inbuf[INBUF_SIZE];
  66 GLOBAL int inbuf_head;
  67
  68 #define OUTBUF_SIZE 2048
  69 #define OUTBUF_MASK (OUTBUF_SIZE-1)
  70 GLOBAL unsigned char outbuf[OUTBUF_SIZE];
  71 GLOBAL int outbuf_head, outbuf_reap;
  72
  73 GLOBAL int has_focus;
  74
  75 GLOBAL int in_vbell;
  76 GLOBAL long vbell_timeout;
  77
  78 GLOBAL int app_cursor_keys, app_keypad_keys, vt52_mode;
  79 GLOBAL int repeat_off, cr_lf_return;
  80
  81 GLOBAL int seen_key_event;
  82 GLOBAL int seen_disp_event;
  83
  84 GLOBAL int session_closed;
  85
  86 #define LGXF_OVR  1                    /* existing logfile overwrite */
  87 #define LGXF_APN  0                    /* existing logfile append */
  88 #define LGXF_ASK -1                    /* existing logfile ask */
  89 #define LGTYP_NONE  0                  /* logmode: no logging */
  90 #define LGTYP_ASCII 1                  /* logmode: pure ascii */
  91 #define LGTYP_DEBUG 2                  /* logmode: all chars of taffic */
  92 GLOBAL char *logfile;
  93
  94 /*
  95  * Window handles for the dialog boxes that can be running during a
  96  * PuTTY session.
  97  */
  98 GLOBAL HWND logbox;
  99
 100 /*
 101  * I've just looked in the windows standard headr files for WM_USER, there
 102  * are hundreds of flags defined using the form WM_USER+123 so I've
 103  * renumbered this NETEVENT value and the two in window.c
 104  */
 105 #define WM_XUSER     (WM_USER + 0x2000)
 106 #define WM_NETEVENT  (WM_XUSER + 5)
 107
 108 typedef enum {
 109     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
 110     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING
 111 } Telnet_Special;
 112
 113 typedef enum {
 114     MBT_NOTHING,
 115     MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
 116     MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
 117     MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
 118 } Mouse_Button;
 119
 120 typedef enum {
 121     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
 122 } Mouse_Action;
 123
 124 typedef enum {
 125     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
 126 } VT_Mode;
 127
 128 enum {
 129     /*
 130      * Line discipline option states: off, on, up to the backend.
 131      */
 132     LD_YES, LD_NO, LD_BACKEND
 133 };
 134
 135 enum {
 136     /*
 137      * Line discipline options which the backend might try to control.
 138      */
 139     LD_EDIT,                           /* local line editing */
 140     LD_ECHO                            /* local echo */
 141 };
 142
 143 enum {
 144     /*
 145      * Close On Exit behaviours. (cfg.close_on_exit)
 146      */
 147     COE_NEVER,                         /* Never close the window */
 148     COE_NORMAL,                        /* Close window on "normal" (non-error) exits only */
 149     COE_ALWAYS                         /* Always close the window */
 150 };
 151
 152 typedef struct {
 153     char *(*init) (char *host, int port, char **realhost);
 154     void (*send) (char *buf, int len);
 155     void (*size) (void);
 156     void (*special) (Telnet_Special code);
 157      Socket(*socket) (void);
 158     int (*sendok) (void);
 159     int (*ldisc) (int);
 160     int default_port;
 161 } Backend;
 162
 163 GLOBAL Backend *back;
 164
 165 extern struct backend_list {
 166     int protocol;
 167     char *name;
 168     Backend *backend;
 169 } backends[];
 170
 171 typedef struct {
 172     /* Basic options */
 173     char host[512];
 174     int port;
 175     enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
 176     int close_on_exit;
 177     int warn_on_close;
 178     int ping_interval;                 /* in seconds */
 179     /* SSH options */
 180     char remote_cmd[512];
 181     char *remote_cmd_ptr;              /* might point to a larger command
 182                                         * but never for loading/saving */
 183     int nopty;
 184     int compression;
 185     int agentfwd;
 186     enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES, CIPHER_AES } cipher;
 187     char keyfile[FILENAME_MAX];
 188     int sshprot;                       /* use v1 or v2 when both available */
 189     int buggymac;                      /* MAC bug commmercial <=v2.3.x SSH2 */
 190     int try_tis_auth;
 191     int ssh_subsys;                    /* run a subsystem rather than a command */
 192     /* Telnet options */
 193     char termtype[32];
 194     char termspeed[32];
 195     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
 196     char username[32];
 197     char localusername[32];
 198     int rfc_environ;
 199     /* Keyboard options */
 200     int bksp_is_delete;
 201     int rxvt_homeend;
 202     int funky_type;
 203     int no_applic_c;                   /* totally disable app cursor keys */
 204     int no_applic_k;                   /* totally disable app keypad */
 205     int app_cursor;
 206     int app_keypad;
 207     int nethack_keypad;
 208     int alt_f4;                        /* is it special? */
 209     int alt_space;                     /* is it special? */
 210     int alt_only;                      /* is it special? */
 211     int localecho;
 212     int localedit;
 213     int alwaysontop;
 214     int scroll_on_key;
 215     int scroll_on_disp;
 216     int compose_key;
 217     int ctrlaltkeys;
 218     char wintitle[256];                /* initial window title */
 219     /* Terminal options */
 220     int savelines;
 221     int dec_om;
 222     int wrap_mode;
 223     int lfhascr;
 224     int cursor_type;                   /* 0=block 1=underline 2=vertical */
 225     int blink_cur;
 226     enum {
 227         BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
 228     } beep;
 229     int bellovl;                       /* bell overload protection active? */
 230     int bellovl_n;                     /* number of bells to cause overload */
 231     int bellovl_t;                     /* time interval for overload (seconds) */
 232     int bellovl_s;                     /* period of silence to re-enable bell (s) */
 233     char bell_wavefile[FILENAME_MAX];
 234     int scrollbar;
 235     int locksize;
 236     int bce;
 237     int blinktext;
 238     int win_name_always;
 239     int width, height;
 240     char font[64];
 241     int fontisbold;
 242     int fontheight;
 243     int fontcharset;
 244     char logfilename[FILENAME_MAX];
 245     int logtype;
 246     int logxfovr;
 247     int hide_mouseptr;
 248     int sunken_edge;
 249     char answerback[256];
 250     /* Colour options */
 251     int try_palette;
 252     int bold_colour;
 253     unsigned char colours[22][3];
 254     /* Selection options */
 255     int mouse_is_xterm;
 256     int rawcnp;
 257     short wordness[256];
 258     /* translations */
 259     VT_Mode vtmode;
 260     int xlat_enablekoiwin;
 261     int xlat_88592w1250;
 262     int xlat_88592cp852;
 263     int xlat_capslockcyr;
 264     /* X11 forwarding */
 265     int x11_forward;
 266     char x11_display[128];
 267 } Config;
 268
 269 /*
 270  * You can compile with -DSSH_DEFAULT to have ssh by default.
 271  */
 272 #ifndef SSH_DEFAULT
 273 #define DEFAULT_PROTOCOL PROT_TELNET
 274 #define DEFAULT_PORT 23
 275 #else
 276 #define DEFAULT_PROTOCOL PROT_SSH
 277 #define DEFAULT_PORT 22
 278 #endif
 279
 280 /*
 281  * Some global flags denoting the type of application.
 282  *
 283  * FLAG_VERBOSE is set when the user requests verbose details.
 284  *
 285  * FLAG_STDERR is set in command-line applications (which have a
 286  * functioning stderr that it makes sense to write to) and not in
 287  * GUI applications (which don't).
 288  *
 289  * FLAG_INTERACTIVE is set when a full interactive shell session is
 290  * being run, _either_ because no remote command has been provided
 291  * _or_ because the application is GUI and can't run non-
 292  * interactively.
 293  */
 294 #define FLAG_VERBOSE     0x0001
 295 #define FLAG_STDERR      0x0002
 296 #define FLAG_INTERACTIVE 0x0004
 297 GLOBAL int flags;
 298
 299 GLOBAL Config cfg;
 300 GLOBAL int default_protocol;
 301 GLOBAL int default_port;
 302
 303 struct RSAKey;                         /* be a little careful of scope */
 304
 305 /*
 306  * Exports from window.c.
 307  */
 308 void request_resize(int, int, int);
 309 void do_text(Context, int, int, char *, int, unsigned long, int);
 310 void set_title(char *);
 311 void set_icon(char *);
 312 void set_sbar(int, int, int);
 313 Context get_ctx(void);
 314 void free_ctx(Context);
 315 void palette_set(int, int, int, int);
 316 void palette_reset(void);
 317 void write_clip(void *, int, int);
 318 void get_clip(void **, int *);
 319 void optimised_move(int, int, int);
 320 void set_raw_mouse_mode(int);
 321 Mouse_Button translate_button(Mouse_Button b);
 322 void connection_fatal(char *, ...);
 323 void fatalbox(char *, ...);
 324 void beep(int);
 325 void begin_session(void);
 326 void sys_cursor(int x, int y);
 327 #define OPTIMISE_IS_SCROLL 1
 328
 329 /*
 330  * Exports from noise.c.
 331  */
 332 void noise_get_heavy(void (*func) (void *, int));
 333 void noise_get_light(void (*func) (void *, int));
 334 void noise_regular(void);
 335 void noise_ultralight(DWORD data);
 336 void random_save_seed(void);
 337 void random_destroy_seed(void);
 338
 339 /*
 340  * Exports from windlg.c.
 341  */
 342 void defuse_showwindow(void);
 343 int do_config(void);
 344 int do_reconfig(HWND);
 345 void do_defaults(char *, Config *);
 346 void logevent(char *);
 347 void showeventlog(HWND);
 348 void showabout(HWND);
 349 void verify_ssh_host_key(char *host, int port, char *keytype,
 350                          char *keystr, char *fingerprint);
 351 int askappend(char *filename);
 352 void registry_cleanup(void);
 353 void force_normal(HWND hwnd);
 354
 355 GLOBAL int nsessions;
 356 GLOBAL char **sessions;
 357
 358 /*
 359  * Exports from settings.c.
 360  */
 361 void save_settings(char *section, int do_host, Config * cfg);
 362 void load_settings(char *section, int do_host, Config * cfg);
 363 void get_sesslist(int allocate);
 364
 365 /*
 366  * Exports from terminal.c.
 367  */
 368
 369 void term_init(void);
 370 void term_size(int, int, int);
 371 void term_out(void);
 372 void term_paint(Context, int, int, int, int);
 373 void term_scroll(int, int);
 374 void term_pwron(void);
 375 void term_clrsb(void);
 376 void term_mouse(Mouse_Button, Mouse_Action, int, int, int, int);
 377 void term_deselect(void);
 378 void term_update(void);
 379 void term_invalidate(void);
 380 void term_blink(int set_cursor);
 381 void term_paste(void);
 382 void term_nopaste(void);
 383 int term_ldisc(int option);
 384 void from_backend(int is_stderr, char *data, int len);
 385 void logfopen(void);
 386 void logfclose(void);
 387 void term_copyall(void);
 388
 389 /*
 390  * Exports from raw.c.
 391  */
 392
 393 extern Backend raw_backend;
 394
 395 /*
 396  * Exports from rlogin.c.
 397  */
 398
 399 extern Backend rlogin_backend;
 400
 401 /*
 402  * Exports from telnet.c.
 403  */
 404
 405 extern Backend telnet_backend;
 406
 407 /*
 408  * Exports from ssh.c.
 409  */
 410
 411 extern int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
 412                             int is_pw);
 413 extern Backend ssh_backend;
 414
 415 /*
 416  * Exports from ldisc.c.
 417  */
 418
 419 extern void ldisc_send(char *buf, int len);
 420
 421 /*
 422  * Exports from sshrand.c.
 423  */
 424
 425 void random_add_noise(void *noise, int length);
 426 void random_init(void);
 427 int random_byte(void);
 428 void random_get_savedata(void **data, int *len);
 429
 430 /*
 431  * Exports from misc.c.
 432  */
 433
 434 #include "misc.h"
 435
 436 /*
 437  * Exports from version.c.
 438  */
 439 extern char ver[];
 440
 441 /*
 442  * Exports from sizetip.c.
 443  */
 444 void UpdateSizeTip(HWND src, int cx, int cy);
 445 void EnableSizeTip(int bEnable);
 446
 447 /*
 448  * Exports from xlat.c.
 449  */
 450 unsigned char xlat_kbd2tty(unsigned char c);
 451 unsigned char xlat_tty2scr(unsigned char c);
 452 unsigned char xlat_latkbd2win(unsigned char c);
 453
 454 /*
 455  * Exports from mscrypto.c
 456  */
 457 #ifdef MSCRYPTOAPI
 458 int crypto_startup();
 459 void crypto_wrapup();
 460 #endif
 461
 462 /*
 463  * Exports from pageantc.c
 464  */
 465 void agent_query(void *in, int inlen, void **out, int *outlen);
 466 int agent_exists(void);
 467
 468
 469 #endif