putty/PUTTY.H

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