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 conf_tag Conf;
  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     /* this line wraps to next */
  74 #define LATTR_WRAPPED2 0x00000020UL    /* with WRAPPED: CJK wide character
  75                                           wrapped to next line, so last
  76                                           single-width cell is empty */
  77
  78 #define ATTR_INVALID 0x03FFFFU
  79
  80 /* Like Linux use the F000 page for direct to font. */
  81 #define CSET_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
  82 #define CSET_ACP     0x0000F100UL      /* Ansi Codepage DTF */
  83
  84 /* These are internal use overlapping with the UTF-16 surrogates */
  85 #define CSET_ASCII   0x0000D800UL      /* normal ASCII charset ESC ( B */
  86 #define CSET_LINEDRW 0x0000D900UL      /* line drawing charset ESC ( 0 */
  87 #define CSET_SCOACS  0x0000DA00UL      /* SCO Alternate charset */
  88 #define CSET_GBCHR   0x0000DB00UL      /* UK variant   charset ESC ( A */
  89 #define CSET_MASK    0xFFFFFF00UL      /* Character set mask */
  90
  91 #define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800)
  92 #define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000)
  93
  94 #define UCSERR       (CSET_LINEDRW|'a') /* UCS Format error character. */
  95 /*
  96  * UCSWIDE is a special value used in the terminal data to signify
  97  * the character cell containing the right-hand half of a CJK wide
  98  * character. We use 0xDFFF because it's part of the surrogate
  99  * range and hence won't be used for anything else (it's impossible
 100  * to input it via UTF-8 because our UTF-8 decoder correctly
 101  * rejects surrogates).
 102  */
 103 #define UCSWIDE      0xDFFF
 104
 105 #define ATTR_NARROW  0x800000U
 106 #define ATTR_WIDE    0x400000U
 107 #define ATTR_BOLD    0x040000U
 108 #define ATTR_UNDER   0x080000U
 109 #define ATTR_REVERSE 0x100000U
 110 #define ATTR_BLINK   0x200000U
 111 #define ATTR_FGMASK  0x0001FFU
 112 #define ATTR_BGMASK  0x03FE00U
 113 #define ATTR_COLOURS 0x03FFFFU
 114 #define ATTR_FGSHIFT 0
 115 #define ATTR_BGSHIFT 9
 116
 117 /*
 118  * The definitive list of colour numbers stored in terminal
 119  * attribute words is kept here. It is:
 120  *
 121  *  - 0-7 are ANSI colours (KRGYBMCW).
 122  *  - 8-15 are the bold versions of those colours.
 123  *  - 16-255 are the remains of the xterm 256-colour mode (a
 124  *    216-colour cube with R at most significant and B at least,
 125  *    followed by a uniform series of grey shades running between
 126  *    black and white but not including either on grounds of
 127  *    redundancy).
 128  *  - 256 is default foreground
 129  *  - 257 is default bold foreground
 130  *  - 258 is default background
 131  *  - 259 is default bold background
 132  *  - 260 is cursor foreground
 133  *  - 261 is cursor background
 134  */
 135
 136 #define ATTR_DEFFG   (256 << ATTR_FGSHIFT)
 137 #define ATTR_DEFBG   (258 << ATTR_BGSHIFT)
 138 #define ATTR_DEFAULT (ATTR_DEFFG | ATTR_DEFBG)
 139
 140 struct sesslist {
 141     int nsessions;
 142     char **sessions;
 143     char *buffer;                      /* so memory can be freed later */
 144 };
 145
 146 struct unicode_data {
 147     char **uni_tbl;
 148     int dbcs_screenfont;
 149     int font_codepage;
 150     int line_codepage;
 151     wchar_t unitab_scoacs[256];
 152     wchar_t unitab_line[256];
 153     wchar_t unitab_font[256];
 154     wchar_t unitab_xterm[256];
 155     wchar_t unitab_oemcp[256];
 156     unsigned char unitab_ctrl[256];
 157 };
 158
 159 #define LGXF_OVR  1                    /* existing logfile overwrite */
 160 #define LGXF_APN  0                    /* existing logfile append */
 161 #define LGXF_ASK -1                    /* existing logfile ask */
 162 #define LGTYP_NONE  0                  /* logmode: no logging */
 163 #define LGTYP_ASCII 1                  /* logmode: pure ascii */
 164 #define LGTYP_DEBUG 2                  /* logmode: all chars of traffic */
 165 #define LGTYP_PACKETS 3                /* logmode: SSH data packets */
 166 #define LGTYP_SSHRAW 4                 /* logmode: SSH raw data */
 167
 168 typedef enum {
 169     /* Actual special commands. Originally Telnet, but some codes have
 170      * been re-used for similar specials in other protocols. */
 171     TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT,
 172     TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING,
 173     TS_EOL,
 174     /* Special command for SSH. */
 175     TS_REKEY,
 176     /* POSIX-style signals. (not Telnet) */
 177     TS_SIGABRT, TS_SIGALRM, TS_SIGFPE,  TS_SIGHUP,  TS_SIGILL,
 178     TS_SIGINT,  TS_SIGKILL, TS_SIGPIPE, TS_SIGQUIT, TS_SIGSEGV,
 179     TS_SIGTERM, TS_SIGUSR1, TS_SIGUSR2,
 180     /* Pseudo-specials used for constructing the specials menu. */
 181     TS_SEP,         /* Separator */
 182     TS_SUBMENU,     /* Start a new submenu with specified name */
 183     TS_EXITMENU     /* Exit current submenu or end of specials */
 184 } Telnet_Special;
 185
 186 struct telnet_special {
 187     const char *name;
 188     int code;
 189 };
 190
 191 typedef enum {
 192     MBT_NOTHING,
 193     MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
 194     MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */
 195     MBT_WHEEL_UP, MBT_WHEEL_DOWN       /* mouse wheel */
 196 } Mouse_Button;
 197
 198 typedef enum {
 199     MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE
 200 } Mouse_Action;
 201
 202 /* Keyboard modifiers -- keys the user is actually holding down */
 203
 204 #define PKM_SHIFT       0x01
 205 #define PKM_CONTROL     0x02
 206 #define PKM_META        0x04
 207 #define PKM_ALT         0x08
 208
 209 /* Keyboard flags that aren't really modifiers */
 210 #define PKF_CAPSLOCK    0x10
 211 #define PKF_NUMLOCK     0x20
 212 #define PKF_REPEAT      0x40
 213
 214 /* Stand-alone keysyms for function keys */
 215
 216 typedef enum {
 217     PK_NULL,            /* No symbol for this key */
 218     /* Main keypad keys */
 219     PK_ESCAPE, PK_TAB, PK_BACKSPACE, PK_RETURN, PK_COMPOSE,
 220     /* Editing keys */
 221     PK_HOME, PK_INSERT, PK_DELETE, PK_END, PK_PAGEUP, PK_PAGEDOWN,
 222     /* Cursor keys */
 223     PK_UP, PK_DOWN, PK_RIGHT, PK_LEFT, PK_REST,
 224     /* Numeric keypad */                        /* Real one looks like: */
 225     PK_PF1, PK_PF2, PK_PF3, PK_PF4,             /* PF1 PF2 PF3 PF4 */
 226     PK_KPCOMMA, PK_KPMINUS, PK_KPDECIMAL,       /*  7   8   9   -  */
 227     PK_KP0, PK_KP1, PK_KP2, PK_KP3, PK_KP4,     /*  4   5   6   ,  */
 228     PK_KP5, PK_KP6, PK_KP7, PK_KP8, PK_KP9,     /*  1   2   3  en- */
 229     PK_KPBIGPLUS, PK_KPENTER,                   /*    0     .  ter */
 230     /* Top row */
 231     PK_F1,  PK_F2,  PK_F3,  PK_F4,  PK_F5,
 232     PK_F6,  PK_F7,  PK_F8,  PK_F9,  PK_F10,
 233     PK_F11, PK_F12, PK_F13, PK_F14, PK_F15,
 234     PK_F16, PK_F17, PK_F18, PK_F19, PK_F20,
 235     PK_PAUSE
 236 } Key_Sym;
 237
 238 #define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN)
 239 #define PK_ISCURSOR(k)  ((k) >= PK_UP && (k) <= PK_REST)
 240 #define PK_ISKEYPAD(k)  ((k) >= PK_PF1 && (k) <= PK_KPENTER)
 241 #define PK_ISFKEY(k)    ((k) >= PK_F1 && (k) <= PK_F20)
 242
 243 enum {
 244     VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE
 245 };
 246
 247 enum {
 248     /*
 249      * SSH-2 key exchange algorithms
 250      */
 251     KEX_WARN,
 252     KEX_DHGROUP1,
 253     KEX_DHGROUP14,
 254     KEX_DHGEX,
 255     KEX_RSA,
 256     KEX_MAX
 257 };
 258
 259 enum {
 260     /*
 261      * SSH ciphers (both SSH-1 and SSH-2)
 262      */
 263     CIPHER_WARN,                       /* pseudo 'cipher' */
 264     CIPHER_3DES,
 265     CIPHER_BLOWFISH,
 266     CIPHER_AES,                        /* (SSH-2 only) */
 267     CIPHER_DES,
 268     CIPHER_ARCFOUR,
 269     CIPHER_MAX                         /* no. ciphers (inc warn) */
 270 };
 271
 272 enum {
 273     /*
 274      * Several different bits of the PuTTY configuration seem to be
 275      * three-way settings whose values are `always yes', `always
 276      * no', and `decide by some more complex automated means'. This
 277      * is true of line discipline options (local echo and line
 278      * editing), proxy DNS, Close On Exit, and SSH server bug
 279      * workarounds. Accordingly I supply a single enum here to deal
 280      * with them all.
 281      */
 282     FORCE_ON, FORCE_OFF, AUTO
 283 };
 284
 285 enum {
 286     /*
 287      * Proxy types.
 288      */
 289     PROXY_NONE, PROXY_SOCKS4, PROXY_SOCKS5,
 290     PROXY_HTTP, PROXY_TELNET, PROXY_CMD
 291 };
 292
 293 enum {
 294     /*
 295      * Line discipline options which the backend might try to control.
 296      */
 297     LD_EDIT,                           /* local line editing */
 298     LD_ECHO                            /* local echo */
 299 };
 300
 301 enum {
 302     /* Actions on remote window title query */
 303     TITLE_NONE, TITLE_EMPTY, TITLE_REAL
 304 };
 305
 306 enum {
 307     /* Protocol back ends. (CONF_protocol) */
 308     PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH,
 309     /* PROT_SERIAL is supported on a subset of platforms, but it doesn't
 310      * hurt to define it globally. */
 311     PROT_SERIAL
 312 };
 313
 314 enum {
 315     /* Bell settings (CONF_beep) */
 316     BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER
 317 };
 318
 319 enum {
 320     /* Taskbar flashing indication on bell (CONF_beep_ind) */
 321     B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
 322 };
 323
 324 enum {
 325     /* Resize actions (CONF_resize_action) */
 326     RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER
 327 };
 328
 329 enum {
 330     /* Function key types (CONF_funky_type) */
 331     FUNKY_TILDE,
 332     FUNKY_LINUX,
 333     FUNKY_XTERM,
 334     FUNKY_VT400,
 335     FUNKY_VT100P,
 336     FUNKY_SCO
 337 };
 338
 339 enum {
 340     FQ_DEFAULT, FQ_ANTIALIASED, FQ_NONANTIALIASED, FQ_CLEARTYPE
 341 };
 342
 343 enum {
 344     SER_PAR_NONE, SER_PAR_ODD, SER_PAR_EVEN, SER_PAR_MARK, SER_PAR_SPACE
 345 };
 346
 347 enum {
 348     SER_FLOW_NONE, SER_FLOW_XONXOFF, SER_FLOW_RTSCTS, SER_FLOW_DSRDTR
 349 };
 350
 351 /*
 352  * Tables of string <-> enum value mappings used in settings.c.
 353  * Defined here so that backends can export their GSS library tables
 354  * to the cross-platform settings code.
 355  */
 356 struct keyvalwhere {
 357     /*
 358      * Two fields which define a string and enum value to be
 359      * equivalent to each other.
 360      */
 361     char *s;
 362     int v;
 363
 364     /*
 365      * The next pair of fields are used by gprefs() in settings.c to
 366      * arrange that when it reads a list of strings representing a
 367      * preference list and translates it into the corresponding list
 368      * of integers, strings not appearing in the list are entered in a
 369      * configurable position rather than uniformly at the end.
 370      */
 371
 372     /*
 373      * 'vrel' indicates which other value in the list to place this
 374      * element relative to. It should be a value that has occurred in
 375      * a 'v' field of some other element of the array, or -1 to
 376      * indicate that we simply place relative to one or other end of
 377      * the list.
 378      *
 379      * gprefs will try to process the elements in an order which makes
 380      * this field work (i.e. so that the element referenced has been
 381      * added before processing this one).
 382      */
 383     int vrel;
 384
 385     /*
 386      * 'where' indicates whether to place the new value before or
 387      * after the one referred to by vrel. -1 means before; +1 means
 388      * after.
 389      *
 390      * When vrel is -1, this also implicitly indicates which end of
 391      * the array to use. So vrel=-1, where=-1 means to place _before_
 392      * some end of the list (hence, at the last element); vrel=-1,
 393      * where=+1 means to place _after_ an end (hence, at the first).
 394      */
 395     int where;
 396 };
 397
 398 #ifndef NO_GSSAPI
 399 extern const int ngsslibs;
 400 extern const char *const gsslibnames[]; /* for displaying in configuration */
 401 extern const struct keyvalwhere gsslibkeywords[]; /* for settings.c */
 402 #endif
 403
 404 extern const char *const ttymodes[];
 405
 406 enum {
 407     /*
 408      * Network address types. Used for specifying choice of IPv4/v6
 409      * in config; also used in proxy.c to indicate whether a given
 410      * host name has already been resolved or will be resolved at
 411      * the proxy end.
 412      */
 413     ADDRTYPE_UNSPEC, ADDRTYPE_IPV4, ADDRTYPE_IPV6, ADDRTYPE_NAME
 414 };
 415
 416 struct backend_tag {
 417     const char *(*init) (void *frontend_handle, void **backend_handle,
 418                          Conf *conf, char *host, int port, char **realhost,
 419                          int nodelay, int keepalive);
 420     void (*free) (void *handle);
 421     /* back->reconfig() passes in a replacement configuration. */
 422     void (*reconfig) (void *handle, Conf *conf);
 423     /* back->send() returns the current amount of buffered data. */
 424     int (*send) (void *handle, char *buf, int len);
 425     /* back->sendbuffer() does the same thing but without attempting a send */
 426     int (*sendbuffer) (void *handle);
 427     void (*size) (void *handle, int width, int height);
 428     void (*special) (void *handle, Telnet_Special code);
 429     const struct telnet_special *(*get_specials) (void *handle);
 430     int (*connected) (void *handle);
 431     int (*exitcode) (void *handle);
 432     /* If back->sendok() returns FALSE, data sent to it from the frontend
 433      * may be lost. */
 434     int (*sendok) (void *handle);
 435     int (*ldisc) (void *handle, int);
 436     void (*provide_ldisc) (void *handle, void *ldisc);
 437     void (*provide_logctx) (void *handle, void *logctx);
 438     /*
 439      * back->unthrottle() tells the back end that the front end
 440      * buffer is clearing.
 441      */
 442     void (*unthrottle) (void *handle, int);
 443     int (*cfg_info) (void *handle);
 444     char *name;
 445     int protocol;
 446     int default_port;
 447 };
 448
 449 extern Backend *backends[];
 450
 451 /*
 452  * Suggested default protocol provided by the backend link module.
 453  * The application is free to ignore this.
 454  */
 455 extern const int be_default_protocol;
 456
 457 /*
 458  * Name of this particular application, for use in the config box
 459  * and other pieces of text.
 460  */
 461 extern const char *const appname;
 462
 463 /*
 464  * Some global flags denoting the type of application.
 465  *
 466  * FLAG_VERBOSE is set when the user requests verbose details.
 467  *
 468  * FLAG_STDERR is set in command-line applications (which have a
 469  * functioning stderr that it makes sense to write to) and not in
 470  * GUI applications (which don't).
 471  *
 472  * FLAG_INTERACTIVE is set when a full interactive shell session is
 473  * being run, _either_ because no remote command has been provided
 474  * _or_ because the application is GUI and can't run non-
 475  * interactively.
 476  *
 477  * These flags describe the type of _application_ - they wouldn't
 478  * vary between individual sessions - and so it's OK to have this
 479  * variable be GLOBAL.
 480  *
 481  * Note that additional flags may be defined in platform-specific
 482  * headers. It's probably best if those ones start from 0x1000, to
 483  * avoid collision.
 484  */
 485 #define FLAG_VERBOSE     0x0001
 486 #define FLAG_STDERR      0x0002
 487 #define FLAG_INTERACTIVE 0x0004
 488 GLOBAL int flags;
 489
 490 /*
 491  * Likewise, these two variables are set up when the application
 492  * initialises, and inform all default-settings accesses after
 493  * that.
 494  */
 495 GLOBAL int default_protocol;
 496 GLOBAL int default_port;
 497
 498 /*
 499  * This is set TRUE by cmdline.c iff a session is loaded with "-load".
 500  */
 501 GLOBAL int loaded_session;
 502 /*
 503  * This is set to the name of the loaded session.
 504  */
 505 GLOBAL char *cmdline_session_name;
 506
 507 struct RSAKey;                         /* be a little careful of scope */
 508
 509 /*
 510  * Mechanism for getting text strings such as usernames and passwords
 511  * from the front-end.
 512  * The fields are mostly modelled after SSH's keyboard-interactive auth.
 513  * FIXME We should probably mandate a character set/encoding (probably UTF-8).
 514  *
 515  * Since many of the pieces of text involved may be chosen by the server,
 516  * the caller must take care to ensure that the server can't spoof locally-
 517  * generated prompts such as key passphrase prompts. Some ground rules:
 518  *  - If the front-end needs to truncate a string, it should lop off the
 519  *    end.
 520  *  - The front-end should filter out any dangerous characters and
 521  *    generally not trust the strings. (But \n is required to behave
 522  *    vaguely sensibly, at least in `instruction', and ideally in
 523  *    `prompt[]' too.)
 524  */
 525 typedef struct {
 526     char *prompt;
 527     int echo;
 528     char *result;       /* allocated/freed by caller */
 529     size_t result_len;
 530 } prompt_t;
 531 typedef struct {
 532     /*
 533      * Indicates whether the information entered is to be used locally
 534      * (for instance a key passphrase prompt), or is destined for the wire.
 535      * This is a hint only; the front-end is at liberty not to use this
 536      * information (so the caller should ensure that the supplied text is
 537      * sufficient).
 538      */
 539     int to_server;
 540     char *name;         /* Short description, perhaps for dialog box title */
 541     int name_reqd;      /* Display of `name' required or optional? */
 542     char *instruction;  /* Long description, maybe with embedded newlines */
 543     int instr_reqd;     /* Display of `instruction' required or optional? */
 544     size_t n_prompts;   /* May be zero (in which case display the foregoing,
 545                          * if any, and return success) */
 546     prompt_t **prompts;
 547     void *frontend;
 548     void *data;         /* slot for housekeeping data, managed by
 549                          * get_userpass_input(); initially NULL */
 550 } prompts_t;
 551 prompts_t *new_prompts(void *frontend);
 552 void add_prompt(prompts_t *p, char *promptstr, int echo, size_t len);
 553 /* Burn the evidence. (Assumes _all_ strings want free()ing.) */
 554 void free_prompts(prompts_t *p);
 555
 556 /*
 557  * Exports from the front end.
 558  */
 559 void request_resize(void *frontend, int, int);
 560 void do_text(Context, int, int, wchar_t *, int, unsigned long, int);
 561 void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int);
 562 int char_width(Context ctx, int uc);
 563 #ifdef OPTIMISE_SCROLL
 564 void do_scroll(Context, int, int, int);
 565 #endif
 566 void set_title(void *frontend, char *);
 567 void set_icon(void *frontend, char *);
 568 void set_sbar(void *frontend, int, int, int);
 569 Context get_ctx(void *frontend);
 570 void free_ctx(Context);
 571 void palette_set(void *frontend, int, int, int, int);
 572 void palette_reset(void *frontend);
 573 void write_aclip(void *frontend, char *, int, int);
 574 void write_clip(void *frontend, wchar_t *, int *, int, int);
 575 void get_clip(void *frontend, wchar_t **, int *);
 576 void optimised_move(void *frontend, int, int, int);
 577 void set_raw_mouse_mode(void *frontend, int);
 578 void connection_fatal(void *frontend, char *, ...);
 579 void fatalbox(char *, ...);
 580 void modalfatalbox(char *, ...);
 581 #ifdef macintosh
 582 #pragma noreturn(fatalbox)
 583 #pragma noreturn(modalfatalbox)
 584 #endif
 585 void do_beep(void *frontend, int);
 586 void begin_session(void *frontend);
 587 void sys_cursor(void *frontend, int x, int y);
 588 void request_paste(void *frontend);
 589 void frontend_keypress(void *frontend);
 590 void ldisc_update(void *frontend, int echo, int edit);
 591 /* It's the backend's responsibility to invoke this at the start of a
 592  * connection, if necessary; it can also invoke it later if the set of
 593  * special commands changes. It does not need to invoke it at session
 594  * shutdown. */
 595 void update_specials_menu(void *frontend);
 596 int from_backend(void *frontend, int is_stderr, const char *data, int len);
 597 int from_backend_untrusted(void *frontend, const char *data, int len);
 598 /* Called when the back end wants to indicate that EOF has arrived on
 599  * the server-to-client stream. Returns FALSE to indicate that we
 600  * intend to keep the session open in the other direction, or TRUE to
 601  * indicate that if they're closing so are we. */
 602 int from_backend_eof(void *frontend);
 603 void notify_remote_exit(void *frontend);
 604 /* Get a sensible value for a tty mode. NULL return = don't set.
 605  * Otherwise, returned value should be freed by caller. */
 606 char *get_ttymode(void *frontend, const char *mode);
 607 /*
 608  * >0 = `got all results, carry on'
 609  * 0  = `user cancelled' (FIXME distinguish "give up entirely" and "next auth"?)
 610  * <0 = `please call back later with more in/inlen'
 611  */
 612 int get_userpass_input(prompts_t *p, unsigned char *in, int inlen);
 613 #define OPTIMISE_IS_SCROLL 1
 614
 615 void set_iconic(void *frontend, int iconic);
 616 void move_window(void *frontend, int x, int y);
 617 void set_zorder(void *frontend, int top);
 618 void refresh_window(void *frontend);
 619 void set_zoomed(void *frontend, int zoomed);
 620 int is_iconic(void *frontend);
 621 void get_window_pos(void *frontend, int *x, int *y);
 622 void get_window_pixels(void *frontend, int *x, int *y);
 623 char *get_window_title(void *frontend, int icon);
 624 /* Hint from backend to frontend about time-consuming operations.
 625  * Initial state is assumed to be BUSY_NOT. */
 626 enum {
 627     BUSY_NOT,       /* Not busy, all user interaction OK */
 628     BUSY_WAITING,   /* Waiting for something; local event loops still running
 629                        so some local interaction (e.g. menus) OK, but network
 630                        stuff is suspended */
 631     BUSY_CPU        /* Locally busy (e.g. crypto); user interaction suspended */
 632 };
 633 void set_busy_status(void *frontend, int status);
 634
 635 void cleanup_exit(int);
 636
 637 /*
 638  * Exports from conf.c, and a big enum (via parametric macro) of
 639  * configuration option keys.
 640  */
 641 #define CONFIG_OPTIONS(X) \
 642     /* X(value-type, subkey-type, keyword) */ \
 643     X(STR, NONE, host) \
 644     X(INT, NONE, port) \
 645     X(INT, NONE, protocol) \
 646     X(INT, NONE, addressfamily) \
 647     X(INT, NONE, close_on_exit) \
 648     X(INT, NONE, warn_on_close) \
 649     X(INT, NONE, ping_interval) /* in seconds */ \
 650     X(INT, NONE, tcp_nodelay) \
 651     X(INT, NONE, tcp_keepalives) \
 652     X(STR, NONE, loghost) /* logical host being contacted, for host key check */ \
 653     /* Proxy options */ \
 654     X(STR, NONE, proxy_exclude_list) \
 655     X(INT, NONE, proxy_dns) \
 656     X(INT, NONE, even_proxy_localhost) \
 657     X(INT, NONE, proxy_type) \
 658     X(STR, NONE, proxy_host) \
 659     X(INT, NONE, proxy_port) \
 660     X(STR, NONE, proxy_username) \
 661     X(STR, NONE, proxy_password) \
 662     X(STR, NONE, proxy_telnet_command) \
 663     /* SSH options */ \
 664     X(STR, NONE, remote_cmd) \
 665     X(STR, NONE, remote_cmd2) /* fallback if remote_cmd fails; never loaded or saved */ \
 666     X(INT, NONE, nopty) \
 667     X(INT, NONE, compression) \
 668     X(INT, INT, ssh_kexlist) \
 669     X(INT, NONE, ssh_rekey_time) /* in minutes */ \
 670     X(STR, NONE, ssh_rekey_data) /* string encoding e.g. "100K", "2M", "1G" */ \
 671     X(INT, NONE, tryagent) \
 672     X(INT, NONE, agentfwd) \
 673     X(INT, NONE, change_username) /* allow username switching in SSH-2 */ \
 674     X(INT, INT, ssh_cipherlist) \
 675     X(FILENAME, NONE, keyfile) \
 676     X(INT, NONE, sshprot) /* use v1 or v2 when both available */ \
 677     X(INT, NONE, ssh2_des_cbc) /* "des-cbc" unrecommended SSH-2 cipher */ \
 678     X(INT, NONE, ssh_no_userauth) /* bypass "ssh-userauth" (SSH-2 only) */ \
 679     X(INT, NONE, ssh_show_banner) /* show USERAUTH_BANNERs (SSH-2 only) */ \
 680     X(INT, NONE, try_tis_auth) \
 681     X(INT, NONE, try_ki_auth) \
 682     X(INT, NONE, try_gssapi_auth) /* attempt gssapi auth */ \
 683     X(INT, NONE, gssapifwd) /* forward tgt via gss */ \
 684     X(INT, INT, ssh_gsslist) /* preference order for local GSS libs */ \
 685     X(FILENAME, NONE, ssh_gss_custom) \
 686     X(INT, NONE, ssh_subsys) /* run a subsystem rather than a command */ \
 687     X(INT, NONE, ssh_subsys2) /* fallback to go with remote_cmd_ptr2 */ \
 688     X(INT, NONE, ssh_no_shell) /* avoid running a shell */ \
 689     X(STR, NONE, ssh_nc_host) /* host to connect to in `nc' mode */ \
 690     X(INT, NONE, ssh_nc_port) /* port to connect to in `nc' mode */ \
 691     /* Telnet options */ \
 692     X(STR, NONE, termtype) \
 693     X(STR, NONE, termspeed) \
 694     X(STR, STR, ttymodes) /* values are "Vvalue" or "A" */ \
 695     X(STR, STR, environmt) \
 696     X(STR, NONE, username) \
 697     X(INT, NONE, username_from_env) \
 698     X(STR, NONE, localusername) \
 699     X(INT, NONE, rfc_environ) \
 700     X(INT, NONE, passive_telnet) \
 701     /* Serial port options */ \
 702     X(STR, NONE, serline) \
 703     X(INT, NONE, serspeed) \
 704     X(INT, NONE, serdatabits) \
 705     X(INT, NONE, serstopbits) \
 706     X(INT, NONE, serparity) \
 707     X(INT, NONE, serflow) \
 708     /* Keyboard options */ \
 709     X(INT, NONE, bksp_is_delete) \
 710     X(INT, NONE, rxvt_homeend) \
 711     X(INT, NONE, funky_type) \
 712     X(INT, NONE, no_applic_c) /* totally disable app cursor keys */ \
 713     X(INT, NONE, no_applic_k) /* totally disable app keypad */ \
 714     X(INT, NONE, no_mouse_rep) /* totally disable mouse reporting */ \
 715     X(INT, NONE, no_remote_resize) /* disable remote resizing */ \
 716     X(INT, NONE, no_alt_screen) /* disable alternate screen */ \
 717     X(INT, NONE, no_remote_wintitle) /* disable remote retitling */ \
 718     X(INT, NONE, no_dbackspace) /* disable destructive backspace */ \
 719     X(INT, NONE, no_remote_charset) /* disable remote charset config */ \
 720     X(INT, NONE, remote_qtitle_action) /* remote win title query action */ \
 721     X(INT, NONE, app_cursor) \
 722     X(INT, NONE, app_keypad) \
 723     X(INT, NONE, nethack_keypad) \
 724     X(INT, NONE, telnet_keyboard) \
 725     X(INT, NONE, telnet_newline) \
 726     X(INT, NONE, alt_f4) /* is it special? */ \
 727     X(INT, NONE, alt_space) /* is it special? */ \
 728     X(INT, NONE, alt_only) /* is it special? */ \
 729     X(INT, NONE, localecho) \
 730     X(INT, NONE, localedit) \
 731     X(INT, NONE, alwaysontop) \
 732     X(INT, NONE, fullscreenonaltenter) \
 733     X(INT, NONE, scroll_on_key) \
 734     X(INT, NONE, scroll_on_disp) \
 735     X(INT, NONE, erase_to_scrollback) \
 736     X(INT, NONE, compose_key) \
 737     X(INT, NONE, ctrlaltkeys) \
 738     X(STR, NONE, wintitle) /* initial window title */ \
 739     /* Terminal options */ \
 740     X(INT, NONE, savelines) \
 741     X(INT, NONE, dec_om) \
 742     X(INT, NONE, wrap_mode) \
 743     X(INT, NONE, lfhascr) \
 744     X(INT, NONE, cursor_type) /* 0=block 1=underline 2=vertical */ \
 745     X(INT, NONE, blink_cur) \
 746     X(INT, NONE, beep) \
 747     X(INT, NONE, beep_ind) \
 748     X(INT, NONE, bellovl) /* bell overload protection active? */ \
 749     X(INT, NONE, bellovl_n) /* number of bells to cause overload */ \
 750     X(INT, NONE, bellovl_t) /* time interval for overload (seconds) */ \
 751     X(INT, NONE, bellovl_s) /* period of silence to re-enable bell (s) */ \
 752     X(FILENAME, NONE, bell_wavefile) \
 753     X(INT, NONE, scrollbar) \
 754     X(INT, NONE, scrollbar_in_fullscreen) \
 755     X(INT, NONE, resize_action) \
 756     X(INT, NONE, bce) \
 757     X(INT, NONE, blinktext) \
 758     X(INT, NONE, win_name_always) \
 759     X(INT, NONE, width) \
 760     X(INT, NONE, height) \
 761     X(FONT, NONE, font) \
 762     X(INT, NONE, font_quality) \
 763     X(FILENAME, NONE, logfilename) \
 764     X(INT, NONE, logtype) \
 765     X(INT, NONE, logxfovr) \
 766     X(INT, NONE, logflush) \
 767     X(INT, NONE, logomitpass) \
 768     X(INT, NONE, logomitdata) \
 769     X(INT, NONE, hide_mouseptr) \
 770     X(INT, NONE, sunken_edge) \
 771     X(INT, NONE, window_border) \
 772     X(STR, NONE, answerback) \
 773     X(STR, NONE, printer) \
 774     X(INT, NONE, arabicshaping) \
 775     X(INT, NONE, bidi) \
 776     /* Colour options */ \
 777     X(INT, NONE, ansi_colour) \
 778     X(INT, NONE, xterm_256_colour) \
 779     X(INT, NONE, system_colour) \
 780     X(INT, NONE, try_palette) \
 781     X(INT, NONE, bold_colour) \
 782     X(INT, INT, colours) \
 783     /* Selection options */ \
 784     X(INT, NONE, mouse_is_xterm) \
 785     X(INT, NONE, rect_select) \
 786     X(INT, NONE, rawcnp) \
 787     X(INT, NONE, rtf_paste) \
 788     X(INT, NONE, mouse_override) \
 789     X(INT, INT, wordness) \
 790     /* translations */ \
 791     X(INT, NONE, vtmode) \
 792     X(STR, NONE, line_codepage) \
 793     X(INT, NONE, cjk_ambig_wide) \
 794     X(INT, NONE, utf8_override) \
 795     X(INT, NONE, xlat_capslockcyr) \
 796     /* X11 forwarding */ \
 797     X(INT, NONE, x11_forward) \
 798     X(STR, NONE, x11_display) \
 799     X(INT, NONE, x11_auth) \
 800     X(FILENAME, NONE, xauthfile) \
 801     /* port forwarding */ \
 802     X(INT, NONE, lport_acceptall) /* accept conns from hosts other than localhost */ \
 803     X(INT, NONE, rport_acceptall) /* same for remote forwarded ports (SSH-2 only) */ \
 804     /*                                                                \
 805      * Subkeys for 'portfwd' can have the following forms:            \
 806      *                                                                \
 807      *   [LR]localport                                                \
 808      *   [LR]localaddr:localport                                      \
 809      *                                                                \
 810      * Dynamic forwardings are indicated by an 'L' key, and the       \
 811      * special value "D". For all other forwardings, the value        \
 812      * should be of the form 'host:port'.                             \
 813      */ \
 814     X(STR, STR, portfwd) \
 815     /* SSH bug compatibility modes */ \
 816     X(INT, NONE, sshbug_ignore1) \
 817     X(INT, NONE, sshbug_plainpw1) \
 818     X(INT, NONE, sshbug_rsa1) \
 819     X(INT, NONE, sshbug_hmac2) \
 820     X(INT, NONE, sshbug_derivekey2) \
 821     X(INT, NONE, sshbug_rsapad2) \
 822     X(INT, NONE, sshbug_pksessid2) \
 823     X(INT, NONE, sshbug_rekey2) \
 824     X(INT, NONE, sshbug_maxpkt2) \
 825     X(INT, NONE, sshbug_ignore2) \
 826     /*                                                                \
 827      * ssh_simple means that we promise never to open any channel     \
 828      * other than the main one, which means it can safely use a very  \
 829      * large window in SSH-2.                                         \
 830      */ \
 831     X(INT, NONE, ssh_simple) \
 832     /* Options for pterm. Should split out into platform-dependent part. */ \
 833     X(INT, NONE, stamp_utmp) \
 834     X(INT, NONE, login_shell) \
 835     X(INT, NONE, scrollbar_on_left) \
 836     X(INT, NONE, shadowbold) \
 837     X(FONT, NONE, boldfont) \
 838     X(FONT, NONE, widefont) \
 839     X(FONT, NONE, wideboldfont) \
 840     X(INT, NONE, shadowboldoffset) \
 841     X(INT, NONE, crhaslf) \
 842     X(STR, NONE, winclass) \
 843
 844 /* Now define the actual enum of option keywords using that macro. */
 845 #define CONF_ENUM_DEF(valtype, keytype, keyword) CONF_ ## keyword,
 846 enum config_primary_key { CONFIG_OPTIONS(CONF_ENUM_DEF) N_CONFIG_OPTIONS };
 847 #undef CONF_ENUM_DEF
 848
 849 #define NCFGCOLOURS 22 /* number of colours in CONF_colours above */
 850
 851 /* Functions handling configuration structures. */
 852 Conf *conf_new(void);                  /* create an empty configuration */
 853 void conf_free(Conf *conf);
 854 Conf *conf_copy(Conf *oldconf);
 855 void conf_copy_into(Conf *dest, Conf *src);
 856 /* Mandatory accessor functions: enforce by assertion that keys exist. */
 857 int conf_get_int(Conf *conf, int key);
 858 int conf_get_int_int(Conf *conf, int key, int subkey);
 859 char *conf_get_str(Conf *conf, int key);   /* result still owned by conf */
 860 char *conf_get_str_str(Conf *conf, int key, const char *subkey);
 861 Filename *conf_get_filename(Conf *conf, int key);
 862 FontSpec *conf_get_fontspec(Conf *conf, int key);
 863 /* Optional accessor function: return NULL if key does not exist. */
 864 char *conf_get_str_str_opt(Conf *conf, int key, const char *subkey);
 865 /* Accessor function to step through a string-subkeyed list.
 866  * Returns the next subkey after the provided one, or the first if NULL.
 867  * Returns NULL if there are none left.
 868  * Both the return value and *subkeyout are still owned by conf. */
 869 char *conf_get_str_strs(Conf *conf, int key, char *subkeyin, char **subkeyout);
 870 /* Return the nth string subkey in a list. Owned by conf. NULL if beyond end */
 871 char *conf_get_str_nthstrkey(Conf *conf, int key, int n);
 872 /* Functions to set entries in configuration. Always copy their inputs. */
 873 void conf_set_int(Conf *conf, int key, int value);
 874 void conf_set_int_int(Conf *conf, int key, int subkey, int value);
 875 void conf_set_str(Conf *conf, int key, const char *value);
 876 void conf_set_str_str(Conf *conf, int key,
 877                       const char *subkey, const char *val);
 878 void conf_del_str_str(Conf *conf, int key, const char *subkey);
 879 void conf_set_filename(Conf *conf, int key, const Filename *val);
 880 void conf_set_fontspec(Conf *conf, int key, const FontSpec *val);
 881 /* Serialisation functions for Duplicate Session */
 882 int conf_serialised_size(Conf *conf);
 883 void conf_serialise(Conf *conf, void *data);
 884 int conf_deserialise(Conf *conf, void *data, int maxsize);/*returns size used*/
 885
 886 /*
 887  * Exports from noise.c.
 888  */
 889 void noise_get_heavy(void (*func) (void *, int));
 890 void noise_get_light(void (*func) (void *, int));
 891 void noise_regular(void);
 892 void noise_ultralight(unsigned long data);
 893 void random_save_seed(void);
 894 void random_destroy_seed(void);
 895
 896 /*
 897  * Exports from settings.c.
 898  */
 899 Backend *backend_from_name(const char *name);
 900 Backend *backend_from_proto(int proto);
 901 char *get_remote_username(Conf *conf); /* dynamically allocated */
 902 char *save_settings(char *section, Conf *conf);
 903 void save_open_settings(void *sesskey, Conf *conf);
 904 void load_settings(char *section, Conf *conf);
 905 void load_open_settings(void *sesskey, Conf *conf);
 906 void get_sesslist(struct sesslist *, int allocate);
 907 void do_defaults(char *, Conf *);
 908 void registry_cleanup(void);
 909
 910 /*
 911  * Functions used by settings.c to provide platform-specific
 912  * default settings.
 913  *
 914  * (The integer one is expected to return `def' if it has no clear
 915  * opinion of its own. This is because there's no integer value
 916  * which I can reliably set aside to indicate `nil'. The string
 917  * function is perfectly all right returning NULL, of course. The
 918  * Filename and FontSpec functions are _not allowed_ to fail to
 919  * return, since these defaults _must_ be per-platform.)
 920  */
 921 char *platform_default_s(const char *name);
 922 int platform_default_i(const char *name, int def);
 923 Filename platform_default_filename(const char *name);
 924 FontSpec platform_default_fontspec(const char *name);
 925
 926 /*
 927  * Exports from terminal.c.
 928  */
 929
 930 Terminal *term_init(Conf *, struct unicode_data *, void *);
 931 void term_free(Terminal *);
 932 void term_size(Terminal *, int, int, int);
 933 void term_paint(Terminal *, Context, int, int, int, int, int);
 934 void term_scroll(Terminal *, int, int);
 935 void term_scroll_to_selection(Terminal *, int);
 936 void term_pwron(Terminal *, int);
 937 void term_clrsb(Terminal *);
 938 void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
 939                 int,int,int,int,int);
 940 void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
 941               unsigned int);
 942 void term_deselect(Terminal *);
 943 void term_update(Terminal *);
 944 void term_invalidate(Terminal *);
 945 void term_blink(Terminal *, int set_cursor);
 946 void term_do_paste(Terminal *);
 947 int term_paste_pending(Terminal *);
 948 void term_paste(Terminal *);
 949 void term_nopaste(Terminal *);
 950 int term_ldisc(Terminal *, int option);
 951 void term_copyall(Terminal *);
 952 void term_reconfig(Terminal *, Conf *);
 953 void term_seen_key_event(Terminal *);
 954 int term_data(Terminal *, int is_stderr, const char *data, int len);
 955 int term_data_untrusted(Terminal *, const char *data, int len);
 956 void term_provide_resize_fn(Terminal *term,
 957                             void (*resize_fn)(void *, int, int),
 958                             void *resize_ctx);
 959 void term_provide_logctx(Terminal *term, void *logctx);
 960 void term_set_focus(Terminal *term, int has_focus);
 961 char *term_get_ttymode(Terminal *term, const char *mode);
 962 int term_get_userpass_input(Terminal *term, prompts_t *p,
 963                             unsigned char *in, int inlen);
 964
 965 int format_arrow_key(char *buf, Terminal *term, int xkey, int ctrl);
 966
 967 /*
 968  * Exports from logging.c.
 969  */
 970 void *log_init(void *frontend, Conf *conf);
 971 void log_free(void *logctx);
 972 void log_reconfig(void *logctx, Conf *conf);
 973 void logfopen(void *logctx);
 974 void logfclose(void *logctx);
 975 void logtraffic(void *logctx, unsigned char c, int logmode);
 976 void logflush(void *logctx);
 977 void log_eventlog(void *logctx, const char *string);
 978 enum { PKT_INCOMING, PKT_OUTGOING };
 979 enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT };
 980 struct logblank_t {
 981     int offset;
 982     int len;
 983     int type;
 984 };
 985 void log_packet(void *logctx, int direction, int type,
 986                 char *texttype, const void *data, int len,
 987                 int n_blanks, const struct logblank_t *blanks,
 988                 const unsigned long *sequence);
 989
 990 /*
 991  * Exports from testback.c
 992  */
 993
 994 extern Backend null_backend;
 995 extern Backend loop_backend;
 996
 997 /*
 998  * Exports from raw.c.
 999  */
