Malcolm Smith's patch to support CHAP (digest-based) authentication
[u/mdw/putty] / putty.h
diff --git a/putty.h b/putty.h
index ad845af..b12429f 100644 (file)
--- a/putty.h
+++ b/putty.h
@@ -1,7 +1,6 @@
 #ifndef PUTTY_PUTTY_H
 #define PUTTY_PUTTY_H
 
-#include <stdio.h>                    /* for FILENAME_MAX */
 #include <stddef.h>                   /* for wchar_t */
 
 /*
@@ -26,17 +25,17 @@ typedef struct terminal_tag Terminal;
 
 #include "puttyps.h"
 #include "network.h"
+#include "misc.h"
 
 /* Three attribute types: 
- * The ATTRs (normal attributes) are stored with the characters in the main
- * display arrays
+ * 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 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')
+ * The LATTRs (line attributes) are an entirely disjoint space of
+ * flags.
  *
  * ATTR_INVALID is an illegal colour combination.
  */
@@ -53,7 +52,7 @@ typedef struct terminal_tag Terminal;
 #define LATTR_WRAPPED 0x10000000UL
 #define LATTR_WRAPPED2 0x20000000UL
 
-#define ATTR_INVALID 0x00FF0000UL
+#define ATTR_INVALID 0x03FF0000UL
 
 /* Like Linux use the F000 page for direct to font. */
 #define ATTR_OEMCP   0x0000F000UL      /* OEM Codepage DTF */
@@ -80,27 +79,27 @@ typedef struct terminal_tag Terminal;
  */
 #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_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 20
+#define ATTR_BGSHIFT 21
 
-#define ATTR_DEFAULT 0x00980000UL
+#define ATTR_DEFAULT 0x01280000UL      /* bg 9, fg 8 */
 #define ATTR_DEFFG   0x00080000UL
