2006-04-23 22:26:03 +04:00
|
|
|
/*
|
|
|
|
* Telnet backend.
|
|
|
|
*/
|
|
|
|
|
1999-01-08 16:02:13 +03:00
|
|
|
#include <stdio.h>
|
|
|
|
#include <stdlib.h>
|
2012-12-22 13:40:47 +04:00
|
|
|
#include <limits.h>
|
1999-01-08 16:02:13 +03:00
|
|
|
|
|
|
|
#include "putty.h"
|
|
|
|
|
2019-09-08 22:29:00 +03:00
|
|
|
#define IAC 255 /* interpret as command: */
|
|
|
|
#define DONT 254 /* you are not to use option */
|
|
|
|
#define DO 253 /* please, you use option */
|
|
|
|
#define WONT 252 /* I won't use option */
|
|
|
|
#define WILL 251 /* I will use option */
|
|
|
|
#define SB 250 /* interpret as subnegotiation */
|
|
|
|
#define SE 240 /* end sub negotiation */
|
|
|
|
|
|
|
|
#define GA 249 /* you may reverse the line */
|
|
|
|
#define EL 248 /* erase the current line */
|
|
|
|
#define EC 247 /* erase the current character */
|
|
|
|
#define AYT 246 /* are you there */
|
|
|
|
#define AO 245 /* abort output--but let prog finish */
|
|
|
|
#define IP 244 /* interrupt process--permanently */
|
|
|
|
#define BREAK 243 /* break */
|
|
|
|
#define DM 242 /* data mark--for connect. cleaning */
|
|
|
|
#define NOP 241 /* nop */
|
|
|
|
#define EOR 239 /* end of record (transparent mode) */
|
|
|
|
#define ABORT 238 /* Abort process */
|
|
|
|
#define SUSP 237 /* Suspend process */
|
|
|
|
#define xEOF 236 /* End of file: EOF is already used... */
|
2001-05-06 18:35:20 +04:00
|
|
|
|
2008-08-31 21:12:37 +04:00
|
|
|
#define TELOPTS(X) \
|
|
|
|
X(BINARY, 0) /* 8-bit data path */ \
|
|
|
|
X(ECHO, 1) /* echo */ \
|
|
|
|
X(RCP, 2) /* prepare to reconnect */ \
|
|
|
|
X(SGA, 3) /* suppress go ahead */ \
|
|
|
|
X(NAMS, 4) /* approximate message size */ \
|
|
|
|
X(STATUS, 5) /* give status */ \
|
|
|
|
X(TM, 6) /* timing mark */ \
|
|
|
|
X(RCTE, 7) /* remote controlled transmission and echo */ \
|
|
|
|
X(NAOL, 8) /* negotiate about output line width */ \
|
|
|
|
X(NAOP, 9) /* negotiate about output page size */ \
|
|
|
|
X(NAOCRD, 10) /* negotiate about CR disposition */ \
|
|
|
|
X(NAOHTS, 11) /* negotiate about horizontal tabstops */ \
|
|
|
|
X(NAOHTD, 12) /* negotiate about horizontal tab disposition */ \
|
|
|
|
X(NAOFFD, 13) /* negotiate about formfeed disposition */ \
|
|
|
|
X(NAOVTS, 14) /* negotiate about vertical tab stops */ \
|
|
|
|
X(NAOVTD, 15) /* negotiate about vertical tab disposition */ \
|
|
|
|
X(NAOLFD, 16) /* negotiate about output LF disposition */ \
|
|
|
|
X(XASCII, 17) /* extended ascic character set */ \
|
|
|
|
X(LOGOUT, 18) /* force logout */ \
|
|
|
|
X(BM, 19) /* byte macro */ \
|
|
|
|
X(DET, 20) /* data entry terminal */ \
|
|
|
|
X(SUPDUP, 21) /* supdup protocol */ \
|
|
|
|
X(SUPDUPOUTPUT, 22) /* supdup output */ \
|
|
|
|
X(SNDLOC, 23) /* send location */ \
|
|
|
|
X(TTYPE, 24) /* terminal type */ \
|
|
|
|
X(EOR, 25) /* end or record */ \
|
|
|
|
X(TUID, 26) /* TACACS user identification */ \
|
|
|
|
X(OUTMRK, 27) /* output marking */ \
|
|
|
|
X(TTYLOC, 28) /* terminal location number */ \
|
|
|
|
X(3270REGIME, 29) /* 3270 regime */ \
|
|
|
|
X(X3PAD, 30) /* X.3 PAD */ \
|
|
|
|
X(NAWS, 31) /* window size */ \
|
|
|
|
X(TSPEED, 32) /* terminal speed */ \
|
|
|
|
X(LFLOW, 33) /* remote flow control */ \
|
|
|
|
X(LINEMODE, 34) /* Linemode option */ \
|
|
|
|
X(XDISPLOC, 35) /* X Display Location */ \
|
|
|
|
X(OLD_ENVIRON, 36) /* Old - Environment variables */ \
|
|
|
|
X(AUTHENTICATION, 37) /* Authenticate */ \
|
|
|
|
X(ENCRYPT, 38) /* Encryption option */ \
|
|
|
|
X(NEW_ENVIRON, 39) /* New - Environment variables */ \
|
|
|
|
X(TN3270E, 40) /* TN3270 enhancements */ \
|
|
|
|
X(XAUTH, 41) \
|
|
|
|
X(CHARSET, 42) /* Character set */ \
|
|
|
|
X(RSP, 43) /* Remote serial port */ \
|
|
|
|
X(COM_PORT_OPTION, 44) /* Com port control */ \
|
|
|
|
X(SLE, 45) /* Suppress local echo */ \
|
|
|
|
X(STARTTLS, 46) /* Start TLS */ \
|
|
|
|
X(KERMIT, 47) /* Automatic Kermit file transfer */ \
|
|
|
|
X(SEND_URL, 48) \
|
|
|
|
X(FORWARD_X, 49) \
|
|
|
|
X(PRAGMA_LOGON, 138) \
|
|
|
|
X(SSPI_LOGON, 139) \
|
|
|
|
X(PRAGMA_HEARTBEAT, 140) \
|
|
|
|
X(EXOPL, 255) /* extended-options-list */
|
|
|
|
|
|
|
|
#define telnet_enum(x,y) TELOPT_##x = y,
|
|
|
|
enum { TELOPTS(telnet_enum) dummy=0 };
|
|
|
|
#undef telnet_enum
|
2001-05-06 18:35:20 +04:00
|
|
|
|
2019-09-08 22:29:00 +03:00
|
|
|
#define TELQUAL_IS 0 /* option is... */
|
|
|
|
#define TELQUAL_SEND 1 /* send option */
|
|
|
|
#define TELQUAL_INFO 2 /* ENVIRON: informational version of IS */
|
1999-01-08 16:02:13 +03:00
|
|
|
#define BSD_VAR 1
|
|
|
|
#define BSD_VALUE 0
|
|
|
|
#define RFC_VAR 0
|
|
|
|
#define RFC_VALUE 1
|
|
|
|
|
|
|
|
#define CR 13
|
|
|
|
#define LF 10
|
|
|
|
#define NUL 0
|
|
|
|
|
2002-12-19 17:22:16 +03:00
|
|
|
#define iswritable(x) \
|
2019-09-08 22:29:00 +03:00
|
|
|
( (x) != IAC && \
|
|
|
|
(telnet->opt_states[o_we_bin.index] == ACTIVE || (x) != CR))
|
1999-01-08 16:02:13 +03:00
|
|
|
|
2015-05-15 13:15:42 +03:00
|
|
|
static const char *telopt(int opt)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2008-08-31 21:12:37 +04:00
|
|
|
#define telnet_str(x,y) case TELOPT_##x: return #x;
|
|
|
|
switch (opt) {
|
2019-09-08 22:29:00 +03:00
|
|
|
TELOPTS(telnet_str)
|
2008-08-31 21:12:37 +04:00
|
|
|
default:
|
2019-09-08 22:29:00 +03:00
|
|
|
return "<unknown>";
|
2008-08-31 21:12:37 +04:00
|
|
|
}
|
|
|
|
#undef telnet_str
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
struct Opt {
|
2019-09-08 22:29:00 +03:00
|
|
|
int send; /* what we initially send */
|
|
|
|
int nsend; /* -ve send if requested to stop it */
|
|
|
|
int ack, nak; /* +ve and -ve acknowledgements */
|
|
|
|
int option; /* the option code */
|
|
|
|
int index; /* index into telnet->opt_states[] */
|
1999-01-08 16:02:13 +03:00
|
|
|
enum {
|
2019-09-08 22:29:00 +03:00
|
|
|
REQUESTED, ACTIVE, INACTIVE, REALLY_INACTIVE
|
2002-10-25 15:30:33 +04:00
|
|
|
} initial_state;
|
|
|
|
};
|
|
|
|
|
|
|
|
enum {
|
|
|
|
OPTINDEX_NAWS,
|
|
|
|
OPTINDEX_TSPEED,
|
|
|
|
OPTINDEX_TTYPE,
|
|
|
|
OPTINDEX_OENV,
|
|
|
|
OPTINDEX_NENV,
|
|
|
|
OPTINDEX_ECHO,
|
|
|
|
OPTINDEX_WE_SGA,
|
|
|
|
OPTINDEX_THEY_SGA,
|
2002-12-19 17:22:16 +03:00
|
|
|
OPTINDEX_WE_BIN,
|
|
|
|
OPTINDEX_THEY_BIN,
|
2002-10-25 15:30:33 +04:00
|
|
|
NUM_OPTS
|
1999-01-08 16:02:13 +03:00
|
|
|
};
|
|
|
|
|
2002-10-25 15:30:33 +04:00
|
|
|
static const struct Opt o_naws =
|
|
|
|
{ WILL, WONT, DO, DONT, TELOPT_NAWS, OPTINDEX_NAWS, REQUESTED };
|
|
|
|
static const struct Opt o_tspeed =
|
|
|
|
{ WILL, WONT, DO, DONT, TELOPT_TSPEED, OPTINDEX_TSPEED, REQUESTED };
|
|
|
|
static const struct Opt o_ttype =
|
|
|
|
{ WILL, WONT, DO, DONT, TELOPT_TTYPE, OPTINDEX_TTYPE, REQUESTED };
|
2005-03-14 04:56:39 +03:00
|
|
|
static const struct Opt o_oenv =
|
|
|
|
{ WILL, WONT, DO, DONT, TELOPT_OLD_ENVIRON, OPTINDEX_OENV, INACTIVE };
|
|
|
|
static const struct Opt o_nenv =
|
|
|
|
{ WILL, WONT, DO, DONT, TELOPT_NEW_ENVIRON, OPTINDEX_NENV, REQUESTED };
|
2002-10-25 15:30:33 +04:00
|
|
|
static const struct Opt o_echo =
|
|
|
|
{ DO, DONT, WILL, WONT, TELOPT_ECHO, OPTINDEX_ECHO, REQUESTED };
|
|
|
|
static const struct Opt o_we_sga =
|
|
|
|
{ WILL, WONT, DO, DONT, TELOPT_SGA, OPTINDEX_WE_SGA, REQUESTED };
|
|
|
|
static const struct Opt o_they_sga =
|
|
|
|
{ DO, DONT, WILL, WONT, TELOPT_SGA, OPTINDEX_THEY_SGA, REQUESTED };
|
2002-12-19 17:22:16 +03:00
|
|
|
static const struct Opt o_we_bin =
|
|
|
|
{ WILL, WONT, DO, DONT, TELOPT_BINARY, OPTINDEX_WE_BIN, INACTIVE };
|
|
|
|
static const struct Opt o_they_bin =
|
|
|
|
{ DO, DONT, WILL, WONT, TELOPT_BINARY, OPTINDEX_THEY_BIN, INACTIVE };
|
2002-10-25 15:30:33 +04:00
|
|
|
|
|
|
|
static const struct Opt *const opts[] = {
|
1999-01-08 16:02:13 +03:00
|
|
|
&o_naws, &o_tspeed, &o_ttype, &o_oenv, &o_nenv, &o_echo,
|
2002-12-19 17:22:16 +03:00
|
|
|
&o_we_sga, &o_they_sga, &o_we_bin, &o_they_bin, NULL
|
1999-01-08 16:02:13 +03:00
|
|
|
};
|
|
|
|
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
typedef struct Telnet Telnet;
|
|
|
|
struct Telnet {
|
|
|
|
Socket *s;
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
bool closed_on_socket_error;
|
2002-10-25 15:30:33 +04:00
|
|
|
|
New abstraction 'Seat', to pass to backends.
This is a new vtable-based abstraction which is passed to a backend in
place of Frontend, and it implements only the subset of the Frontend
functions needed by a backend. (Many other Frontend functions still
exist, notably the wide range of things called by terminal.c providing
platform-independent operations on the GUI terminal window.)
The purpose of making it a vtable is that this opens up the
possibility of creating a backend as an internal implementation detail
of some other activity, by providing just that one backend with a
custom Seat that implements the methods differently.
For example, this refactoring should make it feasible to directly
implement an SSH proxy type, aka the 'jump host' feature supported by
OpenSSH, aka 'open a secondary SSH session in MAINCHAN_DIRECT_TCP
mode, and then expose the main channel of that as the Socket for the
primary connection'. (Which of course you can already do by spawning
'plink -nc' as a separate proxy process, but this would permit it in
the _same_ process without anything getting confused.)
I've centralised a full set of stub methods in misc.c for the new
abstraction, which allows me to get rid of several annoying stubs in
the previous code. Also, while I'm here, I've moved a lot of
duplicated modalfatalbox() type functions from application main
program files into wincons.c / uxcons.c, which I think saves
duplication overall. (A minor visible effect is that the prefixes on
those console-based fatal error messages will now be more consistent
between applications.)
2018-10-11 21:58:42 +03:00
|
|
|
Seat *seat;
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
LogContext *logctx;
|
2018-09-11 17:02:59 +03:00
|
|
|
Ldisc *ldisc;
|
2002-10-25 15:30:33 +04:00
|
|
|
int term_width, term_height;
|
|
|
|
|
|
|
|
int opt_states[NUM_OPTS];
|
|
|
|
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
bool echoing, editing;
|
|
|
|
bool activated;
|
2019-02-06 23:42:44 +03:00
|
|
|
size_t bufsize;
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
bool in_synch;
|
2019-02-11 09:58:07 +03:00
|
|
|
int sb_opt;
|
|
|
|
strbuf *sb_buf;
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
bool session_started;
|
2002-10-25 15:30:33 +04:00
|
|
|
|
|
|
|
enum {
|
2019-09-08 22:29:00 +03:00
|
|
|
TOP_LEVEL, SEENIAC, SEENWILL, SEENWONT, SEENDO, SEENDONT,
|
|
|
|
SEENSB, SUBNEGOT, SUBNEG_IAC, SEENCR
|
2002-10-25 15:30:33 +04:00
|
|
|
} state;
|
|
|
|
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
Conf *conf;
|
2004-11-27 16:20:21 +03:00
|
|
|
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
Pinger *pinger;
|
2018-05-27 11:29:33 +03:00
|
|
|
|
2018-10-05 09:24:16 +03:00
|
|
|
Plug plug;
|
2018-09-11 18:23:38 +03:00
|
|
|
Backend backend;
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
};
|
2002-10-25 15:30:33 +04:00
|
|
|
|
2001-08-25 21:09:23 +04:00
|
|
|
#define TELNET_MAX_BACKLOG 4096
|
|
|
|
|
1999-01-08 16:02:13 +03:00
|
|
|
#define SB_DELTA 1024
|
|
|
|
|
2019-02-06 23:42:44 +03:00
|
|
|
static void c_write(Telnet *telnet, const void *buf, size_t len)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2019-02-06 23:42:44 +03:00
|
|
|
size_t backlog = seat_stdout(telnet->seat, buf, len);
|
2002-10-25 15:30:33 +04:00
|
|
|
sk_set_frozen(telnet->s, backlog > TELNET_MAX_BACKLOG);
|
2000-10-20 17:51:46 +04:00
|
|
|
}
|
|
|
|
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
static void log_option(Telnet *telnet, const char *sender, int cmd, int option)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2002-11-01 15:52:51 +03:00
|
|
|
/*
|
|
|
|
* The strange-looking "<?""?>" below is there to avoid a
|
|
|
|
* trigraph - a double question mark followed by > maps to a
|
|
|
|
* closing brace character!
|
|
|
|
*/
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
logeventf(telnet->logctx, "%s:\t%s %s", sender,
|
|
|
|
(cmd == WILL ? "WILL" : cmd == WONT ? "WONT" :
|
|
|
|
cmd == DO ? "DO" : cmd == DONT ? "DONT" : "<?""?>"),
|
|
|
|
telopt(option));
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
static void send_opt(Telnet *telnet, int cmd, int option)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
1999-01-08 16:02:13 +03:00
|
|
|
unsigned char b[3];
|
|
|
|
|
2001-05-06 18:35:20 +04:00
|
|
|
b[0] = IAC;
|
|
|
|
b[1] = cmd;
|
|
|
|
b[2] = option;
|
2018-05-26 10:31:34 +03:00
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 3);
|
2002-10-26 16:58:13 +04:00
|
|
|
log_option(telnet, "client", cmd, option);
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
static void deactivate_option(Telnet *telnet, const struct Opt *o)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2002-10-25 15:30:33 +04:00
|
|
|
if (telnet->opt_states[o->index] == REQUESTED ||
|
2019-09-08 22:29:00 +03:00
|
|
|
telnet->opt_states[o->index] == ACTIVE)
|
|
|
|
send_opt(telnet, o->nsend, o->option);
|
2002-10-25 15:30:33 +04:00
|
|
|
telnet->opt_states[o->index] = REALLY_INACTIVE;
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
|
2000-10-24 15:16:25 +04:00
|
|
|
/*
|
|
|
|
* Generate side effects of enabling or disabling an option.
|
|
|
|
*/
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
static void option_side_effects(
|
|
|
|
Telnet *telnet, const struct Opt *o, bool enabled)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2001-01-24 17:08:20 +03:00
|
|
|
if (o->option == TELOPT_ECHO && o->send == DO)
|
2019-09-08 22:29:00 +03:00
|
|
|
telnet->echoing = !enabled;
|
2001-02-05 16:04:00 +03:00
|
|
|
else if (o->option == TELOPT_SGA && o->send == DO)
|
2019-09-08 22:29:00 +03:00
|
|
|
telnet->editing = !enabled;
|
|
|
|
if (telnet->ldisc) /* cause ldisc to notice the change */
|
|
|
|
ldisc_echoedit_update(telnet->ldisc);
|
2001-05-09 17:51:07 +04:00
|
|
|
|
|
|
|
/* Ensure we get the minimum options */
|
2002-10-25 15:30:33 +04:00
|
|
|
if (!telnet->activated) {
|
2019-09-08 22:29:00 +03:00
|
|
|
if (telnet->opt_states[o_echo.index] == INACTIVE) {
|
|
|
|
telnet->opt_states[o_echo.index] = REQUESTED;
|
|
|
|
send_opt(telnet, o_echo.send, o_echo.option);
|
|
|
|
}
|
|
|
|
if (telnet->opt_states[o_we_sga.index] == INACTIVE) {
|
|
|
|
telnet->opt_states[o_we_sga.index] = REQUESTED;
|
|
|
|
send_opt(telnet, o_we_sga.send, o_we_sga.option);
|
|
|
|
}
|
|
|
|
if (telnet->opt_states[o_they_sga.index] == INACTIVE) {
|
|
|
|
telnet->opt_states[o_they_sga.index] = REQUESTED;
|
|
|
|
send_opt(telnet, o_they_sga.send, o_they_sga.option);
|
|
|
|
}
|
|
|
|
telnet->activated = true;
|
2001-05-09 17:51:07 +04:00
|
|
|
}
|
2000-10-24 15:16:25 +04:00
|
|
|
}
|
|
|
|
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
static void activate_option(Telnet *telnet, const struct Opt *o)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
1999-01-08 16:02:13 +03:00
|
|
|
if (o->send == WILL && o->option == TELOPT_NAWS)
|
2018-09-11 18:23:38 +03:00
|
|
|
backend_size(&telnet->backend,
|
|
|
|
telnet->term_width, telnet->term_height);
|
1999-01-08 16:02:13 +03:00
|
|
|
if (o->send == WILL &&
|
2019-09-08 22:29:00 +03:00
|
|
|
(o->option == TELOPT_NEW_ENVIRON ||
|
|
|
|
o->option == TELOPT_OLD_ENVIRON)) {
|
|
|
|
/*
|
|
|
|
* We may only have one kind of ENVIRON going at a time.
|
|
|
|
* This is a hack, but who cares.
|
|
|
|
*/
|
|
|
|
deactivate_option(telnet, o->option ==
|
|
|
|
TELOPT_NEW_ENVIRON ? &o_oenv : &o_nenv);
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
option_side_effects(telnet, o, true);
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
static void refused_option(Telnet *telnet, const struct Opt *o)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
1999-01-08 16:02:13 +03:00
|
|
|
if (o->send == WILL && o->option == TELOPT_NEW_ENVIRON &&
|
2019-09-08 22:29:00 +03:00
|
|
|
telnet->opt_states[o_oenv.index] == INACTIVE) {
|
|
|
|
send_opt(telnet, WILL, TELOPT_OLD_ENVIRON);
|
|
|
|
telnet->opt_states[o_oenv.index] = REQUESTED;
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
option_side_effects(telnet, o, false);
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
static void proc_rec_opt(Telnet *telnet, int cmd, int option)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2002-10-25 15:30:33 +04:00
|
|
|
const struct Opt *const *o;
|
1999-01-08 16:02:13 +03:00
|
|
|
|
2002-10-26 16:58:13 +04:00
|
|
|
log_option(telnet, "server", cmd, option);
|
1999-01-08 16:02:13 +03:00
|
|
|
for (o = opts; *o; o++) {
|
2019-09-08 22:29:00 +03:00
|
|
|
if ((*o)->option == option && (*o)->ack == cmd) {
|
|
|
|
switch (telnet->opt_states[(*o)->index]) {
|
|
|
|
case REQUESTED:
|
|
|
|
telnet->opt_states[(*o)->index] = ACTIVE;
|
|
|
|
activate_option(telnet, *o);
|
|
|
|
break;
|
|
|
|
case ACTIVE:
|
|
|
|
break;
|
|
|
|
case INACTIVE:
|
|
|
|
telnet->opt_states[(*o)->index] = ACTIVE;
|
|
|
|
send_opt(telnet, (*o)->send, option);
|
|
|
|
activate_option(telnet, *o);
|
|
|
|
break;
|
|
|
|
case REALLY_INACTIVE:
|
|
|
|
send_opt(telnet, (*o)->nsend, option);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
return;
|
|
|
|
} else if ((*o)->option == option && (*o)->nak == cmd) {
|
|
|
|
switch (telnet->opt_states[(*o)->index]) {
|
|
|
|
case REQUESTED:
|
|
|
|
telnet->opt_states[(*o)->index] = INACTIVE;
|
|
|
|
refused_option(telnet, *o);
|
|
|
|
break;
|
|
|
|
case ACTIVE:
|
|
|
|
telnet->opt_states[(*o)->index] = INACTIVE;
|
|
|
|
send_opt(telnet, (*o)->nsend, option);
|
|
|
|
option_side_effects(telnet, *o, false);
|
|
|
|
break;
|
|
|
|
case INACTIVE:
|
|
|
|
case REALLY_INACTIVE:
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
return;
|
|
|
|
}
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
/*
|
|
|
|
* If we reach here, the option was one we weren't prepared to
|
2005-03-16 16:20:02 +03:00
|
|
|
* cope with. If the request was positive (WILL or DO), we send
|
|
|
|
* a negative ack to indicate refusal. If the request was
|
|
|
|
* negative (WONT / DONT), we must do nothing.
|
1999-01-08 16:02:13 +03:00
|
|
|
*/
|
2005-03-16 16:20:02 +03:00
|
|
|
if (cmd == WILL || cmd == DO)
|
|
|
|
send_opt(telnet, (cmd == WILL ? DONT : WONT), option);
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
static void process_subneg(Telnet *telnet)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
unsigned char *b, *p, *q;
|
|
|
|
int var, value, n, bsize;
|
|
|
|
char *e, *eval, *ekey, *user;
|
1999-01-08 16:02:13 +03:00
|
|
|
|
2002-10-25 15:30:33 +04:00
|
|
|
switch (telnet->sb_opt) {
|
1999-01-08 16:02:13 +03:00
|
|
|
case TELOPT_TSPEED:
|
2019-09-08 22:29:00 +03:00
|
|
|
if (telnet->sb_buf->len == 1 && telnet->sb_buf->u[0] == TELQUAL_SEND) {
|
|
|
|
char *termspeed = conf_get_str(telnet->conf, CONF_termspeed);
|
|
|
|
b = snewn(20 + strlen(termspeed), unsigned char);
|
|
|
|
b[0] = IAC;
|
|
|
|
b[1] = SB;
|
|
|
|
b[2] = TELOPT_TSPEED;
|
|
|
|
b[3] = TELQUAL_IS;
|
|
|
|
strcpy((char *)(b + 4), termspeed);
|
|
|
|
n = 4 + strlen(termspeed);
|
|
|
|
b[n] = IAC;
|
|
|
|
b[n + 1] = SE;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, n + 2);
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
logevent(telnet->logctx, "server:\tSB TSPEED SEND");
|
|
|
|
logeventf(telnet->logctx, "client:\tSB TSPEED IS %s", termspeed);
|
2019-09-08 22:29:00 +03:00
|
|
|
sfree(b);
|
|
|
|
} else
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
logevent(telnet->logctx, "server:\tSB TSPEED <something weird>");
|
2019-09-08 22:29:00 +03:00
|
|
|
break;
|
1999-01-08 16:02:13 +03:00
|
|
|
case TELOPT_TTYPE:
|
2019-09-08 22:29:00 +03:00
|
|
|
if (telnet->sb_buf->len == 1 && telnet->sb_buf->u[0] == TELQUAL_SEND) {
|
|
|
|
char *termtype = conf_get_str(telnet->conf, CONF_termtype);
|
|
|
|
b = snewn(20 + strlen(termtype), unsigned char);
|
|
|
|
b[0] = IAC;
|
|
|
|
b[1] = SB;
|
|
|
|
b[2] = TELOPT_TTYPE;
|
|
|
|
b[3] = TELQUAL_IS;
|
|
|
|
for (n = 0; termtype[n]; n++)
|
|
|
|
b[n + 4] = (termtype[n] >= 'a' && termtype[n] <= 'z' ?
|
|
|
|
termtype[n] + 'A' - 'a' :
|
|
|
|
termtype[n]);
|
|
|
|
b[n + 4] = IAC;
|
|
|
|
b[n + 5] = SE;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, n + 6);
|
|
|
|
b[n + 4] = 0;
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
logevent(telnet->logctx, "server:\tSB TTYPE SEND");
|
|
|
|
logeventf(telnet->logctx, "client:\tSB TTYPE IS %s", b + 4);
|
2019-09-08 22:29:00 +03:00
|
|
|
sfree(b);
|
|
|
|
} else
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
logevent(telnet->logctx, "server:\tSB TTYPE <something weird>\r\n");
|
2019-09-08 22:29:00 +03:00
|
|
|
break;
|
1999-01-08 16:02:13 +03:00
|
|
|
case TELOPT_OLD_ENVIRON:
|
2001-05-06 18:35:20 +04:00
|
|
|
case TELOPT_NEW_ENVIRON:
|
2019-09-08 22:29:00 +03:00
|
|
|
p = telnet->sb_buf->u;
|
|
|
|
q = p + telnet->sb_buf->len;
|
|
|
|
if (p < q && *p == TELQUAL_SEND) {
|
|
|
|
p++;
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
logeventf(telnet->logctx, "server:\tSB %s SEND",
|
|
|
|
telopt(telnet->sb_opt));
|
2019-09-08 22:29:00 +03:00
|
|
|
if (telnet->sb_opt == TELOPT_OLD_ENVIRON) {
|
|
|
|
if (conf_get_bool(telnet->conf, CONF_rfc_environ)) {
|
|
|
|
value = RFC_VALUE;
|
|
|
|
var = RFC_VAR;
|
|
|
|
} else {
|
|
|
|
value = BSD_VALUE;
|
|
|
|
var = BSD_VAR;
|
|
|
|
}
|
|
|
|
/*
|
|
|
|
* Try to guess the sense of VAR and VALUE.
|
|
|
|
*/
|
|
|
|
while (p < q) {
|
|
|
|
if (*p == RFC_VAR) {
|
|
|
|
value = RFC_VALUE;
|
|
|
|
var = RFC_VAR;
|
|
|
|
} else if (*p == BSD_VAR) {
|
|
|
|
value = BSD_VALUE;
|
|
|
|
var = BSD_VAR;
|
|
|
|
}
|
|
|
|
p++;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
/*
|
|
|
|
* With NEW_ENVIRON, the sense of VAR and VALUE
|
|
|
|
* isn't in doubt.
|
|
|
|
*/
|
|
|
|
value = RFC_VALUE;
|
|
|
|
var = RFC_VAR;
|
|
|
|
}
|
|
|
|
bsize = 20;
|
|
|
|
for (eval = conf_get_str_strs(telnet->conf, CONF_environmt,
|
|
|
|
NULL, &ekey);
|
|
|
|
eval != NULL;
|
|
|
|
eval = conf_get_str_strs(telnet->conf, CONF_environmt,
|
|
|
|
ekey, &ekey))
|
|
|
|
bsize += strlen(ekey) + strlen(eval) + 2;
|
|
|
|
user = get_remote_username(telnet->conf);
|
|
|
|
if (user)
|
|
|
|
bsize += 6 + strlen(user);
|
|
|
|
|
|
|
|
b = snewn(bsize, unsigned char);
|
|
|
|
b[0] = IAC;
|
|
|
|
b[1] = SB;
|
|
|
|
b[2] = telnet->sb_opt;
|
|
|
|
b[3] = TELQUAL_IS;
|
|
|
|
n = 4;
|
|
|
|
for (eval = conf_get_str_strs(telnet->conf, CONF_environmt,
|
|
|
|
NULL, &ekey);
|
|
|
|
eval != NULL;
|
|
|
|
eval = conf_get_str_strs(telnet->conf, CONF_environmt,
|
|
|
|
ekey, &ekey)) {
|
|
|
|
b[n++] = var;
|
|
|
|
for (e = ekey; *e; e++)
|
|
|
|
b[n++] = *e;
|
|
|
|
b[n++] = value;
|
|
|
|
for (e = eval; *e; e++)
|
|
|
|
b[n++] = *e;
|
|
|
|
}
|
|
|
|
if (user) {
|
|
|
|
b[n++] = var;
|
|
|
|
b[n++] = 'U';
|
|
|
|
b[n++] = 'S';
|
|
|
|
b[n++] = 'E';
|
|
|
|
b[n++] = 'R';
|
|
|
|
b[n++] = value;
|
|
|
|
for (e = user; *e; e++)
|
|
|
|
b[n++] = *e;
|
|
|
|
}
|
|
|
|
b[n++] = IAC;
|
|
|
|
b[n++] = SE;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, n);
|
|
|
|
if (n == 6) {
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
logeventf(telnet->logctx, "client:\tSB %s IS <nothing>",
|
|
|
|
telopt(telnet->sb_opt));
|
2019-09-08 22:29:00 +03:00
|
|
|
} else {
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
logeventf(telnet->logctx, "client:\tSB %s IS:",
|
|
|
|
telopt(telnet->sb_opt));
|
2019-09-08 22:29:00 +03:00
|
|
|
for (eval = conf_get_str_strs(telnet->conf, CONF_environmt,
|
|
|
|
NULL, &ekey);
|
|
|
|
eval != NULL;
|
|
|
|
eval = conf_get_str_strs(telnet->conf, CONF_environmt,
|
|
|
|
ekey, &ekey)) {
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
logeventf(telnet->logctx, "\t%s=%s", ekey, eval);
|
2019-09-08 22:29:00 +03:00
|
|
|
}
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
if (user)
|
|
|
|
logeventf(telnet->logctx, "\tUSER=%s", user);
|
2019-09-08 22:29:00 +03:00
|
|
|
}
|
|
|
|
sfree(b);
|
|
|
|
sfree(user);
|
|
|
|
}
|
|
|
|
break;
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-02-06 23:42:44 +03:00
|
|
|
static void do_telnet_read(Telnet *telnet, const char *buf, size_t len)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2019-03-01 22:28:00 +03:00
|
|
|
strbuf *outbuf = strbuf_new_nm();
|
1999-01-08 16:02:13 +03:00
|
|
|
|
|
|
|
while (len--) {
|
2019-09-08 22:29:00 +03:00
|
|
|
int c = (unsigned char) *buf++;
|
|
|
|
|
|
|
|
switch (telnet->state) {
|
|
|
|
case TOP_LEVEL:
|
|
|
|
case SEENCR:
|
|
|
|
if (c == NUL && telnet->state == SEENCR)
|
|
|
|
telnet->state = TOP_LEVEL;
|
|
|
|
else if (c == IAC)
|
|
|
|
telnet->state = SEENIAC;
|
|
|
|
else {
|
|
|
|
if (!telnet->in_synch)
|
|
|
|
put_byte(outbuf, c);
|
2000-03-17 13:37:35 +03:00
|
|
|
|
|
|
|
#if 1
|
2019-09-08 22:29:00 +03:00
|
|
|
/* I can't get the F***ing winsock to insert the urgent IAC
|
|
|
|
* into the right position! Even with SO_OOBINLINE it gives
|
|
|
|
* it to recv too soon. And of course the DM byte (that
|
|
|
|
* arrives in the same packet!) appears several K later!!
|
|
|
|
*
|
|
|
|
* Oh well, we do get the DM in the right place so I'll
|
|
|
|
* just stop hiding on the next 0xf2 and hope for the best.
|
|
|
|
*/
|
|
|
|
else if (c == DM)
|
|
|
|
telnet->in_synch = false;
|
2000-03-17 13:37:35 +03:00
|
|
|
#endif
|
2019-09-08 22:29:00 +03:00
|
|
|
if (c == CR && telnet->opt_states[o_they_bin.index] != ACTIVE)
|
|
|
|
telnet->state = SEENCR;
|
|
|
|
else
|
|
|
|
telnet->state = TOP_LEVEL;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
case SEENIAC:
|
|
|
|
if (c == DO)
|
|
|
|
telnet->state = SEENDO;
|
|
|
|
else if (c == DONT)
|
|
|
|
telnet->state = SEENDONT;
|
|
|
|
else if (c == WILL)
|
|
|
|
telnet->state = SEENWILL;
|
|
|
|
else if (c == WONT)
|
|
|
|
telnet->state = SEENWONT;
|
|
|
|
else if (c == SB)
|
|
|
|
telnet->state = SEENSB;
|
|
|
|
else if (c == DM) {
|
|
|
|
telnet->in_synch = false;
|
|
|
|
telnet->state = TOP_LEVEL;
|
|
|
|
} else {
|
|
|
|
/* ignore everything else; print it if it's IAC */
|
|
|
|
if (c == IAC) {
|
|
|
|
put_byte(outbuf, c);
|
|
|
|
}
|
|
|
|
telnet->state = TOP_LEVEL;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
case SEENWILL:
|
|
|
|
proc_rec_opt(telnet, WILL, c);
|
|
|
|
telnet->state = TOP_LEVEL;
|
|
|
|
break;
|
|
|
|
case SEENWONT:
|
|
|
|
proc_rec_opt(telnet, WONT, c);
|
|
|
|
telnet->state = TOP_LEVEL;
|
|
|
|
break;
|
|
|
|
case SEENDO:
|
|
|
|
proc_rec_opt(telnet, DO, c);
|
|
|
|
telnet->state = TOP_LEVEL;
|
|
|
|
break;
|
|
|
|
case SEENDONT:
|
|
|
|
proc_rec_opt(telnet, DONT, c);
|
|
|
|
telnet->state = TOP_LEVEL;
|
|
|
|
break;
|
|
|
|
case SEENSB:
|
|
|
|
telnet->sb_opt = c;
|
2020-01-21 23:16:28 +03:00
|
|
|
strbuf_clear(telnet->sb_buf);
|
2019-09-08 22:29:00 +03:00
|
|
|
telnet->state = SUBNEGOT;
|
|
|
|
break;
|
|
|
|
case SUBNEGOT:
|
|
|
|
if (c == IAC)
|
|
|
|
telnet->state = SUBNEG_IAC;
|
|
|
|
else {
|
|
|
|
subneg_addchar:
|
|
|
|
put_byte(telnet->sb_buf, c);
|
|
|
|
telnet->state = SUBNEGOT; /* in case we came here by goto */
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
case SUBNEG_IAC:
|
|
|
|
if (c != SE)
|
|
|
|
goto subneg_addchar; /* yes, it's a hack, I know, but... */
|
|
|
|
else {
|
|
|
|
process_subneg(telnet);
|
|
|
|
telnet->state = TOP_LEVEL;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
}
|
2019-02-04 23:45:40 +03:00
|
|
|
|
|
|
|
if (outbuf->len >= 4096) {
|
|
|
|
c_write(telnet, outbuf->u, outbuf->len);
|
2020-01-21 23:16:28 +03:00
|
|
|
strbuf_clear(outbuf);
|
2019-02-04 23:45:40 +03:00
|
|
|
}
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
2007-01-08 21:54:49 +03:00
|
|
|
|
2019-02-04 23:45:40 +03:00
|
|
|
if (outbuf->len)
|
2019-09-08 22:29:00 +03:00
|
|
|
c_write(telnet, outbuf->u, outbuf->len);
|
2019-02-04 23:45:40 +03:00
|
|
|
strbuf_free(outbuf);
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
|
2020-02-07 22:17:45 +03:00
|
|
|
static void telnet_log(Plug *plug, PlugLogType type, SockAddr *addr, int port,
|
2019-09-08 22:29:00 +03:00
|
|
|
const char *error_msg, int error_code)
|
2005-01-16 17:29:34 +03:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(plug, Telnet, plug);
|
New abstraction 'Seat', to pass to backends.
This is a new vtable-based abstraction which is passed to a backend in
place of Frontend, and it implements only the subset of the Frontend
functions needed by a backend. (Many other Frontend functions still
exist, notably the wide range of things called by terminal.c providing
platform-independent operations on the GUI terminal window.)
The purpose of making it a vtable is that this opens up the
possibility of creating a backend as an internal implementation detail
of some other activity, by providing just that one backend with a
custom Seat that implements the methods differently.
For example, this refactoring should make it feasible to directly
implement an SSH proxy type, aka the 'jump host' feature supported by
OpenSSH, aka 'open a secondary SSH session in MAINCHAN_DIRECT_TCP
mode, and then expose the main channel of that as the Socket for the
primary connection'. (Which of course you can already do by spawning
'plink -nc' as a separate proxy process, but this would permit it in
the _same_ process without anything getting confused.)
I've centralised a full set of stub methods in misc.c for the new
abstraction, which allows me to get rid of several annoying stubs in
the previous code. Also, while I'm here, I've moved a lot of
duplicated modalfatalbox() type functions from application main
program files into wincons.c / uxcons.c, which I think saves
duplication overall. (A minor visible effect is that the prefixes on
those console-based fatal error messages will now be more consistent
between applications.)
2018-10-11 21:58:42 +03:00
|
|
|
backend_socket_log(telnet->seat, telnet->logctx, type, addr, port,
|
2015-11-22 17:33:28 +03:00
|
|
|
error_msg, error_code, telnet->conf,
|
|
|
|
telnet->session_started);
|
2005-01-16 17:29:34 +03:00
|
|
|
}
|
|
|
|
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
static void telnet_closing(Plug *plug, const char *error_msg, int error_code,
|
2019-09-08 22:29:00 +03:00
|
|
|
bool calling_back)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(plug, Telnet, plug);
|
2002-10-25 15:30:33 +04:00
|
|
|
|
2011-09-13 15:44:03 +04:00
|
|
|
/*
|
|
|
|
* We don't implement independent EOF in each direction for Telnet
|
|
|
|
* connections; as soon as we get word that the remote side has
|
|
|
|
* sent us EOF, we wind up the whole connection.
|
|
|
|
*/
|
|
|
|
|
2002-10-25 15:30:33 +04:00
|
|
|
if (telnet->s) {
|
|
|
|
sk_close(telnet->s);
|
|
|
|
telnet->s = NULL;
|
2012-12-22 13:40:47 +04:00
|
|
|
if (error_msg)
|
2018-10-29 22:50:29 +03:00
|
|
|
telnet->closed_on_socket_error = true;
|
2019-09-08 22:29:00 +03:00
|
|
|
seat_notify_remote_exit(telnet->seat);
|
2001-07-31 18:23:21 +04:00
|
|
|
}
|
2001-03-13 13:22:45 +03:00
|
|
|
if (error_msg) {
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
logevent(telnet->logctx, error_msg);
|
2019-09-08 22:29:00 +03:00
|
|
|
seat_connection_fatal(telnet->seat, "%s", error_msg);
|
2005-01-16 17:29:34 +03:00
|
|
|
}
|
|
|
|
/* Otherwise, the remote side closed the connection normally. */
|
2001-03-13 13:22:45 +03:00
|
|
|
}
|
|
|
|
|
2019-02-06 23:42:44 +03:00
|
|
|
static void telnet_receive(
|
|
|
|
Plug *plug, int urgent, const char *data, size_t len)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(plug, Telnet, plug);
|
2001-05-06 18:35:20 +04:00
|
|
|
if (urgent)
|
2019-09-08 22:29:00 +03:00
|
|
|
telnet->in_synch = true;
|
2018-10-29 22:50:29 +03:00
|
|
|
telnet->session_started = true;
|
2002-10-25 15:30:33 +04:00
|
|
|
do_telnet_read(telnet, data, len);
|
2000-10-23 14:32:37 +04:00
|
|
|
}
|
|
|
|
|
2019-02-06 23:42:44 +03:00
|
|
|
static void telnet_sent(Plug *plug, size_t bufsize)
|
2001-09-08 02:39:01 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(plug, Telnet, plug);
|
2002-10-25 15:30:33 +04:00
|
|
|
telnet->bufsize = bufsize;
|
2001-09-08 02:39:01 +04:00
|
|
|
}
|
|
|
|
|
2018-10-05 09:03:46 +03:00
|
|
|
static const PlugVtable Telnet_plugvt = {
|
2018-05-27 11:29:33 +03:00
|
|
|
telnet_log,
|
|
|
|
telnet_closing,
|
|
|
|
telnet_receive,
|
|
|
|
telnet_sent
|
|
|
|
};
|
|
|
|
|
1999-01-08 16:02:13 +03:00
|
|
|
/*
|
2000-10-23 14:32:37 +04:00
|
|
|
* Called to set up the Telnet connection.
|
1999-01-08 16:02:13 +03:00
|
|
|
*
|
|
|
|
* Returns an error message, or NULL on success.
|
|
|
|
*
|
2001-05-09 18:01:15 +04:00
|
|
|
* Also places the canonical host name into `realhost'. It must be
|
|
|
|
* freed by the caller.
|
1999-01-08 16:02:13 +03:00
|
|
|
*/
|
2020-02-16 14:43:20 +03:00
|
|
|
static const char *telnet_init(const BackendVtable *vt, Seat *seat,
|
|
|
|
Backend **backend_handle, LogContext *logctx,
|
|
|
|
Conf *conf, const char *host, int port,
|
2019-09-08 22:29:00 +03:00
|
|
|
char **realhost, bool nodelay, bool keepalive)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
SockAddr *addr;
|
2003-05-04 18:18:18 +04:00
|
|
|
const char *err;
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
Telnet *telnet;
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
char *loghost;
|
|
|
|
int addressfamily;
|
2002-10-25 15:30:33 +04:00
|
|
|
|
2019-03-10 17:42:11 +03:00
|
|
|
/* No local authentication phase in this protocol */
|
|
|
|
seat_set_trust_status(seat, false);
|
|
|
|
|
Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.
All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.
A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 21:10:23 +03:00
|
|
|
telnet = snew(Telnet);
|
2018-10-05 09:24:16 +03:00
|
|
|
telnet->plug.vt = &Telnet_plugvt;
|
2020-02-16 14:43:20 +03:00
|
|
|
telnet->backend.vt = vt;
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
telnet->conf = conf_copy(conf);
|
2002-10-25 15:30:33 +04:00
|
|
|
telnet->s = NULL;
|
2018-10-29 22:50:29 +03:00
|
|
|
telnet->closed_on_socket_error = false;
|
|
|
|
telnet->echoing = true;
|
|
|
|
telnet->editing = true;
|
|
|
|
telnet->activated = false;
|
2019-02-11 09:58:07 +03:00
|
|
|
telnet->sb_buf = strbuf_new();
|
New abstraction 'Seat', to pass to backends.
This is a new vtable-based abstraction which is passed to a backend in
place of Frontend, and it implements only the subset of the Frontend
functions needed by a backend. (Many other Frontend functions still
exist, notably the wide range of things called by terminal.c providing
platform-independent operations on the GUI terminal window.)
The purpose of making it a vtable is that this opens up the
possibility of creating a backend as an internal implementation detail
of some other activity, by providing just that one backend with a
custom Seat that implements the methods differently.
For example, this refactoring should make it feasible to directly
implement an SSH proxy type, aka the 'jump host' feature supported by
OpenSSH, aka 'open a secondary SSH session in MAINCHAN_DIRECT_TCP
mode, and then expose the main channel of that as the Socket for the
primary connection'. (Which of course you can already do by spawning
'plink -nc' as a separate proxy process, but this would permit it in
the _same_ process without anything getting confused.)
I've centralised a full set of stub methods in misc.c for the new
abstraction, which allows me to get rid of several annoying stubs in
the previous code. Also, while I'm here, I've moved a lot of
duplicated modalfatalbox() type functions from application main
program files into wincons.c / uxcons.c, which I think saves
duplication overall. (A minor visible effect is that the prefixes on
those console-based fatal error messages will now be more consistent
between applications.)
2018-10-11 21:58:42 +03:00
|
|
|
telnet->seat = seat;
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
telnet->logctx = logctx;
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
telnet->term_width = conf_get_int(telnet->conf, CONF_width);
|
|
|
|
telnet->term_height = conf_get_int(telnet->conf, CONF_height);
|
2002-10-25 15:30:33 +04:00
|
|
|
telnet->state = TOP_LEVEL;
|
2004-11-23 19:43:04 +03:00
|
|
|
telnet->ldisc = NULL;
|
2004-11-27 16:20:21 +03:00
|
|
|
telnet->pinger = NULL;
|
2018-10-29 22:50:29 +03:00
|
|
|
telnet->session_started = true;
|
2018-09-11 18:23:38 +03:00
|
|
|
*backend_handle = &telnet->backend;
|
2002-10-22 20:11:33 +04:00
|
|
|
|
1999-01-08 16:02:13 +03:00
|
|
|
/*
|
|
|
|
* Try to find host.
|
|
|
|
*/
|
2015-11-22 12:58:14 +03:00
|
|
|
addressfamily = conf_get_int(telnet->conf, CONF_addressfamily);
|
|
|
|
addr = name_lookup(host, port, realhost, telnet->conf, addressfamily,
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
telnet->logctx, "Telnet connection");
|
2003-08-07 20:04:33 +04:00
|
|
|
if ((err = sk_addr_error(addr)) != NULL) {
|
2019-09-08 22:29:00 +03:00
|
|
|
sk_addr_free(addr);
|
|
|
|
return err;
|
2003-08-07 20:04:33 +04:00
|
|
|
}
|
1999-01-08 16:02:13 +03:00
|
|
|
|
|
|
|
if (port < 0)
|
2019-09-08 22:29:00 +03:00
|
|
|
port = 23; /* default telnet port */
|
1999-01-08 16:02:13 +03:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Open socket.
|
|
|
|
*/
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
telnet->s = new_connection(addr, *realhost, port, false, true, nodelay,
|
|
|
|
keepalive, &telnet->plug, telnet->conf);
|
2003-01-04 19:42:53 +03:00
|
|
|
if ((err = sk_socket_error(telnet->s)) != NULL)
|
2019-09-08 22:29:00 +03:00
|
|
|
return err;
|
1999-01-08 16:02:13 +03:00
|
|
|
|
2018-09-11 18:23:38 +03:00
|
|
|
telnet->pinger = pinger_new(telnet->conf, &telnet->backend);
|
2004-11-27 16:20:21 +03:00
|
|
|
|
1999-01-08 16:02:13 +03:00
|
|
|
/*
|
|
|
|
* Initialise option states.
|
|
|
|
*/
|
2018-10-29 22:57:31 +03:00
|
|
|
if (conf_get_bool(telnet->conf, CONF_passive_telnet)) {
|
2019-09-08 22:29:00 +03:00
|
|
|
const struct Opt *const *o;
|
2001-05-09 17:51:07 +04:00
|
|
|
|
2019-09-08 22:29:00 +03:00
|
|
|
for (o = opts; *o; o++)
|
|
|
|
telnet->opt_states[(*o)->index] = INACTIVE;
|
2001-05-09 17:51:07 +04:00
|
|
|
} else {
|
2019-09-08 22:29:00 +03:00
|
|
|
const struct Opt *const *o;
|
|
|
|
|
|
|
|
for (o = opts; *o; o++) {
|
|
|
|
telnet->opt_states[(*o)->index] = (*o)->initial_state;
|
|
|
|
if (telnet->opt_states[(*o)->index] == REQUESTED)
|
|
|
|
send_opt(telnet, (*o)->send, (*o)->option);
|
|
|
|
}
|
|
|
|
telnet->activated = true;
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Set up SYNCH state.
|
|
|
|
*/
|
2018-10-29 22:50:29 +03:00
|
|
|
telnet->in_synch = false;
|
2000-09-22 17:10:19 +04:00
|
|
|
|
2004-10-17 18:44:27 +04:00
|
|
|
/*
|
|
|
|
* We can send special commands from the start.
|
|
|
|
*/
|
New abstraction 'Seat', to pass to backends.
This is a new vtable-based abstraction which is passed to a backend in
place of Frontend, and it implements only the subset of the Frontend
functions needed by a backend. (Many other Frontend functions still
exist, notably the wide range of things called by terminal.c providing
platform-independent operations on the GUI terminal window.)
The purpose of making it a vtable is that this opens up the
possibility of creating a backend as an internal implementation detail
of some other activity, by providing just that one backend with a
custom Seat that implements the methods differently.
For example, this refactoring should make it feasible to directly
implement an SSH proxy type, aka the 'jump host' feature supported by
OpenSSH, aka 'open a secondary SSH session in MAINCHAN_DIRECT_TCP
mode, and then expose the main channel of that as the Socket for the
primary connection'. (Which of course you can already do by spawning
'plink -nc' as a separate proxy process, but this would permit it in
the _same_ process without anything getting confused.)
I've centralised a full set of stub methods in misc.c for the new
abstraction, which allows me to get rid of several annoying stubs in
the previous code. Also, while I'm here, I've moved a lot of
duplicated modalfatalbox() type functions from application main
program files into wincons.c / uxcons.c, which I think saves
duplication overall. (A minor visible effect is that the prefixes on
those console-based fatal error messages will now be more consistent
between applications.)
2018-10-11 21:58:42 +03:00
|
|
|
seat_update_specials_menu(telnet->seat);
|
2004-10-17 18:44:27 +04:00
|
|
|
|
2008-06-01 15:16:32 +04:00
|
|
|
/*
|
|
|
|
* loghost overrides realhost, if specified.
|
|
|
|
*/
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
loghost = conf_get_str(telnet->conf, CONF_loghost);
|
|
|
|
if (*loghost) {
|
2019-09-08 22:29:00 +03:00
|
|
|
char *colon;
|
2008-06-01 15:16:32 +04:00
|
|
|
|
2019-09-08 22:29:00 +03:00
|
|
|
sfree(*realhost);
|
|
|
|
*realhost = dupstr(loghost);
|
2014-01-25 19:58:54 +04:00
|
|
|
|
2019-09-08 22:29:00 +03:00
|
|
|
colon = host_strrchr(*realhost, ':');
|
|
|
|
if (colon)
|
|
|
|
*colon++ = '\0';
|
2008-06-01 15:16:32 +04:00
|
|
|
}
|
|
|
|
|
1999-01-08 16:02:13 +03:00
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2018-09-11 18:23:38 +03:00
|
|
|
static void telnet_free(Backend *be)
|
2003-01-16 02:30:21 +03:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(be, Telnet, backend);
|
2003-01-16 02:30:21 +03:00
|
|
|
|
2019-02-11 09:58:07 +03:00
|
|
|
strbuf_free(telnet->sb_buf);
|
2003-01-16 02:30:21 +03:00
|
|
|
if (telnet->s)
|
2019-09-08 22:29:00 +03:00
|
|
|
sk_close(telnet->s);
|
2004-11-27 16:20:21 +03:00
|
|
|
if (telnet->pinger)
|
2019-09-08 22:29:00 +03:00
|
|
|
pinger_free(telnet->pinger);
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
conf_free(telnet->conf);
|
2003-01-16 02:30:21 +03:00
|
|
|
sfree(telnet);
|
|
|
|
}
|
2003-01-12 17:48:29 +03:00
|
|
|
/*
|
|
|
|
* Reconfigure the Telnet backend. There's no immediate action
|
|
|
|
* necessary, in this backend: we just save the fresh config for
|
|
|
|
* any subsequent negotiations.
|
|
|
|
*/
|
2018-09-11 18:23:38 +03:00
|
|
|
static void telnet_reconfig(Backend *be, Conf *conf)
|
2003-01-12 17:48:29 +03:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(be, Telnet, backend);
|
Post-release destabilisation! Completely remove the struct type
'Config' in putty.h, which stores all PuTTY's settings and includes an
arbitrary length limit on every single one of those settings which is
stored in string form. In place of it is 'Conf', an opaque data type
everywhere outside the new file conf.c, which stores a list of (key,
value) pairs in which every key contains an integer identifying a
configuration setting, and for some of those integers the key also
contains extra parts (so that, for instance, CONF_environmt is a
string-to-string mapping). Everywhere that a Config was previously
used, a Conf is now; everywhere there was a Config structure copy,
conf_copy() is called; every lookup, adjustment, load and save
operation on a Config has been rewritten; and there's a mechanism for
serialising a Conf into a binary blob and back for use with Duplicate
Session.
User-visible effects of this change _should_ be minimal, though I
don't doubt I've introduced one or two bugs here and there which will
eventually be found. The _intended_ visible effects of this change are
that all arbitrary limits on configuration strings and lists (e.g.
limit on number of port forwardings) should now disappear; that list
boxes in the configuration will now be displayed in a sorted order
rather than the arbitrary order in which they were added to the list
(since the underlying data structure is now a sorted tree234 rather
than an ad-hoc comma-separated string); and one more specific change,
which is that local and dynamic port forwardings on the same port
number are now mutually exclusive in the configuration (putting 'D' in
the key rather than the value was a mistake in the first place).
One other reorganisation as a result of this is that I've moved all
the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
out into config.c, because I can't really justify calling them generic
any more. When they took a pointer to an arbitrary structure type and
the offset of a field within that structure, they were independent of
whether that structure was a Config or something completely different,
but now they really do expect to talk to a Conf, which can _only_ be
used for PuTTY configuration, so I've renamed them all things like
conf_editbox_handler and moved them out of the nominally independent
dialog-box management module into the PuTTY-specific config.c.
[originally from svn r9214]
2011-07-14 22:52:21 +04:00
|
|
|
pinger_reconfig(telnet->pinger, telnet->conf, conf);
|
|
|
|
conf_free(telnet->conf);
|
|
|
|
telnet->conf = conf_copy(conf);
|
2003-01-12 17:48:29 +03:00
|
|
|
}
|
|
|
|
|
1999-01-08 16:02:13 +03:00
|
|
|
/*
|
|
|
|
* Called to send data down the Telnet connection.
|
|
|
|
*/
|
2019-02-06 23:42:44 +03:00
|
|
|
static size_t telnet_send(Backend *be, const char *buf, size_t len)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(be, Telnet, backend);
|
2003-01-04 19:42:53 +03:00
|
|
|
unsigned char *p, *end;
|
2003-01-14 21:43:45 +03:00
|
|
|
static const unsigned char iac[2] = { IAC, IAC };
|
|
|
|
static const unsigned char cr[2] = { CR, NUL };
|
2001-05-09 19:12:26 +04:00
|
|
|
#if 0
|
2003-01-14 21:43:45 +03:00
|
|
|
static const unsigned char nl[2] = { CR, LF };
|
2001-05-09 19:12:26 +04:00
|
|
|
#endif
|
1999-01-08 16:02:13 +03:00
|
|
|
|
2002-10-25 15:30:33 +04:00
|
|
|
if (telnet->s == NULL)
|
2019-09-08 22:29:00 +03:00
|
|
|
return 0;
|
1999-01-08 16:02:13 +03:00
|
|
|
|
2003-01-04 19:42:53 +03:00
|
|
|
p = (unsigned char *)buf;
|
|
|
|
end = (unsigned char *)(buf + len);
|
|
|
|
while (p < end) {
|
2019-09-08 22:29:00 +03:00
|
|
|
unsigned char *q = p;
|
1999-01-08 16:02:13 +03:00
|
|
|
|
2019-09-08 22:29:00 +03:00
|
|
|
while (p < end && iswritable(*p))
|
|
|
|
p++;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, q, p - q);
|
1999-01-08 16:02:13 +03:00
|
|
|
|
2019-09-08 22:29:00 +03:00
|
|
|
while (p < end && !iswritable(*p)) {
|
|
|
|
telnet->bufsize =
|
|
|
|
sk_write(telnet->s, *p == IAC ? iac : cr, 2);
|
|
|
|
p++;
|
|
|
|
}
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
2001-08-25 21:09:23 +04:00
|
|
|
|
2002-10-25 15:30:33 +04:00
|
|
|
return telnet->bufsize;
|
2001-08-25 21:09:23 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Called to query the current socket sendability status.
|
|
|
|
*/
|
2019-02-06 23:42:44 +03:00
|
|
|
static size_t telnet_sendbuffer(Backend *be)
|
2001-08-25 21:09:23 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(be, Telnet, backend);
|
2002-10-25 15:30:33 +04:00
|
|
|
return telnet->bufsize;
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Called to set the size of the window from Telnet's POV.
|
|
|
|
*/
|
2018-09-11 18:23:38 +03:00
|
|
|
static void telnet_size(Backend *be, int width, int height)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(be, Telnet, backend);
|
2003-01-02 14:14:35 +03:00
|
|
|
unsigned char b[24];
|
|
|
|
int n;
|
1999-01-08 16:02:13 +03:00
|
|
|
|
2002-10-25 15:30:33 +04:00
|
|
|
telnet->term_width = width;
|
|
|
|
telnet->term_height = height;
|
2002-10-23 16:41:35 +04:00
|
|
|
|
2002-10-25 15:30:33 +04:00
|
|
|
if (telnet->s == NULL || telnet->opt_states[o_naws.index] != ACTIVE)
|
2019-09-08 22:29:00 +03:00
|
|
|
return;
|
2003-01-02 14:14:35 +03:00
|
|
|
n = 0;
|
|
|
|
b[n++] = IAC;
|
|
|
|
b[n++] = SB;
|
|
|
|
b[n++] = TELOPT_NAWS;
|
|
|
|
b[n++] = telnet->term_width >> 8;
|
|
|
|
if (b[n-1] == IAC) b[n++] = IAC; /* duplicate any IAC byte occurs */
|
|
|
|
b[n++] = telnet->term_width & 0xFF;
|
|
|
|
if (b[n-1] == IAC) b[n++] = IAC; /* duplicate any IAC byte occurs */
|
|
|
|
b[n++] = telnet->term_height >> 8;
|
|
|
|
if (b[n-1] == IAC) b[n++] = IAC; /* duplicate any IAC byte occurs */
|
|
|
|
b[n++] = telnet->term_height & 0xFF;
|
|
|
|
if (b[n-1] == IAC) b[n++] = IAC; /* duplicate any IAC byte occurs */
|
|
|
|
b[n++] = IAC;
|
|
|
|
b[n++] = SE;
|
2018-05-26 10:31:34 +03:00
|
|
|
telnet->bufsize = sk_write(telnet->s, b, n);
|
Refactor the LogContext type.
LogContext is now the owner of the logevent() function that back ends
and so forth are constantly calling. Previously, logevent was owned by
the Frontend, which would store the message into its list for the GUI
Event Log dialog (or print it to standard error, or whatever) and then
pass it _back_ to LogContext to write to the currently open log file.
Now it's the other way round: LogContext gets the message from the
back end first, writes it to its log file if it feels so inclined, and
communicates it back to the front end.
This means that lots of parts of the back end system no longer need to
have a pointer to a full-on Frontend; the only thing they needed it
for was logging, so now they just have a LogContext (which many of
them had to have anyway, e.g. for logging SSH packets or session
traffic).
LogContext itself also doesn't get a full Frontend pointer any more:
it now talks back to the front end via a little vtable of its own
called LogPolicy, which contains the method that passes Event Log
entries through, the old askappend() function that decides whether to
truncate a pre-existing log file, and an emergency function for
printing an especially prominent message if the log file can't be
created. One minor nice effect of this is that console and GUI apps
can implement that last function subtly differently, so that Unix
console apps can write it with a plain \n instead of the \r\n
(harmless but inelegant) that the old centralised implementation
generated.
One other consequence of this is that the LogContext has to be
provided to backend_init() so that it's available to backends from the
instant of creation, rather than being provided via a separate API
call a couple of function calls later, because backends have typically
started doing things that need logging (like making network
connections) before the call to backend_provide_logctx. Fortunately,
there's no case in the whole code base where we don't already have
logctx by the time we make a backend (so I don't actually remember why
I ever delayed providing one). So that shortens the backend API by one
function, which is always nice.
While I'm tidying up, I've also moved the printf-style logeventf() and
the handy logevent_and_free() into logging.c, instead of having copies
of them scattered around other places. This has also let me remove
some stub functions from a couple of outlying applications like
Pageant. Finally, I've removed the pointless "_tag" at the end of
LogContext's official struct name.
2018-10-10 21:26:18 +03:00
|
|
|
logeventf(telnet->logctx, "client:\tSB NAWS %d,%d",
|
|
|
|
telnet->term_width, telnet->term_height);
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Send Telnet special codes.
|
|
|
|
*/
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
static void telnet_special(Backend *be, SessionSpecialCode code, int arg)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(be, Telnet, backend);
|
1999-01-08 16:02:13 +03:00
|
|
|
unsigned char b[2];
|
|
|
|
|
2002-10-25 15:30:33 +04:00
|
|
|
if (telnet->s == NULL)
|
2019-09-08 22:29:00 +03:00
|
|
|
return;
|
1999-01-08 16:02:13 +03:00
|
|
|
|
|
|
|
b[0] = IAC;
|
|
|
|
switch (code) {
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_AYT:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = AYT;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_BRK:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = BREAK;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_EC:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = EC;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_EL:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = EL;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_GA:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = GA;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_NOP:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = NOP;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_ABORT:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = ABORT;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_AO:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = AO;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_IP:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = IP;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_SUSP:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = SUSP;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_EOR:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = EOR;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_EOF:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = xEOF;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_EOL:
|
2019-09-08 22:29:00 +03:00
|
|
|
/* In BINARY mode, CR-LF becomes just CR -
|
|
|
|
* and without the NUL suffix too. */
|
|
|
|
if (telnet->opt_states[o_we_bin.index] == ACTIVE)
|
|
|
|
telnet->bufsize = sk_write(telnet->s, "\r", 1);
|
|
|
|
else
|
|
|
|
telnet->bufsize = sk_write(telnet->s, "\r\n", 2);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_SYNCH:
|
2019-09-08 22:29:00 +03:00
|
|
|
b[1] = DM;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 1);
|
|
|
|
telnet->bufsize = sk_write_oob(telnet->s, b + 1, 1);
|
|
|
|
break;
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
case SS_PING:
|
2019-09-08 22:29:00 +03:00
|
|
|
if (telnet->opt_states[o_they_sga.index] == ACTIVE) {
|
|
|
|
b[1] = NOP;
|
|
|
|
telnet->bufsize = sk_write(telnet->s, b, 2);
|
|
|
|
}
|
|
|
|
break;
|
2004-10-18 01:22:22 +04:00
|
|
|
default:
|
2019-09-08 22:29:00 +03:00
|
|
|
break; /* never heard of it */
|
1999-01-08 16:02:13 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
static const SessionSpecial *telnet_get_specials(Backend *be)
|
2003-04-05 00:21:05 +04:00
|
|
|
{
|
Rework special-commands system to add an integer argument.
In order to list cross-certifiable host keys in the GUI specials menu,
the SSH backend has been inventing new values on the end of the
Telnet_Special enumeration, starting from the value TS_LOCALSTART.
This is inelegant, and also makes it awkward to break up special
handlers (e.g. to dispatch different specials to different SSH
layers), since if all you know about a special is that it's somewhere
in the TS_LOCALSTART+n space, you can't tell what _general kind_ of
thing it is. Also, if I ever need another open-ended set of specials
in future, I'll have to remember which TS_LOCALSTART+n codes are in
which set.
So here's a revamp that causes every special to take an extra integer
argument. For all previously numbered specials, this argument is
passed as zero and ignored, but there's a new main special code for
SSH host key cross-certification, in which the integer argument is an
index into the backend's list of available keys. TS_LOCALSTART is now
a thing of the past: if I need any other open-ended sets of specials
in future, I can add a new top-level code with a nicely separated
space of arguments.
While I'm at it, I've removed the legacy misnomer 'Telnet_Special'
from the code completely; the enum is now SessionSpecialCode, the
struct containing full details of a menu entry is SessionSpecial, and
the enum values now start SS_ rather than TS_.
2018-09-24 11:35:52 +03:00
|
|
|
static const SessionSpecial specials[] = {
|
2019-09-08 22:29:00 +03:00
|
|
|
{"Are You There", SS_AYT},
|
|
|
|
{"Break", SS_BRK},
|
|
|
|
{"Synch", SS_SYNCH},
|
|
|
|
{"Erase Character", SS_EC},
|
|
|
|
{"Erase Line", SS_EL},
|
|
|
|
{"Go Ahead", SS_GA},
|
|
|
|
{"No Operation", SS_NOP},
|
|
|
|
{NULL, SS_SEP},
|
|
|
|
{"Abort Process", SS_ABORT},
|
|
|
|
{"Abort Output", SS_AO},
|
|
|
|
{"Interrupt Process", SS_IP},
|
|
|
|
{"Suspend Process", SS_SUSP},
|
|
|
|
{NULL, SS_SEP},
|
|
|
|
{"End Of Record", SS_EOR},
|
|
|
|
{"End Of File", SS_EOF},
|
|
|
|
{NULL, SS_EXITMENU}
|
2003-04-05 00:21:05 +04:00
|
|
|
};
|
|
|
|
return specials;
|
|
|
|
}
|
|
|
|
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
static bool telnet_connected(Backend *be)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(be, Telnet, backend);
|
2006-08-27 12:03:19 +04:00
|
|
|
return telnet->s != NULL;
|
2001-05-06 18:35:20 +04:00
|
|
|
}
|
2000-09-08 20:42:11 +04:00
|
|
|
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
static bool telnet_sendok(Backend *be)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
/* Telnet *telnet = container_of(be, Telnet, backend); */
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
return true;
|
2001-05-06 18:35:20 +04:00
|
|
|
}
|
2000-09-08 18:45:20 +04:00
|
|
|
|
2019-02-06 23:42:44 +03:00
|
|
|
static void telnet_unthrottle(Backend *be, size_t backlog)
|
2001-08-25 21:09:23 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(be, Telnet, backend);
|
2002-10-25 15:30:33 +04:00
|
|
|
sk_set_frozen(telnet->s, backlog > TELNET_MAX_BACKLOG);
|
2001-08-25 21:09:23 +04:00
|
|
|
}
|
|
|
|
|
Convert a lot of 'int' variables to 'bool'.
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.
PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.
I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!
To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.
In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
- the 'multisel' field in dialog.h's list box structure, for which
the GTK front end in particular recognises a difference between 1
and 2 but nearly everything else treats as boolean
- the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
something about the specific location of the urgent pointer, but
most clients only care about 0 vs 'something nonzero'
- the return value of wc_match, where -1 indicates a syntax error in
the wildcard.
- the return values from SSH-1 RSA-key loading functions, which use
-1 for 'wrong passphrase' and 0 for all other failures (so any
caller which already knows it's not loading an _encrypted private_
key can treat them as boolean)
- term->esc_query, and the 'query' parameter in toggle_mode in
terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
but can also hold -1 for some other intervening character that we
don't support.
In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
- the return value of plug_accepting uses the POSIXish convention of
0=success and nonzero=error; I think if I made it bool then I'd
also want to reverse its sense, and that's a job for a separate
piece of work.
- the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
represent the default and alternate screens. There's no obvious
reason why one of those should be considered 'true' or 'positive'
or 'success' - they're just indices - so I've left it as int.
ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.
In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.
Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
2018-11-02 22:23:19 +03:00
|
|
|
static bool telnet_ldisc(Backend *be, int option)
|
2001-05-06 18:35:20 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(be, Telnet, backend);
|
2001-05-06 18:35:20 +04:00
|
|
|
if (option == LD_ECHO)
|
2019-09-08 22:29:00 +03:00
|
|
|
return telnet->echoing;
|
2001-05-06 18:35:20 +04:00
|
|
|
if (option == LD_EDIT)
|
2019-09-08 22:29:00 +03:00
|
|
|
return telnet->editing;
|
2018-10-29 22:50:29 +03:00
|
|
|
return false;
|
2001-01-24 17:08:20 +03:00
|
|
|
}
|
|
|
|
|
2018-09-11 18:23:38 +03:00
|
|
|
static void telnet_provide_ldisc(Backend *be, Ldisc *ldisc)
|
2002-10-26 14:16:19 +04:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(be, Telnet, backend);
|
2002-10-26 14:16:19 +04:00
|
|
|
telnet->ldisc = ldisc;
|
|
|
|
}
|
|
|
|
|
2018-09-11 18:23:38 +03:00
|
|
|
static int telnet_exitcode(Backend *be)
|
2001-12-29 18:31:42 +03:00
|
|
|
{
|
2018-10-06 01:49:08 +03:00
|
|
|
Telnet *telnet = container_of(be, Telnet, backend);
|
2003-03-31 16:10:08 +04:00
|
|
|
if (telnet->s != NULL)
|
|
|
|
return -1; /* still connected */
|
2012-12-22 13:40:47 +04:00
|
|
|
else if (telnet->closed_on_socket_error)
|
|
|
|
return INT_MAX; /* a socket error counts as an unclean exit */
|
2003-03-31 16:10:08 +04:00
|
|
|
else
|
|
|
|
/* Telnet doesn't transmit exit codes back to the client */
|
|
|
|
return 0;
|
2001-12-29 18:31:42 +03:00
|
|
|
}
|
|
|
|
|
2004-12-29 15:32:25 +03:00
|
|
|
/*
|
|
|
|
* cfg_info for Telnet does nothing at all.
|
|
|
|
*/
|
2018-09-11 18:23:38 +03:00
|
|
|
static int telnet_cfg_info(Backend *be)
|
2004-12-29 15:32:25 +03:00
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2018-10-05 09:03:46 +03:00
|
|
|
const struct BackendVtable telnet_backend = {
|
1999-01-08 16:02:13 +03:00
|
|
|
telnet_init,
|
2003-01-16 02:30:21 +03:00
|
|
|
telnet_free,
|
2003-01-12 17:48:29 +03:00
|
|
|
telnet_reconfig,
|
1999-01-08 16:02:13 +03:00
|
|
|
telnet_send,
|
2001-08-25 21:09:23 +04:00
|
|
|
telnet_sendbuffer,
|
1999-01-08 16:02:13 +03:00
|
|
|
telnet_size,
|
2000-09-08 18:45:20 +04:00
|
|
|
telnet_special,
|
2003-04-05 00:21:05 +04:00
|
|
|
telnet_get_specials,
|
2006-08-27 12:03:19 +04:00
|
|
|
telnet_connected,
|
2001-12-29 18:31:42 +03:00
|
|
|
telnet_exitcode,
|
2000-10-04 18:35:15 +04:00
|
|
|
telnet_sendok,
|
2001-01-24 17:08:20 +03:00
|
|
|
telnet_ldisc,
|
2002-10-26 14:16:19 +04:00
|
|
|
telnet_provide_ldisc,
|
2001-08-25 21:09:23 +04:00
|
|
|
telnet_unthrottle,
|
2004-12-29 15:32:25 +03:00
|
|
|
telnet_cfg_info,
|
2015-09-25 13:46:28 +03:00
|
|
|
NULL /* test_for_upstream */,
|
2020-02-16 14:34:40 +03:00
|
|
|
"telnet", "Telnet",
|
2007-07-01 01:56:44 +04:00
|
|
|
PROT_TELNET,
|
2000-10-04 18:35:15 +04:00
|
|
|
23
|
1999-01-08 16:02:13 +03:00
|
|
|
};
|