]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - putty.h
Revamp of the local X11 connection code. We now parse X display
[PuTTY.git] / putty.h
1 #ifndef PUTTY_PUTTY_H
2 #define PUTTY_PUTTY_H
3
4 #include <stddef.h>                    /* for wchar_t */
5
6 /*
7  * Global variables. Most modules declare these `extern', but
8  * window.c will do `#define PUTTY_DO_GLOBALS' before including this
9  * module, and so will get them properly defined.
10  */
11 #ifndef GLOBAL
12 #ifdef PUTTY_DO_GLOBALS
13 #define GLOBAL
14 #else
15 #define GLOBAL extern
16 #endif
17 #endif
18
19 #ifndef DONE_TYPEDEFS
20 #define DONE_TYPEDEFS
21 typedef struct config_tag Config;
22 typedef struct backend_tag Backend;
23 typedef struct terminal_tag Terminal;
24 #endif
25
26 #include "puttyps.h"
27 #include "network.h"
28 #include "misc.h"
29
30 /*
31  * Fingerprints of the PGP master keys that can be used to establish a trust
32  * path between an executable and other files.
33  */
34 #define PGP_RSA_MASTER_KEY_FP \
35     "8F 15 97 DA 25 30 AB 0D  88 D1 92 54 11 CF 0C 4C"
36 #define PGP_DSA_MASTER_KEY_FP \
37     "313C 3E76 4B74 C2C5 F2AE  83A8 4F5E 6DF5 6A93 B34E"
38
39 /* Three attribute types: 
40  * The ATTRs (normal attributes) are stored with the characters in
41  * the main display arrays
42  *
43  * The TATTRs (temporary attributes) are generated on the fly, they
44  * can overlap with characters but not with normal attributes.
45  *
46  * The LATTRs (line attributes) are an entirely disjoint space of
47  * flags.
48  * 
49  * The DATTRs (display attributes) are internal to terminal.c (but
50  * defined here because their values have to match the others
51  * here); they reuse the TATTR_* space but are always masked off
52  * before sending to the front end.
53  *
54  * ATTR_INVALID is an illegal colour combination.
55  */
56
57 #define TATTR_ACTCURS       0x40000000UL      /* active cursor (block) */
58 #define TATTR_PASCURS       0x20000000UL      /* passive cursor (box) */
59 #define TATTR_RIGHTCURS     0x10000000UL      /* cursor-on-RHS */
60 #define TATTR_COMBINING     0x80000000UL      /* combining characters */
61
62 #define DATTR_STARTRUN      0x80000000UL   /* start of redraw run */
63
64 #define TDATTR_MASK         0xF0000000UL
65 #define TATTR_MASK (TDATTR_MASK)
66 #define DATTR_MASK (TDATTR_MASK)
67
68 #define LATTR_NORM   0x00000000UL
69 #define LATTR_WIDE   0x00000001UL
70 #define LATTR_TOP    0x00000002UL
71 #define LATTR_BOT    0x00000003UL
72 #define LATTR_MODE   0x00000003UL
73 #define LATTR_WRAPPED 0x00000010UL     /* 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. (cfg.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 (cfg.beep) */
316     BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER
317 };
318
319 enum {
320     /* Taskbar flashing indication on bell (cfg.beep_ind) */
321     B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY
322 };
323
324 enum {
325     /* Resize actions (cfg.resize_action) */
326     RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER
327 };
328
329 enum {
330     /* Function key types (cfg.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 extern const char *const ttymodes[];
352
353 enum {
354     /*
355      * Network address types. Used for specifying choice of IPv4/v6
356      * in config; also used in proxy.c to indicate whether a given
357      * host name has already been resolved or will be resolved at
358      * the proxy end.
359      */
360     ADDRTYPE_UNSPEC, ADDRTYPE_IPV4, ADDRTYPE_IPV6, ADDRTYPE_NAME
361 };
362
363 struct backend_tag {
364     const char *(*init) (void *frontend_handle, void **backend_handle,
365                          Config *cfg,
366                          char *host, int port, char **realhost, int nodelay,
367                          int keepalive);
368     void (*free) (void *handle);
369     /* back->reconfig() passes in a replacement configuration. */
370     void (*reconfig) (void *handle, Config *cfg);
371     /* back->send() returns the current amount of buffered data. */
372     int (*send) (void *handle, char *buf, int len);
373     /* back->sendbuffer() does the same thing but without attempting a send */
374     int (*sendbuffer) (void *handle);
375     void (*size) (void *handle, int width, int height);
376     void (*special) (void *handle, Telnet_Special code);
377     const struct telnet_special *(*get_specials) (void *handle);
378     int (*connected) (void *handle);
379     int (*exitcode) (void *handle);
380     /* If back->sendok() returns FALSE, data sent to it from the frontend
381      * may be lost. */
382     int (*sendok) (void *handle);
383     int (*ldisc) (void *handle, int);
384     void (*provide_ldisc) (void *handle, void *ldisc);
385     void (*provide_logctx) (void *handle, void *logctx);
386     /*
387      * back->unthrottle() tells the back end that the front end
388      * buffer is clearing.
389      */
390     void (*unthrottle) (void *handle, int);
391     int (*cfg_info) (void *handle);
392     char *name;
393     int protocol;
394     int default_port;
395 };
396
397 extern Backend *backends[];
398
399 /*
400  * Suggested default protocol provided by the backend link module.
401  * The application is free to ignore this.
402  */
403 extern const int be_default_protocol;
404
405 /*
406  * Name of this particular application, for use in the config box
407  * and other pieces of text.
408  */
409 extern const char *const appname;
410
411 /*
412  * IMPORTANT POLICY POINT: everything in this structure which wants
413  * to be treated like an integer must be an actual, honest-to-
414  * goodness `int'. No enum-typed variables. This is because parts
415  * of the code will want to pass around `int *' pointers to them
416  * and we can't run the risk of porting to some system on which the
417  * enum comes out as a different size from int.
418  */
419 struct config_tag {
420     /* Basic options */
421     char host[512];
422     int port;
423     int protocol;
424     int addressfamily;
425     int close_on_exit;
426     int warn_on_close;
427     int ping_interval;                 /* in seconds */
428     int tcp_nodelay;
429     int tcp_keepalives;
430     char loghost[512];  /* logical host being contacted, for host key check */
431     /* Proxy options */
432     char proxy_exclude_list[512];
433     int proxy_dns;
434     int even_proxy_localhost;
435     int proxy_type;
436     char proxy_host[512];
437     int proxy_port;
438     char proxy_username[128];
439     char proxy_password[128];
440     char proxy_telnet_command[512];
441     /* SSH options */
442     char remote_cmd[512];
443     char *remote_cmd_ptr;              /* might point to a larger command
444                                         * but never for loading/saving */
445     char *remote_cmd_ptr2;             /* might point to a larger command
446                                         * but never for loading/saving */
447     int nopty;
448     int compression;
449     int ssh_kexlist[KEX_MAX];
450     int ssh_rekey_time;                /* in minutes */
451     char ssh_rekey_data[16];
452     int tryagent;
453     int agentfwd;
454     int change_username;               /* allow username switching in SSH-2 */
455     int ssh_cipherlist[CIPHER_MAX];
456     Filename keyfile;
457     int sshprot;                       /* use v1 or v2 when both available */
458     int ssh2_des_cbc;                  /* "des-cbc" unrecommended SSH-2 cipher */
459     int ssh_no_userauth;               /* bypass "ssh-userauth" (SSH-2 only) */
460     int try_tis_auth;
461     int try_ki_auth;
462     int try_gssapi_auth;               /* attempt gssapi auth */
463     int gssapifwd;                     /* forward tgt via gss */
464     int ssh_subsys;                    /* run a subsystem rather than a command */
465     int ssh_subsys2;                   /* fallback to go with remote_cmd_ptr2 */
466     int ssh_no_shell;                  /* avoid running a shell */
467     char ssh_nc_host[512];             /* host to connect to in `nc' mode */
468     int ssh_nc_port;                   /* port to connect to in `nc' mode */
469     /* Telnet options */
470     char termtype[32];
471     char termspeed[32];
472     char ttymodes[768];                /* MODE\tVvalue\0MODE\tA\0\0 */
473     char environmt[1024];              /* VAR\tvalue\0VAR\tvalue\0\0 */
474     char username[100];
475     char localusername[100];
476     int rfc_environ;
477     int passive_telnet;
478     /* Serial port options */
479     char serline[256];
480     int serspeed;
481     int serdatabits, serstopbits;
482     int serparity;
483     int serflow;
484     /* Keyboard options */
485     int bksp_is_delete;
486     int rxvt_homeend;
487     int funky_type;
488     int no_applic_c;                   /* totally disable app cursor keys */
489     int no_applic_k;                   /* totally disable app keypad */
490     int no_mouse_rep;                  /* totally disable mouse reporting */
491     int no_remote_resize;              /* disable remote resizing */
492     int no_alt_screen;                 /* disable alternate screen */
493     int no_remote_wintitle;            /* disable remote retitling */
494     int no_dbackspace;                 /* disable destructive backspace */
495     int no_remote_charset;             /* disable remote charset config */
496     int remote_qtitle_action;          /* remote win title query action */
497     int app_cursor;
498     int app_keypad;
499     int nethack_keypad;
500     int telnet_keyboard;
501     int telnet_newline;
502     int alt_f4;                        /* is it special? */
503     int alt_space;                     /* is it special? */
504     int alt_only;                      /* is it special? */
505     int localecho;
506     int localedit;
507     int alwaysontop;
508     int fullscreenonaltenter;
509     int scroll_on_key;
510     int scroll_on_disp;
511     int erase_to_scrollback;
512     int compose_key;
513     int ctrlaltkeys;
514     char wintitle[256];                /* initial window title */
515     /* Terminal options */
516     int savelines;
517     int dec_om;
518     int wrap_mode;
519     int lfhascr;
520     int cursor_type;                   /* 0=block 1=underline 2=vertical */
521     int blink_cur;
522     int beep;
523     int beep_ind;
524     int bellovl;                       /* bell overload protection active? */
525     int bellovl_n;                     /* number of bells to cause overload */
526     int bellovl_t;                     /* time interval for overload (seconds) */
527     int bellovl_s;                     /* period of silence to re-enable bell (s) */
528     Filename bell_wavefile;
529     int scrollbar;
530     int scrollbar_in_fullscreen;
531     int resize_action;
532     int bce;
533     int blinktext;
534     int win_name_always;
535     int width, height;
536     FontSpec font;
537     int font_quality;
538     Filename logfilename;
539     int logtype;
540     int logxfovr;
541     int logflush;
542     int logomitpass;
543     int logomitdata;
544     int hide_mouseptr;
545     int sunken_edge;
546     int window_border;
547     char answerback[256];
548     char printer[128];
549     int arabicshaping;
550     int bidi;
551     /* Colour options */
552     int ansi_colour;
553     int xterm_256_colour;
554     int system_colour;
555     int try_palette;
556     int bold_colour;
557     unsigned char colours[22][3];
558     /* Selection options */
559     int mouse_is_xterm;
560     int rect_select;
561     int rawcnp;
562     int rtf_paste;
563     int mouse_override;
564     short wordness[256];
565     /* translations */
566     int vtmode;
567     char line_codepage[128];
568     int cjk_ambig_wide;
569     int utf8_override;
570     int xlat_capslockcyr;
571     /* X11 forwarding */
572     int x11_forward;
573     char x11_display[128];
574     int x11_auth;
575     Filename xauthfile;
576     /* port forwarding */
577     int lport_acceptall; /* accept conns from hosts other than localhost */
578     int rport_acceptall; /* same for remote forwarded ports (SSH-2 only) */
579     /*
580      * The port forwarding string contains a number of
581      * NUL-terminated substrings, terminated in turn by an empty
582      * string (i.e. a second NUL immediately after the previous
583      * one). Each string can be of one of the following forms:
584      * 
585      *   [LR]localport\thost:port
586      *   [LR]localaddr:localport\thost:port
587      *   Dlocalport
588      *   Dlocaladdr:localport
589      */
590     char portfwd[1024];
591     /* SSH bug compatibility modes */
592     int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
593         sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
594         sshbug_pksessid2, sshbug_rekey2, sshbug_maxpkt2;
595     /*
596      * ssh_simple means that we promise never to open any channel other
597      * than the main one, which means it can safely use a very large
598      * window in SSH-2.
599      */
600     int ssh_simple;
601     /* Options for pterm. Should split out into platform-dependent part. */
602     int stamp_utmp;
603     int login_shell;
604     int scrollbar_on_left;
605     int shadowbold;
606     FontSpec boldfont;
607     FontSpec widefont;
608     FontSpec wideboldfont;
609     int shadowboldoffset;
610     int crhaslf;
611 };
612
613 /*
614  * Some global flags denoting the type of application.
615  * 
616  * FLAG_VERBOSE is set when the user requests verbose details.
617  * 
618  * FLAG_STDERR is set in command-line applications (which have a
619  * functioning stderr that it makes sense to write to) and not in
620  * GUI applications (which don't).
621  * 
622  * FLAG_INTERACTIVE is set when a full interactive shell session is
623  * being run, _either_ because no remote command has been provided
624  * _or_ because the application is GUI and can't run non-
625  * interactively.
626  * 
627  * These flags describe the type of _application_ - they wouldn't
628  * vary between individual sessions - and so it's OK to have this
629  * variable be GLOBAL.
630  * 
631  * Note that additional flags may be defined in platform-specific
632  * headers. It's probably best if those ones start from 0x1000, to
633  * avoid collision.
634  */
635 #define FLAG_VERBOSE     0x0001
636 #define FLAG_STDERR      0x0002
637 #define FLAG_INTERACTIVE 0x0004
638 GLOBAL int flags;
639
640 /*
641  * Likewise, these two variables are set up when the application
642  * initialises, and inform all default-settings accesses after
643  * that.
644  */
645 GLOBAL int default_protocol;
646 GLOBAL int default_port;
647
648 /*
649  * This is set TRUE by cmdline.c iff a session is loaded with "-load".
650  */
651 GLOBAL int loaded_session;
652
653 struct RSAKey;                         /* be a little careful of scope */
654
655 /*
656  * Mechanism for getting text strings such as usernames and passwords
657  * from the front-end.
658  * The fields are mostly modelled after SSH's keyboard-interactive auth.
659  * FIXME We should probably mandate a character set/encoding (probably UTF-8).
660  *
661  * Since many of the pieces of text involved may be chosen by the server,
662  * the caller must take care to ensure that the server can't spoof locally-
663  * generated prompts such as key passphrase prompts. Some ground rules:
664  *  - If the front-end needs to truncate a string, it should lop off the
665  *    end.
666  *  - The front-end should filter out any dangerous characters and
667  *    generally not trust the strings. (But \n is required to behave
668  *    vaguely sensibly, at least in `instruction', and ideally in
669  *    `prompt[]' too.)
670  */
671 typedef struct {
672     char *prompt;
673     int echo;
674     char *result;       /* allocated/freed by caller */
675     size_t result_len;
676 } prompt_t;
677 typedef struct {
678     /*
679      * Indicates whether the information entered is to be used locally
680      * (for instance a key passphrase prompt), or is destined for the wire.
681      * This is a hint only; the front-end is at liberty not to use this
682      * information (so the caller should ensure that the supplied text is
683      * sufficient).
684      */
685     int to_server;
686     char *name;         /* Short description, perhaps for dialog box title */
687     int name_reqd;      /* Display of `name' required or optional? */
688     char *instruction;  /* Long description, maybe with embedded newlines */
689     int instr_reqd;     /* Display of `instruction' required or optional? */
690     size_t n_prompts;   /* May be zero (in which case display the foregoing,
691                          * if any, and return success) */
692     prompt_t **prompts;
693     void *frontend;
694     void *data;         /* slot for housekeeping data, managed by
695                          * get_userpass_input(); initially NULL */
696 } prompts_t;
697 prompts_t *new_prompts(void *frontend);
698 void add_prompt(prompts_t *p, char *promptstr, int echo, size_t len);
699 /* Burn the evidence. (Assumes _all_ strings want free()ing.) */
700 void free_prompts(prompts_t *p);
701
702 /*
703  * Exports from the front end.
704  */
705 void request_resize(void *frontend, int, int);
706 void do_text(Context, int, int, wchar_t *, int, unsigned long, int);
707 void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int);
708 int char_width(Context ctx, int uc);
709 #ifdef OPTIMISE_SCROLL
710 void do_scroll(Context, int, int, int);
711 #endif
712 void set_title(void *frontend, char *);
713 void set_icon(void *frontend, char *);
714 void set_sbar(void *frontend, int, int, int);
715 Context get_ctx(void *frontend);
716 void free_ctx(Context);
717 void palette_set(void *frontend, int, int, int, int);
718 void palette_reset(void *frontend);
719 void write_aclip(void *frontend, char *, int, int);
720 void write_clip(void *frontend, wchar_t *, int *, int, int);
721 void get_clip(void *frontend, wchar_t **, int *);
722 void optimised_move(void *frontend, int, int, int);
723 void set_raw_mouse_mode(void *frontend, int);
724 void connection_fatal(void *frontend, char *, ...);
725 void fatalbox(char *, ...);
726 void modalfatalbox(char *, ...);
727 #ifdef macintosh
728 #pragma noreturn(fatalbox)
729 #pragma noreturn(modalfatalbox)
730 #endif
731 void do_beep(void *frontend, int);
732 void begin_session(void *frontend);
733 void sys_cursor(void *frontend, int x, int y);
734 void request_paste(void *frontend);
735 void frontend_keypress(void *frontend);
736 void ldisc_update(void *frontend, int echo, int edit);
737 /* It's the backend's responsibility to invoke this at the start of a
738  * connection, if necessary; it can also invoke it later if the set of
739  * special commands changes. It does not need to invoke it at session
740  * shutdown. */
741 void update_specials_menu(void *frontend);
742 int from_backend(void *frontend, int is_stderr, const char *data, int len);
743 int from_backend_untrusted(void *frontend, const char *data, int len);
744 void notify_remote_exit(void *frontend);
745 /* Get a sensible value for a tty mode. NULL return = don't set.
746  * Otherwise, returned value should be freed by caller. */
747 char *get_ttymode(void *frontend, const char *mode);
748 /*
749  * >0 = `got all results, carry on'
750  * 0  = `user cancelled' (FIXME distinguish "give up entirely" and "next auth"?)
751  * <0 = `please call back later with more in/inlen'
752  */
753 int get_userpass_input(prompts_t *p, unsigned char *in, int inlen);
754 #define OPTIMISE_IS_SCROLL 1
755
756 void set_iconic(void *frontend, int iconic);
757 void move_window(void *frontend, int x, int y);
758 void set_zorder(void *frontend, int top);
759 void refresh_window(void *frontend);
760 void set_zoomed(void *frontend, int zoomed);
761 int is_iconic(void *frontend);
762 void get_window_pos(void *frontend, int *x, int *y);
763 void get_window_pixels(void *frontend, int *x, int *y);
764 char *get_window_title(void *frontend, int icon);
765 /* Hint from backend to frontend about time-consuming operations.
766  * Initial state is assumed to be BUSY_NOT. */
767 enum {
768     BUSY_NOT,       /* Not busy, all user interaction OK */
769     BUSY_WAITING,   /* Waiting for something; local event loops still running
770                        so some local interaction (e.g. menus) OK, but network
771                        stuff is suspended */
772     BUSY_CPU        /* Locally busy (e.g. crypto); user interaction suspended */
773 };
774 void set_busy_status(void *frontend, int status);
775
776 void cleanup_exit(int);
777
778 /*
779  * Exports from noise.c.
780  */
781 void noise_get_heavy(void (*func) (void *, int));
782 void noise_get_light(void (*func) (void *, int));
783 void noise_regular(void);
784 void noise_ultralight(unsigned long data);
785 void random_save_seed(void);
786 void random_destroy_seed(void);
787
788 /*
789  * Exports from settings.c.
790  */
791 Backend *backend_from_name(const char *name);
792 Backend *backend_from_proto(int proto);
793 char *save_settings(char *section, Config * cfg);
794 void save_open_settings(void *sesskey, Config *cfg);
795 void load_settings(char *section, Config * cfg);
796 void load_open_settings(void *sesskey, Config *cfg);
797 void get_sesslist(struct sesslist *, int allocate);
798 void do_defaults(char *, Config *);
799 void registry_cleanup(void);
800
801 /*
802  * Functions used by settings.c to provide platform-specific
803  * default settings.
804  * 
805  * (The integer one is expected to return `def' if it has no clear
806  * opinion of its own. This is because there's no integer value
807  * which I can reliably set aside to indicate `nil'. The string
808  * function is perfectly all right returning NULL, of course. The
809  * Filename and FontSpec functions are _not allowed_ to fail to
810  * return, since these defaults _must_ be per-platform.)
811  */
812 char *platform_default_s(const char *name);
813 int platform_default_i(const char *name, int def);
814 Filename platform_default_filename(const char *name);
815 FontSpec platform_default_fontspec(const char *name);
816
817 /*
818  * Exports from terminal.c.
819  */
820
821 Terminal *term_init(Config *, struct unicode_data *, void *);
822 void term_free(Terminal *);
823 void term_size(Terminal *, int, int, int);
824 void term_paint(Terminal *, Context, int, int, int, int, int);
825 void term_scroll(Terminal *, int, int);
826 void term_pwron(Terminal *, int);
827 void term_clrsb(Terminal *);
828 void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action,
829                 int,int,int,int,int);
830 void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int,
831               unsigned int);
832 void term_deselect(Terminal *);
833 void term_update(Terminal *);
834 void term_invalidate(Terminal *);
835 void term_blink(Terminal *, int set_cursor);
836 void term_do_paste(Terminal *);
837 int term_paste_pending(Terminal *);
838 void term_paste(Terminal *);
839 void term_nopaste(Terminal *);
840 int term_ldisc(Terminal *, int option);
841 void term_copyall(Terminal *);
842 void term_reconfig(Terminal *, Config *);
843 void term_seen_key_event(Terminal *); 
844 int term_data(Terminal *, int is_stderr, const char *data, int len);
845 int term_data_untrusted(Terminal *, const char *data, int len);
846 void term_provide_resize_fn(Terminal *term,
847                             void (*resize_fn)(void *, int, int),
848                             void *resize_ctx);
849 void term_provide_logctx(Terminal *term, void *logctx);
850 void term_set_focus(Terminal *term, int has_focus);
851 char *term_get_ttymode(Terminal *term, const char *mode);
852 int term_get_userpass_input(Terminal *term, prompts_t *p,
853                             unsigned char *in, int inlen);
854
855 /*
856  * Exports from logging.c.
857  */
858 void *log_init(void *frontend, Config *cfg);
859 void log_free(void *logctx);
860 void log_reconfig(void *logctx, Config *cfg);
861 void logfopen(void *logctx);
862 void logfclose(void *logctx);
863 void logtraffic(void *logctx, unsigned char c, int logmode);
864 void logflush(void *logctx);
865 void log_eventlog(void *logctx, const char *string);
866 enum { PKT_INCOMING, PKT_OUTGOING };
867 enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT };
868 struct logblank_t {
869     int offset;
870     int len;
871     int type;
872 };
873 void log_packet(void *logctx, int direction, int type,
874                 char *texttype, const void *data, int len,
875                 int n_blanks, const struct logblank_t *blanks,
876                 const unsigned long *sequence);
877
878 /*
879  * Exports from testback.c
880  */
881
882 extern Backend null_backend;
883 extern Backend loop_backend;
884
885 /*
886  * Exports from raw.c.
887  */
888
889 extern Backend raw_backend;
890
891 /*
892  * Exports from rlogin.c.
893  */
894
895 extern Backend rlogin_backend;
896
897 /*
898  * Exports from telnet.c.
899  */
900
901 extern Backend telnet_backend;
902
903 /*
904  * Exports from ssh.c.
905  */
906 extern Backend ssh_backend;
907
908 /*
909  * Exports from ldisc.c.
910  */
911 void *ldisc_create(Config *, Terminal *, Backend *, void *, void *);
912 void ldisc_free(void *);
913 void ldisc_send(void *handle, char *buf, int len, int interactive);
914
915 /*
916  * Exports from ldiscucs.c.
917  */
918 void lpage_send(void *, int codepage, char *buf, int len, int interactive);
919 void luni_send(void *, wchar_t * widebuf, int len, int interactive);
920
921 /*
922  * Exports from sshrand.c.
923  */
924
925 void random_add_noise(void *noise, int length);
926 int random_byte(void);
927 void random_get_savedata(void **data, int *len);
928 extern int random_active;
929 /* The random number subsystem is activated if at least one other entity
930  * within the program expresses an interest in it. So each SSH session
931  * calls random_ref on startup and random_unref on shutdown. */
932 void random_ref(void);
933 void random_unref(void);
934
935 /*
936  * Exports from pinger.c.
937  */
938 typedef struct pinger_tag *Pinger;
939 Pinger pinger_new(Config *cfg, Backend *back, void *backhandle);
940 void pinger_reconfig(Pinger, Config *oldcfg, Config *newcfg);
941 void pinger_free(Pinger);
942
943 /*
944  * Exports from misc.c.
945  */
946
947 #include "misc.h"
948 int cfg_launchable(const Config *cfg);
949 char const *cfg_dest(const Config *cfg);
950
951 /*
952  * Exports from sercfg.c.
953  */
954 void ser_setup_config_box(struct controlbox *b, int midsession,
955                           int parity_mask, int flow_mask);
956
957 /*
958  * Exports from version.c.
959  */
960 extern char ver[];
961
962 /*
963  * Exports from unicode.c.
964  */
965 #ifndef CP_UTF8
966 #define CP_UTF8 65001
967 #endif
968 /* void init_ucs(void); -- this is now in platform-specific headers */
969 int is_dbcs_leadbyte(int codepage, char byte);
970 int mb_to_wc(int codepage, int flags, char *mbstr, int mblen,
971              wchar_t *wcstr, int wclen);
972 int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
973              char *mbstr, int mblen, char *defchr, int *defused,
974              struct unicode_data *ucsdata);
975 wchar_t xlat_uskbd2cyrllic(int ch);
976 int check_compose(int first, int second);
977 int decode_codepage(char *cp_name);
978 const char *cp_enumerate (int index);
979 const char *cp_name(int codepage);
980 void get_unitab(int codepage, wchar_t * unitab, int ftype);
981
982 /*
983  * Exports from wcwidth.c
984  */
985 int mk_wcwidth(wchar_t ucs);
986 int mk_wcswidth(const wchar_t *pwcs, size_t n);
987 int mk_wcwidth_cjk(wchar_t ucs);
988 int mk_wcswidth_cjk(const wchar_t *pwcs, size_t n);
989
990 /*
991  * Exports from mscrypto.c
992  */
993 #ifdef MSCRYPTOAPI
994 int crypto_startup();
995 void crypto_wrapup();
996 #endif
997
998 /*
999  * Exports from pageantc.c.
1000  * 
1001  * agent_query returns 1 for here's-a-response, and 0 for query-in-
1002  * progress. In the latter case there will be a call to `callback'
1003  * at some future point, passing callback_ctx as the first
1004  * parameter and the actual reply data as the second and third.
1005  * 
1006  * The response may be a NULL pointer (in either of the synchronous
1007  * or asynchronous cases), which indicates failure to receive a
1008  * response.
1009  */
1010 int agent_query(void *in, int inlen, void **out, int *outlen,
1011                 void (*callback)(void *, void *, int), void *callback_ctx);
1012 int agent_exists(void);
1013
1014 /*
1015  * Exports from wildcard.c
1016  */
1017 const char *wc_error(int value);
1018 int wc_match(const char *wildcard, const char *target);
1019 int wc_unescape(char *output, const char *wildcard);
1020
1021 /*
1022  * Exports from frontend (windlg.c etc)
1023  */
1024 void logevent(void *frontend, const char *);
1025 void pgp_fingerprints(void);
1026 /*
1027  * verify_ssh_host_key() can return one of three values:
1028  * 
1029  *  - +1 means `key was OK' (either already known or the user just
1030  *    approved it) `so continue with the connection'
1031  * 
1032  *  - 0 means `key was not OK, abandon the connection'
1033  * 
1034  *  - -1 means `I've initiated enquiries, please wait to be called
1035  *    back via the provided function with a result that's either 0
1036  *    or +1'.
1037  */
1038 int verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
1039                         char *keystr, char *fingerprint,
1040                         void (*callback)(void *ctx, int result), void *ctx);
1041 /*
1042  * askalg has the same set of return values as verify_ssh_host_key.
1043  */
1044 int askalg(void *frontend, const char *algtype, const char *algname,
1045            void (*callback)(void *ctx, int result), void *ctx);
1046 /*
1047  * askappend can return four values:
1048  * 
1049  *  - 2 means overwrite the log file
1050  *  - 1 means append to the log file
1051  *  - 0 means cancel logging for this session
1052  *  - -1 means please wait.
1053  */
1054 int askappend(void *frontend, Filename filename,
1055               void (*callback)(void *ctx, int result), void *ctx);
1056
1057 /*
1058  * Exports from console frontends (wincons.c, uxcons.c)
1059  * that aren't equivalents to things in windlg.c et al.
1060  */
1061 extern int console_batch_mode;
1062 int console_get_userpass_input(prompts_t *p, unsigned char *in, int inlen);
1063 void console_provide_logctx(void *logctx);
1064 int is_interactive(void);
1065
1066 /*
1067  * Exports from printing.c.
1068  */
1069 typedef struct printer_enum_tag printer_enum;
1070 typedef struct printer_job_tag printer_job;
1071 printer_enum *printer_start_enum(int *nprinters);
1072 char *printer_get_name(printer_enum *, int);
1073 void printer_finish_enum(printer_enum *);
1074 printer_job *printer_start_job(char *printer);
1075 void printer_job_data(printer_job *, void *, int);
1076 void printer_finish_job(printer_job *);
1077
1078 /*
1079  * Exports from cmdline.c (and also cmdline_error(), which is
1080  * defined differently in various places and required _by_
1081  * cmdline.c).
1082  */
1083 int cmdline_process_param(char *, char *, int, Config *);
1084 void cmdline_run_saved(Config *);
1085 void cmdline_cleanup(void);
1086 int cmdline_get_passwd_input(prompts_t *p, unsigned char *in, int inlen);
1087 #define TOOLTYPE_FILETRANSFER 1
1088 #define TOOLTYPE_NONNETWORK 2
1089 extern int cmdline_tooltype;
1090
1091 void cmdline_error(char *, ...);
1092
1093 /*
1094  * Exports from config.c.
1095  */
1096 struct controlbox;
1097 void setup_config_box(struct controlbox *b, int midsession,
1098                       int protocol, int protcfginfo);
1099
1100 /*
1101  * Exports from minibidi.c.
1102  */
1103 typedef struct bidi_char {
1104     wchar_t origwc, wc;
1105     unsigned short index;
1106 } bidi_char;
1107 int do_bidi(bidi_char *line, int count);
1108 int do_shape(bidi_char *line, bidi_char *to, int count);
1109 int is_rtl(int c);
1110
1111 /*
1112  * X11 auth mechanisms we know about.
1113  */
1114 enum {
1115     X11_NO_AUTH,
1116     X11_MIT,                           /* MIT-MAGIC-COOKIE-1 */
1117     X11_XDM,                           /* XDM-AUTHORIZATION-1 */
1118     X11_NAUTHS
1119 };
1120 extern const char *const x11_authnames[];  /* declared in x11fwd.c */
1121
1122 /*
1123  * Miscellaneous exports from the platform-specific code.
1124  */
1125 Filename filename_from_str(const char *string);
1126 const char *filename_to_str(const Filename *fn);
1127 int filename_equal(Filename f1, Filename f2);
1128 int filename_is_null(Filename fn);
1129 char *get_username(void);              /* return value needs freeing */
1130 char *get_random_data(int bytes);      /* used in cmdgen.c */
1131
1132 /*
1133  * Exports and imports from timing.c.
1134  *
1135  * schedule_timer() asks the front end to schedule a callback to a
1136  * timer function in a given number of ticks. The returned value is
1137  * the time (in ticks since an arbitrary offset) at which the
1138  * callback can be expected. This value will also be passed as the
1139  * `now' parameter to the callback function. Hence, you can (for
1140  * example) schedule an event at a particular time by calling
1141  * schedule_timer() and storing the return value in your context
1142  * structure as the time when that event is due. The first time a
1143  * callback function gives you that value or more as `now', you do
1144  * the thing.
1145  * 
1146  * expire_timer_context() drops all current timers associated with
1147  * a given value of ctx (for when you're about to free ctx).
1148  * 
1149  * run_timers() is called from the front end when it has reason to
1150  * think some timers have reached their moment, or when it simply
1151  * needs to know how long to wait next. We pass it the time we
1152  * think it is. It returns TRUE and places the time when the next
1153  * timer needs to go off in `next', or alternatively it returns
1154  * FALSE if there are no timers at all pending.
1155  * 
1156  * timer_change_notify() must be supplied by the front end; it
1157  * notifies the front end that a new timer has been added to the
1158  * list which is sooner than any existing ones. It provides the
1159  * time when that timer needs to go off.
1160  * 
1161  * *** FRONT END IMPLEMENTORS NOTE:
1162  * 
1163  * There's an important subtlety in the front-end implementation of
1164  * the timer interface. When a front end is given a `next' value,
1165  * either returned from run_timers() or via timer_change_notify(),
1166  * it should ensure that it really passes _that value_ as the `now'
1167  * parameter to its next run_timers call. It should _not_ simply
1168  * call GETTICKCOUNT() to get the `now' parameter when invoking
1169  * run_timers().
1170  * 
1171  * The reason for this is that an OS's system clock might not agree
1172  * exactly with the timing mechanisms it supplies to wait for a
1173  * given interval. I'll illustrate this by the simple example of
1174  * Unix Plink, which uses timeouts to select() in a way which for
1175  * these purposes can simply be considered to be a wait() function.
1176  * Suppose, for the sake of argument, that this wait() function
1177  * tends to return early by 1%. Then a possible sequence of actions
1178  * is:
1179  * 
1180  *  - run_timers() tells the front end that the next timer firing
1181  *    is 10000ms from now.
1182  *  - Front end calls wait(10000ms), but according to
1183  *    GETTICKCOUNT() it has only waited for 9900ms.
1184  *  - Front end calls run_timers() again, passing time T-100ms as
1185  *    `now'.
1186  *  - run_timers() does nothing, and says the next timer firing is
1187  *    still 100ms from now.
1188  *  - Front end calls wait(100ms), which only waits for 99ms.
1189  *  - Front end calls run_timers() yet again, passing time T-1ms.
1190  *  - run_timers() says there's still 1ms to wait.
1191  *  - Front end calls wait(1ms).
1192  * 
1193  * If you're _lucky_ at this point, wait(1ms) will actually wait
1194  * for 1ms and you'll only have woken the program up three times.
1195  * If you're unlucky, wait(1ms) might do nothing at all due to
1196  * being below some minimum threshold, and you might find your
1197  * program spends the whole of the last millisecond tight-looping
1198  * between wait() and run_timers().
1199  * 
1200  * Instead, what you should do is to _save_ the precise `next'
1201  * value provided by run_timers() or via timer_change_notify(), and
1202  * use that precise value as the input to the next run_timers()
1203  * call. So:
1204  * 
1205  *  - run_timers() tells the front end that the next timer firing
1206  *    is at time T, 10000ms from now.
1207  *  - Front end calls wait(10000ms).
1208  *  - Front end then immediately calls run_timers() and passes it
1209  *    time T, without stopping to check GETTICKCOUNT() at all.
1210  * 
1211  * This guarantees that the program wakes up only as many times as
1212  * there are actual timer actions to be taken, and that the timing
1213  * mechanism will never send it into a tight loop.
1214  * 
1215  * (It does also mean that the timer action in the above example
1216  * will occur 100ms early, but this is not generally critical. And
1217  * the hypothetical 1% error in wait() will be partially corrected
1218  * for anyway when, _after_ run_timers() returns, you call
1219  * GETTICKCOUNT() and compare the result with the returned `next'
1220  * value to find out how long you have to make your next wait().)
1221  */
1222 typedef void (*timer_fn_t)(void *ctx, long now);
1223 long schedule_timer(int ticks, timer_fn_t fn, void *ctx);
1224 void expire_timer_context(void *ctx);
1225 int run_timers(long now, long *next);
1226 void timer_change_notify(long next);
1227
1228 #endif