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