374330e2 |
1 | #ifndef PUTTY_PUTTY_H |
2 | #define PUTTY_PUTTY_H |
3 | |
54a2bffb |
4 | #include <stddef.h> /* for wchar_t */ |
ca20bfcf |
5 | |
f7f27309 |
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 | |
a8327734 |
19 | #ifndef DONE_TYPEDEFS |
20 | #define DONE_TYPEDEFS |
f7f27309 |
21 | typedef struct config_tag Config; |
1709795f |
22 | typedef struct backend_tag Backend; |
887035a5 |
23 | typedef struct terminal_tag Terminal; |
a8327734 |
24 | #endif |
8df7a775 |
25 | |
f7f27309 |
26 | #include "puttyps.h" |
27 | #include "network.h" |
9a30e26b |
28 | #include "misc.h" |
374330e2 |
29 | |
2285d016 |
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 | |
4eeb7d09 |
39 | /* Three attribute types: |
50c1be3f |
40 | * The ATTRs (normal attributes) are stored with the characters in |
41 | * the main display arrays |
4eeb7d09 |
42 | * |
50c1be3f |
43 | * The TATTRs (temporary attributes) are generated on the fly, they |
44 | * can overlap with characters but not with normal attributes. |
4eeb7d09 |
45 | * |
50c1be3f |
46 | * The LATTRs (line attributes) are an entirely disjoint space of |
47 | * flags. |
fd59420d |
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. |
4eeb7d09 |
53 | * |
54 | * ATTR_INVALID is an illegal colour combination. |
55 | */ |
56 | |
36566009 |
57 | #define TATTR_ACTCURS 0x40000000UL /* active cursor (block) */ |
58 | #define TATTR_PASCURS 0x20000000UL /* passive cursor (box) */ |
59 | #define TATTR_RIGHTCURS 0x10000000UL /* cursor-on-RHS */ |
c6958dfe |
60 | #define TATTR_COMBINING 0x80000000UL /* combining characters */ |
374330e2 |
61 | |
fd59420d |
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 | |
c9def1b8 |
68 | #define LATTR_NORM 0x00000000UL |
36566009 |
69 | #define LATTR_WIDE 0x00000001UL |
70 | #define LATTR_TOP 0x00000002UL |
71 | #define LATTR_BOT 0x00000003UL |
72 | #define LATTR_MODE 0x00000003UL |
e6717a98 |
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 */ |
4eeb7d09 |
77 | |
fd59420d |
78 | #define ATTR_INVALID 0x03FFFFU |
4eeb7d09 |
79 | |
80 | /* Like Linux use the F000 page for direct to font. */ |
36566009 |
81 | #define CSET_OEMCP 0x0000F000UL /* OEM Codepage DTF */ |
82 | #define CSET_ACP 0x0000F100UL /* Ansi Codepage DTF */ |
4eeb7d09 |
83 | |
84 | /* These are internal use overlapping with the UTF-16 surrogates */ |
36566009 |
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 */ |
4eeb7d09 |
90 | |
36566009 |
91 | #define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800) |
92 | #define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000) |
4eeb7d09 |
93 | |
36566009 |
94 | #define UCSERR (CSET_LINEDRW|'a') /* UCS Format error character. */ |
3c7366f8 |
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 |
4eeb7d09 |
104 | |
cecb13f6 |
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 |
36566009 |
114 | #define ATTR_FGSHIFT 0 |
cecb13f6 |
115 | #define ATTR_BGSHIFT 9 |
36566009 |
116 | |
cecb13f6 |
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 | */ |
4eeb7d09 |
135 | |
cecb13f6 |
136 | #define ATTR_DEFFG (256 << ATTR_FGSHIFT) |
137 | #define ATTR_DEFBG (258 << ATTR_BGSHIFT) |
138 | #define ATTR_DEFAULT (ATTR_DEFFG | ATTR_DEFBG) |
374330e2 |
139 | |
0b4f0bc0 |
140 | struct sesslist { |
141 | int nsessions; |
142 | char **sessions; |
143 | char *buffer; /* so memory can be freed later */ |
144 | }; |
1709795f |
145 | |
21d2b241 |
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 | }; |
4eeb7d09 |
158 | |
32874aea |
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 */ |
00db133f |
164 | #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */ |
165 | #define LGTYP_PACKETS 3 /* logmode: SSH data packets */ |
bf8a49a1 |
166 | #define LGTYP_SSHRAW 4 /* logmode: SSH raw data */ |
5fd04f07 |
167 | |
374330e2 |
168 | typedef enum { |
6f2d0cde |
169 | /* Actual special commands. Originally Telnet, but some codes have |
170 | * been re-used for similar specials in other protocols. */ |
374330e2 |
171 | TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT, |
a5f3e637 |
172 | TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING, |
6f2d0cde |
173 | TS_EOL, |
4423d5c7 |
174 | /* Special command for SSH. */ |
175 | TS_REKEY, |
6f2d0cde |
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 */ |
374330e2 |
184 | } Telnet_Special; |
185 | |
125105d1 |
186 | struct telnet_special { |
6f2d0cde |
187 | const char *name; |
125105d1 |
188 | int code; |
189 | }; |
190 | |
374330e2 |
191 | typedef enum { |
01c034ad |
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 */ |
374330e2 |
196 | } Mouse_Button; |
197 | |
198 | typedef enum { |
199 | MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE |
200 | } Mouse_Action; |
201 | |
6c50d421 |
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 | |
5ecd7ad0 |
243 | enum { |
4eeb7d09 |
244 | VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE |
5ecd7ad0 |
245 | }; |
374330e2 |
246 | |
0965bee0 |
247 | enum { |
248 | /* |
83e7d008 |
249 | * SSH-2 key exchange algorithms |
250 | */ |
251 | KEX_WARN, |
252 | KEX_DHGROUP1, |
253 | KEX_DHGROUP14, |
254 | KEX_DHGEX, |
fae1a71b |
255 | KEX_RSA, |
83e7d008 |
256 | KEX_MAX |
257 | }; |
258 | |
259 | enum { |
260 | /* |
2e85c969 |
261 | * SSH ciphers (both SSH-1 and SSH-2) |
ca20bfcf |
262 | */ |
263 | CIPHER_WARN, /* pseudo 'cipher' */ |
264 | CIPHER_3DES, |
265 | CIPHER_BLOWFISH, |
2e85c969 |
266 | CIPHER_AES, /* (SSH-2 only) */ |
7f1ae1d2 |
267 | CIPHER_DES, |
a2add208 |
268 | CIPHER_ARCFOUR, |
ca20bfcf |
269 | CIPHER_MAX /* no. ciphers (inc warn) */ |
270 | }; |
271 | |
272 | enum { |
273 | /* |
5ecd7ad0 |
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. |
0965bee0 |
281 | */ |
5ecd7ad0 |
282 | FORCE_ON, FORCE_OFF, AUTO |
283 | }; |
284 | |
285 | enum { |
286 | /* |
287 | * Proxy types. |
288 | */ |
10068a0b |
289 | PROXY_NONE, PROXY_SOCKS4, PROXY_SOCKS5, |
290 | PROXY_HTTP, PROXY_TELNET, PROXY_CMD |
0965bee0 |
291 | }; |
292 | |
293 | enum { |
294 | /* |
295 | * Line discipline options which the backend might try to control. |
296 | */ |
32874aea |
297 | LD_EDIT, /* local line editing */ |
298 | LD_ECHO /* local echo */ |
0965bee0 |
299 | }; |
300 | |
b41069ff |
301 | enum { |
e65096f2 |
302 | /* Actions on remote window title query */ |
303 | TITLE_NONE, TITLE_EMPTY, TITLE_REAL |
304 | }; |
305 | |
306 | enum { |
5ecd7ad0 |
307 | /* Protocol back ends. (cfg.protocol) */ |
7374c779 |
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 |
5ecd7ad0 |
312 | }; |
313 | |
314 | enum { |
315 | /* Bell settings (cfg.beep) */ |
85f6b361 |
316 | BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER |
5ecd7ad0 |
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 |
b41069ff |
327 | }; |
328 | |
6c50d421 |
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 | |
17c7fed1 |
339 | enum { |
340 | FQ_DEFAULT, FQ_ANTIALIASED, FQ_NONANTIALIASED, FQ_CLEARTYPE |
341 | }; |
342 | |
7374c779 |
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 | |
c6ccd5c2 |
351 | extern const char *const ttymodes[]; |
352 | |
05581745 |
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 | |
1709795f |
363 | struct backend_tag { |
cbe2d68f |
364 | const char *(*init) (void *frontend_handle, void **backend_handle, |
365 | Config *cfg, |
79bf227b |
366 | char *host, int port, char **realhost, int nodelay, |
367 | int keepalive); |
fabd1805 |
368 | void (*free) (void *handle); |
86916870 |
369 | /* back->reconfig() passes in a replacement configuration. */ |
370 | void (*reconfig) (void *handle, Config *cfg); |
5471d09a |
371 | /* back->send() returns the current amount of buffered data. */ |
51470298 |
372 | int (*send) (void *handle, char *buf, int len); |
5471d09a |
373 | /* back->sendbuffer() does the same thing but without attempting a send */ |
51470298 |
374 | int (*sendbuffer) (void *handle); |
375 | void (*size) (void *handle, int width, int height); |
376 | void (*special) (void *handle, Telnet_Special code); |
125105d1 |
377 | const struct telnet_special *(*get_specials) (void *handle); |
6226c939 |
378 | int (*connected) (void *handle); |
51470298 |
379 | int (*exitcode) (void *handle); |
a52e493d |
380 | /* If back->sendok() returns FALSE, data sent to it from the frontend |
381 | * may be lost. */ |
51470298 |
382 | int (*sendok) (void *handle); |
383 | int (*ldisc) (void *handle, int); |
b9d7bcad |
384 | void (*provide_ldisc) (void *handle, void *ldisc); |
a8327734 |
385 | void (*provide_logctx) (void *handle, void *logctx); |
5471d09a |
386 | /* |
387 | * back->unthrottle() tells the back end that the front end |
388 | * buffer is clearing. |
389 | */ |
51470298 |
390 | void (*unthrottle) (void *handle, int); |
f89c3294 |
391 | int (*cfg_info) (void *handle); |
9e164d82 |
392 | char *name; |
393 | int protocol; |
97db3be4 |
394 | int default_port; |
1709795f |
395 | }; |
374330e2 |
396 | |
9e164d82 |
397 | extern Backend *backends[]; |
89ee5268 |
398 | |
ffa79828 |
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 | |
5ecd7ad0 |
405 | /* |
47e4e735 |
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 | /* |
5ecd7ad0 |
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 | */ |
f7f27309 |
419 | struct config_tag { |
374330e2 |
420 | /* Basic options */ |
421 | char host[512]; |
422 | int port; |
5ecd7ad0 |
423 | int protocol; |
05581745 |
424 | int addressfamily; |
374330e2 |
425 | int close_on_exit; |
9ef49106 |
426 | int warn_on_close; |
32874aea |
427 | int ping_interval; /* in seconds */ |
2184a5d9 |
428 | int tcp_nodelay; |
79bf227b |
429 | int tcp_keepalives; |
8eebd221 |
430 | /* Proxy options */ |
431 | char proxy_exclude_list[512]; |
5ecd7ad0 |
432 | int proxy_dns; |
b804e1e5 |
433 | int even_proxy_localhost; |
5ecd7ad0 |
434 | int proxy_type; |
8eebd221 |
435 | char proxy_host[512]; |
436 | int proxy_port; |
f33ba69e |
437 | char proxy_username[128]; |
438 | char proxy_password[128]; |
8eebd221 |
439 | char proxy_telnet_command[512]; |
fef97f43 |
440 | /* SSH options */ |
6abbf9e3 |
441 | char remote_cmd[512]; |
32874aea |
442 | char *remote_cmd_ptr; /* might point to a larger command |
443 | * but never for loading/saving */ |
fd5e5847 |
444 | char *remote_cmd_ptr2; /* might point to a larger command |
445 | * but never for loading/saving */ |
fef97f43 |
446 | int nopty; |
4ba9b64b |
447 | int compression; |
83e7d008 |
448 | int ssh_kexlist[KEX_MAX]; |
d57f70af |
449 | int ssh_rekey_time; /* in minutes */ |
450 | char ssh_rekey_data[16]; |
973612f5 |
451 | int tryagent; |
979310f1 |
452 | int agentfwd; |
2e85c969 |
453 | int change_username; /* allow username switching in SSH-2 */ |
ca20bfcf |
454 | int ssh_cipherlist[CIPHER_MAX]; |
9a30e26b |
455 | Filename keyfile; |
32874aea |
456 | int sshprot; /* use v1 or v2 when both available */ |
2e85c969 |
457 | int ssh2_des_cbc; /* "des-cbc" unrecommended SSH-2 cipher */ |
a1a1fae4 |
458 | int ssh_no_userauth; /* bypass "ssh-userauth" (SSH-2 only) */ |
ccbfb941 |
459 | int try_tis_auth; |
f091e308 |
460 | int try_ki_auth; |
4a8fc3c4 |
461 | int ssh_subsys; /* run a subsystem rather than a command */ |
d0e498aa |
462 | int ssh_subsys2; /* fallback to go with remote_cmd_ptr2 */ |
0ed48730 |
463 | int ssh_no_shell; /* avoid running a shell */ |
feb02b4e |
464 | char ssh_nc_host[512]; /* host to connect to in `nc' mode */ |
465 | int ssh_nc_port; /* port to connect to in `nc' mode */ |
374330e2 |
466 | /* Telnet options */ |
467 | char termtype[32]; |
468 | char termspeed[32]; |
c6ccd5c2 |
469 | char ttymodes[768]; /* MODE\tVvalue\0MODE\tA\0\0 */ |
32874aea |
470 | char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */ |
277fc55e |
471 | char username[100]; |
472 | char localusername[100]; |
374330e2 |
473 | int rfc_environ; |
8faa456c |
474 | int passive_telnet; |
7374c779 |
475 | /* Serial port options */ |
476 | char serline[256]; |
477 | int serspeed; |
478 | int serdatabits, serstopbits; |
479 | int serparity; |
480 | int serflow; |
374330e2 |
481 | /* Keyboard options */ |
482 | int bksp_is_delete; |
483 | int rxvt_homeend; |
c9def1b8 |
484 | int funky_type; |
32874aea |
485 | int no_applic_c; /* totally disable app cursor keys */ |
486 | int no_applic_k; /* totally disable app keypad */ |
c0d36a72 |
487 | int no_mouse_rep; /* totally disable mouse reporting */ |
0d2086c5 |
488 | int no_remote_resize; /* disable remote resizing */ |
489 | int no_alt_screen; /* disable alternate screen */ |
490 | int no_remote_wintitle; /* disable remote retitling */ |
491 | int no_dbackspace; /* disable destructive backspace */ |
492 | int no_remote_charset; /* disable remote charset config */ |
e65096f2 |
493 | int remote_qtitle_action; /* remote win title query action */ |
374330e2 |
494 | int app_cursor; |
495 | int app_keypad; |
c5e9c988 |
496 | int nethack_keypad; |
a5f3e637 |
497 | int telnet_keyboard; |
eee63b77 |
498 | int telnet_newline; |
c5e9c988 |
499 | int alt_f4; /* is it special? */ |
500 | int alt_space; /* is it special? */ |
a094ae43 |
501 | int alt_only; /* is it special? */ |
0965bee0 |
502 | int localecho; |
503 | int localedit; |
e95edc00 |
504 | int alwaysontop; |
8f57d753 |
505 | int fullscreenonaltenter; |
c9def1b8 |
506 | int scroll_on_key; |
a094ae43 |
507 | int scroll_on_disp; |
876e5d5e |
508 | int erase_to_scrollback; |
a094ae43 |
509 | int compose_key; |
95bbe1ae |
510 | int ctrlaltkeys; |
32874aea |
511 | char wintitle[256]; /* initial window title */ |
374330e2 |
512 | /* Terminal options */ |
513 | int savelines; |
514 | int dec_om; |
515 | int wrap_mode; |
fef97f43 |
516 | int lfhascr; |
4e30ff69 |
517 | int cursor_type; /* 0=block 1=underline 2=vertical */ |
c9def1b8 |
518 | int blink_cur; |
5ecd7ad0 |
519 | int beep; |
520 | int beep_ind; |
156686ef |
521 | int bellovl; /* bell overload protection active? */ |
522 | int bellovl_n; /* number of bells to cause overload */ |
523 | int bellovl_t; /* time interval for overload (seconds) */ |
524 | int bellovl_s; /* period of silence to re-enable bell (s) */ |
9a30e26b |
525 | Filename bell_wavefile; |
c9def1b8 |
526 | int scrollbar; |
a401e5f3 |
527 | int scrollbar_in_fullscreen; |
5ecd7ad0 |
528 | int resize_action; |
c9def1b8 |
529 | int bce; |
530 | int blinktext; |
374330e2 |
531 | int win_name_always; |
532 | int width, height; |
9a30e26b |
533 | FontSpec font; |
17c7fed1 |
534 | int font_quality; |
9a30e26b |
535 | Filename logfilename; |
e1c8e0ed |
536 | int logtype; |
9f89f96e |
537 | int logxfovr; |
6d60c791 |
538 | int logflush; |
9a10ecf4 |
539 | int logomitpass; |
540 | int logomitdata; |
554c540d |
541 | int hide_mouseptr; |
57d08f2f |
542 | int sunken_edge; |
5a73255e |
543 | int window_border; |
e7fbcdd8 |
544 | char answerback[256]; |
b44b307a |
545 | char printer[128]; |
f0fccd51 |
546 | int arabicshaping; |
547 | int bidi; |
374330e2 |
548 | /* Colour options */ |
c6f1b8ed |
549 | int ansi_colour; |
cecb13f6 |
550 | int xterm_256_colour; |
26d1da7b |
551 | int system_colour; |
374330e2 |
552 | int try_palette; |
553 | int bold_colour; |
554 | unsigned char colours[22][3]; |
555 | /* Selection options */ |
556 | int mouse_is_xterm; |
6908fed7 |
557 | int rect_select; |
d3a22f79 |
558 | int rawcnp; |
a7419ea4 |
559 | int rtf_paste; |
b90840c3 |
560 | int mouse_override; |
374330e2 |
561 | short wordness[256]; |
c9def1b8 |
562 | /* translations */ |
5ecd7ad0 |
563 | int vtmode; |
8bb92a1c |
564 | char line_codepage[128]; |
74790953 |
565 | int cjk_ambig_wide; |
6ac7f054 |
566 | int utf8_override; |
a9c02454 |
567 | int xlat_capslockcyr; |
9c964e85 |
568 | /* X11 forwarding */ |
569 | int x11_forward; |
570 | char x11_display[128]; |
b3ebaa28 |
571 | int x11_auth; |
d74d141c |
572 | /* port forwarding */ |
beefa433 |
573 | int lport_acceptall; /* accept conns from hosts other than localhost */ |
2e85c969 |
574 | int rport_acceptall; /* same for remote forwarded ports (SSH-2 only) */ |
820ebe3b |
575 | /* |
576 | * The port forwarding string contains a number of |
577 | * NUL-terminated substrings, terminated in turn by an empty |
578 | * string (i.e. a second NUL immediately after the previous |
579 | * one). Each string can be of one of the following forms: |
580 | * |
581 | * [LR]localport\thost:port |
582 | * [LR]localaddr:localport\thost:port |
583 | * Dlocalport |
584 | * Dlocaladdr:localport |
585 | */ |
586 | char portfwd[1024]; |
2c9c6388 |
587 | /* SSH bug compatibility modes */ |
5ecd7ad0 |
588 | int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1, |
8e975795 |
589 | sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2, |
f382c87d |
590 | sshbug_pksessid2, sshbug_rekey2; |
9b53e9b8 |
591 | /* |
592 | * ssh_simple means that we promise never to open any channel other |
593 | * than the main one, which means it can safely use a very large |
594 | * window in SSH-2. |
595 | */ |
596 | int ssh_simple; |
c8ee61b9 |
597 | /* Options for pterm. Should split out into platform-dependent part. */ |
598 | int stamp_utmp; |
599 | int login_shell; |
239b3b36 |
600 | int scrollbar_on_left; |
bf133a73 |
601 | int shadowbold; |
9a30e26b |
602 | FontSpec boldfont; |
603 | FontSpec widefont; |
604 | FontSpec wideboldfont; |
12994a99 |
605 | int shadowboldoffset; |
7612f22f |
606 | int crhaslf; |
f7f27309 |
607 | }; |
374330e2 |
608 | |
e277c42d |
609 | /* |
4017be6d |
610 | * Some global flags denoting the type of application. |
67779be7 |
611 | * |
612 | * FLAG_VERBOSE is set when the user requests verbose details. |
613 | * |
614 | * FLAG_STDERR is set in command-line applications (which have a |
615 | * functioning stderr that it makes sense to write to) and not in |
616 | * GUI applications (which don't). |
617 | * |
618 | * FLAG_INTERACTIVE is set when a full interactive shell session is |
619 | * being run, _either_ because no remote command has been provided |
620 | * _or_ because the application is GUI and can't run non- |
621 | * interactively. |
0b4f0bc0 |
622 | * |
623 | * These flags describe the type of _application_ - they wouldn't |
624 | * vary between individual sessions - and so it's OK to have this |
625 | * variable be GLOBAL. |
c44bf5bd |
626 | * |
627 | * Note that additional flags may be defined in platform-specific |
628 | * headers. It's probably best if those ones start from 0x1000, to |
629 | * avoid collision. |
4017be6d |
630 | */ |
67779be7 |
631 | #define FLAG_VERBOSE 0x0001 |
632 | #define FLAG_STDERR 0x0002 |
633 | #define FLAG_INTERACTIVE 0x0004 |
4017be6d |
634 | GLOBAL int flags; |
635 | |
0b4f0bc0 |
636 | /* |
637 | * Likewise, these two variables are set up when the application |
638 | * initialises, and inform all default-settings accesses after |
639 | * that. |
640 | */ |
e277c42d |
641 | GLOBAL int default_protocol; |
642 | GLOBAL int default_port; |
374330e2 |
643 | |
18e62ad8 |
644 | /* |
645 | * This is set TRUE by cmdline.c iff a session is loaded with "-load". |
646 | */ |
647 | GLOBAL int loaded_session; |
648 | |
4e23b276 |
649 | struct RSAKey; /* be a little careful of scope */ |
650 | |
374330e2 |
651 | /* |
edd0cb8a |
652 | * Mechanism for getting text strings such as usernames and passwords |
653 | * from the front-end. |
654 | * The fields are mostly modelled after SSH's keyboard-interactive auth. |
655 | * FIXME We should probably mandate a character set/encoding (probably UTF-8). |
656 | * |
657 | * Since many of the pieces of text involved may be chosen by the server, |
658 | * the caller must take care to ensure that the server can't spoof locally- |
659 | * generated prompts such as key passphrase prompts. Some ground rules: |
660 | * - If the front-end needs to truncate a string, it should lop off the |
661 | * end. |
662 | * - The front-end should filter out any dangerous characters and |
663 | * generally not trust the strings. (But \n is required to behave |
664 | * vaguely sensibly, at least in `instruction', and ideally in |
665 | * `prompt[]' too.) |
666 | */ |
667 | typedef struct { |
668 | char *prompt; |
669 | int echo; |
670 | char *result; /* allocated/freed by caller */ |
671 | size_t result_len; |
672 | } prompt_t; |
673 | typedef struct { |
674 | /* |
675 | * Indicates whether the information entered is to be used locally |
676 | * (for instance a key passphrase prompt), or is destined for the wire. |
677 | * This is a hint only; the front-end is at liberty not to use this |
678 | * information (so the caller should ensure that the supplied text is |
679 | * sufficient). |
680 | */ |
681 | int to_server; |
682 | char *name; /* Short description, perhaps for dialog box title */ |
683 | int name_reqd; /* Display of `name' required or optional? */ |
684 | char *instruction; /* Long description, maybe with embedded newlines */ |
685 | int instr_reqd; /* Display of `instruction' required or optional? */ |
686 | size_t n_prompts; |
687 | prompt_t **prompts; |
688 | void *frontend; |
689 | void *data; /* slot for housekeeping data, managed by |
690 | * get_userpass_input(); initially NULL */ |
691 | } prompts_t; |
692 | prompts_t *new_prompts(void *frontend); |
693 | void add_prompt(prompts_t *p, char *promptstr, int echo, size_t len); |
694 | /* Burn the evidence. (Assumes _all_ strings want free()ing.) */ |
695 | void free_prompts(prompts_t *p); |
696 | |
697 | /* |
5b152cce |
698 | * Exports from the front end. |
374330e2 |
699 | */ |
a8327734 |
700 | void request_resize(void *frontend, int, int); |
36566009 |
701 | void do_text(Context, int, int, wchar_t *, int, unsigned long, int); |
702 | void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int); |
2102eb8a |
703 | int char_width(Context ctx, int uc); |
37d2a505 |
704 | #ifdef OPTIMISE_SCROLL |
341eb978 |
705 | void do_scroll(Context, int, int, int); |
37d2a505 |
706 | #endif |
a8327734 |
707 | void set_title(void *frontend, char *); |
708 | void set_icon(void *frontend, char *); |
709 | void set_sbar(void *frontend, int, int, int); |
710 | Context get_ctx(void *frontend); |
32874aea |
711 | void free_ctx(Context); |
a8327734 |
712 | void palette_set(void *frontend, int, int, int, int); |
713 | void palette_reset(void *frontend); |
714 | void write_aclip(void *frontend, char *, int, int); |
c83c79bd |
715 | void write_clip(void *frontend, wchar_t *, int *, int, int); |
a8327734 |
716 | void get_clip(void *frontend, wchar_t **, int *); |
717 | void optimised_move(void *frontend, int, int, int); |
718 | void set_raw_mouse_mode(void *frontend, int); |
a8327734 |
719 | void connection_fatal(void *frontend, char *, ...); |
32874aea |
720 | void fatalbox(char *, ...); |
1709795f |
721 | void modalfatalbox(char *, ...); |
4b599b6d |
722 | #ifdef macintosh |
723 | #pragma noreturn(fatalbox) |
724 | #pragma noreturn(modalfatalbox) |
725 | #endif |
860a34f8 |
726 | void do_beep(void *frontend, int); |
a8327734 |
727 | void begin_session(void *frontend); |
728 | void sys_cursor(void *frontend, int x, int y); |
729 | void request_paste(void *frontend); |
b9d7bcad |
730 | void frontend_keypress(void *frontend); |
731 | void ldisc_update(void *frontend, int echo, int edit); |
533b1743 |
732 | /* It's the backend's responsibility to invoke this at the start of a |
733 | * connection, if necessary; it can also invoke it later if the set of |
734 | * special commands changes. It does not need to invoke it at session |
735 | * shutdown. */ |
125105d1 |
736 | void update_specials_menu(void *frontend); |
fbf6cb3b |
737 | int from_backend(void *frontend, int is_stderr, const char *data, int len); |
edd0cb8a |
738 | int from_backend_untrusted(void *frontend, const char *data, int len); |
39934deb |
739 | void notify_remote_exit(void *frontend); |
c6ccd5c2 |
740 | /* Get a sensible value for a tty mode. NULL return = don't set. |
741 | * Otherwise, returned value should be freed by caller. */ |
742 | char *get_ttymode(void *frontend, const char *mode); |
edd0cb8a |
743 | /* |
744 | * >0 = `got all results, carry on' |
745 | * 0 = `user cancelled' (FIXME distinguish "give up entirely" and "next auth"?) |
746 | * <0 = `please call back later with more in/inlen' |
747 | */ |
748 | int get_userpass_input(prompts_t *p, unsigned char *in, int inlen); |
374330e2 |
749 | #define OPTIMISE_IS_SCROLL 1 |
750 | |
a8327734 |
751 | void set_iconic(void *frontend, int iconic); |
752 | void move_window(void *frontend, int x, int y); |
753 | void set_zorder(void *frontend, int top); |
754 | void refresh_window(void *frontend); |
755 | void set_zoomed(void *frontend, int zoomed); |
756 | int is_iconic(void *frontend); |
757 | void get_window_pos(void *frontend, int *x, int *y); |
758 | void get_window_pixels(void *frontend, int *x, int *y); |
759 | char *get_window_title(void *frontend, int icon); |
755e0524 |
760 | /* Hint from backend to frontend about time-consuming operations. |
761 | * Initial state is assumed to be BUSY_NOT. */ |
762 | enum { |
763 | BUSY_NOT, /* Not busy, all user interaction OK */ |
764 | BUSY_WAITING, /* Waiting for something; local event loops still running |
765 | so some local interaction (e.g. menus) OK, but network |
766 | stuff is suspended */ |
767 | BUSY_CPU /* Locally busy (e.g. crypto); user interaction suspended */ |
768 | }; |
769 | void set_busy_status(void *frontend, int status); |
68f9b3d9 |
770 | |
93b581bd |
771 | void cleanup_exit(int); |
772 | |
374330e2 |
773 | /* |
774 | * Exports from noise.c. |
775 | */ |
32874aea |
776 | void noise_get_heavy(void (*func) (void *, int)); |
777 | void noise_get_light(void (*func) (void *, int)); |
7d6ee6ff |
778 | void noise_regular(void); |
f7f27309 |
779 | void noise_ultralight(unsigned long data); |
374330e2 |
780 | void random_save_seed(void); |
de3df031 |
781 | void random_destroy_seed(void); |
374330e2 |
782 | |
783 | /* |
a9422f39 |
784 | * Exports from settings.c. |
785 | */ |
9e164d82 |
786 | Backend *backend_from_name(const char *name); |
787 | Backend *backend_from_proto(int proto); |
47b5a6ae |
788 | char *save_settings(char *section, Config * cfg); |
789 | void save_open_settings(void *sesskey, Config *cfg); |
790 | void load_settings(char *section, Config * cfg); |
791 | void load_open_settings(void *sesskey, Config *cfg); |
0b4f0bc0 |
792 | void get_sesslist(struct sesslist *, int allocate); |
1709795f |
793 | void do_defaults(char *, Config *); |
794 | void registry_cleanup(void); |
a9422f39 |
795 | |
796 | /* |
5a9eb105 |
797 | * Functions used by settings.c to provide platform-specific |
798 | * default settings. |
799 | * |
800 | * (The integer one is expected to return `def' if it has no clear |
801 | * opinion of its own. This is because there's no integer value |
802 | * which I can reliably set aside to indicate `nil'. The string |
9a30e26b |
803 | * function is perfectly all right returning NULL, of course. The |
804 | * Filename and FontSpec functions are _not allowed_ to fail to |
805 | * return, since these defaults _must_ be per-platform.) |
5a9eb105 |
806 | */ |
c85623f9 |
807 | char *platform_default_s(const char *name); |
808 | int platform_default_i(const char *name, int def); |
9a30e26b |
809 | Filename platform_default_filename(const char *name); |
810 | FontSpec platform_default_fontspec(const char *name); |
5a9eb105 |
811 | |
812 | /* |
374330e2 |
813 | * Exports from terminal.c. |
814 | */ |
815 | |
21d2b241 |
816 | Terminal *term_init(Config *, struct unicode_data *, void *); |
fabd1805 |
817 | void term_free(Terminal *); |
887035a5 |
818 | void term_size(Terminal *, int, int, int); |
c1b55581 |
819 | void term_paint(Terminal *, Context, int, int, int, int, int); |
887035a5 |
820 | void term_scroll(Terminal *, int, int); |
900f9aca |
821 | void term_pwron(Terminal *, int); |
887035a5 |
822 | void term_clrsb(Terminal *); |
fc5b0934 |
823 | void term_mouse(Terminal *, Mouse_Button, Mouse_Button, Mouse_Action, |
824 | int,int,int,int,int); |
6c50d421 |
825 | void term_key(Terminal *, Key_Sym, wchar_t *, size_t, unsigned int, |
826 | unsigned int); |
887035a5 |
827 | void term_deselect(Terminal *); |
828 | void term_update(Terminal *); |
829 | void term_invalidate(Terminal *); |
830 | void term_blink(Terminal *, int set_cursor); |
831 | void term_do_paste(Terminal *); |
832 | int term_paste_pending(Terminal *); |
833 | void term_paste(Terminal *); |
834 | void term_nopaste(Terminal *); |
835 | int term_ldisc(Terminal *, int option); |
836 | void term_copyall(Terminal *); |
64734920 |
837 | void term_reconfig(Terminal *, Config *); |
887035a5 |
838 | void term_seen_key_event(Terminal *); |
fbf6cb3b |
839 | int term_data(Terminal *, int is_stderr, const char *data, int len); |
edd0cb8a |
840 | int term_data_untrusted(Terminal *, const char *data, int len); |
51470298 |
841 | void term_provide_resize_fn(Terminal *term, |
842 | void (*resize_fn)(void *, int, int), |
843 | void *resize_ctx); |
a8327734 |
844 | void term_provide_logctx(Terminal *term, void *logctx); |
1cff1320 |
845 | void term_set_focus(Terminal *term, int has_focus); |
c6ccd5c2 |
846 | char *term_get_ttymode(Terminal *term, const char *mode); |
edd0cb8a |
847 | int term_get_userpass_input(Terminal *term, prompts_t *p, |
848 | unsigned char *in, int inlen); |
374330e2 |
849 | |
850 | /* |
00db133f |
851 | * Exports from logging.c. |
852 | */ |
c229ef97 |
853 | void *log_init(void *frontend, Config *cfg); |
fabd1805 |
854 | void log_free(void *logctx); |
c229ef97 |
855 | void log_reconfig(void *logctx, Config *cfg); |
a8327734 |
856 | void logfopen(void *logctx); |
857 | void logfclose(void *logctx); |
858 | void logtraffic(void *logctx, unsigned char c, int logmode); |
11cc5e30 |
859 | void logflush(void *logctx); |
cbe2d68f |
860 | void log_eventlog(void *logctx, const char *string); |
00db133f |
861 | enum { PKT_INCOMING, PKT_OUTGOING }; |
9a10ecf4 |
862 | enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT }; |
863 | struct logblank_t { |
864 | int offset; |
865 | int len; |
866 | int type; |
867 | }; |
a8327734 |
868 | void log_packet(void *logctx, int direction, int type, |
9a10ecf4 |
869 | char *texttype, void *data, int len, |
870 | int n_blanks, const struct logblank_t *blanks); |
00db133f |
871 | |
872 | /* |
d082ac49 |
873 | * Exports from testback.c |
874 | */ |
875 | |
876 | extern Backend null_backend; |
877 | extern Backend loop_backend; |
878 | |
879 | /* |
5e1a8e27 |
880 | * Exports from raw.c. |
881 | */ |
882 | |
3d9a14c9 |
883 | extern Backend raw_backend; |
5e1a8e27 |
884 | |
885 | /* |
c91409da |
886 | * Exports from rlogin.c. |
887 | */ |
888 | |
889 | extern Backend rlogin_backend; |
890 | |
891 | /* |
374330e2 |
892 | * Exports from telnet.c. |
893 | */ |
894 | |
c14776e8 |
895 | extern Backend telnet_backend; |
374330e2 |
896 | |
897 | /* |
edd0cb8a |
898 | * Exports from ssh.c. |
374330e2 |
899 | */ |
c14776e8 |
900 | extern Backend ssh_backend; |
374330e2 |
901 | |
902 | /* |
5bc238bb |
903 | * Exports from ldisc.c. |
904 | */ |
fe5634f6 |
905 | void *ldisc_create(Config *, Terminal *, Backend *, void *, void *); |
fabd1805 |
906 | void ldisc_free(void *); |
b9d7bcad |
907 | void ldisc_send(void *handle, char *buf, int len, int interactive); |
5bc238bb |
908 | |
909 | /* |
5def7522 |
910 | * Exports from ldiscucs.c. |
911 | */ |
912 | void lpage_send(void *, int codepage, char *buf, int len, int interactive); |
913 | void luni_send(void *, wchar_t * widebuf, int len, int interactive); |
914 | |
915 | /* |
374330e2 |
916 | * Exports from sshrand.c. |
917 | */ |
918 | |
919 | void random_add_noise(void *noise, int length); |
374330e2 |
920 | int random_byte(void); |
921 | void random_get_savedata(void **data, int *len); |
93b581bd |
922 | extern int random_active; |
5d17ccfc |
923 | /* The random number subsystem is activated if at least one other entity |
924 | * within the program expresses an interest in it. So each SSH session |
925 | * calls random_ref on startup and random_unref on shutdown. */ |
926 | void random_ref(void); |
927 | void random_unref(void); |
374330e2 |
928 | |
929 | /* |
39934deb |
930 | * Exports from pinger.c. |
931 | */ |
932 | typedef struct pinger_tag *Pinger; |
933 | Pinger pinger_new(Config *cfg, Backend *back, void *backhandle); |
934 | void pinger_reconfig(Pinger, Config *oldcfg, Config *newcfg); |
935 | void pinger_free(Pinger); |
936 | |
937 | /* |
374330e2 |
938 | * Exports from misc.c. |
939 | */ |
940 | |
db9c0f86 |
941 | #include "misc.h" |
7374c779 |
942 | int cfg_launchable(const Config *cfg); |
943 | char const *cfg_dest(const Config *cfg); |
944 | |
945 | /* |
946 | * Exports from sercfg.c. |
947 | */ |
7eb76ebc |
948 | void ser_setup_config_box(struct controlbox *b, int midsession, |
949 | int parity_mask, int flow_mask); |
374330e2 |
950 | |
951 | /* |
067a15ea |
952 | * Exports from version.c. |
953 | */ |
954 | extern char ver[]; |
955 | |
956 | /* |
4eeb7d09 |
957 | * Exports from unicode.c. |
14963b8f |
958 | */ |
4eeb7d09 |
959 | #ifndef CP_UTF8 |
960 | #define CP_UTF8 65001 |
961 | #endif |
facd762c |
962 | /* void init_ucs(void); -- this is now in platform-specific headers */ |
5def7522 |
963 | int is_dbcs_leadbyte(int codepage, char byte); |
964 | int mb_to_wc(int codepage, int flags, char *mbstr, int mblen, |
965 | wchar_t *wcstr, int wclen); |
966 | int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen, |
21d2b241 |
967 | char *mbstr, int mblen, char *defchr, int *defused, |
968 | struct unicode_data *ucsdata); |
a9c02454 |
969 | wchar_t xlat_uskbd2cyrllic(int ch); |
4eeb7d09 |
970 | int check_compose(int first, int second); |
971 | int decode_codepage(char *cp_name); |
d4413bd2 |
972 | const char *cp_enumerate (int index); |
973 | const char *cp_name(int codepage); |
a7419ea4 |
974 | void get_unitab(int codepage, wchar_t * unitab, int ftype); |
14963b8f |
975 | |
976 | /* |
5f6fe27e |
977 | * Exports from wcwidth.c |
978 | */ |
94debd8c |
979 | int mk_wcwidth(wchar_t ucs); |
980 | int mk_wcswidth(const wchar_t *pwcs, size_t n); |
981 | int mk_wcwidth_cjk(wchar_t ucs); |
982 | int mk_wcswidth_cjk(const wchar_t *pwcs, size_t n); |
5f6fe27e |
983 | |
984 | /* |
8f203108 |
985 | * Exports from mscrypto.c |
986 | */ |
987 | #ifdef MSCRYPTOAPI |
988 | int crypto_startup(); |
989 | void crypto_wrapup(); |
990 | #endif |
991 | |
992 | /* |
839f10db |
993 | * Exports from pageantc.c. |
994 | * |
995 | * agent_query returns 1 for here's-a-response, and 0 for query-in- |
996 | * progress. In the latter case there will be a call to `callback' |
997 | * at some future point, passing callback_ctx as the first |
998 | * parameter and the actual reply data as the second and third. |
999 | * |
1000 | * The response may be a NULL pointer (in either of the synchronous |
1001 | * or asynchronous cases), which indicates failure to receive a |
1002 | * response. |
5c58ad2d |
1003 | */ |
839f10db |
1004 | int agent_query(void *in, int inlen, void **out, int *outlen, |
1005 | void (*callback)(void *, void *, int), void *callback_ctx); |
5c58ad2d |
1006 | int agent_exists(void); |
1007 | |
4eb24e3a |
1008 | /* |
1009 | * Exports from wildcard.c |
1010 | */ |
1011 | const char *wc_error(int value); |
1012 | int wc_match(const char *wildcard, const char *target); |
1013 | int wc_unescape(char *output, const char *wildcard); |
374330e2 |
1014 | |
ff2ae367 |
1015 | /* |
2285d016 |
1016 | * Exports from frontend (windlg.c etc) |
1709795f |
1017 | */ |
cbe2d68f |
1018 | void logevent(void *frontend, const char *); |
2285d016 |
1019 | void pgp_fingerprints(void); |
3d9449a1 |
1020 | /* |
1021 | * verify_ssh_host_key() can return one of three values: |
1022 | * |
1023 | * - +1 means `key was OK' (either already known or the user just |
1024 | * approved it) `so continue with the connection' |
1025 | * |
1026 | * - 0 means `key was not OK, abandon the connection' |
1027 | * |
1028 | * - -1 means `I've initiated enquiries, please wait to be called |
1029 | * back via the provided function with a result that's either 0 |
1030 | * or +1'. |
1031 | */ |
1032 | int verify_ssh_host_key(void *frontend, char *host, int port, char *keytype, |
1033 | char *keystr, char *fingerprint, |
1034 | void (*callback)(void *ctx, int result), void *ctx); |
1035 | /* |
1036 | * askalg has the same set of return values as verify_ssh_host_key. |
1037 | */ |
1038 | int askalg(void *frontend, const char *algtype, const char *algname, |
1039 | void (*callback)(void *ctx, int result), void *ctx); |
919baedb |
1040 | /* |
1041 | * askappend can return four values: |
1042 | * |
1043 | * - 2 means overwrite the log file |
1044 | * - 1 means append to the log file |
1045 | * - 0 means cancel logging for this session |
1046 | * - -1 means please wait. |
1047 | */ |
1048 | int askappend(void *frontend, Filename filename, |
1049 | void (*callback)(void *ctx, int result), void *ctx); |
1709795f |
1050 | |
1051 | /* |
edd0cb8a |
1052 | * Exports from console frontends (wincons.c, uxcons.c) |
1053 | * that aren't equivalents to things in windlg.c et al. |
ff2ae367 |
1054 | */ |
1055 | extern int console_batch_mode; |
edd0cb8a |
1056 | int console_get_userpass_input(prompts_t *p, unsigned char *in, int inlen); |
d3fef4a5 |
1057 | void console_provide_logctx(void *logctx); |
47a6b94c |
1058 | int is_interactive(void); |
ff2ae367 |
1059 | |
b44b307a |
1060 | /* |
1061 | * Exports from printing.c. |
1062 | */ |
1063 | typedef struct printer_enum_tag printer_enum; |
1064 | typedef struct printer_job_tag printer_job; |
1065 | printer_enum *printer_start_enum(int *nprinters); |
1066 | char *printer_get_name(printer_enum *, int); |
1067 | void printer_finish_enum(printer_enum *); |
1068 | printer_job *printer_start_job(char *printer); |
1069 | void printer_job_data(printer_job *, void *, int); |
1070 | void printer_finish_job(printer_job *); |
1071 | |
c0a81592 |
1072 | /* |
1073 | * Exports from cmdline.c (and also cmdline_error(), which is |
1074 | * defined differently in various places and required _by_ |
1075 | * cmdline.c). |
1076 | */ |
5555d393 |
1077 | int cmdline_process_param(char *, char *, int, Config *); |
1078 | void cmdline_run_saved(Config *); |
679539d7 |
1079 | void cmdline_cleanup(void); |
edd0cb8a |
1080 | int cmdline_get_passwd_input(prompts_t *p, unsigned char *in, int inlen); |
c0a81592 |
1081 | #define TOOLTYPE_FILETRANSFER 1 |
46a3419b |
1082 | #define TOOLTYPE_NONNETWORK 2 |
c0a81592 |
1083 | extern int cmdline_tooltype; |
1084 | |
1085 | void cmdline_error(char *, ...); |
1086 | |
e0e7dff8 |
1087 | /* |
d1582b2e |
1088 | * Exports from config.c. |
1089 | */ |
1a602f03 |
1090 | struct controlbox; |
12745e35 |
1091 | void setup_config_box(struct controlbox *b, int midsession, |
1092 | int protocol, int protcfginfo); |
d1582b2e |
1093 | |
1094 | /* |
f0fccd51 |
1095 | * Exports from minibidi.c. |
1096 | */ |
1097 | typedef struct bidi_char { |
1098 | wchar_t origwc, wc; |
1099 | unsigned short index; |
1100 | } bidi_char; |
1101 | int do_bidi(bidi_char *line, int count); |
1102 | int do_shape(bidi_char *line, bidi_char *to, int count); |
fe75e503 |
1103 | int is_rtl(int c); |
f0fccd51 |
1104 | |
1105 | /* |
e0e7dff8 |
1106 | * X11 auth mechanisms we know about. |
1107 | */ |
1108 | enum { |
1109 | X11_NO_AUTH, |
1110 | X11_MIT, /* MIT-MAGIC-COOKIE-1 */ |
2f92b717 |
1111 | X11_XDM, /* XDM-AUTHORIZATION-1 */ |
e0e7dff8 |
1112 | X11_NAUTHS |
1113 | }; |
1114 | extern const char *const x11_authnames[]; /* declared in x11fwd.c */ |
1115 | |
9a30e26b |
1116 | /* |
1117 | * Miscellaneous exports from the platform-specific code. |
1118 | */ |
9fab77dc |
1119 | Filename filename_from_str(const char *string); |
1120 | const char *filename_to_str(const Filename *fn); |
9a30e26b |
1121 | int filename_equal(Filename f1, Filename f2); |
1122 | int filename_is_null(Filename fn); |
799dfcfa |
1123 | char *get_username(void); /* return value needs freeing */ |
47a6b94c |
1124 | char *get_random_data(int bytes); /* used in cmdgen.c */ |
9a30e26b |
1125 | |
39934deb |
1126 | /* |
1127 | * Exports and imports from timing.c. |
1128 | * |
1129 | * schedule_timer() asks the front end to schedule a callback to a |
1130 | * timer function in a given number of ticks. The returned value is |
1131 | * the time (in ticks since an arbitrary offset) at which the |
1132 | * callback can be expected. This value will also be passed as the |
1133 | * `now' parameter to the callback function. Hence, you can (for |
1134 | * example) schedule an event at a particular time by calling |
1135 | * schedule_timer() and storing the return value in your context |
1136 | * structure as the time when that event is due. The first time a |
1137 | * callback function gives you that value or more as `now', you do |
1138 | * the thing. |
1139 | * |
1140 | * expire_timer_context() drops all current timers associated with |
1141 | * a given value of ctx (for when you're about to free ctx). |
1142 | * |
1143 | * run_timers() is called from the front end when it has reason to |
1144 | * think some timers have reached their moment, or when it simply |
1145 | * needs to know how long to wait next. We pass it the time we |
1146 | * think it is. It returns TRUE and places the time when the next |
1147 | * timer needs to go off in `next', or alternatively it returns |
1148 | * FALSE if there are no timers at all pending. |
1149 | * |
1150 | * timer_change_notify() must be supplied by the front end; it |
1151 | * notifies the front end that a new timer has been added to the |
1152 | * list which is sooner than any existing ones. It provides the |
1153 | * time when that timer needs to go off. |
4ce3729f |
1154 | * |
1155 | * *** FRONT END IMPLEMENTORS NOTE: |
1156 | * |
1157 | * There's an important subtlety in the front-end implementation of |
1158 | * the timer interface. When a front end is given a `next' value, |
1159 | * either returned from run_timers() or via timer_change_notify(), |
1160 | * it should ensure that it really passes _that value_ as the `now' |
1161 | * parameter to its next run_timers call. It should _not_ simply |
1162 | * call GETTICKCOUNT() to get the `now' parameter when invoking |
1163 | * run_timers(). |
1164 | * |
1165 | * The reason for this is that an OS's system clock might not agree |
1166 | * exactly with the timing mechanisms it supplies to wait for a |
1167 | * given interval. I'll illustrate this by the simple example of |
1168 | * Unix Plink, which uses timeouts to select() in a way which for |
1169 | * these purposes can simply be considered to be a wait() function. |
1170 | * Suppose, for the sake of argument, that this wait() function |
1171 | * tends to return early by 1%. Then a possible sequence of actions |
1172 | * is: |
1173 | * |
1174 | * - run_timers() tells the front end that the next timer firing |
1175 | * is 10000ms from now. |
1176 | * - Front end calls wait(10000ms), but according to |
1177 | * GETTICKCOUNT() it has only waited for 9900ms. |
1178 | * - Front end calls run_timers() again, passing time T-100ms as |
1179 | * `now'. |
1180 | * - run_timers() does nothing, and says the next timer firing is |
1181 | * still 100ms from now. |
1182 | * - Front end calls wait(100ms), which only waits for 99ms. |
1183 | * - Front end calls run_timers() yet again, passing time T-1ms. |
1184 | * - run_timers() says there's still 1ms to wait. |
1185 | * - Front end calls wait(1ms). |
1186 | * |
1187 | * If you're _lucky_ at this point, wait(1ms) will actually wait |
1188 | * for 1ms and you'll only have woken the program up three times. |
1189 | * If you're unlucky, wait(1ms) might do nothing at all due to |
1190 | * being below some minimum threshold, and you might find your |
1191 | * program spends the whole of the last millisecond tight-looping |
1192 | * between wait() and run_timers(). |
1193 | * |
1194 | * Instead, what you should do is to _save_ the precise `next' |
1195 | * value provided by run_timers() or via timer_change_notify(), and |
1196 | * use that precise value as the input to the next run_timers() |
1197 | * call. So: |
1198 | * |
1199 | * - run_timers() tells the front end that the next timer firing |
1200 | * is at time T, 10000ms from now. |
1201 | * - Front end calls wait(10000ms). |
1202 | * - Front end then immediately calls run_timers() and passes it |
1203 | * time T, without stopping to check GETTICKCOUNT() at all. |
1204 | * |
1205 | * This guarantees that the program wakes up only as many times as |
1206 | * there are actual timer actions to be taken, and that the timing |
1207 | * mechanism will never send it into a tight loop. |
1208 | * |
1209 | * (It does also mean that the timer action in the above example |
1210 | * will occur 100ms early, but this is not generally critical. And |
1211 | * the hypothetical 1% error in wait() will be partially corrected |
1212 | * for anyway when, _after_ run_timers() returns, you call |
1213 | * GETTICKCOUNT() and compare the result with the returned `next' |
1214 | * value to find out how long you have to make your next wait().) |
39934deb |
1215 | */ |
1216 | typedef void (*timer_fn_t)(void *ctx, long now); |
1217 | long schedule_timer(int ticks, timer_fn_t fn, void *ctx); |
1218 | void expire_timer_context(void *ctx); |
1219 | int run_timers(long now, long *next); |
1220 | void timer_change_notify(long next); |
1221 | |
374330e2 |
1222 | #endif |