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 typedef struct {
 119     char *(*init) (char *host, int port, char **realhost);
 120     void (*send) (char *buf, int len);
 121     void (*size) (void);
 122     void (*special) (Telnet_Special code);
 123     Socket (*socket) (void);
 124     int (*sendok) (void);
 125     int default_port;
 126 } Backend;
 127
 128 GLOBAL Backend *back;
 129
 130 extern struct backend_list {
 131     int protocol;
 132     char *name;
 133     Backend *backend;
 134 } backends[];
 135
 136 typedef struct {
 137     void (*send) (char *buf, int len);
 138 } Ldisc;
 139
 140 GLOBAL Ldisc *ldisc;
 141
 142 typedef struct {
 143     /* Basic options */
 144     char host[512];
 145     int port;
 146     enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol;
 147     int close_on_exit;
 148     int warn_on_close;
 149     int ping_interval;                 /* in seconds */
 150     /* SSH options */
 151     char remote_cmd[512];
 152     int nopty;
 153     int compression;
 154     int agentfwd;
 155     enum { CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_DES } cipher;
 156     char keyfile[FILENAME_MAX];
 157     int sshprot;                       /* use v1 or v2 when both available */
 158     int buggymac;                      /* MAC bug commmercial <=v2.3.x SSH2 */
 159     int try_tis_auth;
 160     /* Telnet options */
 161     char termtype[32];
 162     char termspeed[32];
 163     char environmt[1024];                    /* VAR\tvalue\0VAR\tvalue\0\0 */
 164     char username[32];
 165     char localusername[32];
 166     int rfc_environ;
 167     /* Keyboard options */
 168     int bksp_is_delete;
 169     int rxvt_homeend;
 170     int funky_type;
 171     int no_applic_c;                   /* totally disable app cursor keys */
 172     int no_applic_k;                   /* totally disable app keypad */
 173     int app_cursor;
 174     int app_keypad;
 175     int nethack_keypad;
 176     int alt_f4;                        /* is it special? */
 177     int alt_space;                     /* is it special? */
 178     int alt_only;                      /* is it special? */
 179     int ldisc_term;
 180     int alwaysontop;
 181     int scroll_on_key;
 182     int scroll_on_disp;
 183     int compose_key;
 184     char wintitle[256];                /* initial window title */
 185     /* Terminal options */
 186     int savelines;
 187     int dec_om;
 188     int wrap_mode;
 189     int lfhascr;
 190     int cursor_type;                   /* 0=block 1=underline 2=vertical */
 191     int blink_cur;
 192     int beep;
 193     int scrollbar;
 194     int locksize;
 195     int bce;
 196     int blinktext;
 197     int win_name_always;
 198     int width, height;
 199     char font[64];
 200     int fontisbold;
 201     int fontheight;
 202     int fontcharset;
 203     char logfilename[FILENAME_MAX];
 204     int logtype;
 205     int hide_mouseptr;
 206     /* Colour options */
 207     int try_palette;
 208     int bold_colour;
 209     unsigned char colours[22][3];
 210     /* Selection options */
 211     int mouse_is_xterm;
 212     short wordness[256];
 213     /* translations */
 214     VT_Mode vtmode;
 215     int xlat_enablekoiwin;
 216     int xlat_88592w1250;
 217     int xlat_88592cp852;
 218     int xlat_capslockcyr;
 219     /* X11 forwarding */
 220     int x11_forward;
 221     char x11_display[128];
 222 } Config;
 223
 224 /*
 225  * You can compile with -DSSH_DEFAULT to have ssh by default.
 226  */
 227 #ifndef SSH_DEFAULT
 228 #define DEFAULT_PROTOCOL PROT_TELNET
 229 #define DEFAULT_PORT 23
 230 #else
 231 #define DEFAULT_PROTOCOL PROT_SSH
 232 #define DEFAULT_PORT 22
 233 #endif
 234
 235 /*
 236  * Some global flags denoting the type of application.
 237  *
 238  * FLAG_VERBOSE is set when the user requests verbose details.
 239  *
 240  * FLAG_STDERR is set in command-line applications (which have a
 241  * functioning stderr that it makes sense to write to) and not in
 242  * GUI applications (which don't).
 243  *
 244  * FLAG_INTERACTIVE is set when a full interactive shell session is
 245  * being run, _either_ because no remote command has been provided
 246  * _or_ because the application is GUI and can't run non-
 247  * interactively.
 248  */
 249 #define FLAG_VERBOSE     0x0001
 250 #define FLAG_STDERR      0x0002
 251 #define FLAG_INTERACTIVE 0x0004
 252 GLOBAL int flags;
 253
 254 GLOBAL Config cfg;
 255 GLOBAL int default_protocol;
 256 GLOBAL int default_port;
 257
 258 struct RSAKey;                         /* be a little careful of scope */
 259
 260 /*
 261  * Exports from window.c.
 262  */
 263 void request_resize (int, int, int);
 264 void do_text (Context, int, int, char *, int, unsigned long, int);
 265 void set_title (char *);
 266 void set_icon (char *);
 267 void set_sbar (int, int, int);
 268 Context get_ctx(void);
 269 void free_ctx (Context);
 270 void palette_set (int, int, int, int);
 271 void palette_reset (void);
 272 void write_clip (void *, int, int);
 273 void get_clip (void **, int *);
 274 void optimised_move (int, int, int);
 275 void connection_fatal(char *, ...);
 276 void fatalbox (char *, ...);
 277 void beep (int);
 278 void begin_session(void);
 279 void sys_cursor(int x, int y);
 280 #define OPTIMISE_IS_SCROLL 1
 281
 282 /*
 283  * Exports from noise.c.
 284  */
 285 void noise_get_heavy(void (*func)(void *, int));
 286 void noise_get_light(void (*func)(void *, int));
 287 void noise_regular(void);
 288 void noise_ultralight(DWORD data);
 289 void random_save_seed(void);
 290 void random_destroy_seed(void);
 291
 292 /*
 293  * Exports from windlg.c.
 294  */
 295 void defuse_showwindow(void);
 296 int do_config (void);
 297 int do_reconfig (HWND);
 298 void do_defaults (char *, Config *);
 299 void logevent (char *);
 300 void showeventlog (HWND);
 301 void showabout (HWND);
 302 void verify_ssh_host_key(char *host, int port, char *keytype,
 303                          char *keystr, char *fingerprint);
 304 int askappend(char *filename);
 305 void registry_cleanup(void);
 306 void force_normal(HWND hwnd);
 307
 308 GLOBAL int nsessions;
 309 GLOBAL char **sessions;
 310
 311 /*
 312  * Exports from settings.c.
 313  */
 314 void save_settings (char *section, int do_host, Config *cfg);
 315 void load_settings (char *section, int do_host, Config *cfg);
 316 void get_sesslist(int allocate);
 317
 318 /*
 319  * Exports from terminal.c.
 320  */
 321
 322 void term_init (void);
 323 void term_size (int, int, int);
 324 void term_out (void);
 325 void term_paint (Context, int, int, int, int);
 326 void term_scroll (int, int);
 327 void term_pwron (void);
 328 void term_clrsb (void);
 329 void term_mouse (Mouse_Button, Mouse_Action, int, int);
 330 void term_deselect (void);
 331 void term_update (void);
 332 void term_invalidate(void);
 333 void term_blink(int set_cursor);
 334 void term_paste(void);
 335 void term_nopaste(void);
 336 void from_backend(int is_stderr, char *data, int len);
 337 void logfopen (void);
 338 void logfclose (void);
 339 void term_copyall(void);
 340
 341 /*
 342  * Exports from raw.c.
 343  */
 344
 345 extern Backend raw_backend;
 346
 347 /*
 348  * Exports from rlogin.c.
 349  */
 350
 351 extern Backend rlogin_backend;
 352
 353 /*
 354  * Exports from telnet.c.
 355  */
 356
 357 extern Backend telnet_backend;
 358
 359 /*
 360  * Exports from ssh.c.
 361  */
 362
 363 extern int (*ssh_get_password)(const char *prompt, char *str, int maxlen);
 364 extern Backend ssh_backend;
 365
 366 /*
 367  * Exports from ldisc.c.
 368  */
 369
 370 extern Ldisc ldisc_term, ldisc_simple;
 371
 372 /*
 373  * Exports from sshrand.c.
 374  */
 375
 376 void random_add_noise(void *noise, int length);
 377 void random_init(void);
 378 int random_byte(void);
 379 void random_get_savedata(void **data, int *len);
 380
 381 /*
 382  * Exports from misc.c.
 383  */
 384
 385 #include "puttymem.h"
 386
 387 /*
 388  * Exports from version.c.
 389  */
 390 extern char ver[];
 391
 392 /*
 393  * Exports from sizetip.c.
 394  */
 395 void UpdateSizeTip(HWND src, int cx, int cy);
 396 void EnableSizeTip(int bEnable);
 397
 398 /*
 399  * Exports from xlat.c.
 400  */
 401 unsigned char xlat_kbd2tty(unsigned char c);
 402 unsigned char xlat_tty2scr(unsigned char c);
 403 unsigned char xlat_latkbd2win(unsigned char c);
 404
 405 /*
 406  * Exports from mscrypto.c
 407  */
 408 #ifdef MSCRYPTOAPI
 409 int crypto_startup();
 410 void crypto_wrapup();
 411 #endif
 412
 413 /*
 414  * Exports from pageantc.c
 415  */
 416 void agent_query(void *in, int inlen, void **out, int *outlen);
 417 int agent_exists(void);
 418
 419 #ifdef DEBUG
 420 void dprintf(char *fmt, ...);
 421 #define debug(x) (dprintf x)
 422 #else
 423 #define debug(x)
 424 #endif
 425
 426 #endif