1000
1001 extern Backend raw_backend;
1002
1003 /*
1004  * Exports from rlogin.c.
1005  */
1006
1007 extern Backend rlogin_backend;
1008
1009 /*
1010  * Exports from telnet.c.
1011  */
1012
1013 extern Backend telnet_backend;
1014
1015 /*
1016  * Exports from ssh.c.
1017  */
1018 extern Backend ssh_backend;
1019
1020 /*
1021  * Exports from ldisc.c.
1022  */
1023 void *ldisc_create(Conf *, Terminal *, Backend *, void *, void *);
1024 void ldisc_configure(void *, Conf *);
1025 void ldisc_free(void *);
1026 void ldisc_send(void *handle, char *buf, int len, int interactive);
1027
1028 /*
1029  * Exports from ldiscucs.c.
1030  */
1031 void lpage_send(void *, int codepage, char *buf, int len, int interactive);
1032 void luni_send(void *, wchar_t * widebuf, int len, int interactive);
1033
1034 /*
1035  * Exports from sshrand.c.
1036  */
1037
1038 void random_add_noise(void *noise, int length);
1039 int random_byte(void);
1040 void random_get_savedata(void **data, int *len);
1041 extern int random_active;
1042 /* The random number subsystem is activated if at least one other entity
1043  * within the program expresses an interest in it. So each SSH session
1044  * calls random_ref on startup and random_unref on shutdown. */
1045 void random_ref(void);
1046 void random_unref(void);
1047
1048 /*
1049  * Exports from pinger.c.
1050  */
1051 typedef struct pinger_tag *Pinger;
1052 Pinger pinger_new(Conf *conf, Backend *back, void *backhandle);
1053 void pinger_reconfig(Pinger, Conf *oldconf, Conf *newconf);
1054 void pinger_free(Pinger);
1055
1056 /*
1057  * Exports from misc.c.
1058  */
1059
1060 #include "misc.h"
1061 int conf_launchable(Conf *conf);
1062 char const *conf_dest(Conf *conf);
1063
1064 /*
1065  * Exports from sercfg.c.
1066  */
1067 void ser_setup_config_box(struct controlbox *b, int midsession,
1068                           int parity_mask, int flow_mask);
1069
1070 /*
1071  * Exports from version.c.
1072  */
1073 extern char ver[];
1074
1075 /*
1076  * Exports from unicode.c.
1077  */
1078 #ifndef CP_UTF8
1079 #define CP_UTF8 65001
1080 #endif
1081 /* void init_ucs(void); -- this is now in platform-specific headers */
1082 int is_dbcs_leadbyte(int codepage, char byte);
1083 int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
1084              wchar_t *wcstr, int wclen);
1085 int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
1086              char *mbstr, int mblen, char *defchr, int *defused,
1087              struct unicode_data *ucsdata);
1088 wchar_t xlat_uskbd2cyrllic(int ch);
1089 int check_compose(int first, int second);
1090 int decode_codepage(char *cp_name);
1091 const char *cp_enumerate (int index);
1092 const char *cp_name(int codepage);
1093 void get_unitab(int codepage, wchar_t * unitab, int ftype);
1094
1095 /*
1096  * Exports from wcwidth.c
1097  */
1098 int mk_wcwidth(wchar_t ucs);
1099 int mk_wcswidth(const wchar_t *pwcs, size_t n);
1100 int mk_wcwidth_cjk(wchar_t ucs);
1101 int mk_wcswidth_cjk(const wchar_t *pwcs, size_t n);
1102
1103 /*
1104  * Exports from mscrypto.c
1105  */
1106 #ifdef MSCRYPTOAPI
1107 int crypto_startup();
1108 void crypto_wrapup();
1109 #endif
1110
1111 /*
1112  * Exports from pageantc.c.
1113  *
1114  * agent_query returns 1 for here's-a-response, and 0 for query-in-
1115  * progress. In the latter case there will be a call to `callback'
1116  * at some future point, passing callback_ctx as the first
1117  * parameter and the actual reply data as the second and third.
1118  *
1119  * The response may be a NULL pointer (in either of the synchronous
1120  * or asynchronous cases), which indicates failure to receive a
1121  * response.
1122  */
1123 int agent_query(void *in, int inlen, void **out, int *outlen,
1124                 void (*callback)(void *, void *, int), void *callback_ctx);
1125 int agent_exists(void);
1126
1127 /*
1128  * Exports from wildcard.c
1129  */
1130 const char *wc_error(int value);
1131 int wc_match(const char *wildcard, const char *target);
1132 int wc_unescape(char *output, const char *wildcard);
1133
1134 /*
1135  * Exports from frontend (windlg.c etc)
1136  */
1137 void logevent(void *frontend, const char *);
1138 void pgp_fingerprints(void);
1139 /*
1140  * verify_ssh_host_key() can return one of three values:
1141  *
1142  *  - +1 means `key was OK' (either already known or the user just
1143  *    approved it) `so continue with the connection'
1144  *
1145  *  - 0 means `key was not OK, abandon the connection'
1146  *
1147  *  - -1 means `I've initiated enquiries, please wait to be called
1148  *    back via the provided function with a result that's either 0
1149  *    or +1'.
1150  */
1151 int verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
1152                         char *keystr, char *fingerprint,
1153                         void (*callback)(void *ctx, int result), void *ctx);
1154 /*
1155  * askalg has the same set of return values as verify_ssh_host_key.
1156  */
1157 int askalg(void *frontend, const char *algtype, const char *algname,
1158            void (*callback)(void *ctx, int result), void *ctx);
1159 /*
1160  * askappend can return four values:
1161  *
1162  *  - 2 means overwrite the log file
1163  *  - 1 means append to the log file
1164  *  - 0 means cancel logging for this session
1165  *  - -1 means please wait.
1166  */
1167 int askappend(void *frontend, Filename filename,
1168               void (*callback)(void *ctx, int result), void *ctx);
1169
1170 /*
1171  * Exports from console frontends (wincons.c, uxcons.c)
1172  * that aren't equivalents to things in windlg.c et al.
1173  */
1174 extern int console_batch_mode;
1175 int console_get_userpass_input(prompts_t *p, unsigned char *in, int inlen);
1176 void console_provide_logctx(void *logctx);
1177 int is_interactive(void);
1178
1179 /*
1180  * Exports from printing.c.
1181  */
1182 typedef struct printer_enum_tag printer_enum;
1183 typedef struct printer_job_tag printer_job;
1184 printer_enum *printer_start_enum(int *nprinters);
1185 char *printer_get_name(printer_enum *, int);
1186 void printer_finish_enum(printer_enum *);
1187 printer_job *printer_start_job(char *printer);
1188 void printer_job_data(printer_job *, void *, int);
1189 void printer_finish_job(printer_job *);
1190
1191 /*
1192  * Exports from cmdline.c (and also cmdline_error(), which is
1193  * defined differently in various places and required _by_
1194  * cmdline.c).
1195  */
1196 int cmdline_process_param(char *, char *, int, Conf *);
1197 void cmdline_run_saved(Conf *);
1198 void cmdline_cleanup(void);
1199 int cmdline_get_passwd_input(prompts_t *p, unsigned char *in, int inlen);
1200 #define TOOLTYPE_FILETRANSFER 1
1201 #define TOOLTYPE_NONNETWORK 2
1202 extern int cmdline_tooltype;
1203
1204 void cmdline_error(char *, ...);
1205
1206 /*
1207  * Exports from config.c.
1208  */
1209 struct controlbox;
1210 union control;
1211 void conf_radiobutton_handler(union control *ctrl, void *dlg,
1212                               void *data, int event);
1213 #define CHECKBOX_INVERT (1<<30)
1214 void conf_checkbox_handler(union control *ctrl, void *dlg,
1215                            void *data, int event);
1216 void conf_editbox_handler(union control *ctrl, void *dlg,
1217                           void *data, int event);
1218 void conf_filesel_handler(union control *ctrl, void *dlg,
1219                           void *data, int event);
1220 void conf_fontsel_handler(union control *ctrl, void *dlg,
1221                           void *data, int event);
1222 void setup_config_box(struct controlbox *b, int midsession,
1223                       int protocol, int protcfginfo);
1224
1225 /*
1226  * Exports from minibidi.c.
1227  */
1228 typedef struct bidi_char {
1229     wchar_t origwc, wc;
1230     unsigned short index;
1231 } bidi_char;
1232 int do_bidi(bidi_char *line, int count);
1233 int do_shape(bidi_char *line, bidi_char *to, int count);
1234 int is_rtl(int c);
1235
1236 /*
1237  * X11 auth mechanisms we know about.
1238  */
1239 enum {
1240     X11_NO_AUTH,
1241     X11_MIT,                           /* MIT-MAGIC-COOKIE-1 */
1242     X11_XDM,                           /* XDM-AUTHORIZATION-1 */
1243     X11_NAUTHS
1244 };
1245 extern const char *const x11_authnames[];  /* declared in x11fwd.c */
1246
1247 /*
1248  * Miscellaneous exports from the platform-specific code.
1249  */
1250 Filename filename_from_str(const char *string);
1251 const char *filename_to_str(const Filename *fn);
1252 int filename_equal(Filename f1, Filename f2);
1253 int filename_is_null(Filename fn);
1254 char *get_username(void);              /* return value needs freeing */
1255 char *get_random_data(int bytes);      /* used in cmdgen.c */
1256
1257 /*
1258  * Exports and imports from timing.c.
1259  *
1260  * schedule_timer() asks the front end to schedule a callback to a
1261  * timer function in a given number of ticks. The returned value is
1262  * the time (in ticks since an arbitrary offset) at which the
1263  * callback can be expected. This value will also be passed as the
1264  * `now' parameter to the callback function. Hence, you can (for
1265  * example) schedule an event at a particular time by calling
1266  * schedule_timer() and storing the return value in your context
1267  * structure as the time when that event is due. The first time a
1268  * callback function gives you that value or more as `now', you do
1269  * the thing.
1270  *
1271  * expire_timer_context() drops all current timers associated with
1272  * a given value of ctx (for when you're about to free ctx).
1273  *
1274  * run_timers() is called from the front end when it has reason to
1275  * think some timers have reached their moment, or when it simply
1276  * needs to know how long to wait next. We pass it the time we
1277  * think it is. It returns TRUE and places the time when the next
1278  * timer needs to go off in `next', or alternatively it returns
1279  * FALSE if there are no timers at all pending.
1280  *
1281  * timer_change_notify() must be supplied by the front end; it
1282  * notifies the front end that a new timer has been added to the
1283  * list which is sooner than any existing ones. It provides the
1284  * time when that timer needs to go off.
1285  *
1286  * *** FRONT END IMPLEMENTORS NOTE:
1287  *
1288  * There's an important subtlety in the front-end implementation of
1289  * the timer interface. When a front end is given a `next' value,
1290  * either returned from run_timers() or via timer_change_notify(),
1291  * it should ensure that it really passes _that value_ as the `now'
1292  * parameter to its next run_timers call. It should _not_ simply
1293  * call GETTICKCOUNT() to get the `now' parameter when invoking
1294  * run_timers().
1295  *
1296  * The reason for this is that an OS's system clock might not agree
1297  * exactly with the timing mechanisms it supplies to wait for a
1298  * given interval. I'll illustrate this by the simple example of
1299  * Unix Plink, which uses timeouts to select() in a way which for
1300  * these purposes can simply be considered to be a wait() function.
1301  * Suppose, for the sake of argument, that this wait() function
1302  * tends to return early by 1%. Then a possible sequence of actions
1303  * is:
1304  *
1305  *  - run_timers() tells the front end that the next timer firing
1306  *    is 10000ms from now.
1307  *  - Front end calls wait(10000ms), but according to
1308  *    GETTICKCOUNT() it has only waited for 9900ms.
1309  *  - Front end calls run_timers() again, passing time T-100ms as
1310  *    `now'.
1311  *  - run_timers() does nothing, and says the next timer firing is
1312  *    still 100ms from now.
1313  *  - Front end calls wait(100ms), which only waits for 99ms.
1314  *  - Front end calls run_timers() yet again, passing time T-1ms.
1315  *  - run_timers() says there's still 1ms to wait.
1316  *  - Front end calls wait(1ms).
1317  *
1318  * If you're _lucky_ at this point, wait(1ms) will actually wait
1319  * for 1ms and you'll only have woken the program up three times.
1320  * If you're unlucky, wait(1ms) might do nothing at all due to
1321  * being below some minimum threshold, and you might find your
1322  * program spends the whole of the last millisecond tight-looping
1323  * between wait() and run_timers().
1324  *
1325  * Instead, what you should do is to _save_ the precise `next'
1326  * value provided by run_timers() or via timer_change_notify(), and
1327  * use that precise value as the input to the next run_timers()
1328  * call. So:
1329  *
1330  *  - run_timers() tells the front end that the next timer firing
1331  *    is at time T, 10000ms from now.
1332  *  - Front end calls wait(10000ms).
1333  *  - Front end then immediately calls run_timers() and passes it
1334  *    time T, without stopping to check GETTICKCOUNT() at all.
1335  *
1336  * This guarantees that the program wakes up only as many times as
1337  * there are actual timer actions to be taken, and that the timing
1338  * mechanism will never send it into a tight loop.
1339  *
1340  * (It does also mean that the timer action in the above example
1341  * will occur 100ms early, but this is not generally critical. And
1342  * the hypothetical 1% error in wait() will be partially corrected
1343  * for anyway when, _after_ run_timers() returns, you call
1344  * GETTICKCOUNT() and compare the result with the returned `next'
1345  * value to find out how long you have to make your next wait().)
1346  */
1347 typedef void (*timer_fn_t)(void *ctx, long now);
1348 long schedule_timer(int ticks, timer_fn_t fn, void *ctx);
1349 void expire_timer_context(void *ctx);
1350 int run_timers(long now, long *next);
1351 void timer_change_notify(long next);
1352
1353 /*
1354  * Define no-op macros for the jump list functions, on platforms that
1355  * don't support them. (This is a bit of a hack, and it'd be nicer to
1356  * localise even the calls to those functions into the Windows front
1357  * end, but it'll do for the moment.)
1358  */
1359 #ifndef JUMPLIST_SUPPORTED
1360 #define add_session_to_jumplist(x) ((void)0)
1361 #define remove_session_from_jumplist(x) ((void)0)
1362 #endif
1363
1364 #endif