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