4 #include <stdio.h> /* for FILENAME_MAX */
5 #include <stddef.h> /* for wchar_t */
8 * Global variables. Most modules declare these `extern', but
9 * window.c will do `#define PUTTY_DO_GLOBALS' before including this
10 * module, and so will get them properly defined.
13 #ifdef PUTTY_DO_GLOBALS
22 typedef struct config_tag Config
;
23 typedef struct backend_tag Backend
;
24 typedef struct terminal_tag Terminal
;
30 /* Three attribute types:
31 * The ATTRs (normal attributes) are stored with the characters in the main
34 * The TATTRs (temporary attributes) are generated on the fly, they can overlap
35 * with characters but not with normal attributes.
37 * The LATTRs (line attributes) conflict with no others and only have one
38 * value per line. But on area clears the LATTR cells are set to the erase_char
39 * (or DEFAULT_ATTR + 'E')
41 * ATTR_INVALID is an illegal colour combination.
44 #define TATTR_ACTCURS 0x4UL /* active cursor (block) */
45 #define TATTR_PASCURS 0x2UL /* passive cursor (box) */
46 #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */
48 #define LATTR_NORM 0x00000000UL
49 #define LATTR_WIDE 0x01000000UL
50 #define LATTR_TOP 0x02000000UL
51 #define LATTR_BOT 0x03000000UL
52 #define LATTR_MODE 0x03000000UL
53 #define LATTR_WRAPPED 0x10000000UL
54 #define LATTR_WRAPPED2 0x20000000UL
56 #define ATTR_INVALID 0x00FF0000UL
58 /* Like Linux use the F000 page for direct to font. */
59 #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */
60 #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */
62 /* These are internal use overlapping with the UTF-16 surrogates */
63 #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */
64 #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */
65 #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */
66 #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */
67 #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */
69 #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800)
70 #define DIRECT_FONT(c) ((c&0xFE00)==0xF000)
72 #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */
74 * UCSWIDE is a special value used in the terminal data to signify
75 * the character cell containing the right-hand half of a CJK wide
76 * character. We use 0xDFFF because it's part of the surrogate
77 * range and hence won't be used for anything else (it's impossible
78 * to input it via UTF-8 because our UTF-8 decoder correctly
79 * rejects surrogates).
81 #define UCSWIDE 0xDFFF
83 #define ATTR_NARROW 0x20000000UL
84 #define ATTR_WIDE 0x10000000UL
85 #define ATTR_BOLD 0x01000000UL
86 #define ATTR_UNDER 0x02000000UL
87 #define ATTR_REVERSE 0x04000000UL
88 #define ATTR_BLINK 0x08000000UL
89 #define ATTR_FGMASK 0x000F0000UL
90 #define ATTR_BGMASK 0x00F00000UL
91 #define ATTR_COLOURS 0x00FF0000UL
92 #define ATTR_FGSHIFT 16
93 #define ATTR_BGSHIFT 20
95 #define ATTR_DEFAULT 0x00980000UL
96 #define ATTR_DEFFG 0x00080000UL
97 #define ATTR_DEFBG 0x00900000UL
98 #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ')
99 #define ATTR_MASK 0xFFFFFF00UL
100 #define CHAR_MASK 0x000000FFUL
102 #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS))
103 #define ATTR_CUR_XOR 0x00BA0000UL
108 char *buffer
; /* so memory can be freed later */
111 GLOBAL
int dbcs_screenfont
;
112 GLOBAL
int font_codepage
;
113 GLOBAL
int line_codepage
;
114 GLOBAL
wchar_t unitab_scoacs
[256];
115 GLOBAL
wchar_t unitab_line
[256];
116 GLOBAL
wchar_t unitab_font
[256];
117 GLOBAL
wchar_t unitab_xterm
[256];
118 GLOBAL
wchar_t unitab_oemcp
[256];
119 GLOBAL
unsigned char unitab_ctrl
[256];
121 #define LGXF_OVR 1 /* existing logfile overwrite */
122 #define LGXF_APN 0 /* existing logfile append */
123 #define LGXF_ASK -1 /* existing logfile ask */
124 #define LGTYP_NONE 0 /* logmode: no logging */
125 #define LGTYP_ASCII 1 /* logmode: pure ascii */
126 #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */
127 #define LGTYP_PACKETS 3 /* logmode: SSH data packets */
130 TS_AYT
, TS_BRK
, TS_SYNCH
, TS_EC
, TS_EL
, TS_GA
, TS_NOP
, TS_ABORT
,
131 TS_AO
, TS_IP
, TS_SUSP
, TS_EOR
, TS_EOF
, TS_LECHO
, TS_RECHO
, TS_PING
,
137 MBT_LEFT
, MBT_MIDDLE
, MBT_RIGHT
, /* `raw' button designations */
138 MBT_SELECT
, MBT_EXTEND
, MBT_PASTE
, /* `cooked' button designations */
139 MBT_WHEEL_UP
, MBT_WHEEL_DOWN
/* mouse wheel */
143 MA_NOTHING
, MA_CLICK
, MA_2CLK
, MA_3CLK
, MA_DRAG
, MA_RELEASE
147 VT_XWINDOWS
, VT_OEMANSI
, VT_OEMONLY
, VT_POORMAN
, VT_UNICODE
152 * SSH ciphers (both SSH1 and SSH2)
154 CIPHER_WARN
, /* pseudo 'cipher' */
157 CIPHER_AES
, /* (SSH 2 only) */
159 CIPHER_MAX
/* no. ciphers (inc warn) */
164 * Line discipline option states: off, on, up to the backend.
166 LD_YES
, LD_NO
, LD_BACKEND
171 * Line discipline options which the backend might try to control.
173 LD_EDIT
, /* local line editing */
174 LD_ECHO
/* local echo */
179 * Close On Exit behaviours. (cfg.close_on_exit)
181 COE_NEVER
, /* Never close the window */
182 COE_NORMAL
, /* Close window on "normal" (non-error) exits only */
183 COE_ALWAYS
/* Always close the window */
187 char *(*init
) (void *frontend_handle
, void **backend_handle
, Config
*cfg
,
188 char *host
, int port
, char **realhost
, int nodelay
);
189 /* back->reconfig() passes in a replacement configuration. */
190 void (*reconfig
) (void *handle
, Config
*cfg
);
191 /* back->send() returns the current amount of buffered data. */
192 int (*send
) (void *handle
, char *buf
, int len
);
193 /* back->sendbuffer() does the same thing but without attempting a send */
194 int (*sendbuffer
) (void *handle
);
195 void (*size
) (void *handle
, int width
, int height
);
196 void (*special
) (void *handle
, Telnet_Special code
);
197 Socket(*socket
) (void *handle
);
198 int (*exitcode
) (void *handle
);
199 int (*sendok
) (void *handle
);
200 int (*ldisc
) (void *handle
, int);
201 void (*provide_ldisc
) (void *handle
, void *ldisc
);
202 void (*provide_logctx
) (void *handle
, void *logctx
);
204 * back->unthrottle() tells the back end that the front end
205 * buffer is clearing.
207 void (*unthrottle
) (void *handle
, int);
211 extern struct backend_list
{
221 enum { PROT_RAW
, PROT_TELNET
, PROT_RLOGIN
, PROT_SSH
} protocol
;
224 int ping_interval
; /* in seconds */
227 char proxy_exclude_list
[512];
228 enum { PROXYDNS_NO
, PROXYDNS_AUTO
, PROXYDNS_YES
} proxy_dns
;
229 int even_proxy_localhost
;
230 enum { PROXY_NONE
, PROXY_HTTP
, PROXY_SOCKS
, PROXY_TELNET
} proxy_type
;
231 char proxy_host
[512];
233 char proxy_username
[32];
234 char proxy_password
[32];
235 char proxy_telnet_command
[512];
236 int proxy_socks_version
;
238 char remote_cmd
[512];
239 char remote_cmd2
[512]; /* fallback if the first fails
240 * (used internally for scp) */
241 char *remote_cmd_ptr
; /* might point to a larger command
242 * but never for loading/saving */
243 char *remote_cmd_ptr2
; /* might point to a larger command
244 * but never for loading/saving */
248 int change_username
; /* allow username switching in SSH2 */
249 int ssh_cipherlist
[CIPHER_MAX
];
250 char keyfile
[FILENAME_MAX
];
251 int sshprot
; /* use v1 or v2 when both available */
252 int ssh2_des_cbc
; /* "des-cbc" nonstandard SSH2 cipher */
255 int ssh_subsys
; /* run a subsystem rather than a command */
256 int ssh_subsys2
; /* fallback to go with remote_cmd2 */
260 char environmt
[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */
262 char localusername
[100];
265 /* Keyboard options */
269 int no_applic_c
; /* totally disable app cursor keys */
270 int no_applic_k
; /* totally disable app keypad */
271 int no_mouse_rep
; /* totally disable mouse reporting */
272 int no_remote_resize
; /* disable remote resizing */
273 int no_alt_screen
; /* disable alternate screen */
274 int no_remote_wintitle
; /* disable remote retitling */
275 int no_dbackspace
; /* disable destructive backspace */
276 int no_remote_charset
; /* disable remote charset config */
282 int alt_f4
; /* is it special? */
283 int alt_space
; /* is it special? */
284 int alt_only
; /* is it special? */
288 int fullscreenonaltenter
;
293 char wintitle
[256]; /* initial window title */
294 /* Terminal options */
299 int cursor_type
; /* 0=block 1=underline 2=vertical */
302 BELL_DISABLED
, BELL_DEFAULT
, BELL_VISUAL
, BELL_WAVEFILE
305 B_IND_DISABLED
, B_IND_FLASH
, B_IND_STEADY
307 int bellovl
; /* bell overload protection active? */
308 int bellovl_n
; /* number of bells to cause overload */
309 int bellovl_t
; /* time interval for overload (seconds) */
310 int bellovl_s
; /* period of silence to re-enable bell (s) */
311 char bell_wavefile
[FILENAME_MAX
];
313 int scrollbar_in_fullscreen
;
314 enum { RESIZE_TERM
, RESIZE_DISABLED
, RESIZE_FONT
, RESIZE_EITHER
} resize_action
;
323 char logfilename
[FILENAME_MAX
];
329 char answerback
[256];
334 unsigned char colours
[22][3];
335 /* Selection options */
344 char line_codepage
[128];
345 int xlat_capslockcyr
;
348 char x11_display
[128];
350 /* port forwarding */
351 int lport_acceptall
; /* accept conns from hosts other than localhost */
352 int rport_acceptall
; /* same for remote forwarded ports (SSH2 only) */
353 char portfwd
[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */
354 /* SSH bug compatibility modes */
356 BUG_AUTO
, BUG_OFF
, BUG_ON
357 } sshbug_ignore1
, sshbug_plainpw1
, sshbug_rsa1
,
358 sshbug_hmac2
, sshbug_derivekey2
, sshbug_rsapad2
,
360 /* Options for pterm. Should split out into platform-dependent part. */
363 int scrollbar_on_left
;
366 char wideboldfont
[256];
367 int shadowboldoffset
;
371 * You can compile with -DSSH_DEFAULT to have ssh by default.
374 #define DEFAULT_PROTOCOL PROT_TELNET
375 #define DEFAULT_PORT 23
377 #define DEFAULT_PROTOCOL PROT_SSH
378 #define DEFAULT_PORT 22
382 * Some global flags denoting the type of application.
384 * FLAG_VERBOSE is set when the user requests verbose details.
386 * FLAG_STDERR is set in command-line applications (which have a
387 * functioning stderr that it makes sense to write to) and not in
388 * GUI applications (which don't).
390 * FLAG_INTERACTIVE is set when a full interactive shell session is
391 * being run, _either_ because no remote command has been provided
392 * _or_ because the application is GUI and can't run non-
395 * These flags describe the type of _application_ - they wouldn't
396 * vary between individual sessions - and so it's OK to have this
397 * variable be GLOBAL.
399 #define FLAG_VERBOSE 0x0001
400 #define FLAG_STDERR 0x0002
401 #define FLAG_INTERACTIVE 0x0004
405 * Likewise, these two variables are set up when the application
406 * initialises, and inform all default-settings accesses after
409 GLOBAL
int default_protocol
;
410 GLOBAL
int default_port
;
412 struct RSAKey
; /* be a little careful of scope */
415 * Exports from window.c.
417 void request_resize(void *frontend
, int, int);
418 void do_text(Context
, int, int, char *, int, unsigned long, int);
419 void do_cursor(Context
, int, int, char *, int, unsigned long, int);
420 int char_width(Context ctx
, int uc
);
421 #ifdef OPTIMISE_SCROLL
422 void do_scroll(void *, int, int, int);
424 void set_title(void *frontend
, char *);
425 void set_icon(void *frontend
, char *);
426 void set_sbar(void *frontend
, int, int, int);
427 Context
get_ctx(void *frontend
);
428 void free_ctx(Context
);
429 void palette_set(void *frontend
, int, int, int, int);
430 void palette_reset(void *frontend
);
431 void write_aclip(void *frontend
, char *, int, int);
432 void write_clip(void *frontend
, wchar_t *, int, int);
433 void get_clip(void *frontend
, wchar_t **, int *);
434 void optimised_move(void *frontend
, int, int, int);
435 void set_raw_mouse_mode(void *frontend
, int);
436 Mouse_Button
translate_button(void *frontend
, Mouse_Button b
);
437 void connection_fatal(void *frontend
, char *, ...);
438 void fatalbox(char *, ...);
439 void modalfatalbox(char *, ...);
441 #pragma noreturn(fatalbox)
442 #pragma noreturn(modalfatalbox)
444 void beep(void *frontend
, int);
445 void begin_session(void *frontend
);
446 void sys_cursor(void *frontend
, int x
, int y
);
447 void request_paste(void *frontend
);
448 void frontend_keypress(void *frontend
);
449 void ldisc_update(void *frontend
, int echo
, int edit
);
450 #define OPTIMISE_IS_SCROLL 1
452 void set_iconic(void *frontend
, int iconic
);
453 void move_window(void *frontend
, int x
, int y
);
454 void set_zorder(void *frontend
, int top
);
455 void refresh_window(void *frontend
);
456 void set_zoomed(void *frontend
, int zoomed
);
457 int is_iconic(void *frontend
);
458 void get_window_pos(void *frontend
, int *x
, int *y
);
459 void get_window_pixels(void *frontend
, int *x
, int *y
);
460 char *get_window_title(void *frontend
, int icon
);
462 void cleanup_exit(int);
465 * Exports from noise.c.
467 void noise_get_heavy(void (*func
) (void *, int));
468 void noise_get_light(void (*func
) (void *, int));
469 void noise_regular(void);
470 void noise_ultralight(unsigned long data
);
471 void random_save_seed(void);
472 void random_destroy_seed(void);
475 * Exports from settings.c.
477 void save_settings(char *section
, int do_host
, Config
* cfg
);
478 void load_settings(char *section
, int do_host
, Config
* cfg
);
479 void load_open_settings(void *sesskey
, int do_host
, Config
*cfg
);
480 void get_sesslist(struct sesslist
*, int allocate
);
481 void do_defaults(char *, Config
*);
482 void registry_cleanup(void);
485 * Functions used by settings.c to provide platform-specific
488 * (The integer one is expected to return `def' if it has no clear
489 * opinion of its own. This is because there's no integer value
490 * which I can reliably set aside to indicate `nil'. The string
491 * function is perfectly all right returning NULL, of course.)
493 char *platform_default_s(char *name
);
494 int platform_default_i(char *name
, int def
);
497 * Exports from terminal.c.
500 Terminal
*term_init(Config
*, void *);
501 void term_size(Terminal
*, int, int, int);
502 void term_out(Terminal
*);
503 void term_paint(Terminal
*, Context
, int, int, int, int, int);
504 void term_scroll(Terminal
*, int, int);
505 void term_pwron(Terminal
*);
506 void term_clrsb(Terminal
*);
507 void term_mouse(Terminal
*, Mouse_Button
, Mouse_Action
, int,int,int,int,int);
508 void term_deselect(Terminal
*);
509 void term_update(Terminal
*);
510 void term_invalidate(Terminal
*);
511 void term_blink(Terminal
*, int set_cursor
);
512 void term_do_paste(Terminal
*);
513 int term_paste_pending(Terminal
*);
514 void term_paste(Terminal
*);
515 void term_nopaste(Terminal
*);
516 int term_ldisc(Terminal
*, int option
);
517 void term_copyall(Terminal
*);
518 void term_reconfig(Terminal
*, Config
*);
519 void term_seen_key_event(Terminal
*);
520 int from_backend(void *, int is_stderr
, char *data
, int len
);
521 void term_provide_resize_fn(Terminal
*term
,
522 void (*resize_fn
)(void *, int, int),
524 void term_provide_logctx(Terminal
*term
, void *logctx
);
527 * Exports from logging.c.
529 void *log_init(void *frontend
, Config
*cfg
);
530 void log_reconfig(void *logctx
, Config
*cfg
);
531 void logfopen(void *logctx
);
532 void logfclose(void *logctx
);
533 void logtraffic(void *logctx
, unsigned char c
, int logmode
);
534 void log_eventlog(void *logctx
, char *string
);
535 enum { PKT_INCOMING
, PKT_OUTGOING
};
536 void log_packet(void *logctx
, int direction
, int type
,
537 char *texttype
, void *data
, int len
);
540 * Exports from testback.c
543 extern Backend null_backend
;
544 extern Backend loop_backend
;
547 * Exports from raw.c.
550 extern Backend raw_backend
;
553 * Exports from rlogin.c.
556 extern Backend rlogin_backend
;
559 * Exports from telnet.c.
562 extern Backend telnet_backend
;
565 * Exports from ssh.c. (NB the getline variables have to be GLOBAL
566 * so that PuTTYtel will still compile - otherwise it would depend
570 GLOBAL
int (*ssh_get_line
) (const char *prompt
, char *str
, int maxlen
,
572 GLOBAL
int ssh_getline_pw_only
;
573 extern Backend ssh_backend
;
576 * Exports from ldisc.c.
578 void *ldisc_create(Config
*, Terminal
*, Backend
*, void *, void *);
579 void ldisc_send(void *handle
, char *buf
, int len
, int interactive
);
582 * Exports from ldiscucs.c.
584 void lpage_send(void *, int codepage
, char *buf
, int len
, int interactive
);
585 void luni_send(void *, wchar_t * widebuf
, int len
, int interactive
);
588 * Exports from sshrand.c.
591 void random_add_noise(void *noise
, int length
);
592 void random_init(void);
593 int random_byte(void);
594 void random_get_savedata(void **data
, int *len
);
595 extern int random_active
;
598 * Exports from misc.c.
604 * Exports from version.c.
609 * Exports from unicode.c.
612 #define CP_UTF8 65001
614 /* void init_ucs(void); -- this is now in platform-specific headers */
615 int is_dbcs_leadbyte(int codepage
, char byte
);
616 int mb_to_wc(int codepage
, int flags
, char *mbstr
, int mblen
,
617 wchar_t *wcstr
, int wclen
);
618 int wc_to_mb(int codepage
, int flags
, wchar_t *wcstr
, int wclen
,
619 char *mbstr
, int mblen
, char *defchr
, int *defused
);
620 wchar_t xlat_uskbd2cyrllic(int ch
);
621 int check_compose(int first
, int second
);
622 int decode_codepage(char *cp_name
);
623 char *cp_enumerate (int index
);
624 char *cp_name(int codepage
);
625 void get_unitab(int codepage
, wchar_t * unitab
, int ftype
);
628 * Exports from wcwidth.c
630 int wcwidth(wchar_t ucs
);
631 int wcswidth(const wchar_t *pwcs
, size_t n
);
634 * Exports from mscrypto.c
637 int crypto_startup();
638 void crypto_wrapup();
642 * Exports from pageantc.c
644 void agent_query(void *in
, int inlen
, void **out
, int *outlen
);
645 int agent_exists(void);
648 * Exports from wildcard.c
650 const char *wc_error(int value
);
651 int wc_match(const char *wildcard
, const char *target
);
652 int wc_unescape(char *output
, const char *wildcard
);
655 * Exports from windlg.c
657 void logevent(void *frontend
, char *);
658 void verify_ssh_host_key(void *frontend
, char *host
, int port
, char *keytype
,
659 char *keystr
, char *fingerprint
);
660 void askcipher(void *frontend
, char *ciphername
, int cs
);
661 int askappend(void *frontend
, char *filename
);
664 * Exports from console.c (that aren't equivalents to things in
667 extern int console_batch_mode
;
668 int console_get_line(const char *prompt
, char *str
, int maxlen
, int is_pw
);
671 * Exports from printing.c.
673 typedef struct printer_enum_tag printer_enum
;
674 typedef struct printer_job_tag printer_job
;
675 printer_enum
*printer_start_enum(int *nprinters
);
676 char *printer_get_name(printer_enum
*, int);
677 void printer_finish_enum(printer_enum
*);
678 printer_job
*printer_start_job(char *printer
);
679 void printer_job_data(printer_job
*, void *, int);
680 void printer_finish_job(printer_job
*);
683 * Exports from cmdline.c (and also cmdline_error(), which is
684 * defined differently in various places and required _by_
687 int cmdline_process_param(char *, char *, int, Config
*);
688 void cmdline_run_saved(Config
*);
689 extern char *cmdline_password
;
690 #define TOOLTYPE_FILETRANSFER 1
691 extern int cmdline_tooltype
;
693 void cmdline_error(char *, ...);
696 * X11 auth mechanisms we know about.
700 X11_MIT
, /* MIT-MAGIC-COOKIE-1 */
701 X11_XDM
, /* XDM-AUTHORIZATION-1 */
704 extern const char *const x11_authnames
[]; /* declared in x11fwd.c */