#ifndef PUTTY_PUTTY_H #define PUTTY_PUTTY_H #include /* for FILENAME_MAX */ #include /* for wchar_t */ /* * Global variables. Most modules declare these `extern', but * window.c will do `#define PUTTY_DO_GLOBALS' before including this * module, and so will get them properly defined. */ #ifndef GLOBAL #ifdef PUTTY_DO_GLOBALS #define GLOBAL #else #define GLOBAL extern #endif #endif #ifndef DONE_TYPEDEFS #define DONE_TYPEDEFS typedef struct config_tag Config; typedef struct backend_tag Backend; typedef struct terminal_tag Terminal; #endif #include "puttyps.h" #include "network.h" /* Three attribute types: * The ATTRs (normal attributes) are stored with the characters in the main * display arrays * * The TATTRs (temporary attributes) are generated on the fly, they can overlap * with characters but not with normal attributes. * * The LATTRs (line attributes) conflict with no others and only have one * value per line. But on area clears the LATTR cells are set to the erase_char * (or DEFAULT_ATTR + 'E') * * ATTR_INVALID is an illegal colour combination. */ #define TATTR_ACTCURS 0x4UL /* active cursor (block) */ #define TATTR_PASCURS 0x2UL /* passive cursor (box) */ #define TATTR_RIGHTCURS 0x1UL /* cursor-on-RHS */ #define LATTR_NORM 0x00000000UL #define LATTR_WIDE 0x01000000UL #define LATTR_TOP 0x02000000UL #define LATTR_BOT 0x03000000UL #define LATTR_MODE 0x03000000UL #define LATTR_WRAPPED 0x10000000UL #define LATTR_WRAPPED2 0x20000000UL #define ATTR_INVALID 0x00FF0000UL /* Like Linux use the F000 page for direct to font. */ #define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */ #define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */ /* These are internal use overlapping with the UTF-16 surrogates */ #define ATTR_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */ #define ATTR_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */ #define ATTR_SCOACS 0x0000DA00UL /* SCO Alternate charset */ #define ATTR_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */ #define CSET_MASK 0x0000FF00UL /* Character set mask; MUST be 0xFF00 */ #define DIRECT_CHAR(c) ((c&0xFC00)==0xD800) #define DIRECT_FONT(c) ((c&0xFE00)==0xF000) #define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */ /* * UCSWIDE is a special value used in the terminal data to signify * the character cell containing the right-hand half of a CJK wide * character. We use 0xDFFF because it's part of the surrogate * range and hence won't be used for anything else (it's impossible * to input it via UTF-8 because our UTF-8 decoder correctly * rejects surrogates). */ #define UCSWIDE 0xDFFF #define ATTR_NARROW 0x20000000UL #define ATTR_WIDE 0x10000000UL #define ATTR_BOLD 0x01000000UL #define ATTR_UNDER 0x02000000UL #define ATTR_REVERSE 0x04000000UL #define ATTR_BLINK 0x08000000UL #define ATTR_FGMASK 0x000F0000UL #define ATTR_BGMASK 0x00F00000UL #define ATTR_COLOURS 0x00FF0000UL #define ATTR_FGSHIFT 16 #define ATTR_BGSHIFT 20 #define ATTR_DEFAULT 0x00980000UL #define ATTR_DEFFG 0x00080000UL #define ATTR_DEFBG 0x00900000UL #define ERASE_CHAR (ATTR_DEFAULT | ATTR_ASCII | ' ') #define ATTR_MASK 0xFFFFFF00UL #define CHAR_MASK 0x000000FFUL #define ATTR_CUR_AND (~(ATTR_BOLD|ATTR_REVERSE|ATTR_BLINK|ATTR_COLOURS)) #define ATTR_CUR_XOR 0x00BA0000UL struct sesslist { int nsessions; char **sessions; char *buffer; /* so memory can be freed later */ }; GLOBAL int dbcs_screenfont; GLOBAL int font_codepage; GLOBAL int line_codepage; GLOBAL wchar_t unitab_scoacs[256]; GLOBAL wchar_t unitab_line[256]; GLOBAL wchar_t unitab_font[256]; GLOBAL wchar_t unitab_xterm[256]; GLOBAL wchar_t unitab_oemcp[256]; GLOBAL unsigned char unitab_ctrl[256]; #define LGXF_OVR 1 /* existing logfile overwrite */ #define LGXF_APN 0 /* existing logfile append */ #define LGXF_ASK -1 /* existing logfile ask */ #define LGTYP_NONE 0 /* logmode: no logging */ #define LGTYP_ASCII 1 /* logmode: pure ascii */ #define LGTYP_DEBUG 2 /* logmode: all chars of traffic */ #define LGTYP_PACKETS 3 /* logmode: SSH data packets */ typedef enum { TS_AYT, TS_BRK, TS_SYNCH, TS_EC, TS_EL, TS_GA, TS_NOP, TS_ABORT, TS_AO, TS_IP, TS_SUSP, TS_EOR, TS_EOF, TS_LECHO, TS_RECHO, TS_PING, TS_EOL } Telnet_Special; typedef enum { MBT_NOTHING, MBT_LEFT, MBT_MIDDLE, MBT_RIGHT, /* `raw' button designations */ MBT_SELECT, MBT_EXTEND, MBT_PASTE, /* `cooked' button designations */ MBT_WHEEL_UP, MBT_WHEEL_DOWN /* mouse wheel */ } Mouse_Button; typedef enum { MA_NOTHING, MA_CLICK, MA_2CLK, MA_3CLK, MA_DRAG, MA_RELEASE } Mouse_Action; typedef enum { VT_XWINDOWS, VT_OEMANSI, VT_OEMONLY, VT_POORMAN, VT_UNICODE } VT_Mode; enum { /* * SSH ciphers (both SSH1 and SSH2) */ CIPHER_WARN, /* pseudo 'cipher' */ CIPHER_3DES, CIPHER_BLOWFISH, CIPHER_AES, /* (SSH 2 only) */ CIPHER_DES, CIPHER_MAX /* no. ciphers (inc warn) */ }; enum { /* * Line discipline option states: off, on, up to the backend. */ LD_YES, LD_NO, LD_BACKEND }; enum { /* * Line discipline options which the backend might try to control. */ LD_EDIT, /* local line editing */ LD_ECHO /* local echo */ }; enum { /* * Close On Exit behaviours. (cfg.close_on_exit) */ COE_NEVER, /* Never close the window */ COE_NORMAL, /* Close window on "normal" (non-error) exits only */ COE_ALWAYS /* Always close the window */ }; struct backend_tag { char *(*init) (void *frontend_handle, void **backend_handle, char *host, int port, char **realhost, int nodelay); /* back->send() returns the current amount of buffered data. */ int (*send) (void *handle, char *buf, int len); /* back->sendbuffer() does the same thing but without attempting a send */ int (*sendbuffer) (void *handle); void (*size) (void *handle, int width, int height); void (*special) (void *handle, Telnet_Special code); Socket(*socket) (void *handle); int (*exitcode) (void *handle); int (*sendok) (void *handle); int (*ldisc) (void *handle, int); void (*provide_ldisc) (void *handle, void *ldisc); void (*provide_logctx) (void *handle, void *logctx); /* * back->unthrottle() tells the back end that the front end * buffer is clearing. */ void (*unthrottle) (void *handle, int); int default_port; }; extern struct backend_list { int protocol; char *name; Backend *backend; } backends[]; struct config_tag { /* Basic options */ char host[512]; int port; enum { PROT_RAW, PROT_TELNET, PROT_RLOGIN, PROT_SSH } protocol; int close_on_exit; int warn_on_close; int ping_interval; /* in seconds */ int tcp_nodelay; /* Proxy options */ char proxy_exclude_list[512]; enum { PROXYDNS_NO, PROXYDNS_AUTO, PROXYDNS_YES } proxy_dns; int even_proxy_localhost; enum { PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET } proxy_type; char proxy_host[512]; int proxy_port; char proxy_username[32]; char proxy_password[32]; char proxy_telnet_command[512]; int proxy_socks_version; /* SSH options */ char remote_cmd[512]; char remote_cmd2[512]; /* fallback if the first fails * (used internally for scp) */ char *remote_cmd_ptr; /* might point to a larger command * but never for loading/saving */ char *remote_cmd_ptr2; /* might point to a larger command * but never for loading/saving */ int nopty; int compression; int agentfwd; int change_username; /* allow username switching in SSH2 */ int ssh_cipherlist[CIPHER_MAX]; char keyfile[FILENAME_MAX]; int sshprot; /* use v1 or v2 when both available */ int ssh2_des_cbc; /* "des-cbc" nonstandard SSH2 cipher */ int try_tis_auth; int try_ki_auth; int ssh_subsys; /* run a subsystem rather than a command */ int ssh_subsys2; /* fallback to go with remote_cmd2 */ /* Telnet options */ char termtype[32]; char termspeed[32]; char environmt[1024]; /* VAR\tvalue\0VAR\tvalue\0\0 */ char username[100]; char localusername[100]; int rfc_environ; int passive_telnet; /* Keyboard options */ int bksp_is_delete; int rxvt_homeend; int funky_type; int no_applic_c; /* totally disable app cursor keys */ int no_applic_k; /* totally disable app keypad */ int no_mouse_rep; /* totally disable mouse reporting */ int no_remote_resize; /* disable remote resizing */ int no_alt_screen; /* disable alternate screen */ int no_remote_wintitle; /* disable remote retitling */ int no_dbackspace; /* disable destructive backspace */ int no_remote_charset; /* disable remote charset config */ int app_cursor; int app_keypad; int nethack_keypad; int telnet_keyboard; int telnet_newline; int alt_f4; /* is it special? */ int alt_space; /* is it special? */ int alt_only; /* is it special? */ int localecho; int localedit; int alwaysontop; int fullscreenonaltenter; int scroll_on_key; int scroll_on_disp; int compose_key; int ctrlaltkeys; char wintitle[256]; /* initial window title */ /* Terminal options */ int savelines; int dec_om; int wrap_mode; int lfhascr; int cursor_type; /* 0=block 1=underline 2=vertical */ int blink_cur; enum { BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE } beep; enum { B_IND_DISABLED, B_IND_FLASH, B_IND_STEADY } beep_ind; int bellovl; /* bell overload protection active? */ int bellovl_n; /* number of bells to cause overload */ int bellovl_t; /* time interval for overload (seconds) */ int bellovl_s; /* period of silence to re-enable bell (s) */ char bell_wavefile[FILENAME_MAX]; int scrollbar; int scrollbar_in_fullscreen; enum { RESIZE_TERM, RESIZE_DISABLED, RESIZE_FONT, RESIZE_EITHER } resize_action; int bce; int blinktext; int win_name_always; int width, height; char font[256]; int fontisbold; int fontheight; int fontcharset; char logfilename[FILENAME_MAX]; int logtype; int logxfovr; int hide_mouseptr; int sunken_edge; int window_border; char answerback[256]; char printer[128]; /* Colour options */ int try_palette; int bold_colour; unsigned char colours[22][3]; /* Selection options */ int mouse_is_xterm; int rect_select; int rawcnp; int rtf_paste; int mouse_override; short wordness[256]; /* translations */ VT_Mode vtmode; char line_codepage[128]; int xlat_capslockcyr; /* X11 forwarding */ int x11_forward; char x11_display[128]; /* port forwarding */ int lport_acceptall; /* accept conns from hosts other than localhost */ int rport_acceptall; /* same for remote forwarded ports (SSH2 only) */ char portfwd[1024]; /* [LR]localport\thost:port\000[LR]localport\thost:port\000\000 */ /* SSH bug compatibility modes */ enum { BUG_AUTO, BUG_OFF, BUG_ON } sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1, sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2, sshbug_dhgex2; /* Options for pterm. Should split out into platform-dependent part. */ int stamp_utmp; int login_shell; int scrollbar_on_left; char boldfont[256]; char widefont[256]; char wideboldfont[256]; int shadowboldoffset; }; /* * You can compile with -DSSH_DEFAULT to have ssh by default. */ #ifndef SSH_DEFAULT #define DEFAULT_PROTOCOL PROT_TELNET #define DEFAULT_PORT 23 #else #define DEFAULT_PROTOCOL PROT_SSH #define DEFAULT_PORT 22 #endif /* * Some global flags denoting the type of application. * * FLAG_VERBOSE is set when the user requests verbose details. * * FLAG_STDERR is set in command-line applications (which have a * functioning stderr that it makes sense to write to) and not in * GUI applications (which don't). * * FLAG_INTERACTIVE is set when a full interactive shell session is * being run, _either_ because no remote command has been provided * _or_ because the application is GUI and can't run non- * interactively. * * These flags describe the type of _application_ - they wouldn't * vary between individual sessions - and so it's OK to have this * variable be GLOBAL. */ #define FLAG_VERBOSE 0x0001 #define FLAG_STDERR 0x0002 #define FLAG_INTERACTIVE 0x0004 GLOBAL int flags; /* * Likewise, these two variables are set up when the application * initialises, and inform all default-settings accesses after * that. */ GLOBAL int default_protocol; GLOBAL int default_port; /* This variable, OTOH, needs to be made non-global ASAP. FIXME. */ GLOBAL Config cfg; struct RSAKey; /* be a little careful of scope */ /* * Exports from window.c. */ void request_resize(void *frontend, int, int); void do_text(Context, int, int, char *, int, unsigned long, int); void do_cursor(Context, int, int, char *, int, unsigned long, int); int char_width(Context ctx, int uc); #ifdef OPTIMISE_SCROLL void do_scroll(void *, int, int, int); #endif void set_title(void *frontend, char *); void set_icon(void *frontend, char *); void set_sbar(void *frontend, int, int, int); Context get_ctx(void *frontend); void free_ctx(Context); void palette_set(void *frontend, int, int, int, int); void palette_reset(void *frontend); void write_aclip(void *frontend, char *, int, int); void write_clip(void *frontend, wchar_t *, int, int); void get_clip(void *frontend, wchar_t **, int *); void optimised_move(void *frontend, int, int, int); void set_raw_mouse_mode(void *frontend, int); Mouse_Button translate_button(void *frontend, Mouse_Button b); void connection_fatal(void *frontend, char *, ...); void fatalbox(char *, ...); void modalfatalbox(char *, ...); #ifdef macintosh #pragma noreturn(fatalbox) #pragma noreturn(modalfatalbox) #endif void beep(void *frontend, int); void begin_session(void *frontend); void sys_cursor(void *frontend, int x, int y); void request_paste(void *frontend); void frontend_keypress(void *frontend); void ldisc_update(void *frontend, int echo, int edit); #define OPTIMISE_IS_SCROLL 1 void set_iconic(void *frontend, int iconic); void move_window(void *frontend, int x, int y); void set_zorder(void *frontend, int top); void refresh_window(void *frontend); void set_zoomed(void *frontend, int zoomed); int is_iconic(void *frontend); void get_window_pos(void *frontend, int *x, int *y); void get_window_pixels(void *frontend, int *x, int *y); char *get_window_title(void *frontend, int icon); void cleanup_exit(int); /* * Exports from noise.c. */ void noise_get_heavy(void (*func) (void *, int)); void noise_get_light(void (*func) (void *, int)); void noise_regular(void); void noise_ultralight(unsigned long data); void random_save_seed(void); void random_destroy_seed(void); /* * Exports from settings.c. */ void save_settings(char *section, int do_host, Config * cfg); void load_settings(char *section, int do_host, Config * cfg); void load_open_settings(void *sesskey, int do_host, Config *cfg); void get_sesslist(struct sesslist *, int allocate); void do_defaults(char *, Config *); void registry_cleanup(void); /* * Exports from terminal.c. */ Terminal *term_init(Config *, void *); void term_size(Terminal *, int, int, int); void term_out(Terminal *); void term_paint(Terminal *, Context, int, int, int, int, int); void term_scroll(Terminal *, int, int); void term_pwron(Terminal *); void term_clrsb(Terminal *); void term_mouse(Terminal *, Mouse_Button, Mouse_Action, int,int,int,int,int); void term_deselect(Terminal *); void term_update(Terminal *); void term_invalidate(Terminal *); void term_blink(Terminal *, int set_cursor); void term_do_paste(Terminal *); int term_paste_pending(Terminal *); void term_paste(Terminal *); void term_nopaste(Terminal *); int term_ldisc(Terminal *, int option); void term_copyall(Terminal *); void term_reconfig(Terminal *); void term_seen_key_event(Terminal *); int from_backend(void *, int is_stderr, char *data, int len); void term_provide_resize_fn(Terminal *term, void (*resize_fn)(void *, int, int), void *resize_ctx); void term_provide_logctx(Terminal *term, void *logctx); /* * Exports from logging.c. */ void *log_init(void *frontend); void logfopen(void *logctx); void logfclose(void *logctx); void logtraffic(void *logctx, unsigned char c, int logmode); void log_eventlog(void *logctx, char *string); enum { PKT_INCOMING, PKT_OUTGOING }; void log_packet(void *logctx, int direction, int type, char *texttype, void *data, int len); /* * Exports from testback.c */ extern Backend null_backend; extern Backend loop_backend; /* * Exports from raw.c. */ extern Backend raw_backend; /* * Exports from rlogin.c. */ extern Backend rlogin_backend; /* * Exports from telnet.c. */ extern Backend telnet_backend; /* * Exports from ssh.c. (NB the getline variables have to be GLOBAL * so that PuTTYtel will still compile - otherwise it would depend * on ssh.c.) */ GLOBAL int (*ssh_get_line) (const char *prompt, char *str, int maxlen, int is_pw); GLOBAL int ssh_getline_pw_only; extern Backend ssh_backend; /* * Exports from ldisc.c. */ void *ldisc_create(Config *, Terminal *, Backend *, void *, void *); void ldisc_send(void *handle, char *buf, int len, int interactive); /* * Exports from ldiscucs.c. */ void lpage_send(void *, int codepage, char *buf, int len, int interactive); void luni_send(void *, wchar_t * widebuf, int len, int interactive); /* * Exports from sshrand.c. */ void random_add_noise(void *noise, int length); void random_init(void); int random_byte(void); void random_get_savedata(void **data, int *len); extern int random_active; /* * Exports from misc.c. */ #include "misc.h" /* * Exports from version.c. */ extern char ver[]; /* * Exports from unicode.c. */ #ifndef CP_UTF8 #define CP_UTF8 65001 #endif /* void init_ucs(void); -- this is now in platform-specific headers */ int is_dbcs_leadbyte(int codepage, char byte); int mb_to_wc(int codepage, int flags, char *mbstr, int mblen, wchar_t *wcstr, int wclen); int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen, char *mbstr, int mblen, char *defchr, int *defused); wchar_t xlat_uskbd2cyrllic(int ch); int check_compose(int first, int second); int decode_codepage(char *cp_name); char *cp_enumerate (int index); char *cp_name(int codepage); void get_unitab(int codepage, wchar_t * unitab, int ftype); /* * Exports from wcwidth.c */ int wcwidth(wchar_t ucs); int wcswidth(const wchar_t *pwcs, size_t n); /* * Exports from mscrypto.c */ #ifdef MSCRYPTOAPI int crypto_startup(); void crypto_wrapup(); #endif /* * Exports from pageantc.c */ void agent_query(void *in, int inlen, void **out, int *outlen); int agent_exists(void); /* * Exports from wildcard.c */ const char *wc_error(int value); int wc_match(const char *wildcard, const char *target); int wc_unescape(char *output, const char *wildcard); /* * Exports from windlg.c */ void logevent(void *frontend, char *); void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype, char *keystr, char *fingerprint); void askcipher(void *frontend, char *ciphername, int cs); int askappend(void *frontend, char *filename); /* * Exports from console.c (that aren't equivalents to things in * windlg.c). */ extern int console_batch_mode; int console_get_line(const char *prompt, char *str, int maxlen, int is_pw); /* * Exports from printing.c. */ typedef struct printer_enum_tag printer_enum; typedef struct printer_job_tag printer_job; printer_enum *printer_start_enum(int *nprinters); char *printer_get_name(printer_enum *, int); void printer_finish_enum(printer_enum *); printer_job *printer_start_job(char *printer); void printer_job_data(printer_job *, void *, int); void printer_finish_job(printer_job *); /* * Exports from cmdline.c (and also cmdline_error(), which is * defined differently in various places and required _by_ * cmdline.c). */ int cmdline_process_param(char *, char *, int); void cmdline_run_saved(void); extern char *cmdline_password; #define TOOLTYPE_FILETRANSFER 1 extern int cmdline_tooltype; void cmdline_error(char *, ...); #endif