2015-11-22 14:49:14 +03:00
|
|
|
/*
|
|
|
|
* be_misc.c: helper functions shared between main network backends.
|
|
|
|
*/
|
|
|
|
|
2015-11-22 17:33:28 +03:00
|
|
|
#include <assert.h>
|
|
|
|
#include <string.h>
|
|
|
|
|
2015-11-22 14:49:14 +03:00
|
|
|
#include "putty.h"
|
|
|
|
#include "network.h"
|
|
|
|
|
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
|
|
|
void backend_socket_log(Seat *seat, LogContext *logctx,
|
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
|
|
|
int type, SockAddr *addr, int port,
|
2015-11-22 17:33:28 +03:00
|
|
|
const char *error_msg, int error_code, Conf *conf,
|
|
|
|
int session_started)
|
2015-11-22 14:49:14 +03:00
|
|
|
{
|
|
|
|
char addrbuf[256], *msg;
|
|
|
|
|
|
|
|
switch (type) {
|
|
|
|
case 0:
|
|
|
|
sk_getaddr(addr, addrbuf, lenof(addrbuf));
|
|
|
|
if (sk_addr_needs_port(addr)) {
|
|
|
|
msg = dupprintf("Connecting to %s port %d", addrbuf, port);
|
|
|
|
} else {
|
|
|
|
msg = dupprintf("Connecting to %s", addrbuf);
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
case 1:
|
|
|
|
sk_getaddr(addr, addrbuf, lenof(addrbuf));
|
|
|
|
msg = dupprintf("Failed to connect to %s: %s", addrbuf, error_msg);
|
|
|
|
break;
|
2015-11-22 15:15:52 +03:00
|
|
|
case 2:
|
|
|
|
/* Proxy-related log messages have their own identifying
|
|
|
|
* prefix already, put on by our caller. */
|
2015-11-22 17:33:28 +03:00
|
|
|
{
|
|
|
|
int len, log_to_term;
|
|
|
|
|
|
|
|
/* Suffix \r\n temporarily, so we can log to the terminal. */
|
|
|
|
msg = dupprintf("%s\r\n", error_msg);
|
|
|
|
len = strlen(msg);
|
|
|
|
assert(len >= 2);
|
|
|
|
|
|
|
|
log_to_term = conf_get_int(conf, CONF_proxy_log_to_term);
|
|
|
|
if (log_to_term == AUTO)
|
|
|
|
log_to_term = session_started ? FORCE_OFF : FORCE_ON;
|
|
|
|
if (log_to_term == FORCE_ON)
|
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_stderr(seat, msg, len);
|
2015-11-22 17:33:28 +03:00
|
|
|
|
|
|
|
msg[len-2] = '\0'; /* remove the \r\n again */
|
|
|
|
}
|
2015-11-22 15:15:52 +03:00
|
|
|
break;
|
2015-11-22 14:49:14 +03:00
|
|
|
default:
|
|
|
|
msg = NULL; /* shouldn't happen, but placate optimiser */
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (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(logctx, msg);
|
2015-11-22 14:49:14 +03:00
|
|
|
sfree(msg);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
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
|
|
|
void log_proxy_stderr(Plug *plug, bufchain *buf, const void *vdata, int len)
|
2015-11-22 14:50:37 +03:00
|
|
|
{
|
|
|
|
const char *data = (const char *)vdata;
|
|
|
|
int pos = 0;
|
|
|
|
int msglen;
|
2018-05-26 10:00:20 +03:00
|
|
|
const char *nlpos;
|
|
|
|
char *msg, *fullmsg;
|
2015-11-22 14:50:37 +03:00
|
|
|
|
|
|
|
/*
|
|
|
|
* This helper function allows us to collect the data written to a
|
|
|
|
* local proxy command's standard error in whatever size chunks we
|
|
|
|
* happen to get from its pipe, and whenever we have a complete
|
|
|
|
* line, we pass it to plug_log.
|
|
|
|
*
|
|
|
|
* Prerequisites: a plug to log to, and a bufchain stored
|
|
|
|
* somewhere to collect the data in.
|
|
|
|
*/
|
|
|
|
|
|
|
|
while (pos < len && (nlpos = memchr(data+pos, '\n', len-pos)) != NULL) {
|
|
|
|
/*
|
|
|
|
* Found a newline in the current input buffer. Append it to
|
|
|
|
* the bufchain (which may contain a partial line from last
|
|
|
|
* time).
|
|
|
|
*/
|
|
|
|
bufchain_add(buf, data + pos, nlpos - (data + pos));
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Collect the resulting line of data and pass it to plug_log.
|
|
|
|
*/
|
|
|
|
msglen = bufchain_size(buf);
|
|
|
|
msg = snewn(msglen+1, char);
|
|
|
|
bufchain_fetch(buf, msg, msglen);
|
|
|
|
bufchain_consume(buf, msglen);
|
2018-10-07 16:46:21 +03:00
|
|
|
while (msglen > 0 && (msg[msglen-1] == '\n' || msg[msglen-1] == '\r'))
|
|
|
|
msglen--;
|
2015-11-22 14:50:37 +03:00
|
|
|
msg[msglen] = '\0';
|
|
|
|
fullmsg = dupprintf("proxy: %s", msg);
|
|
|
|
plug_log(plug, 2, NULL, 0, fullmsg, 0);
|
|
|
|
sfree(fullmsg);
|
|
|
|
sfree(msg);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Advance past the newline.
|
|
|
|
*/
|
|
|
|
pos += nlpos+1 - (data + pos);
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Now any remaining data is a partial line, which we save for
|
|
|
|
* next time.
|
|
|
|
*/
|
|
|
|
bufchain_add(buf, data + pos, len - pos);
|
|
|
|
}
|