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
74 #define LATTR_WRAPPED2 0x00000020UL
76 #define ATTR_INVALID 0x03FFFFU
78 /* Like Linux use the F000 page for direct to font. */
79 #define CSET_OEMCP 0x0000F000UL /* OEM Codepage DTF */
80 #define CSET_ACP 0x0000F100UL /* Ansi Codepage DTF */
82 /* These are internal use overlapping with the UTF-16 surrogates */
83 #define CSET_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
84 #define CSET_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
85 #define CSET_SCOACS 0x0000DA00UL /* SCO Alternate charset */
86 #define CSET_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
87 #define CSET_MASK 0xFFFFFF00UL /* Character set mask */
89 #define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800)
90 #define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000)
92 #define UCSERR (CSET_LINEDRW|'a') /* UCS Format error character. */
94 * UCSWIDE is a special value used in the terminal data to signify
95 * the character cell containing the right-hand half of a CJK wide
96 * character. We use 0xDFFF because it's part of the surrogate
97 * range and hence won't be used for anything else (it's impossible
98 * to input it via UTF-8 because our UTF-8 decoder correctly
99 * rejects surrogates).
101 #define UCSWIDE 0xDFFF
103 #define ATTR_NARROW 0x800000U
104 #define ATTR_WIDE 0x400000U
105 #define ATTR_BOLD 0x040000U
106 #define ATTR_UNDER 0x080000U
107 #define ATTR_REVERSE 0x100000U
108 #define ATTR_BLINK 0x200000U
109 #define ATTR_FGMASK 0x0001FFU
110 #define ATTR_BGMASK 0x03FE00U
111 #define ATTR_COLOURS 0x03FFFFU
112 #define ATTR_FGSHIFT 0
113 #define ATTR_BGSHIFT 9
116 * The definitive list of colour numbers stored in terminal
117 * attribute words is kept here. It is:
119 * - 0-7 are ANSI colours (KRGYBMCW).
120 * - 8-15 are the bold versions of those colours.
121 * - 16-255 are the remains of the xterm 256-colour mode (a
122 * 216-colour cube with R at most significant and B at least,
123 * followed by a uniform series of grey shades running between
124 * black and white but not including either on grounds of
126 * - 256 is default foreground
127 * - 257 is default bold foreground
128 * - 258 is default background
129 * - 259 is default bold background
130 * - 260 is cursor foreground
131 * - 261 is cursor background
134 #define ATTR_DEFFG (256 << ATTR_FGSHIFT)
135 #define ATTR_DEFBG (258 << ATTR_BGSHIFT)
136 #define ATTR_DEFAULT (ATTR_DEFFG | ATTR_DEFBG)
141 char *buffer
; /* so memory can be freed later */
144 struct unicode_data
{
149 wchar_t unitab_scoacs
[256];
150 wchar_t unitab_line
[256];
151 wchar_t unitab_font
[256];
152 wchar_t unitab_xterm
[256];
153 wchar_t unitab_oemcp
[256];
154 unsigned char unitab_ctrl
[256];
157 #define LGXF_OVR 1 /* existing logfile overwrite */
158 #define LGXF_APN 0 /* existing logfile append */
159 #define LGXF_ASK -1 /* existing logfile ask */
160 #define LGTYP_NONE 0 /* logmode: no logging */
161 #define LGTYP_ASCII 1 /* logmode: pure ascii */
162 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
163 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
166 /* Actual special commands. Originally Telnet, but some codes have
167 * been re-used for similar specials in other protocols. */
168 TS_AYT
, TS_BRK
, TS_SYNCH
, TS_EC
, TS_EL
, TS_GA
, TS_NOP
, TS_ABORT
,
169 TS_AO
, TS_IP
, TS_SUSP
, TS_EOR
, TS_EOF
, TS_LECHO
, TS_RECHO
, TS_PING
,
171 /* Special command for SSH. */
173 /* POSIX-style signals. (not Telnet) */
174 TS_SIGABRT
, TS_SIGALRM
, TS_SIGFPE
, TS_SIGHUP
, TS_SIGILL
,
175 TS_SIGINT
, TS_SIGKILL
, TS_SIGPIPE
, TS_SIGQUIT
, TS_SIGSEGV
,
176 TS_SIGTERM
, TS_SIGUSR1
, TS_SIGUSR2
,
177 /* Pseudo-specials used for constructing the specials menu. */
178 TS_SEP
, /* Separator */
179 TS_SUBMENU
, /* Start a new submenu with specified name */
180 TS_EXITMENU
/* Exit current submenu or end of specials */
183 struct telnet_special
{
190 MBT_LEFT
, MBT_MIDDLE
, MBT_RIGHT
, /* `raw' button designations */
191 MBT_SELECT
, MBT_EXTEND
, MBT_PASTE
, /* `cooked' button designations */
192 MBT_WHEEL_UP
, MBT_WHEEL_DOWN
/* mouse wheel */
196 MA_NOTHING
, MA_CLICK
, MA_2CLK
, MA_3CLK
, MA_DRAG
, MA_RELEASE
199 /* Keyboard modifiers -- keys the user is actually holding down */
201 #define PKM_SHIFT 0x01
202 #define PKM_CONTROL 0x02
203 #define PKM_META 0x04
206 /* Keyboard flags that aren't really modifiers */
207 #define PKF_CAPSLOCK 0x10
208 #define PKF_NUMLOCK 0x20
209 #define PKF_REPEAT 0x40
211 /* Stand-alone keysyms for function keys */
214 PK_NULL
, /* No symbol for this key */
215 /* Main keypad keys */
216 PK_ESCAPE
, PK_TAB
, PK_BACKSPACE
, PK_RETURN
, PK_COMPOSE
,
218 PK_HOME
, PK_INSERT
, PK_DELETE
, PK_END
, PK_PAGEUP
, PK_PAGEDOWN
,
220 PK_UP
, PK_DOWN
, PK_RIGHT
, PK_LEFT
, PK_REST
,
221 /* Numeric keypad */ /* Real one looks like: */
222 PK_PF1
, PK_PF2
, PK_PF3
, PK_PF4
, /* PF1 PF2 PF3 PF4 */
223 PK_KPCOMMA
, PK_KPMINUS
, PK_KPDECIMAL
, /* 7 8 9 - */
224 PK_KP0
, PK_KP1
, PK_KP2
, PK_KP3
, PK_KP4
, /* 4 5 6 , */
225 PK_KP5
, PK_KP6
, PK_KP7
, PK_KP8
, PK_KP9
, /* 1 2 3 en- */
226 PK_KPBIGPLUS
, PK_KPENTER
, /* 0 . ter */
228 PK_F1
, PK_F2
, PK_F3
, PK_F4
, PK_F5
,
229 PK_F6
, PK_F7
, PK_F8
, PK_F9
, PK_F10
,
230 PK_F11
, PK_F12
, PK_F13
, PK_F14
, PK_F15
,
231 PK_F16
, PK_F17
, PK_F18
, PK_F19
, PK_F20
,
235 #define PK_ISEDITING(k) ((k) >= PK_HOME && (k) <= PK_PAGEDOWN)
236 #define PK_ISCURSOR(k) ((k) >= PK_UP && (k) <= PK_REST)
237 #define PK_ISKEYPAD(k) ((k) >= PK_PF1 && (k) <= PK_KPENTER)
238 #define PK_ISFKEY(k) ((k) >= PK_F1 && (k) <= PK_F20)
241 VT_XWINDOWS
, VT_OEMANSI
, VT_OEMONLY
, VT_POORMAN
, VT_UNICODE
246 * SSH-2 key exchange algorithms
257 * SSH ciphers (both SSH-1 and SSH-2)
259 CIPHER_WARN
, /* pseudo 'cipher' */
262 CIPHER_AES
, /* (SSH-2 only) */
265 CIPHER_MAX
/* no. ciphers (inc warn) */
270 * Several different bits of the PuTTY configuration seem to be
271 * three-way settings whose values are `always yes', `always
272 * no', and `decide by some more complex automated means'. This
273 * is true of line discipline options (local echo and line
274 * editing), proxy DNS, Close On Exit, and SSH server bug
275 * workarounds. Accordingly I supply a single enum here to deal
278 FORCE_ON
, FORCE_OFF
, AUTO
285 PROXY_NONE
, PROXY_SOCKS4
, PROXY_SOCKS5
,
286 PROXY_HTTP
, PROXY_TELNET
, PROXY_CMD
291 * Line discipline options which the backend might try to control.
293 LD_EDIT
, /* local line editing */
294 LD_ECHO
/* local echo */
298 /* Protocol back ends. (cfg.protocol) */
299 PROT_RAW
, PROT_TELNET
, PROT_RLOGIN
, PROT_SSH
303 /* Bell settings (cfg.beep) */
304 BELL_DISABLED
, BELL_DEFAULT
, BELL_VISUAL
, BELL_WAVEFILE
, BELL_PCSPEAKER
308 /* Taskbar flashing indication on bell (cfg.beep_ind) */
309 B_IND_DISABLED
, B_IND_FLASH
, B_IND_STEADY
313 /* Resize actions (cfg.resize_action) */
314 RESIZE_TERM
, RESIZE_DISABLED
, RESIZE_FONT
, RESIZE_EITHER
318 /* Function key types (cfg.funky_type) */
329 * Network address types. Used for specifying choice of IPv4/v6
330 * in config; also used in proxy.c to indicate whether a given
331 * host name has already been resolved or will be resolved at
334 ADDRTYPE_UNSPEC
, ADDRTYPE_IPV4
, ADDRTYPE_IPV6
, ADDRTYPE_NAME
338 const char *(*init
) (void *frontend_handle
, void **backend_handle
,
340 char *host
, int port
, char **realhost
, int nodelay
,
342 void (*free
) (void *handle
);
343 /* back->reconfig() passes in a replacement configuration. */
344 void (*reconfig
) (void *handle
, Config
*cfg
);
345 /* back->send() returns the current amount of buffered data. */
346 int (*send
) (void *handle
, char *buf
, int len
);
347 /* back->sendbuffer() does the same thing but without attempting a send */
348 int (*sendbuffer
) (void *handle
);
349 void (*size
) (void *handle
, int width
, int height
);
350 void (*special
) (void *handle
, Telnet_Special code
);
351 const struct telnet_special
*(*get_specials
) (void *handle
);
352 Socket(*socket
) (void *handle
);
353 int (*exitcode
) (void *handle
);
354 int (*sendok
) (void *handle
);
355 int (*ldisc
) (void *handle
, int);
356 void (*provide_ldisc
) (void *handle
, void *ldisc
);
357 void (*provide_logctx
) (void *handle
, void *logctx
);
359 * back->unthrottle() tells the back end that the front end
360 * buffer is clearing.
362 void (*unthrottle
) (void *handle
, int);
363 int (*cfg_info
) (void *handle
);
367 extern struct backend_list
{
374 * Suggested default protocol provided by the backend link module.
375 * The application is free to ignore this.
377 extern const int be_default_protocol
;
380 * Name of this particular application, for use in the config box
381 * and other pieces of text.
383 extern const char *const appname
;
386 * IMPORTANT POLICY POINT: everything in this structure which wants
387 * to be treated like an integer must be an actual, honest-to-
388 * goodness `int'. No enum-typed variables. This is because parts
389 * of the code will want to pass around `int *' pointers to them
390 * and we can't run the risk of porting to some system on which the
391 * enum comes out as a different size from int.
401 int ping_interval
; /* in seconds */
405 char proxy_exclude_list
[512];
407 int even_proxy_localhost
;
409 char proxy_host
[512];
411 char proxy_username
[128];
412 char proxy_password
[128];
413 char proxy_telnet_command
[512];
415 char remote_cmd
[512];
416 char remote_cmd2
[512]; /* fallback if the first fails
417 * (used internally for scp) */
418 char *remote_cmd_ptr
; /* might point to a larger command
419 * but never for loading/saving */
420 char *remote_cmd_ptr2
; /* might point to a larger command
421 * but never for loading/saving */
424 int ssh_kexlist
[KEX_MAX
];
425 int ssh_rekey_time
; /* in minutes */
426 char ssh_rekey_data
[16];
428 int change_username
; /* allow username switching in SSH-2 */
429 int ssh_cipherlist
[CIPHER_MAX
];
431 int sshprot
; /* use v1 or v2 when both available */
432 int ssh2_des_cbc
; /* "des-cbc" unrecommended SSH-2 cipher */
435 int ssh_subsys
; /* run a subsystem rather than a command */
436 int ssh_subsys2
; /* fallback to go with remote_cmd2 */
437 int ssh_no_shell
; /* avoid running a shell */
441 char environmt
[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
443 char localusername
[100];
446 /* Keyboard options */
450 int no_applic_c
; /* totally disable app cursor keys */
451 int no_applic_k
; /* totally disable app keypad */
452 int no_mouse_rep
; /* totally disable mouse reporting */
453 int no_remote_resize
; /* disable remote resizing */
454 int no_alt_screen
; /* disable alternate screen */
455 int no_remote_wintitle
; /* disable remote retitling */
456 int no_dbackspace
; /* disable destructive backspace */
457 int no_remote_charset
; /* disable remote charset config */
458 int no_remote_qtitle
; /* disable remote win title query */
464 int alt_f4
; /* is it special? */
465 int alt_space
; /* is it special? */
466 int alt_only
; /* is it special? */
470 int fullscreenonaltenter
;
473 int erase_to_scrollback
;
476 char wintitle
[256]; /* initial window title */
477 /* Terminal options */
482 int cursor_type
; /* 0=block 1=underline 2=vertical */
486 int bellovl
; /* bell overload protection active? */
487 int bellovl_n
; /* number of bells to cause overload */
488 int bellovl_t
; /* time interval for overload (seconds) */
489 int bellovl_s
; /* period of silence to re-enable bell (s) */
490 Filename bell_wavefile
;
492 int scrollbar_in_fullscreen
;
499 Filename logfilename
;
508 char answerback
[256];
514 int xterm_256_colour
;
518 unsigned char colours
[22][3];
519 /* Selection options */
528 char line_codepage
[128];
531 int xlat_capslockcyr
;
534 char x11_display
[128];
536 /* port forwarding */
537 int lport_acceptall
; /* accept conns from hosts other than localhost */
538 int rport_acceptall
; /* same for remote forwarded ports (SSH-2 only) */
540 * The port forwarding string contains a number of
541 * NUL-terminated substrings, terminated in turn by an empty
542 * string (i.e. a second NUL immediately after the previous
543 * one). Each string can be of one of the following forms:
545 * [LR]localport\thost:port
546 * [LR]localaddr:localport\thost:port
548 * Dlocaladdr:localport
551 /* SSH bug compatibility modes */
552 int sshbug_ignore1
, sshbug_plainpw1
, sshbug_rsa1
,
553 sshbug_hmac2
, sshbug_derivekey2
, sshbug_rsapad2
,
554 sshbug_pksessid2
, sshbug_rekey2
;
555 /* Options for pterm. Should split out into platform-dependent part. */
558 int scrollbar_on_left
;
562 FontSpec wideboldfont
;
563 int shadowboldoffset
;
567 * Some global flags denoting the type of application.
569 * FLAG_VERBOSE is set when the user requests verbose details.
571 * FLAG_STDERR is set in command-line applications (which have a
572 * functioning stderr that it makes sense to write to) and not in
573 * GUI applications (which don't).
575 * FLAG_INTERACTIVE is set when a full interactive shell session is
576 * being run, _either_ because no remote command has been provided
577 * _or_ because the application is GUI and can't run non-
580 * These flags describe the type of _application_ - they wouldn't
581 * vary between individual sessions - and so it's OK to have this
582 * variable be GLOBAL.
584 * Note that additional flags may be defined in platform-specific
585 * headers. It's probably best if those ones start from 0x1000, to
588 #define FLAG_VERBOSE 0x0001
589 #define FLAG_STDERR 0x0002
590 #define FLAG_INTERACTIVE 0x0004
594 * Likewise, these two variables are set up when the application
595 * initialises, and inform all default-settings accesses after
598 GLOBAL
int default_protocol
;
599 GLOBAL
int default_port
;
602 * This is set TRUE by cmdline.c iff a session is loaded with "-load".
604 GLOBAL
int loaded_session
;
606 struct RSAKey
; /* be a little careful of scope */
609 * Exports from the front end.
611 void request_resize(void *frontend
, int, int);
612 void do_text(Context
, int, int, wchar_t *, int, unsigned long, int);
613 void do_cursor(Context
, int, int, wchar_t *, int, unsigned long, int);
614 int char_width(Context ctx
, int uc
);
615 #ifdef OPTIMISE_SCROLL
616 void do_scroll(Context
, int, int, int);
618 void set_title(void *frontend
, char *);
619 void set_icon(void *frontend
, char *);
620 void set_sbar(void *frontend
, int, int, int);
621 Context
get_ctx(void *frontend
);
622 void free_ctx(Context
);
623 void palette_set(void *frontend
, int, int, int, int);
624 void palette_reset(void *frontend
);
625 void write_aclip(void *frontend
, char *, int, int);
626 void write_clip(void *frontend
, wchar_t *, int, int);
627 void get_clip(void *frontend
, wchar_t **, int *);
628 void optimised_move(void *frontend
, int, int, int);
629 void set_raw_mouse_mode(void *frontend
, int);
630 void connection_fatal(void *frontend
, char *, ...);
631 void fatalbox(char *, ...);
632 void modalfatalbox(char *, ...);
634 #pragma noreturn(fatalbox)
635 #pragma noreturn(modalfatalbox)
637 void beep(void *frontend
, int);
638 void begin_session(void *frontend
);
639 void sys_cursor(void *frontend
, int x
, int y
);
640 void request_paste(void *frontend
);
641 void frontend_keypress(void *frontend
);
642 void ldisc_update(void *frontend
, int echo
, int edit
);
643 /* It's the backend's responsibility to invoke this at the start of a
644 * connection, if necessary; it can also invoke it later if the set of
645 * special commands changes. It does not need to invoke it at session
647 void update_specials_menu(void *frontend
);
648 int from_backend(void *frontend
, int is_stderr
, const char *data
, int len
);
649 void notify_remote_exit(void *frontend
);
650 #define OPTIMISE_IS_SCROLL 1
652 void set_iconic(void *frontend
, int iconic
);
653 void move_window(void *frontend
, int x
, int y
);
654 void set_zorder(void *frontend
, int top
);
655 void refresh_window(void *frontend
);
656 void set_zoomed(void *frontend
, int zoomed
);
657 int is_iconic(void *frontend
);
658 void get_window_pos(void *frontend
, int *x
, int *y
);
659 void get_window_pixels(void *frontend
, int *x
, int *y
);
660 char *get_window_title(void *frontend
, int icon
);
661 /* Hint from backend to frontend about time-consuming operations.
662 * Initial state is assumed to be BUSY_NOT. */
664 BUSY_NOT
, /* Not busy, all user interaction OK */
665 BUSY_WAITING
, /* Waiting for something; local event loops still running
666 so some local interaction (e.g. menus) OK, but network
667 stuff is suspended */
668 BUSY_CPU
/* Locally busy (e.g. crypto); user interaction suspended */
670 void set_busy_status(void *frontend
, int status
);
672 void cleanup_exit(int);
675 * Exports from noise.c.
677 void noise_get_heavy(void (*func
) (void *, int));
678 void noise_get_light(void (*func
) (void *, int));
679 void noise_regular(void);
680 void noise_ultralight(unsigned long data
);
681 void random_save_seed(void);
682 void random_destroy_seed(void);
685 * Exports from settings.c.
687 char *save_settings(char *section
, int do_host
, Config
* cfg
);
688 void save_open_settings(void *sesskey
, int do_host
, Config
*cfg
);
689 void load_settings(char *section
, int do_host
, Config
* cfg
);
690 void load_open_settings(void *sesskey
, int do_host
, Config
*cfg
);
691 void get_sesslist(struct sesslist
*, int allocate
);
692 void do_defaults(char *, Config
*);
693 void registry_cleanup(void);
696 * Functions used by settings.c to provide platform-specific
699 * (The integer one is expected to return `def' if it has no clear
700 * opinion of its own. This is because there's no integer value
701 * which I can reliably set aside to indicate `nil'. The string
702 * function is perfectly all right returning NULL, of course. The
703 * Filename and FontSpec functions are _not allowed_ to fail to
704 * return, since these defaults _must_ be per-platform.)
706 char *platform_default_s(const char *name
);
707 int platform_default_i(const char *name
, int def
);
708 Filename
platform_default_filename(const char *name
);
709 FontSpec
platform_default_fontspec(const char *name
);
712 * Exports from terminal.c.
715 Terminal
*term_init(Config
*, struct unicode_data
*, void *);
716 void term_free(Terminal
*);
717 void term_size(Terminal
*, int, int, int);
718 void term_paint(Terminal
*, Context
, int, int, int, int, int);
719 void term_scroll(Terminal
*, int, int);
720 void term_pwron(Terminal
*);
721 void term_clrsb(Terminal
*);
722 void term_mouse(Terminal
*, Mouse_Button
, Mouse_Button
, Mouse_Action
,
723 int,int,int,int,int);
724 void term_key(Terminal
*, Key_Sym
, wchar_t *, size_t, unsigned int,
726 void term_deselect(Terminal
*);
727 void term_update(Terminal
*);
728 void term_invalidate(Terminal
*);
729 void term_blink(Terminal
*, int set_cursor
);
730 void term_do_paste(Terminal
*);
731 int term_paste_pending(Terminal
*);
732 void term_paste(Terminal
*);
733 void term_nopaste(Terminal
*);
734 int term_ldisc(Terminal
*, int option
);
735 void term_copyall(Terminal
*);
736 void term_reconfig(Terminal
*, Config
*);
737 void term_seen_key_event(Terminal
*);
738 int term_data(Terminal
*, int is_stderr
, const char *data
, int len
);
739 void term_provide_resize_fn(Terminal
*term
,
740 void (*resize_fn
)(void *, int, int),
742 void term_provide_logctx(Terminal
*term
, void *logctx
);
743 void term_set_focus(Terminal
*term
, int has_focus
);
746 * Exports from logging.c.
748 void *log_init(void *frontend
, Config
*cfg
);
749 void log_free(void *logctx
);
750 void log_reconfig(void *logctx
, Config
*cfg
);
751 void logfopen(void *logctx
);
752 void logfclose(void *logctx
);
753 void logtraffic(void *logctx
, unsigned char c
, int logmode
);
754 void logflush(void *logctx
);
755 void log_eventlog(void *logctx
, const char *string
);
756 enum { PKT_INCOMING
, PKT_OUTGOING
};
757 enum { PKTLOG_EMIT
, PKTLOG_BLANK
, PKTLOG_OMIT
};
763 void log_packet(void *logctx
, int direction
, int type
,
764 char *texttype
, void *data
, int len
,
765 int n_blanks
, const struct logblank_t
*blanks
);
768 * Exports from testback.c
771 extern Backend null_backend
;
772 extern Backend loop_backend
;
775 * Exports from raw.c.
778 extern Backend raw_backend
;
781 * Exports from rlogin.c.
784 extern Backend rlogin_backend
;
787 * Exports from telnet.c.
790 extern Backend telnet_backend
;
793 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
794 * so that PuTTYtel will still compile - otherwise it would depend
798 GLOBAL
int (*ssh_get_line
) (const char *prompt
, char *str
, int maxlen
,
800 GLOBAL
int ssh_getline_pw_only
;
801 extern Backend ssh_backend
;
804 * Exports from ldisc.c.
806 void *ldisc_create(Config
*, Terminal
*, Backend
*, void *, void *);
807 void ldisc_free(void *);
808 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
);
811 * Exports from ldiscucs.c.
813 void lpage_send(void *, int codepage
, char *buf
, int len
, int interactive
);
814 void luni_send(void *, wchar_t * widebuf
, int len
, int interactive
);
817 * Exports from sshrand.c.
820 void random_add_noise(void *noise
, int length
);
821 int random_byte(void);
822 void random_get_savedata(void **data
, int *len
);
823 extern int random_active
;
824 /* The random number subsystem is activated if at least one other entity
825 * within the program expresses an interest in it. So each SSH session
826 * calls random_ref on startup and random_unref on shutdown. */
827 void random_ref(void);
828 void random_unref(void);
831 * Exports from pinger.c.
833 typedef struct pinger_tag
*Pinger
;
834 Pinger
pinger_new(Config
*cfg
, Backend
*back
, void *backhandle
);
835 void pinger_reconfig(Pinger
, Config
*oldcfg
, Config
*newcfg
);
836 void pinger_free(Pinger
);
839 * Exports from misc.c.
845 * Exports from version.c.
850 * Exports from unicode.c.
853 #define CP_UTF8 65001
855 /* void init_ucs(void); -- this is now in platform-specific headers */
856 int is_dbcs_leadbyte(int codepage
, char byte
);
857 int mb_to_wc(int codepage
, int flags
, char *mbstr
, int mblen
,
858 wchar_t *wcstr
, int wclen
);
859 int wc_to_mb(int codepage
, int flags
, wchar_t *wcstr
, int wclen
,
860 char *mbstr
, int mblen
, char *defchr
, int *defused
,
861 struct unicode_data
*ucsdata
);
862 wchar_t xlat_uskbd2cyrllic(int ch
);
863 int check_compose(int first
, int second
);
864 int decode_codepage(char *cp_name
);
865 const char *cp_enumerate (int index
);
866 const char *cp_name(int codepage
);
867 void get_unitab(int codepage
, wchar_t * unitab
, int ftype
);
870 * Exports from wcwidth.c
872 int mk_wcwidth(wchar_t ucs
);
873 int mk_wcswidth(const wchar_t *pwcs
, size_t n
);
874 int mk_wcwidth_cjk(wchar_t ucs
);
875 int mk_wcswidth_cjk(const wchar_t *pwcs
, size_t n
);
878 * Exports from mscrypto.c
881 int crypto_startup();
882 void crypto_wrapup();
886 * Exports from pageantc.c.
888 * agent_query returns 1 for here's-a-response, and 0 for query-in-
889 * progress. In the latter case there will be a call to `callback'
890 * at some future point, passing callback_ctx as the first
891 * parameter and the actual reply data as the second and third.
893 * The response may be a NULL pointer (in either of the synchronous
894 * or asynchronous cases), which indicates failure to receive a
897 int agent_query(void *in
, int inlen
, void **out
, int *outlen
,
898 void (*callback
)(void *, void *, int), void *callback_ctx
);
899 int agent_exists(void);
902 * Exports from wildcard.c
904 const char *wc_error(int value
);
905 int wc_match(const char *wildcard
, const char *target
);
906 int wc_unescape(char *output
, const char *wildcard
);
909 * Exports from frontend (windlg.c etc)
911 void logevent(void *frontend
, const char *);
912 void pgp_fingerprints(void);
914 * verify_ssh_host_key() can return one of three values:
916 * - +1 means `key was OK' (either already known or the user just
917 * approved it) `so continue with the connection'
919 * - 0 means `key was not OK, abandon the connection'
921 * - -1 means `I've initiated enquiries, please wait to be called
922 * back via the provided function with a result that's either 0
925 int verify_ssh_host_key(void *frontend
, char *host
, int port
, char *keytype
,
926 char *keystr
, char *fingerprint
,
927 void (*callback
)(void *ctx
, int result
), void *ctx
);
929 * askalg has the same set of return values as verify_ssh_host_key.
931 int askalg(void *frontend
, const char *algtype
, const char *algname
,
932 void (*callback
)(void *ctx
, int result
), void *ctx
);
934 * askappend can return four values:
936 * - 2 means overwrite the log file
937 * - 1 means append to the log file
938 * - 0 means cancel logging for this session
939 * - -1 means please wait.
941 int askappend(void *frontend
, Filename filename
,
942 void (*callback
)(void *ctx
, int result
), void *ctx
);
945 * Exports from console.c (that aren't equivalents to things in
948 extern int console_batch_mode
;
949 int console_get_line(const char *prompt
, char *str
, int maxlen
, int is_pw
);
950 void console_provide_logctx(void *logctx
);
951 int is_interactive(void);
954 * Exports from printing.c.
956 typedef struct printer_enum_tag printer_enum
;
957 typedef struct printer_job_tag printer_job
;
958 printer_enum
*printer_start_enum(int *nprinters
);
959 char *printer_get_name(printer_enum
*, int);
960 void printer_finish_enum(printer_enum
*);
961 printer_job
*printer_start_job(char *printer
);
962 void printer_job_data(printer_job
*, void *, int);
963 void printer_finish_job(printer_job
*);
966 * Exports from cmdline.c (and also cmdline_error(), which is
967 * defined differently in various places and required _by_
970 int cmdline_process_param(char *, char *, int, Config
*);
971 void cmdline_run_saved(Config
*);
972 void cmdline_cleanup(void);
973 extern char *cmdline_password
;
974 #define TOOLTYPE_FILETRANSFER 1
975 #define TOOLTYPE_NONNETWORK 2
976 extern int cmdline_tooltype
;
978 void cmdline_error(char *, ...);
981 * Exports from config.c.
984 void setup_config_box(struct controlbox
*b
, int midsession
,
985 int protocol
, int protcfginfo
);
988 * Exports from minibidi.c.
990 typedef struct bidi_char
{
992 unsigned short index
;
994 int do_bidi(bidi_char
*line
, int count
);
995 int do_shape(bidi_char
*line
, bidi_char
*to
, int count
);
998 * X11 auth mechanisms we know about.
1002 X11_MIT
, /* MIT-MAGIC-COOKIE-1 */
1003 X11_XDM
, /* XDM-AUTHORIZATION-1 */
1006 extern const char *const x11_authnames
[]; /* declared in x11fwd.c */
1009 * Miscellaneous exports from the platform-specific code.
1011 Filename
filename_from_str(const char *string
);
1012 const char *filename_to_str(const Filename
*fn
);
1013 int filename_equal(Filename f1
, Filename f2
);
1014 int filename_is_null(Filename fn
);
1015 char *get_username(void); /* return value needs freeing */
1016 char *get_random_data(int bytes
); /* used in cmdgen.c */
1019 * Exports and imports from timing.c.
1021 * schedule_timer() asks the front end to schedule a callback to a
1022 * timer function in a given number of ticks. The returned value is
1023 * the time (in ticks since an arbitrary offset) at which the
1024 * callback can be expected. This value will also be passed as the
1025 * `now' parameter to the callback function. Hence, you can (for
1026 * example) schedule an event at a particular time by calling
1027 * schedule_timer() and storing the return value in your context
1028 * structure as the time when that event is due. The first time a
1029 * callback function gives you that value or more as `now', you do
1032 * expire_timer_context() drops all current timers associated with
1033 * a given value of ctx (for when you're about to free ctx).
1035 * run_timers() is called from the front end when it has reason to
1036 * think some timers have reached their moment, or when it simply
1037 * needs to know how long to wait next. We pass it the time we
1038 * think it is. It returns TRUE and places the time when the next
1039 * timer needs to go off in `next', or alternatively it returns
1040 * FALSE if there are no timers at all pending.
1042 * timer_change_notify() must be supplied by the front end; it
1043 * notifies the front end that a new timer has been added to the
1044 * list which is sooner than any existing ones. It provides the
1045 * time when that timer needs to go off.
1047 * *** FRONT END IMPLEMENTORS NOTE:
1049 * There's an important subtlety in the front-end implementation of
1050 * the timer interface. When a front end is given a `next' value,
1051 * either returned from run_timers() or via timer_change_notify(),
1052 * it should ensure that it really passes _that value_ as the `now'
1053 * parameter to its next run_timers call. It should _not_ simply
1054 * call GETTICKCOUNT() to get the `now' parameter when invoking
1057 * The reason for this is that an OS's system clock might not agree
1058 * exactly with the timing mechanisms it supplies to wait for a
1059 * given interval. I'll illustrate this by the simple example of
1060 * Unix Plink, which uses timeouts to select() in a way which for
1061 * these purposes can simply be considered to be a wait() function.
1062 * Suppose, for the sake of argument, that this wait() function
1063 * tends to return early by 1%. Then a possible sequence of actions
1066 * - run_timers() tells the front end that the next timer firing
1067 * is 10000ms from now.
1068 * - Front end calls wait(10000ms), but according to
1069 * GETTICKCOUNT() it has only waited for 9900ms.
1070 * - Front end calls run_timers() again, passing time T-100ms as
1072 * - run_timers() does nothing, and says the next timer firing is
1073 * still 100ms from now.
1074 * - Front end calls wait(100ms), which only waits for 99ms.
1075 * - Front end calls run_timers() yet again, passing time T-1ms.
1076 * - run_timers() says there's still 1ms to wait.
1077 * - Front end calls wait(1ms).
1079 * If you're _lucky_ at this point, wait(1ms) will actually wait
1080 * for 1ms and you'll only have woken the program up three times.
1081 * If you're unlucky, wait(1ms) might do nothing at all due to
1082 * being below some minimum threshold, and you might find your
1083 * program spends the whole of the last millisecond tight-looping
1084 * between wait() and run_timers().
1086 * Instead, what you should do is to _save_ the precise `next'
1087 * value provided by run_timers() or via timer_change_notify(), and
1088 * use that precise value as the input to the next run_timers()
1091 * - run_timers() tells the front end that the next timer firing
1092 * is at time T, 10000ms from now.
1093 * - Front end calls wait(10000ms).
1094 * - Front end then immediately calls run_timers() and passes it
1095 * time T, without stopping to check GETTICKCOUNT() at all.
1097 * This guarantees that the program wakes up only as many times as
1098 * there are actual timer actions to be taken, and that the timing
1099 * mechanism will never send it into a tight loop.
1101 * (It does also mean that the timer action in the above example
1102 * will occur 100ms early, but this is not generally critical. And
1103 * the hypothetical 1% error in wait() will be partially corrected
1104 * for anyway when, _after_ run_timers() returns, you call
1105 * GETTICKCOUNT() and compare the result with the returned `next'
1106 * value to find out how long you have to make your next wait().)
1108 typedef void (*timer_fn_t
)(void *ctx
, long now
);
1109 long schedule_timer(int ticks
, timer_fn_t fn
, void *ctx
);
1110 void expire_timer_context(void *ctx
);
1111 int run_timers(long now
, long *next
);
1112 void timer_change_notify(long next
);