X-Git-Url: https://git.distorted.org.uk/u/mdw/putty/blobdiff_plain/fbf6cb3b1fcbb6c3a19dd61d308d116878ed2d3d..f89c329410c18fe1f09d843747fad77babb9f89c:/putty.h diff --git a/putty.h b/putty.h index a35bbc3e..0d74e940 100644 --- a/putty.h +++ b/putty.h @@ -36,39 +36,51 @@ typedef struct terminal_tag Terminal; * * The LATTRs (line attributes) are an entirely disjoint space of * flags. + * + * The DATTRs (display attributes) are internal to terminal.c (but + * defined here because their values have to match the others + * here); they reuse the TATTR_* space but are always masked off + * before sending to the front end. * * 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 TATTR_ACTCURS 0x40000000UL /* active cursor (block) */ +#define TATTR_PASCURS 0x20000000UL /* passive cursor (box) */ +#define TATTR_RIGHTCURS 0x10000000UL /* cursor-on-RHS */ +#define TATTR_COMBINING 0x80000000UL /* combining characters */ + +#define DATTR_STARTRUN 0x80000000UL /* start of redraw run */ + +#define TDATTR_MASK 0xF0000000UL +#define TATTR_MASK (TDATTR_MASK) +#define DATTR_MASK (TDATTR_MASK) #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 LATTR_WIDE 0x00000001UL +#define LATTR_TOP 0x00000002UL +#define LATTR_BOT 0x00000003UL +#define LATTR_MODE 0x00000003UL +#define LATTR_WRAPPED 0x00000010UL +#define LATTR_WRAPPED2 0x00000020UL -#define ATTR_INVALID 0x03FF0000UL +#define ATTR_INVALID 0x03FFFFU /* Like Linux use the F000 page for direct to font. */ -#define ATTR_OEMCP 0x0000F000UL /* OEM Codepage DTF */ -#define ATTR_ACP 0x0000F100UL /* Ansi Codepage DTF */ +#define CSET_OEMCP 0x0000F000UL /* OEM Codepage DTF */ +#define CSET_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 CSET_ASCII 0x0000D800UL /* normal ASCII charset ESC ( B */ +#define CSET_LINEDRW 0x0000D900UL /* line drawing charset ESC ( 0 */ +#define CSET_SCOACS 0x0000DA00UL /* SCO Alternate charset */ +#define CSET_GBCHR 0x0000DB00UL /* UK variant charset ESC ( A */ +#define CSET_MASK 0xFFFFFF00UL /* Character set mask */ -#define DIRECT_CHAR(c) ((c&0xFC00)==0xD800) -#define DIRECT_FONT(c) ((c&0xFE00)==0xF000) +#define DIRECT_CHAR(c) ((c&0xFFFFFC00)==0xD800) +#define DIRECT_FONT(c) ((c&0xFFFFFE00)==0xF000) -#define UCSERR (ATTR_LINEDRW|'a') /* UCS Format error character. */ +#define UCSERR (CSET_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 @@ -79,27 +91,40 @@ typedef struct terminal_tag Terminal; */ #define UCSWIDE 0xDFFF -#define ATTR_NARROW 0x80000000UL -#define ATTR_WIDE 0x40000000UL -#define ATTR_BOLD 0x04000000UL -#define ATTR_UNDER 0x08000000UL -#define ATTR_REVERSE 0x10000000UL -#define ATTR_BLINK 0x20000000UL -#define ATTR_FGMASK 0x001F0000UL -#define ATTR_BGMASK 0x03E00000UL -#define ATTR_COLOURS 0x03FF0000UL -#define ATTR_FGSHIFT 16 -#define ATTR_BGSHIFT 21 - -#define ATTR_DEFAULT 0x01280000UL /* bg 9, fg 8 */ -#define ATTR_DEFFG 0x00080000UL -#define ATTR_DEFBG 0x01200000UL -#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 0x016A0000UL +#define ATTR_NARROW 0x800000U +#define ATTR_WIDE 0x400000U +#define ATTR_BOLD 0x040000U +#define ATTR_UNDER 0x080000U +#define ATTR_REVERSE 0x100000U +#define ATTR_BLINK 0x200000U +#define ATTR_FGMASK 0x0001FFU +#define ATTR_BGMASK 0x03FE00U +#define ATTR_COLOURS 0x03FFFFU +#define ATTR_FGSHIFT 0 +#define ATTR_BGSHIFT 9 + +/* + * The definitive list of colour numbers stored in terminal + * attribute words is kept here. It is: + * + * - 0-7 are ANSI colours (KRGYBMCW). + * - 8-15 are the bold versions of those colours. + * - 16-255 are the remains of the xterm 256-colour mode (a + * 216-colour cube with R at most significant and B at least, + * followed by a uniform series of grey shades running between + * black and white but not including either on grounds of + * redundancy). + * - 256 is default foreground + * - 257 is default bold foreground + * - 258 is default background + * - 259 is default bold background + * - 260 is cursor foreground + * - 261 is cursor background + */ + +#define ATTR_DEFFG (256 << ATTR_FGSHIFT) +#define ATTR_DEFBG (258 << ATTR_BGSHIFT) +#define ATTR_DEFAULT (ATTR_DEFFG | ATTR_DEFBG) struct sesslist { int nsessions; @@ -129,13 +154,25 @@ struct unicode_data { #define LGTYP_PACKETS 3 /* logmode: SSH data packets */ typedef enum { + /* Actual special commands. Originally Telnet, but some codes have + * been re-used for similar specials in other protocols. */ 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 + TS_EOL, + /* Special command for SSH. */ + TS_REKEY, + /* POSIX-style signals. (not Telnet) */ + TS_SIGABRT, TS_SIGALRM, TS_SIGFPE, TS_SIGHUP, TS_SIGILL, + TS_SIGINT, TS_SIGKILL, TS_SIGPIPE, TS_SIGQUIT, TS_SIGSEGV, + TS_SIGTERM, TS_SIGUSR1, TS_SIGUSR2, + /* Pseudo-specials used for constructing the specials menu. */ + TS_SEP, /* Separator */ + TS_SUBMENU, /* Start a new submenu with specified name */ + TS_EXITMENU /* Exit current submenu or end of specials */ } Telnet_Special; struct telnet_special { - const char *name; /* NULL==end, ""==separator */ + const char *name; int code; }; @@ -197,6 +234,17 @@ enum { enum { /* + * SSH-2 key exchange algorithms + */ + KEX_WARN, + KEX_DHGROUP1, + KEX_DHGROUP14, + KEX_DHGEX, + KEX_MAX +}; + +enum { + /* * SSH ciphers (both SSH1 and SSH2) */ CIPHER_WARN, /* pseudo 'cipher' */ @@ -224,7 +272,8 @@ enum { /* * Proxy types. */ - PROXY_NONE, PROXY_HTTP, PROXY_SOCKS, PROXY_TELNET + PROXY_NONE, PROXY_SOCKS4, PROXY_SOCKS5, + PROXY_HTTP, PROXY_TELNET, PROXY_CMD }; enum { @@ -242,7 +291,7 @@ enum { enum { /* Bell settings (cfg.beep) */ - BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE + BELL_DISABLED, BELL_DEFAULT, BELL_VISUAL, BELL_WAVEFILE, BELL_PCSPEAKER }; enum { @@ -266,8 +315,10 @@ enum { }; struct backend_tag { - char *(*init) (void *frontend_handle, void **backend_handle, Config *cfg, - char *host, int port, char **realhost, int nodelay); + const char *(*init) (void *frontend_handle, void **backend_handle, + Config *cfg, + char *host, int port, char **realhost, int nodelay, + int keepalive); void (*free) (void *handle); /* back->reconfig() passes in a replacement configuration. */ void (*reconfig) (void *handle, Config *cfg); @@ -289,6 +340,7 @@ struct backend_tag { * buffer is clearing. */ void (*unthrottle) (void *handle, int); + int (*cfg_info) (void *handle); int default_port; }; @@ -327,6 +379,7 @@ struct config_tag { int warn_on_close; int ping_interval; /* in seconds */ int tcp_nodelay; + int tcp_keepalives; /* Proxy options */ char proxy_exclude_list[512]; int proxy_dns; @@ -334,10 +387,9 @@ struct config_tag { int proxy_type; char proxy_host[512]; int proxy_port; - char proxy_username[32]; - char proxy_password[32]; + char proxy_username[128]; + char proxy_password[128]; char proxy_telnet_command[512]; - int proxy_socks_version; /* SSH options */ char remote_cmd[512]; char remote_cmd2[512]; /* fallback if the first fails @@ -348,6 +400,9 @@ struct config_tag { * but never for loading/saving */ int nopty; int compression; + int ssh_kexlist[KEX_MAX]; + int ssh_rekey_time; /* in minutes */ + char ssh_rekey_data[16]; int agentfwd; int change_username; /* allow username switching in SSH2 */ int ssh_cipherlist[CIPHER_MAX]; @@ -358,6 +413,7 @@ struct config_tag { int try_ki_auth; int ssh_subsys; /* run a subsystem rather than a command */ int ssh_subsys2; /* fallback to go with remote_cmd2 */ + int ssh_no_shell; /* avoid running a shell */ /* Telnet options */ char termtype[32]; char termspeed[32]; @@ -378,6 +434,7 @@ struct config_tag { int no_remote_wintitle; /* disable remote retitling */ int no_dbackspace; /* disable destructive backspace */ int no_remote_charset; /* disable remote charset config */ + int no_remote_qtitle; /* disable remote win title query */ int app_cursor; int app_keypad; int nethack_keypad; @@ -421,12 +478,20 @@ struct config_tag { Filename logfilename; int logtype; int logxfovr; + int logflush; + int logomitpass; + int logomitdata; int hide_mouseptr; int sunken_edge; int window_border; char answerback[256]; char printer[128]; + int arabicshaping; + int bidi; /* Colour options */ + int ansi_colour; + int xterm_256_colour; + int system_colour; int try_palette; int bold_colour; unsigned char colours[22][3]; @@ -440,6 +505,7 @@ struct config_tag { /* translations */ int vtmode; char line_codepage[128]; + int utf8_override; int xlat_capslockcyr; /* X11 forwarding */ int x11_forward; @@ -463,11 +529,12 @@ struct config_tag { /* SSH bug compatibility modes */ int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1, sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2, - sshbug_dhgex2, sshbug_pksessid2; + sshbug_pksessid2; /* Options for pterm. Should split out into platform-dependent part. */ int stamp_utmp; int login_shell; int scrollbar_on_left; + int shadowbold; FontSpec boldfont; FontSpec widefont; FontSpec wideboldfont; @@ -491,6 +558,10 @@ struct config_tag { * 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. + * + * Note that additional flags may be defined in platform-specific + * headers. It's probably best if those ones start from 0x1000, to + * avoid collision. */ #define FLAG_VERBOSE 0x0001 #define FLAG_STDERR 0x0002 @@ -505,14 +576,19 @@ GLOBAL int flags; GLOBAL int default_protocol; GLOBAL int default_port; +/* + * This is set TRUE by cmdline.c iff a session is loaded with "-load". + */ +GLOBAL int loaded_session; + 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); +void do_text(Context, int, int, wchar_t *, int, unsigned long, int); +void do_cursor(Context, int, int, wchar_t *, int, unsigned long, int); int char_width(Context ctx, int uc); #ifdef OPTIMISE_SCROLL void do_scroll(Context, int, int, int); @@ -542,8 +618,13 @@ 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); +/* It's the backend's responsibility to invoke this at the start of a + * connection, if necessary; it can also invoke it later if the set of + * special commands changes. It does not need to invoke it at session + * shutdown. */ void update_specials_menu(void *frontend); int from_backend(void *frontend, int is_stderr, const char *data, int len); +void notify_remote_exit(void *frontend); #define OPTIMISE_IS_SCROLL 1 void set_iconic(void *frontend, int iconic); @@ -602,7 +683,6 @@ FontSpec platform_default_fontspec(const char *name); Terminal *term_init(Config *, struct unicode_data *, void *); void term_free(Terminal *); 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 *); @@ -628,6 +708,7 @@ void term_provide_resize_fn(Terminal *term, void (*resize_fn)(void *, int, int), void *resize_ctx); void term_provide_logctx(Terminal *term, void *logctx); +void term_set_focus(Terminal *term, int has_focus); /* * Exports from logging.c. @@ -638,10 +719,18 @@ void log_reconfig(void *logctx, Config *cfg); void logfopen(void *logctx); void logfclose(void *logctx); void logtraffic(void *logctx, unsigned char c, int logmode); -void log_eventlog(void *logctx, char *string); +void logflush(void *logctx); +void log_eventlog(void *logctx, const char *string); enum { PKT_INCOMING, PKT_OUTGOING }; +enum { PKTLOG_EMIT, PKTLOG_BLANK, PKTLOG_OMIT }; +struct logblank_t { + int offset; + int len; + int type; +}; void log_packet(void *logctx, int direction, int type, - char *texttype, void *data, int len); + char *texttype, void *data, int len, + int n_blanks, const struct logblank_t *blanks); /* * Exports from testback.c @@ -697,10 +786,22 @@ void luni_send(void *, wchar_t * widebuf, int len, int interactive); */ 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; +/* The random number subsystem is activated if at least one other entity + * within the program expresses an interest in it. So each SSH session + * calls random_ref on startup and random_unref on shutdown. */ +void random_ref(void); +void random_unref(void); + +/* + * Exports from pinger.c. + */ +typedef struct pinger_tag *Pinger; +Pinger pinger_new(Config *cfg, Backend *back, void *backhandle); +void pinger_reconfig(Pinger, Config *oldcfg, Config *newcfg); +void pinger_free(Pinger); /* * Exports from misc.c. @@ -748,9 +849,19 @@ void crypto_wrapup(); #endif /* - * Exports from pageantc.c + * Exports from pageantc.c. + * + * agent_query returns 1 for here's-a-response, and 0 for query-in- + * progress. In the latter case there will be a call to `callback' + * at some future point, passing callback_ctx as the first + * parameter and the actual reply data as the second and third. + * + * The response may be a NULL pointer (in either of the synchronous + * or asynchronous cases), which indicates failure to receive a + * response. */ -void agent_query(void *in, int inlen, void **out, int *outlen); +int agent_query(void *in, int inlen, void **out, int *outlen, + void (*callback)(void *, void *, int), void *callback_ctx); int agent_exists(void); /* @@ -763,10 +874,10 @@ int wc_unescape(char *output, const char *wildcard); /* * Exports from windlg.c */ -void logevent(void *frontend, char *); +void logevent(void *frontend, const 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); +void askalg(void *frontend, const char *algtype, const char *algname); int askappend(void *frontend, Filename filename); /* @@ -776,6 +887,7 @@ int askappend(void *frontend, Filename filename); extern int console_batch_mode; int console_get_line(const char *prompt, char *str, int maxlen, int is_pw); void console_provide_logctx(void *logctx); +int is_interactive(void); /* * Exports from printing.c. @@ -796,6 +908,7 @@ void printer_finish_job(printer_job *); */ int cmdline_process_param(char *, char *, int, Config *); void cmdline_run_saved(Config *); +void cmdline_cleanup(void); extern char *cmdline_password; #define TOOLTYPE_FILETRANSFER 1 #define TOOLTYPE_NONNETWORK 2 @@ -808,7 +921,17 @@ void cmdline_error(char *, ...); */ struct controlbox; void setup_config_box(struct controlbox *b, struct sesslist *sesslist, - int midsession, int protocol); + int midsession, int protocol, int protcfginfo); + +/* + * Exports from minibidi.c. + */ +typedef struct bidi_char { + wchar_t origwc, wc; + unsigned short index; +} bidi_char; +int do_bidi(bidi_char *line, int count); +int do_shape(bidi_char *line, bidi_char *to, int count); /* * X11 auth mechanisms we know about. @@ -828,5 +951,42 @@ Filename filename_from_str(const char *string); const char *filename_to_str(const Filename *fn); int filename_equal(Filename f1, Filename f2); int filename_is_null(Filename fn); +char *get_username(void); /* return value needs freeing */ +char *get_random_data(int bytes); /* used in cmdgen.c */ + +/* + * Exports and imports from timing.c. + * + * schedule_timer() asks the front end to schedule a callback to a + * timer function in a given number of ticks. The returned value is + * the time (in ticks since an arbitrary offset) at which the + * callback can be expected. This value will also be passed as the + * `now' parameter to the callback function. Hence, you can (for + * example) schedule an event at a particular time by calling + * schedule_timer() and storing the return value in your context + * structure as the time when that event is due. The first time a + * callback function gives you that value or more as `now', you do + * the thing. + * + * expire_timer_context() drops all current timers associated with + * a given value of ctx (for when you're about to free ctx). + * + * run_timers() is called from the front end when it has reason to + * think some timers have reached their moment, or when it simply + * needs to know how long to wait next. We pass it the time we + * think it is. It returns TRUE and places the time when the next + * timer needs to go off in `next', or alternatively it returns + * FALSE if there are no timers at all pending. + * + * timer_change_notify() must be supplied by the front end; it + * notifies the front end that a new timer has been added to the + * list which is sooner than any existing ones. It provides the + * time when that timer needs to go off. + */ +typedef void (*timer_fn_t)(void *ctx, long now); +long schedule_timer(int ticks, timer_fn_t fn, void *ctx); +void expire_timer_context(void *ctx); +int run_timers(long now, long *next); +void timer_change_notify(long next); #endif