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