putty.h

   1 #ifndef PUTTY_PUTTY_H
   2 #define PUTTY_PUTTY_H
   3
   4 #include <stddef.h>                    /* for wchar_t */
   5
   6 /*
   7  * Global variables. Most modules declare these `extern', but
   8  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
   9  * module, and so will get them properly defined.
  10  */
  11 #ifndef GLOBAL
  12 #ifdef PUTTY_DO_GLOBALS
  13 #define GLOBAL
  14 #else
  15 #define GLOBAL extern
  16 #endif
  17 #endif
  18
  19 #ifndef DONE_TYPEDEFS
  20 #define DONE_TYPEDEFS
  21 typedef struct config_tag Config;
  22 typedef struct backend_tag Backend;
  23 typedef struct terminal_tag Terminal;
  24 #endif
  25
  26 #include "puttyps.h"
  27 #include "network.h"
  28 #include "misc.h"
  29
  30 /*
  31  * Fingerprints of the PGP master keys that can be used to establish a trust
  32  * path between an executable and other files.
  33  */
  34 #define PGP_RSA_MASTER_KEY_FP \
  35     "8F 15 97 DA 25 30 AB 0D  88 D1 92 54 11 CF 0C 4C"
  36 #define PGP_DSA_MASTER_KEY_FP \
  37     "313C 3E76 4B74 C2C5 F2AE  83A8 4F5E 6DF5 6A93 B34E"
  38
  39 /* Three attribute types:
  40  * The ATTRs (normal attributes) are stored with the characters in
  41  * the main display arrays
  42  *
  43  * The TATTRs (temporary attributes) are generated on the fly, they
  44  * can overlap with characters but not with normal attributes.
  45  *
  46  * The LATTRs (line attributes) are an entirely disjoint space of
  47  * flags.
  48  *
  49  * The DATTRs (display attributes) are internal to terminal.c (but
  50  * defined here because their values have to match the others
  51  * here); they reuse the TATTR_* space but are always masked off
  52  * before sending to the front end.
  53  *
  54  * ATTR_INVALID is an illegal colour combination.
  55  */
  56
  57 #define TATTR_ACTCURS       0x40000000UL      /* active cursor (block) */
  58 #define TATTR_PASCURS       0x20000000UL      /* passive cursor (box) */
  59 #define TATTR_RIGHTCURS     0x10000000UL      /* cursor-on-RHS */
  60 #define TATTR_COMBINING     0x80000000UL      /* combining characters */
  61
  62 #define DATTR_STARTRUN      0x80000000UL   /* start of redraw run */
  63
  64 #define TDATTR_MASK         0xF0000000UL
  65 #define TATTR_MASK (TDATTR_MASK)
  66 #define DATTR_MASK (TDATTR_MASK)
  67
  68 #define LATTR_NORM   0x00000000UL
  69 #define LATTR_WIDE   0x00000001UL
  70 #define LATTR_TOP    0x00000002UL
  71 #define LATTR_BOT    0x00000003UL
  72 #define LATTR_MODE   0x00000003UL
  73 #define LATTR_WRAPPED 0x00000010UL
  74 #define LATTR_WRAPPED2 0x00000020UL
  75
  76 #define ATTR_INVALID 0x03FFFFU
  77
  78 /* Like Linux use the F000 page for direct to font. */
  79 #define CSET_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
  80 #define CSET_ACP     0x0000F100UL      /* Ansi Codepage DTF */
  81
  82 /* These are internal use overlapping with the UTF-16 surrogates */
  83 #define CSET_ASCII   0x0000D800UL      /* normal ASCII charset ESC ( B */
  84 #define CSET_LINEDRW 0x0000D900UL      /* line drawing charset ESC ( 0 */
  85 #define CSET_SCOACS  0x0000DA00UL      /* SCO Alternate charset */
  86 #define CSET_GBCHR   0x0000DB00UL      /* UK variant   charset ESC ( A */
  87 #define CSET_MASK    0xFFFFFF00UL      /* Character set mask */
  88
  89 #define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800)
  90 #define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000)
  91
  92 #define UCSERR       (CSET_LINEDRW|'a') /* UCS Format error character. */
  93 /*
  94  * UCSWIDE is a special value used in the terminal data to signify
  95  * the character cell containing the right-hand half of a CJK wide
  96  * character. We use 0xDFFF because it's part of the surrogate
  97  * range and hence won't be used for anything else (it's impossible
  98  * to input it via UTF-8 because our UTF-8 decoder correctly
  99  * rejects surrogates).
 100  */
 101 #define UCSWIDE      0xDFFF
 102
 103 #define ATTR_NARROW  0x800000U
 104 #define ATTR_WIDE    0x400000U
 105 #define ATTR_BOLD    0x040000U
 106 #define ATTR_UNDER   0x080000U
 107 #define ATTR_REVERSE 0x100000U
 108 #define ATTR_BLINK   0x200000U
 109 #define ATTR_FGMASK  0x0001FFU
 110 #define ATTR_BGMASK  0x03FE00U
 111 #define ATTR_COLOURS 0x03FFFFU
 112 #define ATTR_FGSHIFT 0
 113 #define ATTR_BGSHIFT 9
 114
 115 /*
 116  * The definitive list of colour numbers stored in terminal
 117  * attribute words is kept here. It is:
 118  *
 119  *  - 0-7 are ANSI colours (KRGYBMCW).
 120  *  - 8-15 are the bold versions of those colours.
 121  *  - 16-255 are the remains of the xterm 256-colour mode (a
 122  *    216-colour cube with R at most significant and B at least,
 123  *    followed by a uniform series of grey shades running between
 124  *    black and white but not including either on grounds of
 125  *    redundancy).
 126  *  - 256 is default foreground
 127  *  - 257 is default bold foreground
 128  *  - 258 is default background
 129  *  - 259 is default bold background
 130  *  - 260 is cursor foreground
 131  *  - 261 is cursor background
 132  */
 133
 134 #define ATTR_DEFFG   (256 << ATTR_FGSHIFT)
 135 #define ATTR_DEFBG   (258 << ATTR_BGSHIFT)
 136 #define ATTR_DEFAULT (ATTR_DEFFG | ATTR_DEFBG)
 137
 138 struct sesslist {
 139     int nsessions;
 140     char **sessions;
 141     char *buffer;                      /* so memory can be freed later */
 142 };
 143
 144 struct unicode_data {
 145     char **uni_tbl;
 146     int dbcs_screenfont;
 147     int font_codepage;
 148     int line_codepage;
 149     wchar_t unitab_scoacs[256];
 150     wchar_t unitab_line[256];
 151     wchar_t unitab_font[256];
 152     wchar_t unitab_xterm[256];
 153     wchar_t unitab_oemcp[256];
 154     unsigned char unitab_ctrl[256];
 155 };
 156
 157 #define LGXF_OVR  1                    /* existing logfile overwrite */
 158 #define LGXF_APN  0                    /* existing logfile append */
 159 #define LGXF_ASK -1                    /* existing logfile ask */
 160 #define LGTYP_NONE  0                  /* logmode: no logging */
 161 #define LGTYP_ASCII 1                  /* logmode: pure ascii */
 162 #define LGTYP_DEBUG 2                  /* logmode: all chars of traffic */
 163 #define LGTYP_PACKETS 3                /* logmode: SSH data packets */
 164
 165 typedef enum {
 166     /* Actual special commands. Originally Telnet, but some codes have
 167      * been re-used for similar specials in other protocols. */
 168     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
 169     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
 170     TS_EOL,
 171     /* Special command for SSH. */
 172     TS_REKEY,
 173     /* POSIX-style signals. (not Telnet) */
 174     TS_SIGABRT, TS_SIGALRM, TS_SIGFPE,  TS_SIGHUP,  TS_SIGILL,
 175     TS_SIGINT,  TS_SIGKILL, TS_SIGPIPE, TS_SIGQUIT, TS_SIGSEGV,
 176     TS_SIGTERM, TS_SIGUSR1, TS_SIGUSR2,
 177     /* Pseudo-specials used for constructing the specials menu. */
 178     TS_SEP,         /* Separator */
 179     TS_SUBMENU,     /* Start a new submenu with specified name */
 180     TS_EXITMENU     /* Exit current submenu or end of specials */
 181 } Telnet_Special;
 182
 183 struct telnet_special {
 184     const char *name;
 185     int code;
 186 };
 187
 188 typedef enum {
 189     MBT_NOTHING,
 190     MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
 191     MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
 192     MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
 193 } Mouse_Button;
 194
 195 typedef enum {
 196     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
 197 } Mouse_Action;
 198
 199 /* Keyboard modifiers -- keys the user is actually holding down */
 200
 201 #define PKM_SHIFT       0x01
 202 #define PKM_CONTROL     0x02
 203 #define PKM_META        0x04
 204 #define PKM_ALT         0x08
 205
 206 /* Keyboard flags that aren't really modifiers */
 207 #define PKF_CAPSLOCK    0x10
 208 #define PKF_NUMLOCK     0x20
 209 #define PKF_REPEAT      0x40
 210
 211 /* Stand-alone keysyms for function keys */
 212
 213 typedef enum {
 214     PK_NULL,            /* No symbol for this key */
 215     /* Main keypad keys */
 216     PK_ESCAPE, PK_TAB, PK_BACKSPACE, PK_RETURN, PK_COMPOSE,
 217     /* Editing keys */
 218     PK_HOME, PK_INSERT, PK_DELETE, PK_END, PK_PAGEUP, PK_PAGEDOWN,
 219     /* Cursor keys */
 220     PK_UP, PK_DOWN, PK_RIGHT, PK_LEFT, PK_REST,
 221     /* Numeric keypad */                        /* Real one looks like: */
 222     PK_PF1, PK_PF2, PK_PF3, PK_PF4,             /* PF1 PF2 PF3 PF4 */
 223     PK_KPCOMMA, PK_KPMINUS, PK_KPDECIMAL,       /*  7   8   9   -  */
 224     PK_KP0, PK_KP1, PK_KP2, PK_KP3, PK_KP4,     /*  4   5   6   ,  */
 225     PK_KP5, PK_KP6, PK_KP7, PK_KP8, PK_KP9,     /*  1   2   3  en- */
 226     PK_KPBIGPLUS, PK_KPENTER,                   /*    0     .  ter */
 227     /* Top row */
 228     PK_F1,  PK_F2,  PK_F3,  PK_F4,  PK_F5,
 229     PK_F6,  PK_F7,  PK_F8,  PK_F9,  PK_F10,
 230     PK_F11, PK_F12, PK_F13, PK_F14, PK_F15,
 231     PK_F16, PK_F17, PK_F18, PK_F19, PK_F20,
 232     PK_PAUSE
 233 } Key_Sym;
 234
 235 #define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN)
 236 #define PK_ISCURSOR(k)  ((k) >= PK_UP && (k) <= PK_REST)
 237 #define PK_ISKEYPAD(k)  ((k) >= PK_PF1 && (k) <= PK_KPENTER)
 238 #define PK_ISFKEY(k)    ((k) >= PK_F1 && (k) <= PK_F20)
 239
 240 enum {
 241     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
 242 };
 243
 244 enum {
 245     /*
 246      * SSH-2 key exchange algorithms
 247      */
 248     KEX_WARN,
 249     KEX_DHGROUP1,
 250     KEX_DHGROUP14,
 251     KEX_DHGEX,
 252     KEX_MAX
 253 };
 254
 255 enum {
 256     /*
 257      * SSH ciphers (both SSH-1 and SSH-2)
 258      */
 259     CIPHER_WARN,                       /* pseudo 'cipher' */
 260     CIPHER_3DES,
 261     CIPHER_BLOWFISH,
 262     CIPHER_AES,                        /* (SSH-2 only) */
 263     CIPHER_DES,
 264     CIPHER_ARCFOUR,
 265     CIPHER_MAX                         /* no. ciphers (inc warn) */
 266 };
 267
 268 enum {
 269     /*
 270      * Several different bits of the PuTTY configuration seem to be
 271      * three-way settings whose values are `always yes', `always
 272      * no', and `decide by some more complex automated means'. This
 273      * is true of line discipline options (local echo and line
 274      * editing), proxy DNS, Close On Exit, and SSH server bug
 275      * workarounds. Accordingly I supply a single enum here to deal
 276      * with them all.
 277      */
 278     FORCE_ON, FORCE_OFF, AUTO
 279 };
 280
 281 enum {
 282     /*
 283      * Proxy types.
 284      */
 285     PROXY_NONE, PROXY_SOCKS4, PROXY_SOCKS5,
 286     PROXY_HTTP, PROXY_TELNET, PROXY_CMD
 287 };
 288
 289 enum {
 290     /*
 291      * Line discipline options which the backend might try to control.
 292      */
 293     LD_EDIT,                           /* local line editing */
 294     LD_ECHO                            /* local echo */
 295 };
 296
 297 enum {
 298     /* Protocol back ends. (cfg.protocol) */
 299     PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH
 300 };
 301
 302 enum {
 303     /* Bell settings (cfg.beep) */
 304     BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER
 305 };
 306
 307 enum {
 308     /* Taskbar flashing indication on bell (cfg.beep_ind) */
 309     B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
 310 };
 311
 312 enum {
 313     /* Resize actions (cfg.resize_action) */
 314     RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER
 315 };
 316
 317 enum {
 318     /* Function key types (cfg.funky_type) */
 319     FUNKY_TILDE,
 320     FUNKY_LINUX,
 321     FUNKY_XTERM,
 322     FUNKY_VT400,
 323     FUNKY_VT100P,
 324     FUNKY_SCO
 325 };
 326
 327 extern const char *const ttymodes[];
 328
 329 enum {
 330     /*
 331      * Network address types. Used for specifying choice of IPv4/v6
 332      * in config; also used in proxy.c to indicate whether a given
 333      * host name has already been resolved or will be resolved at
 334      * the proxy end.
 335      */
 336     ADDRTYPE_UNSPEC, ADDRTYPE_IPV4, ADDRTYPE_IPV6, ADDRTYPE_NAME
 337 };
 338
 339 struct backend_tag {
 340     const char *(*init) (void *frontend_handle, void **backend_handle,
 341                          Config *cfg,
 342                          char *host, int port, char **realhost, int nodelay,
 343                          int keepalive);
 344     void (*free) (void *handle);
 345     /* back->reconfig() passes in a replacement configuration. */
 346     void (*reconfig) (void *handle, Config *cfg);
 347     /* back->send() returns the current amount of buffered data. */
 348     int (*send) (void *handle, char *buf, int len);
 349     /* back->sendbuffer() does the same thing but without attempting a send */
 350     int (*sendbuffer) (void *handle);
 351     void (*size) (void *handle, int width, int height);
 352     void (*special) (void *handle, Telnet_Special code);
 353     const struct telnet_special *(*get_specials) (void *handle);
 354     Socket(*socket) (void *handle);
 355     int (*exitcode) (void *handle);
 356     int (*sendok) (void *handle);
 357     int (*ldisc) (void *handle, int);
 358     void (*provide_ldisc) (void *handle, void *ldisc);
 359     void (*provide_logctx) (void *handle, void *logctx);
 360     /*
 361      * back->unthrottle() tells the back end that the front end
 362      * buffer is clearing.
 363      */
 364     void (*unthrottle) (void *handle, int);
 365     int (*cfg_info) (void *handle);
 366     int default_port;
 367 };
 368
 369 extern struct backend_list {
 370     int protocol;
 371     char *name;
 372     Backend *backend;
 373 } backends[];
 374
 375 /*
 376  * Suggested default protocol provided by the backend link module.
 377  * The application is free to ignore this.
 378  */
 379 extern const int be_default_protocol;
 380
 381 /*
 382  * Name of this particular application, for use in the config box
 383  * and other pieces of text.
 384  */
 385 extern const char *const appname;
 386
 387 /*
 388  * IMPORTANT POLICY POINT: everything in this structure which wants
 389  * to be treated like an integer must be an actual, honest-to-
 390  * goodness `int'. No enum-typed variables. This is because parts
 391  * of the code will want to pass around `int *' pointers to them
 392  * and we can't run the risk of porting to some system on which the
 393  * enum comes out as a different size from int.
 394  */
 395 struct config_tag {
 396     /* Basic options */
 397     char host[512];
 398     int port;
 399     int protocol;
 400     int addressfamily;
 401     int close_on_exit;
 402     int warn_on_close;
 403     int ping_interval;                 /* in seconds */
 404     int tcp_nodelay;
 405     int tcp_keepalives;
 406     /* Proxy options */
 407     char proxy_exclude_list[512];
 408     int proxy_dns;
 409     int even_proxy_localhost;
 410     int proxy_type;
 411     char proxy_host[512];
 412     int proxy_port;
 413     char proxy_username[128];
 414     char proxy_password[128];
 415     char proxy_telnet_command[512];
 416     /* SSH options */
 417     char remote_cmd[512];
 418     char remote_cmd2[512];             /* fallback if the first fails
 419                                         * (used internally for scp) */
 420     char *remote_cmd_ptr;              /* might point to a larger command
 421                                         * but never for loading/saving */
 422     char *remote_cmd_ptr2;             /* might point to a larger command
 423                                         * but never for loading/saving */
 424     int nopty;
 425     int compression;
 426     int ssh_kexlist[KEX_MAX];
 427     int ssh_rekey_time;                /* in minutes */
 428     char ssh_rekey_data[16];
 429     int agentfwd;
 430     int change_username;               /* allow username switching in SSH-2 */
 431     int ssh_cipherlist[CIPHER_MAX];
 432     Filename keyfile;
 433     int sshprot;                       /* use v1 or v2 when both available */
 434     int ssh2_des_cbc;                  /* "des-cbc" unrecommended SSH-2 cipher */
 435     int try_tis_auth;
 436     int try_ki_auth;
 437     int ssh_subsys;                    /* run a subsystem rather than a command */
 438     int ssh_subsys2;                   /* fallback to go with remote_cmd2 */
 439     int ssh_no_shell;                  /* avoid running a shell */
 440     /* Telnet options */
 441     char termtype[32];
 442     char termspeed[32];
 443     char ttymodes[768];                /* MODE\tVvalue\0MODE\tA\0\0 */
 444     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
 445     char username[100];
 446     char localusername[100];
 447     int rfc_environ;
 448     int passive_telnet;
 449     /* Keyboard options */
 450     int bksp_is_delete;
 451     int rxvt_homeend;
 452     int funky_type;
 453     int no_applic_c;                   /* totally disable app cursor keys */
 454     int no_applic_k;                   /* totally disable app keypad */
 455     int no_mouse_rep;                  /* totally disable mouse reporting */
 456     int no_remote_resize;              /* disable remote resizing */
 457     int no_alt_screen;                 /* disable alternate screen */
 458     int no_remote_wintitle;            /* disable remote retitling */
 459     int no_dbackspace;                 /* disable destructive backspace */
 460     int no_remote_charset;             /* disable remote charset config */
 461     int no_remote_qtitle;              /* disable remote win title query */
 462     int app_cursor;
 463     int app_keypad;
 464     int nethack_keypad;
 465     int telnet_keyboard;
 466     int telnet_newline;
 467     int alt_f4;                        /* is it special? */
 468     int alt_space;                     /* is it special? */
 469     int alt_only;                      /* is it special? */
 470     int localecho;
 471     int localedit;
 472     int alwaysontop;
 473     int fullscreenonaltenter;
 474     int scroll_on_key;
 475     int scroll_on_disp;
 476     int erase_to_scrollback;
 477     int compose_key;
 478     int ctrlaltkeys;
 479     char wintitle[256];                /* initial window title */
 480     /* Terminal options */
 481     int savelines;
 482     int dec_om;
 483     int wrap_mode;
 484     int lfhascr;
 485     int cursor_type;                   /* 0=block 1=underline 2=vertical */
 486     int blink_cur;
 487     int beep;
 488     int beep_ind;
 489     int bellovl;                       /* bell overload protection active? */
 490     int bellovl_n;                     /* number of bells to cause overload */
 491     int bellovl_t;                     /* time interval for overload (seconds) */
 492     int bellovl_s;                     /* period of silence to re-enable bell (s) */
 493     Filename bell_wavefile;
 494     int scrollbar;
 495     int scrollbar_in_fullscreen;
 496     int resize_action;
 497     int bce;
 498     int blinktext;
 499     int win_name_always;
 500     int width, height;
 501     FontSpec font;
 502     Filename logfilename;
 503     int logtype;
 504     int logxfovr;
 505     int logflush;
 506     int logomitpass;
 507     int logomitdata;
 508     int hide_mouseptr;
 509     int sunken_edge;
 510     int window_border;
 511     char answerback[256];
 512     char printer[128];
 513     int arabicshaping;
 514     int bidi;
 515     /* Colour options */
 516     int ansi_colour;
 517     int xterm_256_colour;
 518     int system_colour;
 519     int try_palette;
 520     int bold_colour;
 521     unsigned char colours[22][3];
 522     /* Selection options */
 523     int mouse_is_xterm;
 524     int rect_select;
 525     int rawcnp;
 526     int rtf_paste;
 527     int mouse_override;
 528     short wordness[256];
 529     /* translations */
 530     int vtmode;
 531     char line_codepage[128];
 532     int cjk_ambig_wide;
 533     int utf8_override;
 534     int xlat_capslockcyr;
 535     /* X11 forwarding */
 536     int x11_forward;
 537     char x11_display[128];
 538     int x11_auth;
 539     /* port forwarding */
 540     int lport_acceptall; /* accept conns from hosts other than localhost */
 541     int rport_acceptall; /* same for remote forwarded ports (SSH-2 only) */
 542     /*
 543      * The port forwarding string contains a number of
 544      * NUL-terminated substrings, terminated in turn by an empty
 545      * string (i.e. a second NUL immediately after the previous
 546      * one). Each string can be of one of the following forms:
 547      *
 548      *   [LR]localport\thost:port
 549      *   [LR]localaddr:localport\thost:port
 550      *   Dlocalport
 551      *   Dlocaladdr:localport
 552      */
 553     char portfwd[1024];
 554     /* SSH bug compatibility modes */
 555     int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
 556         sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
 557         sshbug_pksessid2, sshbug_rekey2;
 558     /* Options for pterm. Should split out into platform-dependent part. */
 559     int stamp_utmp;
 560     int login_shell;
 561     int scrollbar_on_left;
 562     int shadowbold;
 563     FontSpec boldfont;
 564     FontSpec widefont;
 565     FontSpec wideboldfont;
 566     int shadowboldoffset;
 567 };
 568
 569 /*
 570  * Some global flags denoting the type of application.
 571  *
 572  * FLAG_VERBOSE is set when the user requests verbose details.
 573  *
 574  * FLAG_STDERR is set in command-line applications (which have a
 575  * functioning stderr that it makes sense to write to) and not in
 576  * GUI applications (which don't).
 577  *
 578  * FLAG_INTERACTIVE is set when a full interactive shell session is
 579  * being run, _either_ because no remote command has been provided
 580  * _or_ because the application is GUI and can't run non-
 581  * interactively.
 582  *
 583  * These flags describe the type of _application_ - they wouldn't
 584  * vary between individual sessions - and so it's OK to have this
 585  * variable be GLOBAL.
 586  *
 587  * Note that additional flags may be defined in platform-specific
 588  * headers. It's probably best if those ones start from 0x1000, to
 589  * avoid collision.
 590  */
 591 #define FLAG_VERBOSE     0x0001
 592 #define FLAG_STDERR      0x0002
 593 #define FLAG_INTERACTIVE 0x0004
 594 GLOBAL int flags;
 595
 596 /*
 597  * Likewise, these two variables are set up when the application
 598  * initialises, and inform all default-settings accesses after
 599  * that.
 600  */
 601 GLOBAL int default_protocol;
 602 GLOBAL int default_port;
 603
 604 /*
 605  * This is set TRUE by cmdline.c iff a session is loaded with "-load".
 606  */
 607 GLOBAL int loaded_session;
 608
 609 struct RSAKey;                         /* be a little careful of scope */
 610
 611 /*
 612  * Exports from the front end.
 613  */
 614 void request_resize(void *frontend, int, int);
 615 void do_text(Context, int, int, wchar_t *, int, unsigned long, int);
 616 void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int);
 617 int char_width(Context ctx, int uc);
 618 #ifdef OPTIMISE_SCROLL
 619 void do_scroll(Context, int, int, int);
 620 #endif
 621 void set_title(void *frontend, char *);
 622 void set_icon(void *frontend, char *);
 623 void set_sbar(void *frontend, int, int, int);
 624 Context get_ctx(void *frontend);
 625 void free_ctx(Context);
 626 void palette_set(void *frontend, int, int, int, int);
 627 void palette_reset(void *frontend);
 628 void write_aclip(void *frontend, char *, int, int);
 629 void write_clip(void *frontend, wchar_t *, int, int);
 630 void get_clip(void *frontend, wchar_t **, int *);
 631 void optimised_move(void *frontend, int, int, int);
 632 void set_raw_mouse_mode(void *frontend, int);
 633 void connection_fatal(void *frontend, char *, ...);
 634 void fatalbox(char *, ...);
 635 void modalfatalbox(char *, ...);
 636 #ifdef macintosh
 637 #pragma noreturn(fatalbox)
 638 #pragma noreturn(modalfatalbox)
 639 #endif
 640 void beep(void *frontend, int);
 641 void begin_session(void *frontend);
 642 void sys_cursor(void *frontend, int x, int y);
 643 void request_paste(void *frontend);
 644 void frontend_keypress(void *frontend);
 645 void ldisc_update(void *frontend, int echo, int edit);
 646 /* It's the backend's responsibility to invoke this at the start of a
 647  * connection, if necessary; it can also invoke it later if the set of
 648  * special commands changes. It does not need to invoke it at session
 649  * shutdown. */
 650 void update_specials_menu(void *frontend);
 651 int from_backend(void *frontend, int is_stderr, const char *data, int len);
 652 void notify_remote_exit(void *frontend);
 653 /* Get a sensible value for a tty mode. NULL return = don't set.
 654  * Otherwise, returned value should be freed by caller. */
 655 char *get_ttymode(void *frontend, const char *mode);
 656 #define OPTIMISE_IS_SCROLL 1
 657
 658 void set_iconic(void *frontend, int iconic);
 659 void move_window(void *frontend, int x, int y);
 660 void set_zorder(void *frontend, int top);
 661 void refresh_window(void *frontend);
 662 void set_zoomed(void *frontend, int zoomed);
 663 int is_iconic(void *frontend);
 664 void get_window_pos(void *frontend, int *x, int *y);
 665 void get_window_pixels(void *frontend, int *x, int *y);
 666 char *get_window_title(void *frontend, int icon);
 667 /* Hint from backend to frontend about time-consuming operations.
 668  * Initial state is assumed to be BUSY_NOT. */
 669 enum {
 670     BUSY_NOT,       /* Not busy, all user interaction OK */
 671     BUSY_WAITING,   /* Waiting for something; local event loops still running
 672                        so some local interaction (e.g. menus) OK, but network
 673                        stuff is suspended */
 674     BUSY_CPU        /* Locally busy (e.g. crypto); user interaction suspended */
 675 };
 676 void set_busy_status(void *frontend, int status);
 677
 678 void cleanup_exit(int);
 679
 680 /*
 681  * Exports from noise.c.
 682  */
 683 void noise_get_heavy(void (*func) (void *, int));
 684 void noise_get_light(void (*func) (void *, int));
 685 void noise_regular(void);
 686 void noise_ultralight(unsigned long data);
 687 void random_save_seed(void);
 688 void random_destroy_seed(void);
 689
 690 /*
 691  * Exports from settings.c.
 692  */
 693 char *save_settings(char *section, int do_host, Config * cfg);
 694 void save_open_settings(void *sesskey, int do_host, Config *cfg);
 695 void load_settings(char *section, int do_host, Config * cfg);
 696 void load_open_settings(void *sesskey, int do_host, Config *cfg);
 697 void get_sesslist(struct sesslist *, int allocate);
 698 void do_defaults(char *, Config *);
 699 void registry_cleanup(void);
 700
 701 /*
 702  * Functions used by settings.c to provide platform-specific
 703  * default settings.
 704  *
 705  * (The integer one is expected to return `def' if it has no clear
 706  * opinion of its own. This is because there's no integer value
 707  * which I can reliably set aside to indicate `nil'. The string
 708  * function is perfectly all right returning NULL, of course. The
 709  * Filename and FontSpec functions are _not allowed_ to fail to
 710  * return, since these defaults _must_ be per-platform.)
 711  */
 712 char *platform_default_s(const char *name);
 713 int platform_default_i(const char *name, int def);
 714 Filename platform_default_filename(const char *name);
 715 FontSpec platform_default_fontspec(const char *name);
 716
 717 /*
 718  * Exports from terminal.c.
 719  */
 720
 721 Terminal *term_init(Config *, struct unicode_data *, void *);
 722 void term_free(Terminal *);
 723 void term_size(Terminal *, int, int, int);
 724 void term_paint(Terminal *, Context, int, int, int, int, int);
 725 void term_scroll(Terminal *, int, int);
 726 void term_pwron(Terminal *);
 727 void term_clrsb(Terminal *);
 728 void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
 729                 int,int,int,int,int);
 730 void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
 731               unsigned int);
 732 void term_deselect(Terminal *);
 733 void term_update(Terminal *);
 734 void term_invalidate(Terminal *);
 735 void term_blink(Terminal *, int set_cursor);
 736 void term_do_paste(Terminal *);
 737 int term_paste_pending(Terminal *);
 738 void term_paste(Terminal *);
 739 void term_nopaste(Terminal *);
 740 int term_ldisc(Terminal *, int option);
 741 void term_copyall(Terminal *);
 742 void term_reconfig(Terminal *, Config *);
 743 void term_seen_key_event(Terminal *);
 744 int term_data(Terminal *, int is_stderr, const char *data, int len);
 745 void term_provide_resize_fn(Terminal *term,
 746                             void (*resize_fn)(void *, int, int),
 747                             void *resize_ctx);
 748 void term_provide_logctx(Terminal *term, void *logctx);
 749 void term_set_focus(Terminal *term, int has_focus);
 750 char *term_get_ttymode(Terminal *term, const char *mode);
 751
 752 /*
 753  * Exports from logging.c.
 754  */
 755 void *log_init(void *frontend, Config *cfg);
 756 void log_free(void *logctx);
 757 void log_reconfig(void *logctx, Config *cfg);
 758 void logfopen(void *logctx);
 759 void logfclose(void *logctx);
 760 void logtraffic(void *logctx, unsigned char c, int logmode);
 761 void logflush(void *logctx);
 762 void log_eventlog(void *logctx, const char *string);
 763 enum { PKT_INCOMING, PKT_OUTGOING };
 764 enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT };
 765 struct logblank_t {
 766     int offset;
 767     int len;
 768     int type;
 769 };
 770 void log_packet(void *logctx, int direction, int type,
 771                 char *texttype, void *data, int len,
 772                 int n_blanks, const struct logblank_t *blanks);
 773
 774 /*
 775  * Exports from testback.c
 776  */
 777
 778 extern Backend null_backend;
 779 extern Backend loop_backend;
 780
 781 /*
 782  * Exports from raw.c.
 783  */
 784
 785 extern Backend raw_backend;
 786
 787 /*
 788  * Exports from rlogin.c.
 789  */
 790
 791 extern Backend rlogin_backend;
 792
 793 /*
 794  * Exports from telnet.c.
 795  */
 796
 797 extern Backend telnet_backend;
 798
 799 /*
 800  * Exports from ssh.c. (NB the getline variables have to be GLOBAL
 801  * so that PuTTYtel will still compile - otherwise it would depend
 802  * on ssh.c.)
 803  */
 804
 805 GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen,
 806                             int is_pw);
 807 GLOBAL int ssh_getline_pw_only;
 808 extern Backend ssh_backend;
 809
 810 /*
 811  * Exports from ldisc.c.
 812  */
 813 void *ldisc_create(Config *, Terminal *, Backend *, void *, void *);
 814 void ldisc_free(void *);
 815 void ldisc_send(void *handle, char *buf, int len, int interactive);
 816
 817 /*
 818  * Exports from ldiscucs.c.
 819  */
 820 void lpage_send(void *, int codepage, char *buf, int len, int interactive);
 821 void luni_send(void *, wchar_t * widebuf, int len, int interactive);
 822
 823 /*
 824  * Exports from sshrand.c.
 825  */
 826
 827 void random_add_noise(void *noise, int length);
 828 int random_byte(void);
 829 void random_get_savedata(void **data, int *len);
 830 extern int random_active;
 831 /* The random number subsystem is activated if at least one other entity
 832  * within the program expresses an interest in it. So each SSH session
 833  * calls random_ref on startup and random_unref on shutdown. */
 834 void random_ref(void);
 835 void random_unref(void);
 836
 837 /*
 838  * Exports from pinger.c.
 839  */
 840 typedef struct pinger_tag *Pinger;
 841 Pinger pinger_new(Config *cfg, Backend *back, void *backhandle);
 842 void pinger_reconfig(Pinger, Config *oldcfg, Config *newcfg);
 843 void pinger_free(Pinger);
 844
 845 /*
 846  * Exports from misc.c.
 847  */
 848
 849 #include "misc.h"
 850
 851 /*
 852  * Exports from version.c.
 853  */
 854 extern char ver[];
 855
 856 /*
 857  * Exports from unicode.c.
 858  */
 859 #ifndef CP_UTF8
 860 #define CP_UTF8 65001
 861 #endif
 862 /* void init_ucs(void); -- this is now in platform-specific headers */
 863 int is_dbcs_leadbyte(int codepage, char byte);
 864 int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
 865              wchar_t *wcstr, int wclen);
 866 int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
 867              char *mbstr, int mblen, char *defchr, int *defused,
 868              struct unicode_data *ucsdata);
 869 wchar_t xlat_uskbd2cyrllic(int ch);
 870 int check_compose(int first, int second);
 871 int decode_codepage(char *cp_name);
 872 const char *cp_enumerate (int index);
 873 const char *cp_name(int codepage);
 874 void get_unitab(int codepage, wchar_t * unitab, int ftype);
 875
 876 /*
 877  * Exports from wcwidth.c
 878  */
 879 int mk_wcwidth(wchar_t ucs);
 880 int mk_wcswidth(const wchar_t *pwcs, size_t n);
 881 int mk_wcwidth_cjk(wchar_t ucs);
 882 int mk_wcswidth_cjk(const wchar_t *pwcs, size_t n);
 883
 884 /*
 885  * Exports from mscrypto.c
 886  */
 887 #ifdef MSCRYPTOAPI
 888 int crypto_startup();
 889 void crypto_wrapup();
 890 #endif
 891
 892 /*
 893  * Exports from pageantc.c.
 894  *
 895  * agent_query returns 1 for here's-a-response, and 0 for query-in-
 896  * progress. In the latter case there will be a call to `callback'
 897  * at some future point, passing callback_ctx as the first
 898  * parameter and the actual reply data as the second and third.
 899  *
 900  * The response may be a NULL pointer (in either of the synchronous
 901  * or asynchronous cases), which indicates failure to receive a
 902  * response.
 903  */
 904 int agent_query(void *in, int inlen, void **out, int *outlen,
 905                 void (*callback)(void *, void *, int), void *callback_ctx);
 906 int agent_exists(void);
 907
 908 /*
 909  * Exports from wildcard.c
 910  */
 911 const char *wc_error(int value);
 912 int wc_match(const char *wildcard, const char *target);
 913 int wc_unescape(char *output, const char *wildcard);
 914
 915 /*
 916  * Exports from frontend (windlg.c etc)
 917  */
 918 void logevent(void *frontend, const char *);
 919 void pgp_fingerprints(void);
 920 /*
 921  * verify_ssh_host_key() can return one of three values:
 922  *
 923  *  - +1 means `key was OK' (either already known or the user just
 924  *    approved it) `so continue with the connection'
 925  *
 926  *  - 0 means `key was not OK, abandon the connection'
 927  *
 928  *  - -1 means `I've initiated enquiries, please wait to be called
 929  *    back via the provided function with a result that's either 0
 930  *    or +1'.
 931  */
 932 int verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
 933                         char *keystr, char *fingerprint,
 934                         void (*callback)(void *ctx, int result), void *ctx);
 935 /*
 936  * askalg has the same set of return values as verify_ssh_host_key.
 937  */
 938 int askalg(void *frontend, const char *algtype, const char *algname,
 939            void (*callback)(void *ctx, int result), void *ctx);
 940 /*
 941  * askappend can return four values:
 942  *
 943  *  - 2 means overwrite the log file
 944  *  - 1 means append to the log file
 945  *  - 0 means cancel logging for this session
 946  *  - -1 means please wait.
 947  */
 948 int askappend(void *frontend, Filename filename,
 949               void (*callback)(void *ctx, int result), void *ctx);
 950
 951 /*
 952  * Exports from console.c (that aren't equivalents to things in
 953  * windlg.c).
 954  */
 955 extern int console_batch_mode;
 956 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw);
 957 void console_provide_logctx(void *logctx);
 958 int is_interactive(void);
 959
 960 /*
 961  * Exports from printing.c.
 962  */
 963 typedef struct printer_enum_tag printer_enum;
 964 typedef struct printer_job_tag printer_job;
 965 printer_enum *printer_start_enum(int *nprinters);
 966 char *printer_get_name(printer_enum *, int);
 967 void printer_finish_enum(printer_enum *);
 968 printer_job *printer_start_job(char *printer);
 969 void printer_job_data(printer_job *, void *, int);
 970 void printer_finish_job(printer_job *);
 971
 972 /*
 973  * Exports from cmdline.c (and also cmdline_error(), which is
 974  * defined differently in various places and required _by_
 975  * cmdline.c).
 976  */
 977 int cmdline_process_param(char *, char *, int, Config *);
 978 void cmdline_run_saved(Config *);
 979 void cmdline_cleanup(void);
 980 extern char *cmdline_password;
 981 #define TOOLTYPE_FILETRANSFER 1
 982 #define TOOLTYPE_NONNETWORK 2
 983 extern int cmdline_tooltype;
 984
 985 void cmdline_error(char *, ...);
 986
 987 /*
 988  * Exports from config.c.
 989  */
 990 struct controlbox;
 991 void setup_config_box(struct controlbox *b, int midsession,
 992                       int protocol, int protcfginfo);
 993
 994 /*
 995  * Exports from minibidi.c.
 996  */
 997 typedef struct bidi_char {
 998     wchar_t origwc, wc;
 999     unsigned short index;
1000 } bidi_char;
1001 int do_bidi(bidi_char *line, int count);
1002 int do_shape(bidi_char *line, bidi_char *to, int count);
1003
1004 /*
1005  * X11 auth mechanisms we know about.
1006  */
1007 enum {
1008     X11_NO_AUTH,
1009     X11_MIT,                           /* MIT-MAGIC-COOKIE-1 */
1010     X11_XDM,                           /* XDM-AUTHORIZATION-1 */
1011     X11_NAUTHS
1012 };
1013 extern const char *const x11_authnames[];  /* declared in x11fwd.c */
1014
1015 /*
1016  * Miscellaneous exports from the platform-specific code.
1017  */
1018 Filename filename_from_str(const char *string);
1019 const char *filename_to_str(const Filename *fn);
1020 int filename_equal(Filename f1, Filename f2);
1021 int filename_is_null(Filename fn);
1022 char *get_username(void);              /* return value needs freeing */
1023 char *get_random_data(int bytes);      /* used in cmdgen.c */
1024
1025 /*
1026  * Exports and imports from timing.c.
1027  *
1028  * schedule_timer() asks the front end to schedule a callback to a
1029  * timer function in a given number of ticks. The returned value is
1030  * the time (in ticks since an arbitrary offset) at which the
1031  * callback can be expected. This value will also be passed as the
1032  * `now' parameter to the callback function. Hence, you can (for
1033  * example) schedule an event at a particular time by calling
1034  * schedule_timer() and storing the return value in your context
1035  * structure as the time when that event is due. The first time a
1036  * callback function gives you that value or more as `now', you do
1037  * the thing.
1038  *
1039  * expire_timer_context() drops all current timers associated with
1040  * a given value of ctx (for when you're about to free ctx).
1041  *
1042  * run_timers() is called from the front end when it has reason to
1043  * think some timers have reached their moment, or when it simply
1044  * needs to know how long to wait next. We pass it the time we
1045  * think it is. It returns TRUE and places the time when the next
1046  * timer needs to go off in `next', or alternatively it returns
1047  * FALSE if there are no timers at all pending.
1048  *
1049  * timer_change_notify() must be supplied by the front end; it
1050  * notifies the front end that a new timer has been added to the
1051  * list which is sooner than any existing ones. It provides the
1052  * time when that timer needs to go off.
1053  *
1054  * *** FRONT END IMPLEMENTORS NOTE:
1055  *
1056  * There's an important subtlety in the front-end implementation of
1057  * the timer interface. When a front end is given a `next' value,
1058  * either returned from run_timers() or via timer_change_notify(),
1059  * it should ensure that it really passes _that value_ as the `now'
1060  * parameter to its next run_timers call. It should _not_ simply
1061  * call GETTICKCOUNT() to get the `now' parameter when invoking
1062  * run_timers().
1063  *
1064  * The reason for this is that an OS's system clock might not agree
1065  * exactly with the timing mechanisms it supplies to wait for a
1066  * given interval. I'll illustrate this by the simple example of
1067  * Unix Plink, which uses timeouts to select() in a way which for
1068  * these purposes can simply be considered to be a wait() function.
1069  * Suppose, for the sake of argument, that this wait() function
1070  * tends to return early by 1%. Then a possible sequence of actions
1071  * is:
1072  *
1073  *  - run_timers() tells the front end that the next timer firing
1074  *    is 10000ms from now.
1075  *  - Front end calls wait(10000ms), but according to
1076  *    GETTICKCOUNT() it has only waited for 9900ms.
1077  *  - Front end calls run_timers() again, passing time T-100ms as
1078  *    `now'.
1079  *  - run_timers() does nothing, and says the next timer firing is
1080  *    still 100ms from now.
1081  *  - Front end calls wait(100ms), which only waits for 99ms.
1082  *  - Front end calls run_timers() yet again, passing time T-1ms.
1083  *  - run_timers() says there's still 1ms to wait.
1084  *  - Front end calls wait(1ms).
1085  *
1086  * If you're _lucky_ at this point, wait(1ms) will actually wait
1087  * for 1ms and you'll only have woken the program up three times.
1088  * If you're unlucky, wait(1ms) might do nothing at all due to
1089  * being below some minimum threshold, and you might find your
1090  * program spends the whole of the last millisecond tight-looping
1091  * between wait() and run_timers().
1092  *
1093  * Instead, what you should do is to _save_ the precise `next'
1094  * value provided by run_timers() or via timer_change_notify(), and
1095  * use that precise value as the input to the next run_timers()
1096  * call. So:
1097  *
1098  *  - run_timers() tells the front end that the next timer firing
1099  *    is at time T, 10000ms from now.
1100  *  - Front end calls wait(10000ms).
1101  *  - Front end then immediately calls run_timers() and passes it
1102  *    time T, without stopping to check GETTICKCOUNT() at all.
1103  *
1104  * This guarantees that the program wakes up only as many times as
1105  * there are actual timer actions to be taken, and that the timing
1106  * mechanism will never send it into a tight loop.
1107  *
1108  * (It does also mean that the timer action in the above example
1109  * will occur 100ms early, but this is not generally critical. And
1110  * the hypothetical 1% error in wait() will be partially corrected
1111  * for anyway when, _after_ run_timers() returns, you call
1112  * GETTICKCOUNT() and compare the result with the returned `next'
1113  * value to find out how long you have to make your next wait().)
1114  */
1115 typedef void (*timer_fn_t)(void *ctx, long now);
1116 long schedule_timer(int ticks, timer_fn_t fn, void *ctx);
1117 void expire_timer_context(void *ctx);
1118 int run_timers(long now, long *next);
1119 void timer_change_notify(long next);
1120
1121 #endif