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 LGTYP_NONE  0  /* logmode: no logging */
  87 #define LGTYP_ASCII 1  /* logmode: pure ascii */
  88 #define LGTYP_DEBUG 2  /* logmode: all chars of taffic */
  89 GLOBAL char *logfile;
  90
  91 /*
  92  * Window handles for the dialog boxes that can be running during a
  93  * PuTTY session.
  94  */
  95 GLOBAL HWND logbox;
  96
  97 /*
  98  * I've just looked in the windows standard headr files for WM_USER, there
  99  * are hundreds of flags defined using the form WM_USER+123 so I've
 100  * renumbered this NETEVENT value and the two in window.c
 101  */
 102 #define WM_XUSER     (WM_USER + 0x2000)
 103 #define WM_NETEVENT  (WM_XUSER + 5)
 104
 105 typedef enum {
 106     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
 107     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING
 108 } Telnet_Special;
 109
 110 typedef enum {
 111     MB_NOTHING, MB_SELECT, MB_EXTEND, MB_PASTE
 112 } Mouse_Button;
 113
 114 typedef enum {
 115     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
 116 } Mouse_Action;
 117
 118 typedef enum {
 119     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN
 120 } VT_Mode;
 121
 122 enum {
 123     /*
 124      * Line discipline option states: off, on, up to the backend.
 125      */
 126     LD_YES, LD_NO, LD_BACKEND
 127 };
 128
 129 enum {
 130     /*
 131      * Line discipline options which the backend might try to control.
 132      */
 133     LD_EDIT,                           /* local line editing */
 134     LD_ECHO                            /* local echo */
 135 };
 136
 137 enum {
 138     /*
 139      * Close On Exit behaviours. (cfg.close_on_exit)
 140      */
 141     COE_NEVER,      /* Never close the window */
 142     COE_NORMAL,     /* Close window on "normal" (non-error) exits only */
 143     COE_ALWAYS      /* Always close the window */
 144 };
 145
 146 typedef struct {
 147     char *(*init) (char *host, int port, char **realhost);
 148     void (*send) (char *buf, int len);
 149     void (*size) (void);
 150     void (*special) (Telnet_Special code);
 151     Socket (*socket) (void);
 152     int (*sendok) (void);
 153     int (*ldisc) (int);
 154     int default_port;
 155 } Backend;
 156
 157 GLOBAL Backend *back;
 158
 159 extern struct backend_list {
 160     int protocol;
 161     char *name;
 162     Backend *backend;
 163 } backends[];
 164
 165 typedef struct {
 166     /* Basic options */
 167     char host[512];
 168     int port;
 169     enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
 170     int close_on_exit;
 171     int warn_on_close;
 172     int ping_interval;                 /* in seconds */
 173     /* SSH options */
 174     char remote_cmd[512];
 175     char *remote_cmd_ptr;              /* might point to a larger command
 176                                         * but never for loading/saving */
 177     int nopty;
 178     int compression;
 179     int agentfwd;
 180     enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES, CIPHER_AES } cipher;
 181     char keyfile[FILENAME_MAX];
 182     int sshprot;                       /* use v1 or v2 when both available */
 183     int buggymac;                      /* MAC bug commmercial <=v2.3.x SSH2 */
 184     int try_tis_auth;
 185     int ssh_subsys;                    /* run a subsystem rather than a command */
 186     /* Telnet options */
 187     char termtype[32];
 188     char termspeed[32];
 189     char environmt[1024];                    /* VAR\tvalue\0VAR\tvalue\0\0 */
 190     char username[32];
 191     char localusername[32];
 192     int rfc_environ;
 193     /* Keyboard options */
 194     int bksp_is_delete;
 195     int rxvt_homeend;
 196     int funky_type;
 197     int no_applic_c;                   /* totally disable app cursor keys */
 198     int no_applic_k;                   /* totally disable app keypad */
 199     int app_cursor;
 200     int app_keypad;
 201     int nethack_keypad;
 202     int alt_f4;                        /* is it special? */
 203     int alt_space;                     /* is it special? */
 204     int alt_only;                      /* is it special? */
 205     int localecho;
 206     int localedit;
 207     int alwaysontop;
 208     int scroll_on_key;
 209     int scroll_on_disp;
 210     int compose_key;
 211     int ctrlaltkeys;
 212     char wintitle[256];                /* initial window title */
 213     /* Terminal options */
 214     int savelines;
 215     int dec_om;
 216     int wrap_mode;
 217     int lfhascr;
 218     int cursor_type;                   /* 0=block 1=underline 2=vertical */
 219     int blink_cur;
 220     enum {
 221         BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE
 222     } beep;
 223     int bellovl;                       /* bell overload protection active? */
 224     int bellovl_n;                     /* number of bells to cause overload */
 225     int bellovl_t;                     /* time interval for overload (seconds) */
 226     int bellovl_s;                     /* period of silence to re-enable bell (s) */
 227     char bell_wavefile[FILENAME_MAX];
 228     int scrollbar;
 229     int locksize;
 230     int bce;
 231     int blinktext;
 232     int win_name_always;
 233     int width, height;
 234     char font[64];
 235     int fontisbold;
 236     int fontheight;
 237     int fontcharset;
 238     char logfilename[FILENAME_MAX];
 239     int logtype;
 240     int hide_mouseptr;
 241     char answerback[256];
 242     /* Colour options */
 243     int try_palette;
 244     int bold_colour;
 245     unsigned char colours[22][3];
 246     /* Selection options */
 247     int mouse_is_xterm;
 248     int rawcnp;
 249     short wordness[256];
 250     /* translations */
 251     VT_Mode vtmode;
 252     int xlat_enablekoiwin;
 253     int xlat_88592w1250;
 254     int xlat_88592cp852;
 255     int xlat_capslockcyr;
 256     /* X11 forwarding */
 257     int x11_forward;
 258     char x11_display[128];
 259 } Config;
 260
 261 /*
 262  * You can compile with -DSSH_DEFAULT to have ssh by default.
 263  */
 264 #ifndef SSH_DEFAULT
 265 #define DEFAULT_PROTOCOL PROT_TELNET
 266 #define DEFAULT_PORT 23
 267 #else
 268 #define DEFAULT_PROTOCOL PROT_SSH
 269 #define DEFAULT_PORT 22
 270 #endif
 271
 272 /*
 273  * Some global flags denoting the type of application.
 274  *
 275  * FLAG_VERBOSE is set when the user requests verbose details.
 276  *
 277  * FLAG_STDERR is set in command-line applications (which have a
 278  * functioning stderr that it makes sense to write to) and not in
 279  * GUI applications (which don't).
 280  *
 281  * FLAG_INTERACTIVE is set when a full interactive shell session is
 282  * being run, _either_ because no remote command has been provided
 283  * _or_ because the application is GUI and can't run non-
 284  * interactively.
 285  */
 286 #define FLAG_VERBOSE     0x0001
 287 #define FLAG_STDERR      0x0002
 288 #define FLAG_INTERACTIVE 0x0004
 289 GLOBAL int flags;
 290
 291 GLOBAL Config cfg;
 292 GLOBAL int default_protocol;
 293 GLOBAL int default_port;
 294
 295 struct RSAKey;                         /* be a little careful of scope */
 296
 297 /*
 298  * Exports from window.c.
 299  */
 300 void request_resize (int, int, int);
 301 void do_text (Context, int, int, char *, int, unsigned long, int);
 302 void set_title (char *);
 303 void set_icon (char *);
 304 void set_sbar (int, int, int);
 305 Context get_ctx(void);
 306 void free_ctx (Context);
 307 void palette_set (int, int, int, int);
 308 void palette_reset (void);
 309 void write_clip (void *, int, int);
 310 void get_clip (void **, int *);
 311 void optimised_move (int, int, int);
 312 void connection_fatal(char *, ...);
 313 void fatalbox (char *, ...);
 314 void beep (int);
 315 void begin_session(void);
 316 void sys_cursor(int x, int y);
 317 #define OPTIMISE_IS_SCROLL 1
 318
 319 /*
 320  * Exports from noise.c.
 321  */
 322 void noise_get_heavy(void (*func)(void *, int));
 323 void noise_get_light(void (*func)(void *, int));
 324 void noise_regular(void);
 325 void noise_ultralight(DWORD data);
 326 void random_save_seed(void);
 327 void random_destroy_seed(void);
 328
 329 /*
 330  * Exports from windlg.c.
 331  */
 332 void defuse_showwindow(void);
 333 int do_config (void);
 334 int do_reconfig (HWND);
 335 void do_defaults (char *, Config *);
 336 void logevent (char *);
 337 void showeventlog (HWND);
 338 void showabout (HWND);
 339 void verify_ssh_host_key(char *host, int port, char *keytype,
 340                          char *keystr, char *fingerprint);
 341 int askappend(char *filename);
 342 void registry_cleanup(void);
 343 void force_normal(HWND hwnd);
 344
 345 GLOBAL int nsessions;
 346 GLOBAL char **sessions;
 347
 348 /*
 349  * Exports from settings.c.
 350  */
 351 void save_settings (char *section, int do_host, Config *cfg);
 352 void load_settings (char *section, int do_host, Config *cfg);
 353 void get_sesslist(int allocate);
 354
 355 /*
 356  * Exports from terminal.c.
 357  */
 358
 359 void term_init (void);
 360 void term_size (int, int, int);
 361 void term_out (void);
 362 void term_paint (Context, int, int, int, int);
 363 void term_scroll (int, int);
 364 void term_pwron (void);
 365 void term_clrsb (void);
 366 void term_mouse (Mouse_Button, Mouse_Action, int, int);
 367 void term_deselect (void);
 368 void term_update (void);
 369 void term_invalidate(void);
 370 void term_blink(int set_cursor);
 371 void term_paste(void);
 372 void term_nopaste(void);
 373 int term_ldisc(int option);
 374 void from_backend(int is_stderr, char *data, int len);
 375 void logfopen (void);
 376 void logfclose (void);
 377 void term_copyall(void);
 378
 379 /*
 380  * Exports from raw.c.
 381  */
 382
 383 extern Backend raw_backend;
 384
 385 /*
 386  * Exports from rlogin.c.
 387  */
 388
 389 extern Backend rlogin_backend;
 390
 391 /*
 392  * Exports from telnet.c.
 393  */
 394
 395 extern Backend telnet_backend;
 396
 397 /*
 398  * Exports from ssh.c.
 399  */
 400
 401 extern int (*ssh_get_line)(const char *prompt, char *str, int maxlen,
 402                            int is_pw);
 403 extern Backend ssh_backend;
 404
 405 /*
 406  * Exports from ldisc.c.
 407  */
 408
 409 extern void ldisc_send(char *buf, int len);
 410
 411 /*
 412  * Exports from sshrand.c.
 413  */
 414
 415 void random_add_noise(void *noise, int length);
 416 void random_init(void);
 417 int random_byte(void);
 418 void random_get_savedata(void **data, int *len);
 419
 420 /*
 421  * Exports from misc.c.
 422  */
 423
 424 #include "puttymem.h"
 425
 426 /*
 427  * Exports from version.c.
 428  */
 429 extern char ver[];
 430
 431 /*
 432  * Exports from sizetip.c.
 433  */
 434 void UpdateSizeTip(HWND src, int cx, int cy);
 435 void EnableSizeTip(int bEnable);
 436
 437 /*
 438  * Exports from xlat.c.
 439  */
 440 unsigned char xlat_kbd2tty(unsigned char c);
 441 unsigned char xlat_tty2scr(unsigned char c);
 442 unsigned char xlat_latkbd2win(unsigned char c);
 443
 444 /*
 445  * Exports from mscrypto.c
 446  */
 447 #ifdef MSCRYPTOAPI
 448 int crypto_startup();
 449 void crypto_wrapup();
 450 #endif
 451
 452 /*
 453  * Exports from pageantc.c
 454  */
 455 void agent_query(void *in, int inlen, void **out, int *outlen);
 456 int agent_exists(void);
 457
 458 #ifdef DEBUG
 459 void dprintf(char *fmt, ...);
 460 #define debug(x) (dprintf x)
 461 #else
 462 #define debug(x)
 463 #endif
 464
 465 #endif