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