4 #include <stddef.h> /* for wchar_t */
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.
12 #ifdef PUTTY_DO_GLOBALS
21 typedef struct config_tag Config
;
22 typedef struct backend_tag Backend
;
23 typedef struct terminal_tag Terminal
;
31 * Fingerprints of the PGP master keys that can be used to establish a trust
32 * path between an executable and other files.
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"
39 /* Three attribute types:
40 * The ATTRs (normal attributes) are stored with the characters in
41 * the main display arrays
43 * The TATTRs (temporary attributes) are generated on the fly, they
44 * can overlap with characters but not with normal attributes.
46 * The LATTRs (line attributes) are an entirely disjoint space of
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.
54 * ATTR_INVALID is an illegal colour combination.
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 */
62 #define DATTR_STARTRUN 0x80000000UL /* start of redraw run */
64 #define TDATTR_MASK 0xF0000000UL
65 #define TATTR_MASK (TDATTR_MASK)
66 #define DATTR_MASK (TDATTR_MASK)
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 */
78 #define ATTR_INVALID 0x03FFFFU
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 */
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 */
91 #define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800)
92 #define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000)
94 #define UCSERR (CSET_LINEDRW|'a') /* UCS Format error character. */
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).
103 #define UCSWIDE 0xDFFF
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
118 * The definitive list of colour numbers stored in terminal
119 * attribute words is kept here. It is:
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
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
136 #define ATTR_DEFFG (256 << ATTR_FGSHIFT)
137 #define ATTR_DEFBG (258 << ATTR_BGSHIFT)
138 #define ATTR_DEFAULT (ATTR_DEFFG | ATTR_DEFBG)
143 char *buffer
; /* so memory can be freed later */
146 struct unicode_data
{
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];
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 */
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
,
174 /* Special command for SSH. */
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 */
186 struct telnet_special
{
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 */
199 MA_NOTHING
, MA_CLICK
, MA_2CLK
, MA_3CLK
, MA_DRAG
, MA_RELEASE
202 /* Keyboard modifiers -- keys the user is actually holding down */
204 #define PKM_SHIFT 0x01
205 #define PKM_CONTROL 0x02
206 #define PKM_META 0x04
209 /* Keyboard flags that aren't really modifiers */
210 #define PKF_CAPSLOCK 0x10
211 #define PKF_NUMLOCK 0x20
212 #define PKF_REPEAT 0x40
214 /* Stand-alone keysyms for function keys */
217 PK_NULL
, /* No symbol for this key */
218 /* Main keypad keys */
219 PK_ESCAPE
, PK_TAB
, PK_BACKSPACE
, PK_RETURN
, PK_COMPOSE
,
221 PK_HOME
, PK_INSERT
, PK_DELETE
, PK_END
, PK_PAGEUP
, PK_PAGEDOWN
,
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 */
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
,
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)
244 VT_XWINDOWS
, VT_OEMANSI
, VT_OEMONLY
, VT_POORMAN
, VT_UNICODE
249 * SSH-2 key exchange algorithms
260 * SSH ciphers (both SSH-1 and SSH-2)
262 CIPHER_WARN
, /* pseudo 'cipher' */
265 CIPHER_AES
, /* (SSH-2 only) */
268 CIPHER_MAX
/* no. ciphers (inc warn) */
273 * Several different bits of the PuTTY configuration seem to be
274 * three-way settings whose values are `always yes', `always
275 * no', and `decide by some more complex automated means'. This
276 * is true of line discipline options (local echo and line
277 * editing), proxy DNS, Close On Exit, and SSH server bug
278 * workarounds. Accordingly I supply a single enum here to deal
281 FORCE_ON
, FORCE_OFF
, AUTO
288 PROXY_NONE
, PROXY_SOCKS4
, PROXY_SOCKS5
,
289 PROXY_HTTP
, PROXY_TELNET
, PROXY_CMD
294 * Line discipline options which the backend might try to control.
296 LD_EDIT
, /* local line editing */
297 LD_ECHO
/* local echo */
301 /* Actions on remote window title query */
302 TITLE_NONE
, TITLE_EMPTY
, TITLE_REAL
306 /* Protocol back ends. (cfg.protocol) */
307 PROT_RAW
, PROT_TELNET
, PROT_RLOGIN
, PROT_SSH
,
308 /* PROT_SERIAL is supported on a subset of platforms, but it doesn't
309 * hurt to define it globally. */
314 /* Bell settings (cfg.beep) */
315 BELL_DISABLED
, BELL_DEFAULT
, BELL_VISUAL
, BELL_WAVEFILE
, BELL_PCSPEAKER
319 /* Taskbar flashing indication on bell (cfg.beep_ind) */
320 B_IND_DISABLED
, B_IND_FLASH
, B_IND_STEADY
324 /* Resize actions (cfg.resize_action) */
325 RESIZE_TERM
, RESIZE_DISABLED
, RESIZE_FONT
, RESIZE_EITHER
329 /* Function key types (cfg.funky_type) */
339 FQ_DEFAULT
, FQ_ANTIALIASED
, FQ_NONANTIALIASED
, FQ_CLEARTYPE
343 SER_PAR_NONE
, SER_PAR_ODD
, SER_PAR_EVEN
, SER_PAR_MARK
, SER_PAR_SPACE
347 SER_FLOW_NONE
, SER_FLOW_XONXOFF
, SER_FLOW_RTSCTS
, SER_FLOW_DSRDTR
350 extern const char *const ttymodes
[];
354 * Network address types. Used for specifying choice of IPv4/v6
355 * in config; also used in proxy.c to indicate whether a given
356 * host name has already been resolved or will be resolved at
359 ADDRTYPE_UNSPEC
, ADDRTYPE_IPV4
, ADDRTYPE_IPV6
, ADDRTYPE_NAME
363 const char *(*init
) (void *frontend_handle
, void **backend_handle
,
365 char *host
, int port
, char **realhost
, int nodelay
,
367 void (*free
) (void *handle
);
368 /* back->reconfig() passes in a replacement configuration. */
369 void (*reconfig
) (void *handle
, Config
*cfg
);
370 /* back->send() returns the current amount of buffered data. */
371 int (*send
) (void *handle
, char *buf
, int len
);
372 /* back->sendbuffer() does the same thing but without attempting a send */
373 int (*sendbuffer
) (void *handle
);
374 void (*size
) (void *handle
, int width
, int height
);
375 void (*special
) (void *handle
, Telnet_Special code
);
376 const struct telnet_special
*(*get_specials
) (void *handle
);
377 int (*connected
) (void *handle
);
378 int (*exitcode
) (void *handle
);
379 /* If back->sendok() returns FALSE, data sent to it from the frontend
381 int (*sendok
) (void *handle
);
382 int (*ldisc
) (void *handle
, int);
383 void (*provide_ldisc
) (void *handle
, void *ldisc
);
384 void (*provide_logctx
) (void *handle
, void *logctx
);
386 * back->unthrottle() tells the back end that the front end
387 * buffer is clearing.
389 void (*unthrottle
) (void *handle
, int);
390 int (*cfg_info
) (void *handle
);
394 extern struct backend_list
{
401 * Suggested default protocol provided by the backend link module.
402 * The application is free to ignore this.
404 extern const int be_default_protocol
;
407 * Name of this particular application, for use in the config box
408 * and other pieces of text.
410 extern const char *const appname
;
413 * IMPORTANT POLICY POINT: everything in this structure which wants
414 * to be treated like an integer must be an actual, honest-to-
415 * goodness `int'. No enum-typed variables. This is because parts
416 * of the code will want to pass around `int *' pointers to them
417 * and we can't run the risk of porting to some system on which the
418 * enum comes out as a different size from int.
428 int ping_interval
; /* in seconds */
432 char proxy_exclude_list
[512];
434 int even_proxy_localhost
;
436 char proxy_host
[512];
438 char proxy_username
[128];
439 char proxy_password
[128];
440 char proxy_telnet_command
[512];
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 */
449 int ssh_kexlist
[KEX_MAX
];
450 int ssh_rekey_time
; /* in minutes */
451 char ssh_rekey_data
[16];
454 int change_username
; /* allow username switching in SSH-2 */
455 int ssh_cipherlist
[CIPHER_MAX
];
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) */
462 int ssh_subsys
; /* run a subsystem rather than a command */
463 int ssh_subsys2
; /* fallback to go with remote_cmd_ptr2 */
464 int ssh_no_shell
; /* avoid running a shell */
465 char ssh_nc_host
[512]; /* host to connect to in `nc' mode */
466 int ssh_nc_port
; /* port to connect to in `nc' mode */
470 char ttymodes
[768]; /* MODE\tVvalue\0MODE\tA\0\0 */
471 char environmt
[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
473 char localusername
[100];
476 /* Serial port options */
479 int serdatabits
, serstopbits
;
482 /* Keyboard options */
486 int no_applic_c
; /* totally disable app cursor keys */
487 int no_applic_k
; /* totally disable app keypad */
488 int no_mouse_rep
; /* totally disable mouse reporting */
489 int no_remote_resize
; /* disable remote resizing */
490 int no_alt_screen
; /* disable alternate screen */
491 int no_remote_wintitle
; /* disable remote retitling */
492 int no_dbackspace
; /* disable destructive backspace */
493 int no_remote_charset
; /* disable remote charset config */
494 int remote_qtitle_action
; /* remote win title query action */
500 int alt_f4
; /* is it special? */
501 int alt_space
; /* is it special? */
502 int alt_only
; /* is it special? */
506 int fullscreenonaltenter
;
509 int erase_to_scrollback
;
512 char wintitle
[256]; /* initial window title */
513 /* Terminal options */
518 int cursor_type
; /* 0=block 1=underline 2=vertical */
522 int bellovl
; /* bell overload protection active? */
523 int bellovl_n
; /* number of bells to cause overload */
524 int bellovl_t
; /* time interval for overload (seconds) */
525 int bellovl_s
; /* period of silence to re-enable bell (s) */
526 Filename bell_wavefile
;
528 int scrollbar_in_fullscreen
;
536 Filename logfilename
;
545 char answerback
[256];
551 int xterm_256_colour
;
555 unsigned char colours
[22][3];
556 /* Selection options */
565 char line_codepage
[128];
568 int xlat_capslockcyr
;
571 char x11_display
[128];
573 /* port forwarding */
574 int lport_acceptall
; /* accept conns from hosts other than localhost */
575 int rport_acceptall
; /* same for remote forwarded ports (SSH-2 only) */
577 * The port forwarding string contains a number of
578 * NUL-terminated substrings, terminated in turn by an empty
579 * string (i.e. a second NUL immediately after the previous
580 * one). Each string can be of one of the following forms:
582 * [LR]localport\thost:port
583 * [LR]localaddr:localport\thost:port
585 * Dlocaladdr:localport
588 /* SSH bug compatibility modes */
589 int sshbug_ignore1
, sshbug_plainpw1
, sshbug_rsa1
,
590 sshbug_hmac2
, sshbug_derivekey2
, sshbug_rsapad2
,
591 sshbug_pksessid2
, sshbug_rekey2
;
592 /* Options for pterm. Should split out into platform-dependent part. */
595 int scrollbar_on_left
;
599 FontSpec wideboldfont
;
600 int shadowboldoffset
;
604 * Some global flags denoting the type of application.
606 * FLAG_VERBOSE is set when the user requests verbose details.
608 * FLAG_STDERR is set in command-line applications (which have a
609 * functioning stderr that it makes sense to write to) and not in
610 * GUI applications (which don't).
612 * FLAG_INTERACTIVE is set when a full interactive shell session is
613 * being run, _either_ because no remote command has been provided
614 * _or_ because the application is GUI and can't run non-
617 * These flags describe the type of _application_ - they wouldn't
618 * vary between individual sessions - and so it's OK to have this
619 * variable be GLOBAL.
621 * Note that additional flags may be defined in platform-specific
622 * headers. It's probably best if those ones start from 0x1000, to
625 #define FLAG_VERBOSE 0x0001
626 #define FLAG_STDERR 0x0002
627 #define FLAG_INTERACTIVE 0x0004
631 * Likewise, these two variables are set up when the application
632 * initialises, and inform all default-settings accesses after
635 GLOBAL
int default_protocol
;
636 GLOBAL
int default_port
;
639 * This is set TRUE by cmdline.c iff a session is loaded with "-load".
641 GLOBAL
int loaded_session
;
643 struct RSAKey
; /* be a little careful of scope */
646 * Mechanism for getting text strings such as usernames and passwords
647 * from the front-end.
648 * The fields are mostly modelled after SSH's keyboard-interactive auth.
649 * FIXME We should probably mandate a character set/encoding (probably UTF-8).
651 * Since many of the pieces of text involved may be chosen by the server,
652 * the caller must take care to ensure that the server can't spoof locally-
653 * generated prompts such as key passphrase prompts. Some ground rules:
654 * - If the front-end needs to truncate a string, it should lop off the
656 * - The front-end should filter out any dangerous characters and
657 * generally not trust the strings. (But \n is required to behave
658 * vaguely sensibly, at least in `instruction', and ideally in
664 char *result
; /* allocated/freed by caller */
669 * Indicates whether the information entered is to be used locally
670 * (for instance a key passphrase prompt), or is destined for the wire.
671 * This is a hint only; the front-end is at liberty not to use this
672 * information (so the caller should ensure that the supplied text is
676 char *name
; /* Short description, perhaps for dialog box title */
677 int name_reqd
; /* Display of `name' required or optional? */
678 char *instruction
; /* Long description, maybe with embedded newlines */
679 int instr_reqd
; /* Display of `instruction' required or optional? */
683 void *data
; /* slot for housekeeping data, managed by
684 * get_userpass_input(); initially NULL */
686 prompts_t
*new_prompts(void *frontend
);
687 void add_prompt(prompts_t
*p
, char *promptstr
, int echo
, size_t len
);
688 /* Burn the evidence. (Assumes _all_ strings want free()ing.) */
689 void free_prompts(prompts_t
*p
);
692 * Exports from the front end.
694 void request_resize(void *frontend
, int, int);
695 void do_text(Context
, int, int, wchar_t *, int, unsigned long, int);
696 void do_cursor(Context
, int, int, wchar_t *, int, unsigned long, int);
697 int char_width(Context ctx
, int uc
);
698 #ifdef OPTIMISE_SCROLL
699 void do_scroll(Context
, int, int, int);
701 void set_title(void *frontend
, char *);
702 void set_icon(void *frontend
, char *);
703 void set_sbar(void *frontend
, int, int, int);
704 Context
get_ctx(void *frontend
);
705 void free_ctx(Context
);
706 void palette_set(void *frontend
, int, int, int, int);
707 void palette_reset(void *frontend
);
708 void write_aclip(void *frontend
, char *, int, int);
709 void write_clip(void *frontend
, wchar_t *, int *, int, int);
710 void get_clip(void *frontend
, wchar_t **, int *);
711 void optimised_move(void *frontend
, int, int, int);
712 void set_raw_mouse_mode(void *frontend
, int);
713 void connection_fatal(void *frontend
, char *, ...);
714 void fatalbox(char *, ...);
715 void modalfatalbox(char *, ...);
717 #pragma noreturn(fatalbox)
718 #pragma noreturn(modalfatalbox)
720 void do_beep(void *frontend
, int);
721 void begin_session(void *frontend
);
722 void sys_cursor(void *frontend
, int x
, int y
);
723 void request_paste(void *frontend
);
724 void frontend_keypress(void *frontend
);
725 void ldisc_update(void *frontend
, int echo
, int edit
);
726 /* It's the backend's responsibility to invoke this at the start of a
727 * connection, if necessary; it can also invoke it later if the set of
728 * special commands changes. It does not need to invoke it at session
730 void update_specials_menu(void *frontend
);
731 int from_backend(void *frontend
, int is_stderr
, const char *data
, int len
);
732 int from_backend_untrusted(void *frontend
, const char *data
, int len
);
733 void notify_remote_exit(void *frontend
);
734 /* Get a sensible value for a tty mode. NULL return = don't set.
735 * Otherwise, returned value should be freed by caller. */
736 char *get_ttymode(void *frontend
, const char *mode
);
738 * >0 = `got all results, carry on'
739 * 0 = `user cancelled' (FIXME distinguish "give up entirely" and "next auth"?)
740 * <0 = `please call back later with more in/inlen'
742 int get_userpass_input(prompts_t
*p
, unsigned char *in
, int inlen
);
743 #define OPTIMISE_IS_SCROLL 1
745 void set_iconic(void *frontend
, int iconic
);
746 void move_window(void *frontend
, int x
, int y
);
747 void set_zorder(void *frontend
, int top
);
748 void refresh_window(void *frontend
);
749 void set_zoomed(void *frontend
, int zoomed
);
750 int is_iconic(void *frontend
);
751 void get_window_pos(void *frontend
, int *x
, int *y
);
752 void get_window_pixels(void *frontend
, int *x
, int *y
);
753 char *get_window_title(void *frontend
, int icon
);
754 /* Hint from backend to frontend about time-consuming operations.
755 * Initial state is assumed to be BUSY_NOT. */
757 BUSY_NOT
, /* Not busy, all user interaction OK */
758 BUSY_WAITING
, /* Waiting for something; local event loops still running
759 so some local interaction (e.g. menus) OK, but network
760 stuff is suspended */
761 BUSY_CPU
/* Locally busy (e.g. crypto); user interaction suspended */
763 void set_busy_status(void *frontend
, int status
);
765 void cleanup_exit(int);
768 * Exports from noise.c.
770 void noise_get_heavy(void (*func
) (void *, int));
771 void noise_get_light(void (*func
) (void *, int));
772 void noise_regular(void);
773 void noise_ultralight(unsigned long data
);
774 void random_save_seed(void);
775 void random_destroy_seed(void);
778 * Exports from settings.c.
780 char *save_settings(char *section
, int do_host
, Config
* cfg
);
781 void save_open_settings(void *sesskey
, int do_host
, Config
*cfg
);
782 void load_settings(char *section
, int do_host
, Config
* cfg
);
783 void load_open_settings(void *sesskey
, int do_host
, Config
*cfg
);
784 void get_sesslist(struct sesslist
*, int allocate
);
785 void do_defaults(char *, Config
*);
786 void registry_cleanup(void);
789 * Functions used by settings.c to provide platform-specific
792 * (The integer one is expected to return `def' if it has no clear
793 * opinion of its own. This is because there's no integer value
794 * which I can reliably set aside to indicate `nil'. The string
795 * function is perfectly all right returning NULL, of course. The
796 * Filename and FontSpec functions are _not allowed_ to fail to
797 * return, since these defaults _must_ be per-platform.)
799 char *platform_default_s(const char *name
);
800 int platform_default_i(const char *name
, int def
);
801 Filename
platform_default_filename(const char *name
);
802 FontSpec
platform_default_fontspec(const char *name
);
805 * Exports from terminal.c.
808 Terminal
*term_init(Config
*, struct unicode_data
*, void *);
809 void term_free(Terminal
*);
810 void term_size(Terminal
*, int, int, int);
811 void term_paint(Terminal
*, Context
, int, int, int, int, int);
812 void term_scroll(Terminal
*, int, int);
813 void term_pwron(Terminal
*, int);
814 void term_clrsb(Terminal
*);
815 void term_mouse(Terminal
*, Mouse_Button
, Mouse_Button
, Mouse_Action
,
816 int,int,int,int,int);
817 void term_key(Terminal
*, Key_Sym
, wchar_t *, size_t, unsigned int,
819 void term_deselect(Terminal
*);
820 void term_update(Terminal
*);
821 void term_invalidate(Terminal
*);
822 void term_blink(Terminal
*, int set_cursor
);
823 void term_do_paste(Terminal
*);
824 int term_paste_pending(Terminal
*);
825 void term_paste(Terminal
*);
826 void term_nopaste(Terminal
*);
827 int term_ldisc(Terminal
*, int option
);
828 void term_copyall(Terminal
*);
829 void term_reconfig(Terminal
*, Config
*);
830 void term_seen_key_event(Terminal
*);
831 int term_data(Terminal
*, int is_stderr
, const char *data
, int len
);
832 int term_data_untrusted(Terminal
*, const char *data
, int len
);
833 void term_provide_resize_fn(Terminal
*term
,
834 void (*resize_fn
)(void *, int, int),
836 void term_provide_logctx(Terminal
*term
, void *logctx
);
837 void term_set_focus(Terminal
*term
, int has_focus
);
838 char *term_get_ttymode(Terminal
*term
, const char *mode
);
839 int term_get_userpass_input(Terminal
*term
, prompts_t
*p
,
840 unsigned char *in
, int inlen
);
843 * Exports from logging.c.
845 void *log_init(void *frontend
, Config
*cfg
);
846 void log_free(void *logctx
);
847 void log_reconfig(void *logctx
, Config
*cfg
);
848 void logfopen(void *logctx
);
849 void logfclose(void *logctx
);
850 void logtraffic(void *logctx
, unsigned char c
, int logmode
);
851 void logflush(void *logctx
);
852 void log_eventlog(void *logctx
, const char *string
);
853 enum { PKT_INCOMING
, PKT_OUTGOING
};
854 enum { PKTLOG_EMIT
, PKTLOG_BLANK
, PKTLOG_OMIT
};
860 void log_packet(void *logctx
, int direction
, int type
,
861 char *texttype
, void *data
, int len
,
862 int n_blanks
, const struct logblank_t
*blanks
);
865 * Exports from testback.c
868 extern Backend null_backend
;
869 extern Backend loop_backend
;
872 * Exports from raw.c.
875 extern Backend raw_backend
;
878 * Exports from rlogin.c.
881 extern Backend rlogin_backend
;
884 * Exports from telnet.c.
887 extern Backend telnet_backend
;
890 * Exports from ssh.c.
892 extern Backend ssh_backend
;
895 * Exports from ldisc.c.
897 void *ldisc_create(Config
*, Terminal
*, Backend
*, void *, void *);
898 void ldisc_free(void *);
899 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
);
902 * Exports from ldiscucs.c.
904 void lpage_send(void *, int codepage
, char *buf
, int len
, int interactive
);
905 void luni_send(void *, wchar_t * widebuf
, int len
, int interactive
);
908 * Exports from sshrand.c.
911 void random_add_noise(void *noise
, int length
);
912 int random_byte(void);
913 void random_get_savedata(void **data
, int *len
);
914 extern int random_active
;
915 /* The random number subsystem is activated if at least one other entity
916 * within the program expresses an interest in it. So each SSH session
917 * calls random_ref on startup and random_unref on shutdown. */
918 void random_ref(void);
919 void random_unref(void);
922 * Exports from pinger.c.
924 typedef struct pinger_tag
*Pinger
;
925 Pinger
pinger_new(Config
*cfg
, Backend
*back
, void *backhandle
);
926 void pinger_reconfig(Pinger
, Config
*oldcfg
, Config
*newcfg
);
927 void pinger_free(Pinger
);
930 * Exports from misc.c.
934 int cfg_launchable(const Config
*cfg
);
935 char const *cfg_dest(const Config
*cfg
);
938 * Exports from sercfg.c.
940 void ser_setup_config_box(struct controlbox
*b
, int midsession
,
941 int parity_mask
, int flow_mask
);
944 * Exports from version.c.
949 * Exports from unicode.c.
952 #define CP_UTF8 65001
954 /* void init_ucs(void); -- this is now in platform-specific headers */
955 int is_dbcs_leadbyte(int codepage
, char byte
);
956 int mb_to_wc(int codepage
, int flags
, char *mbstr
, int mblen
,
957 wchar_t *wcstr
, int wclen
);
958 int wc_to_mb(int codepage
, int flags
, wchar_t *wcstr
, int wclen
,
959 char *mbstr
, int mblen
, char *defchr
, int *defused
,
960 struct unicode_data
*ucsdata
);
961 wchar_t xlat_uskbd2cyrllic(int ch
);
962 int check_compose(int first
, int second
);
963 int decode_codepage(char *cp_name
);
964 const char *cp_enumerate (int index
);
965 const char *cp_name(int codepage
);
966 void get_unitab(int codepage
, wchar_t * unitab
, int ftype
);
969 * Exports from wcwidth.c
971 int mk_wcwidth(wchar_t ucs
);
972 int mk_wcswidth(const wchar_t *pwcs
, size_t n
);
973 int mk_wcwidth_cjk(wchar_t ucs
);
974 int mk_wcswidth_cjk(const wchar_t *pwcs
, size_t n
);
977 * Exports from mscrypto.c
980 int crypto_startup();
981 void crypto_wrapup();
985 * Exports from pageantc.c.
987 * agent_query returns 1 for here's-a-response, and 0 for query-in-
988 * progress. In the latter case there will be a call to `callback'
989 * at some future point, passing callback_ctx as the first
990 * parameter and the actual reply data as the second and third.
992 * The response may be a NULL pointer (in either of the synchronous
993 * or asynchronous cases), which indicates failure to receive a
996 int agent_query(void *in
, int inlen
, void **out
, int *outlen
,
997 void (*callback
)(void *, void *, int), void *callback_ctx
);
998 int agent_exists(void);
1001 * Exports from wildcard.c
1003 const char *wc_error(int value
);
1004 int wc_match(const char *wildcard
, const char *target
);
1005 int wc_unescape(char *output
, const char *wildcard
);
1008 * Exports from frontend (windlg.c etc)
1010 void logevent(void *frontend
, const char *);
1011 void pgp_fingerprints(void);
1013 * verify_ssh_host_key() can return one of three values:
1015 * - +1 means `key was OK' (either already known or the user just
1016 * approved it) `so continue with the connection'
1018 * - 0 means `key was not OK, abandon the connection'
1020 * - -1 means `I've initiated enquiries, please wait to be called
1021 * back via the provided function with a result that's either 0
1024 int verify_ssh_host_key(void *frontend
, char *host
, int port
, char *keytype
,
1025 char *keystr
, char *fingerprint
,
1026 void (*callback
)(void *ctx
, int result
), void *ctx
);
1028 * askalg has the same set of return values as verify_ssh_host_key.
1030 int askalg(void *frontend
, const char *algtype
, const char *algname
,
1031 void (*callback
)(void *ctx
, int result
), void *ctx
);
1033 * askappend can return four values:
1035 * - 2 means overwrite the log file
1036 * - 1 means append to the log file
1037 * - 0 means cancel logging for this session
1038 * - -1 means please wait.
1040 int askappend(void *frontend
, Filename filename
,
1041 void (*callback
)(void *ctx
, int result
), void *ctx
);
1044 * Exports from console frontends (wincons.c, uxcons.c)
1045 * that aren't equivalents to things in windlg.c et al.
1047 extern int console_batch_mode
;
1048 int console_get_userpass_input(prompts_t
*p
, unsigned char *in
, int inlen
);
1049 void console_provide_logctx(void *logctx
);
1050 int is_interactive(void);
1053 * Exports from printing.c.
1055 typedef struct printer_enum_tag printer_enum
;
1056 typedef struct printer_job_tag printer_job
;
1057 printer_enum
*printer_start_enum(int *nprinters
);
1058 char *printer_get_name(printer_enum
*, int);
1059 void printer_finish_enum(printer_enum
*);
1060 printer_job
*printer_start_job(char *printer
);
1061 void printer_job_data(printer_job
*, void *, int);
1062 void printer_finish_job(printer_job
*);
1065 * Exports from cmdline.c (and also cmdline_error(), which is
1066 * defined differently in various places and required _by_
1069 int cmdline_process_param(char *, char *, int, Config
*);
1070 void cmdline_run_saved(Config
*);
1071 void cmdline_cleanup(void);
1072 int cmdline_get_passwd_input(prompts_t
*p
, unsigned char *in
, int inlen
);
1073 #define TOOLTYPE_FILETRANSFER 1
1074 #define TOOLTYPE_NONNETWORK 2
1075 extern int cmdline_tooltype
;
1077 void cmdline_error(char *, ...);
1080 * Exports from config.c.
1083 void setup_config_box(struct controlbox
*b
, int midsession
,
1084 int protocol
, int protcfginfo
);
1087 * Exports from minibidi.c.
1089 typedef struct bidi_char
{
1091 unsigned short index
;
1093 int do_bidi(bidi_char
*line
, int count
);
1094 int do_shape(bidi_char
*line
, bidi_char
*to
, int count
);
1098 * X11 auth mechanisms we know about.
1102 X11_MIT
, /* MIT-MAGIC-COOKIE-1 */
1103 X11_XDM
, /* XDM-AUTHORIZATION-1 */
1106 extern const char *const x11_authnames
[]; /* declared in x11fwd.c */
1109 * Miscellaneous exports from the platform-specific code.
1111 Filename
filename_from_str(const char *string
);
1112 const char *filename_to_str(const Filename
*fn
);
1113 int filename_equal(Filename f1
, Filename f2
);
1114 int filename_is_null(Filename fn
);
1115 char *get_username(void); /* return value needs freeing */
1116 char *get_random_data(int bytes
); /* used in cmdgen.c */
1119 * Exports and imports from timing.c.
1121 * schedule_timer() asks the front end to schedule a callback to a
1122 * timer function in a given number of ticks. The returned value is
1123 * the time (in ticks since an arbitrary offset) at which the
1124 * callback can be expected. This value will also be passed as the
1125 * `now' parameter to the callback function. Hence, you can (for
1126 * example) schedule an event at a particular time by calling
1127 * schedule_timer() and storing the return value in your context
1128 * structure as the time when that event is due. The first time a
1129 * callback function gives you that value or more as `now', you do
1132 * expire_timer_context() drops all current timers associated with
1133 * a given value of ctx (for when you're about to free ctx).
1135 * run_timers() is called from the front end when it has reason to
1136 * think some timers have reached their moment, or when it simply
1137 * needs to know how long to wait next. We pass it the time we
1138 * think it is. It returns TRUE and places the time when the next
1139 * timer needs to go off in `next', or alternatively it returns
1140 * FALSE if there are no timers at all pending.
1142 * timer_change_notify() must be supplied by the front end; it
1143 * notifies the front end that a new timer has been added to the
1144 * list which is sooner than any existing ones. It provides the
1145 * time when that timer needs to go off.
1147 * *** FRONT END IMPLEMENTORS NOTE:
1149 * There's an important subtlety in the front-end implementation of
1150 * the timer interface. When a front end is given a `next' value,
1151 * either returned from run_timers() or via timer_change_notify(),
1152 * it should ensure that it really passes _that value_ as the `now'
1153 * parameter to its next run_timers call. It should _not_ simply
1154 * call GETTICKCOUNT() to get the `now' parameter when invoking
1157 * The reason for this is that an OS's system clock might not agree
1158 * exactly with the timing mechanisms it supplies to wait for a
1159 * given interval. I'll illustrate this by the simple example of
1160 * Unix Plink, which uses timeouts to select() in a way which for
1161 * these purposes can simply be considered to be a wait() function.
1162 * Suppose, for the sake of argument, that this wait() function
1163 * tends to return early by 1%. Then a possible sequence of actions
1166 * - run_timers() tells the front end that the next timer firing
1167 * is 10000ms from now.
1168 * - Front end calls wait(10000ms), but according to
1169 * GETTICKCOUNT() it has only waited for 9900ms.
1170 * - Front end calls run_timers() again, passing time T-100ms as
1172 * - run_timers() does nothing, and says the next timer firing is
1173 * still 100ms from now.
1174 * - Front end calls wait(100ms), which only waits for 99ms.
1175 * - Front end calls run_timers() yet again, passing time T-1ms.
1176 * - run_timers() says there's still 1ms to wait.
1177 * - Front end calls wait(1ms).
1179 * If you're _lucky_ at this point, wait(1ms) will actually wait
1180 * for 1ms and you'll only have woken the program up three times.
1181 * If you're unlucky, wait(1ms) might do nothing at all due to
1182 * being below some minimum threshold, and you might find your
1183 * program spends the whole of the last millisecond tight-looping
1184 * between wait() and run_timers().
1186 * Instead, what you should do is to _save_ the precise `next'
1187 * value provided by run_timers() or via timer_change_notify(), and
1188 * use that precise value as the input to the next run_timers()
1191 * - run_timers() tells the front end that the next timer firing
1192 * is at time T, 10000ms from now.
1193 * - Front end calls wait(10000ms).
1194 * - Front end then immediately calls run_timers() and passes it
1195 * time T, without stopping to check GETTICKCOUNT() at all.
1197 * This guarantees that the program wakes up only as many times as
1198 * there are actual timer actions to be taken, and that the timing
1199 * mechanism will never send it into a tight loop.
1201 * (It does also mean that the timer action in the above example
1202 * will occur 100ms early, but this is not generally critical. And
1203 * the hypothetical 1% error in wait() will be partially corrected
1204 * for anyway when, _after_ run_timers() returns, you call
1205 * GETTICKCOUNT() and compare the result with the returned `next'
1206 * value to find out how long you have to make your next wait().)
1208 typedef void (*timer_fn_t
)(void *ctx
, long now
);
1209 long schedule_timer(int ticks
, timer_fn_t fn
, void *ctx
);
1210 void expire_timer_context(void *ctx
);
1211 int run_timers(long now
, long *next
);
1212 void timer_change_notify(long next
);