-#define ATTR_DEFBG   0x00900000UL
+#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 0x00BA0000UL
+#define ATTR_CUR_XOR 0x016A0000UL
 
 struct sesslist {
     int nsessions;
@@ -135,6 +134,11 @@ typedef enum {
     TS_EOL
 } Telnet_Special;
 
+struct telnet_special {
+    const char *name;                 /* NULL==end, ""==separator */
+    int code;
+};
+
 typedef enum {
     MBT_NOTHING,
     MBT_LEFT, MBT_MIDDLE, MBT_RIGHT,   /* `raw' button designations */
@@ -220,7 +224,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 {
@@ -238,7 +243,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 {
@@ -262,8 +267,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);
@@ -273,6 +280,7 @@ struct backend_tag {
     int (*sendbuffer) (void *handle);
     void (*size) (void *handle, int width, int height);
     void (*special) (void *handle, Telnet_Special code);
+    const struct telnet_special *(*get_specials) (void *handle);
     Socket(*socket) (void *handle);
     int (*exitcode) (void *handle);
     int (*sendok) (void *handle);
@@ -300,6 +308,12 @@ extern struct backend_list {
 extern const int be_default_protocol;
 
 /*
+ * Name of this particular application, for use in the config box
+ * and other pieces of text.
+ */
+extern const char *const appname;
+
+/*
  * IMPORTANT POLICY POINT: everything in this structure which wants
  * to be treated like an integer must be an actual, honest-to-
  * goodness `int'. No enum-typed variables. This is because parts
@@ -316,6 +330,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;
@@ -323,10 +338,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
@@ -340,7 +354,7 @@ struct config_tag {
     int agentfwd;
     int change_username;              /* allow username switching in SSH2 */
     int ssh_cipherlist[CIPHER_MAX];
-    char keyfile[FILENAME_MAX];
+    Filename keyfile;
     int sshprot;                      /* use v1 or v2 when both available */
     int ssh2_des_cbc;                 /* "des-cbc" nonstandard SSH2 cipher */
     int try_tis_auth;
@@ -367,6 +381,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;
@@ -381,6 +396,7 @@ struct config_tag {
     int fullscreenonaltenter;
     int scroll_on_key;
     int scroll_on_disp;
+    int erase_to_scrollback;
     int compose_key;
     int ctrlaltkeys;
     char wintitle[256];                       /* initial window title */
@@ -397,7 +413,7 @@ struct config_tag {
     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];
+    Filename bell_wavefile;
     int scrollbar;
     int scrollbar_in_fullscreen;
     int resize_action;
@@ -405,11 +421,8 @@ struct config_tag {
     int blinktext;
     int win_name_always;
     int width, height;
-    char font[256];
-    int fontisbold;
-    int fontheight;
-    int fontcharset;
-    char logfilename[FILENAME_MAX];
+    FontSpec font;
+    Filename logfilename;
     int logtype;
     int logxfovr;
     int hide_mouseptr;
@@ -417,7 +430,10 @@ struct config_tag {
     int window_border;
     char answerback[256];
     char printer[128];
+    int arabicshaping;
+    int bidi;
     /* Colour options */
+    int system_colour;
     int try_palette;
     int bold_colour;
     unsigned char colours[22][3];
@@ -439,18 +455,30 @@ struct config_tag {
     /* 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 */
+    /*
+     * The port forwarding string contains a number of
+     * NUL-terminated substrings, terminated in turn by an empty
+     * string (i.e. a second NUL immediately after the previous
+     * one). Each string can be of one of the following forms:
+     * 
+     *   [LR]localport\thost:port
+     *   [LR]localaddr:localport\thost:port
+     *   Dlocalport
+     *   Dlocaladdr:localport
+     */
+    char portfwd[1024];
     /* SSH bug compatibility modes */
     int sshbug_ignore1, sshbug_plainpw1, sshbug_rsa1,
        sshbug_hmac2, sshbug_derivekey2, sshbug_rsapad2,
-       sshbug_dhgex2;
+       sshbug_dhgex2, sshbug_pksessid2;
     /* 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 shadowbold;
+    FontSpec boldfont;
+    FontSpec widefont;
+    FontSpec wideboldfont;
     int shadowboldoffset;
 };
 
@@ -471,6 +499,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
@@ -485,6 +517,11 @@ 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 */
 
 /*
@@ -495,7 +532,7 @@ 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);
+void do_scroll(Context, int, int, int);
 #endif
 void set_title(void *frontend, char *);
 void set_icon(void *frontend, char *);
@@ -522,6 +559,8 @@ 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);
+void update_specials_menu(void *frontend);
+int from_backend(void *frontend, int is_stderr, const char *data, int len);
 #define OPTIMISE_IS_SCROLL 1
 
 void set_iconic(void *frontend, int iconic);
@@ -549,7 +588,7 @@ void random_destroy_seed(void);
 /*
  * Exports from settings.c.
  */
-void save_settings(char *section, int do_host, Config * cfg);
+char *save_settings(char *section, int do_host, Config * cfg);
 void save_open_settings(void *sesskey, 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);
@@ -564,10 +603,14 @@ void registry_cleanup(void);
  * (The integer one is expected to return `def' if it has no clear
  * opinion of its own. This is because there's no integer value
  * which I can reliably set aside to indicate `nil'. The string
- * function is perfectly all right returning NULL, of course.)
+ * function is perfectly all right returning NULL, of course. The
+ * Filename and FontSpec functions are _not allowed_ to fail to
+ * return, since these defaults _must_ be per-platform.)
  */
 char *platform_default_s(const char *name);
 int platform_default_i(const char *name, int def);
+Filename platform_default_filename(const char *name);
+FontSpec platform_default_fontspec(const char *name);
 
 /*
  * Exports from terminal.c.
@@ -597,7 +640,7 @@ int term_ldisc(Terminal *, int option);
 void term_copyall(Terminal *);
 void term_reconfig(Terminal *, Config *);
 void term_seen_key_event(Terminal *); 
-int from_backend(void *, int is_stderr, char *data, int len);
+int term_data(Terminal *, int is_stderr, const char *data, int len);
 void term_provide_resize_fn(Terminal *term,
                            void (*resize_fn)(void *, int, int),
                            void *resize_ctx);
@@ -612,7 +655,8 @@ 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 };
 void log_packet(void *logctx, int direction, int type,
                char *texttype, void *data, int len);
@@ -703,8 +747,8 @@ int wc_to_mb(int codepage, int flags, wchar_t *wcstr, int wclen,
 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);
+const char *cp_enumerate (int index);
+const char *cp_name(int codepage);
 void get_unitab(int codepage, wchar_t * unitab, int ftype);
 
 /*
@@ -722,9 +766,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);
 
 /*
@@ -737,11 +791,11 @@ 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);
-int askappend(void *frontend, char *filename);
+int askappend(void *frontend, Filename filename);
 
 /*
  * Exports from console.c (that aren't equivalents to things in
@@ -750,6 +804,7 @@ int askappend(void *frontend, char *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.
@@ -770,13 +825,32 @@ 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
 extern int cmdline_tooltype;
 
 void cmdline_error(char *, ...);
 
 /*
+ * Exports from config.c.
+ */
+struct controlbox;
+void setup_config_box(struct controlbox *b, struct sesslist *sesslist,
+                     int midsession, int protocol);
+
+/*
+ * 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.
  */
 enum {
@@ -787,4 +861,14 @@ enum {
 };
 extern const char *const x11_authnames[];  /* declared in x11fwd.c */
 
+/*
+ * Miscellaneous exports from the platform-specific code.
+ */
+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 */
+
 #endif