2001-12-31 16:15:19 +00:00
|
|
|
/*
|
2006-04-23 18:26:03 +00:00
|
|
|
* wincons.c - various interactive-prompt routines shared between
|
2004-04-27 12:31:57 +00:00
|
|
|
* the Windows console PuTTY tools
|
2001-12-31 16:15:19 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <stdlib.h>
|
|
|
|
|
|
|
|
#include "putty.h"
|
|
|
|
#include "storage.h"
|
|
|
|
#include "ssh.h"
|
2021-03-13 09:24:17 +00:00
|
|
|
#include "console.h"
|
2001-12-31 16:15:19 +00:00
|
|
|
|
2002-03-06 20:13:22 +00:00
|
|
|
void cleanup_exit(int code)
|
|
|
|
{
|
|
|
|
/*
|
|
|
|
* Clean up.
|
|
|
|
*/
|
|
|
|
sk_cleanup();
|
|
|
|
|
2003-01-12 13:44:35 +00:00
|
|
|
random_save_seed();
|
2002-03-06 20:13:22 +00:00
|
|
|
|
|
|
|
exit(code);
|
|
|
|
}
|
|
|
|
|
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 18:58:42 +00:00
|
|
|
void console_print_error_msg(const char *prefix, const char *msg)
|
|
|
|
{
|
|
|
|
fputs(prefix, stderr);
|
|
|
|
fputs(": ", stderr);
|
|
|
|
fputs(msg, stderr);
|
|
|
|
fputc('\n', stderr);
|
|
|
|
fflush(stderr);
|
|
|
|
}
|
|
|
|
|
|
|
|
int console_verify_ssh_host_key(
|
|
|
|
Seat *seat, const char *host, int port,
|
|
|
|
const char *keytype, char *keystr, char *fingerprint,
|
|
|
|
void (*callback)(void *ctx, int result), void *ctx)
|
2001-12-31 16:15:19 +00:00
|
|
|
{
|
|
|
|
int ret;
|
|
|
|
HANDLE hin;
|
|
|
|
DWORD savemode, i;
|
2021-03-13 09:24:17 +00:00
|
|
|
const char *common_fmt, *intro, *prompt;
|
2001-12-31 16:15:19 +00:00
|
|
|
|
|
|
|
char line[32];
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Verify the key against the registry.
|
|
|
|
*/
|
|
|
|
ret = verify_host_key(host, port, keytype, keystr);
|
|
|
|
|
2019-09-08 19:29:00 +00:00
|
|
|
if (ret == 0) /* success - key matched OK */
|
|
|
|
return 1;
|
2001-12-31 16:15:19 +00:00
|
|
|
|
2019-09-08 19:29:00 +00:00
|
|
|
if (ret == 2) { /* key was different */
|
2021-03-13 09:24:17 +00:00
|
|
|
common_fmt = hk_wrongmsg_common_fmt;
|
|
|
|
intro = hk_wrongmsg_interactive_intro;
|
|
|
|
prompt = hk_wrongmsg_interactive_prompt;
|
|
|
|
} else { /* key was absent */
|
|
|
|
common_fmt = hk_absentmsg_common_fmt;
|
|
|
|
intro = hk_absentmsg_interactive_intro;
|
|
|
|
prompt = hk_absentmsg_interactive_prompt;
|
2001-12-31 16:15:19 +00:00
|
|
|
}
|
2021-03-13 09:24:17 +00:00
|
|
|
|
|
|
|
fprintf(stderr, common_fmt, keytype, fingerprint);
|
|
|
|
if (console_batch_mode) {
|
|
|
|
fputs(console_abandoned_msg, stderr);
|
|
|
|
return 0;
|
2001-12-31 16:15:19 +00:00
|
|
|
}
|
|
|
|
|
2021-03-13 09:24:17 +00:00
|
|
|
fputs(intro, stderr);
|
|
|
|
fflush(stderr);
|
|
|
|
|
|
|
|
fputs(prompt, stderr);
|
|
|
|
fflush(stderr);
|
|
|
|
|
|
|
|
line[0] = '\0'; /* fail safe if ReadFile returns no data */
|
2017-02-15 06:03:50 +00:00
|
|
|
|
2001-12-31 16:15:19 +00:00
|
|
|
hin = GetStdHandle(STD_INPUT_HANDLE);
|
|
|
|
GetConsoleMode(hin, &savemode);
|
|
|
|
SetConsoleMode(hin, (savemode | ENABLE_ECHO_INPUT |
|
2019-09-08 19:29:00 +00:00
|
|
|
ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT));
|
2001-12-31 16:15:19 +00:00
|
|
|
ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
|
|
|
|
SetConsoleMode(hin, savemode);
|
|
|
|
|
|
|
|
if (line[0] != '\0' && line[0] != '\r' && line[0] != '\n') {
|
2019-09-08 19:29:00 +00:00
|
|
|
if (line[0] == 'y' || line[0] == 'Y')
|
|
|
|
store_host_key(host, port, keytype, keystr);
|
2005-02-17 18:34:24 +00:00
|
|
|
return 1;
|
2001-12-31 16:15:19 +00:00
|
|
|
} else {
|
2021-03-13 09:24:17 +00:00
|
|
|
fputs(console_abandoned_msg, stderr);
|
2005-02-17 18:34:24 +00:00
|
|
|
return 0;
|
2001-12-31 16:15:19 +00: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 18:58:42 +00:00
|
|
|
int console_confirm_weak_crypto_primitive(
|
|
|
|
Seat *seat, const char *algtype, const char *algname,
|
|
|
|
void (*callback)(void *ctx, int result), void *ctx)
|
2001-12-31 16:15:19 +00:00
|
|
|
{
|
|
|
|
HANDLE hin;
|
|
|
|
DWORD savemode, i;
|
|
|
|
|
|
|
|
char line[32];
|
|
|
|
|
2021-03-13 09:24:17 +00:00
|
|
|
fprintf(stderr, weakcrypto_msg_common_fmt, algtype, algname);
|
|
|
|
|
2001-12-31 16:15:19 +00:00
|
|
|
if (console_batch_mode) {
|
2021-03-13 09:24:17 +00:00
|
|
|
fputs(console_abandoned_msg, stderr);
|
2019-09-08 19:29:00 +00:00
|
|
|
return 0;
|
2001-12-31 16:15:19 +00:00
|
|
|
}
|
|
|
|
|
2021-03-13 09:24:17 +00:00
|
|
|
fputs(console_continue_prompt, stderr);
|
2001-12-31 16:15:19 +00:00
|
|
|
fflush(stderr);
|
|
|
|
|
|
|
|
hin = GetStdHandle(STD_INPUT_HANDLE);
|
|
|
|
GetConsoleMode(hin, &savemode);
|
|
|
|
SetConsoleMode(hin, (savemode | ENABLE_ECHO_INPUT |
|
2019-09-08 19:29:00 +00:00
|
|
|
ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT));
|
2001-12-31 16:15:19 +00:00
|
|
|
ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
|
|
|
|
SetConsoleMode(hin, savemode);
|
|
|
|
|
|
|
|
if (line[0] == 'y' || line[0] == 'Y') {
|
2019-09-08 19:29:00 +00:00
|
|
|
return 1;
|
2001-12-31 16:15:19 +00:00
|
|
|
} else {
|
2021-03-13 09:24:17 +00:00
|
|
|
fputs(console_abandoned_msg, stderr);
|
2019-09-08 19:29:00 +00:00
|
|
|
return 0;
|
2001-12-31 16:15:19 +00: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 18:58:42 +00:00
|
|
|
int console_confirm_weak_cached_hostkey(
|
|
|
|
Seat *seat, const char *algname, const char *betteralgs,
|
|
|
|
void (*callback)(void *ctx, int result), void *ctx)
|
2016-03-27 17:08:49 +00:00
|
|
|
{
|
|
|
|
HANDLE hin;
|
|
|
|
DWORD savemode, i;
|
|
|
|
|
|
|
|
char line[32];
|
|
|
|
|
2021-03-13 09:24:17 +00:00
|
|
|
fprintf(stderr, weakhk_msg_common_fmt, algname, betteralgs);
|
|
|
|
|
2016-03-27 17:08:49 +00:00
|
|
|
if (console_batch_mode) {
|
2021-03-13 09:24:17 +00:00
|
|
|
fputs(console_abandoned_msg, stderr);
|
2019-09-08 19:29:00 +00:00
|
|
|
return 0;
|
2016-03-27 17:08:49 +00:00
|
|
|
}
|
|
|
|
|
2021-03-13 09:24:17 +00:00
|
|
|
fputs(console_continue_prompt, stderr);
|
2016-03-27 17:08:49 +00:00
|
|
|
fflush(stderr);
|
|
|
|
|
|
|
|
hin = GetStdHandle(STD_INPUT_HANDLE);
|
|
|
|
GetConsoleMode(hin, &savemode);
|
|
|
|
SetConsoleMode(hin, (savemode | ENABLE_ECHO_INPUT |
|
2019-09-08 19:29:00 +00:00
|
|
|
ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT));
|
2016-03-27 17:08:49 +00:00
|
|
|
ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
|
|
|
|
SetConsoleMode(hin, savemode);
|
|
|
|
|
|
|
|
if (line[0] == 'y' || line[0] == 'Y') {
|
2019-09-08 19:29:00 +00:00
|
|
|
return 1;
|
2016-03-27 17:08:49 +00:00
|
|
|
} else {
|
2021-03-13 09:24:17 +00:00
|
|
|
fputs(console_abandoned_msg, stderr);
|
2019-09-08 19:29:00 +00:00
|
|
|
return 0;
|
2016-03-27 17:08:49 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-03-10 14:42:33 +00:00
|
|
|
bool is_interactive(void)
|
|
|
|
{
|
|
|
|
return is_console_handle(GetStdHandle(STD_INPUT_HANDLE));
|
|
|
|
}
|
|
|
|
|
|
|
|
bool console_antispoof_prompt = true;
|
2019-03-10 14:42:11 +00:00
|
|
|
bool console_set_trust_status(Seat *seat, bool trusted)
|
|
|
|
{
|
2019-03-10 14:42:33 +00:00
|
|
|
if (console_batch_mode || !is_interactive() || !console_antispoof_prompt) {
|
|
|
|
/*
|
|
|
|
* In batch mode, we don't need to worry about the server
|
|
|
|
* mimicking our interactive authentication, because the user
|
|
|
|
* already knows not to expect any.
|
|
|
|
*
|
|
|
|
* If standard input isn't connected to a terminal, likewise,
|
|
|
|
* because even if the server did send a spoof authentication
|
|
|
|
* prompt, the user couldn't respond to it via the terminal
|
|
|
|
* anyway.
|
|
|
|
*
|
|
|
|
* We also vacuously return success if the user has purposely
|
|
|
|
* disabled the antispoof prompt.
|
|
|
|
*/
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2019-03-10 14:42:11 +00:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2001-12-31 16:15:19 +00:00
|
|
|
/*
|
|
|
|
* Ask whether to wipe a session log file before writing to it.
|
|
|
|
* Returns 2 for wipe, 1 for append, 0 for cancel (don't log).
|
|
|
|
*/
|
2020-01-31 09:38:36 +00:00
|
|
|
int console_askappend(LogPolicy *lp, Filename *filename,
|
|
|
|
void (*callback)(void *ctx, int result), void *ctx)
|
2001-12-31 16:15:19 +00:00
|
|
|
{
|
|
|
|
HANDLE hin;
|
|
|
|
DWORD savemode, i;
|
|
|
|
|
|
|
|
static const char msgtemplate[] =
|
2019-09-08 19:29:00 +00:00
|
|
|
"The session log file \"%.*s\" already exists.\n"
|
|
|
|
"You can overwrite it with a new session log,\n"
|
|
|
|
"append your session log to the end of it,\n"
|
|
|
|
"or disable session logging for this session.\n"
|
|
|
|
"Enter \"y\" to wipe the file, \"n\" to append to it,\n"
|
|
|
|
"or just press Return to disable logging.\n"
|
|
|
|
"Wipe the log file? (y/n, Return cancels logging) ";
|
2001-12-31 16:15:19 +00:00
|
|
|
|
|
|
|
static const char msgtemplate_batch[] =
|
2019-09-08 19:29:00 +00:00
|
|
|
"The session log file \"%.*s\" already exists.\n"
|
|
|
|
"Logging will not be enabled.\n";
|
2001-12-31 16:15:19 +00:00
|
|
|
|
|
|
|
char line[32];
|
|
|
|
|
|
|
|
if (console_batch_mode) {
|
2019-09-08 19:29:00 +00:00
|
|
|
fprintf(stderr, msgtemplate_batch, FILENAME_MAX, filename->path);
|
|
|
|
fflush(stderr);
|
|
|
|
return 0;
|
2001-12-31 16:15:19 +00:00
|
|
|
}
|
2011-10-02 11:01:57 +00:00
|
|
|
fprintf(stderr, msgtemplate, FILENAME_MAX, filename->path);
|
2001-12-31 16:15:19 +00:00
|
|
|
fflush(stderr);
|
|
|
|
|
|
|
|
hin = GetStdHandle(STD_INPUT_HANDLE);
|
|
|
|
GetConsoleMode(hin, &savemode);
|
|
|
|
SetConsoleMode(hin, (savemode | ENABLE_ECHO_INPUT |
|
2019-09-08 19:29:00 +00:00
|
|
|
ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT));
|
2001-12-31 16:15:19 +00:00
|
|
|
ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
|
|
|
|
SetConsoleMode(hin, savemode);
|
|
|
|
|
|
|
|
if (line[0] == 'y' || line[0] == 'Y')
|
2019-09-08 19:29:00 +00:00
|
|
|
return 2;
|
2001-12-31 16:15:19 +00:00
|
|
|
else if (line[0] == 'n' || line[0] == 'N')
|
2019-09-08 19:29:00 +00:00
|
|
|
return 1;
|
2001-12-31 16:15:19 +00:00
|
|
|
else
|
2019-09-08 19:29:00 +00:00
|
|
|
return 0;
|
2001-12-31 16:15:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Warn about the obsolescent key file format.
|
2019-09-08 19:29:00 +00:00
|
|
|
*
|
2002-10-26 12:58:13 +00:00
|
|
|
* Uniquely among these functions, this one does _not_ expect a
|
|
|
|
* frontend handle. This means that if PuTTY is ported to a
|
|
|
|
* platform which requires frontend handles, this function will be
|
|
|
|
* an anomaly. Fortunately, the problem it addresses will not have
|
|
|
|
* been present on that platform, so it can plausibly be
|
|
|
|
* implemented as an empty function.
|
2001-12-31 16:15:19 +00:00
|
|
|
*/
|
|
|
|
void old_keyfile_warning(void)
|
|
|
|
{
|
|
|
|
static const char message[] =
|
2019-09-08 19:29:00 +00:00
|
|
|
"You are loading an SSH-2 private key which has an\n"
|
|
|
|
"old version of the file format. This means your key\n"
|
|
|
|
"file is not fully tamperproof. Future versions of\n"
|
|
|
|
"PuTTY may stop supporting this private key format,\n"
|
|
|
|
"so we recommend you convert your key to the new\n"
|
|
|
|
"format.\n"
|
|
|
|
"\n"
|
|
|
|
"Once the key is loaded into PuTTYgen, you can perform\n"
|
|
|
|
"this conversion simply by saving it again.\n";
|
2001-12-31 16:15:19 +00:00
|
|
|
|
|
|
|
fputs(message, stderr);
|
|
|
|
}
|
|
|
|
|
2005-03-19 02:26:58 +00:00
|
|
|
/*
|
|
|
|
* Display the fingerprints of the PGP Master Keys to the user.
|
|
|
|
*/
|
|
|
|
void pgp_fingerprints(void)
|
|
|
|
{
|
|
|
|
fputs("These are the fingerprints of the PuTTY PGP Master Keys. They can\n"
|
2019-09-08 19:29:00 +00:00
|
|
|
"be used to establish a trust path from this executable to another\n"
|
|
|
|
"one. See the manual for more information.\n"
|
|
|
|
"(Note: these fingerprints have nothing to do with SSH!)\n"
|
|
|
|
"\n"
|
|
|
|
"PuTTY Master Key as of " PGP_MASTER_KEY_YEAR
|
2018-08-25 13:36:25 +00:00
|
|
|
" (" PGP_MASTER_KEY_DETAILS "):\n"
|
2019-09-08 19:29:00 +00:00
|
|
|
" " PGP_MASTER_KEY_FP "\n\n"
|
|
|
|
"Previous Master Key (" PGP_PREV_MASTER_KEY_YEAR
|
2018-08-25 13:36:25 +00:00
|
|
|
", " PGP_PREV_MASTER_KEY_DETAILS "):\n"
|
2019-09-08 19:29:00 +00:00
|
|
|
" " PGP_PREV_MASTER_KEY_FP "\n", stdout);
|
2005-03-19 02:26:58 +00:00
|
|
|
}
|
|
|
|
|
2020-01-31 09:38:36 +00:00
|
|
|
void console_logging_error(LogPolicy *lp, const char *string)
|
2003-01-21 19:18:06 +00: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 18:26:18 +00:00
|
|
|
/* Ordinary Event Log entries are displayed in the same way as
|
|
|
|
* logging errors, but only in verbose mode */
|
|
|
|
fprintf(stderr, "%s\n", string);
|
|
|
|
fflush(stderr);
|
2003-01-21 19:18:06 +00:00
|
|
|
}
|
|
|
|
|
2020-01-31 09:38:36 +00:00
|
|
|
void console_eventlog(LogPolicy *lp, const char *string)
|
2001-12-31 16:15:19 +00: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 18:26:18 +00:00
|
|
|
/* Ordinary Event Log entries are displayed in the same way as
|
|
|
|
* logging errors, but only in verbose mode */
|
Remove FLAG_VERBOSE.
The global 'int flags' has always been an ugly feature of this code
base, and I suddenly thought that perhaps it's time to start throwing
it out, one flag at a time, until it's totally unused.
My first target is FLAG_VERBOSE. This was usually set by cmdline.c
when it saw a -v option on the program's command line, except that GUI
PuTTY itself sets it unconditionally on startup. And then various bits
of the code would check it in order to decide whether to print a given
message.
In the current system of front-end abstraction traits, there's no
_one_ place that I can move it to. But there are two: every place that
checked FLAG_VERBOSE has access to either a Seat or a LogPolicy. So
now each of those traits has a query method for 'do I want verbose
messages?'.
A good effect of this is that subsidiary Seats, like the ones used in
Uppity for the main SSH server module itself and the server end of
shell channels, now get to have their own verbosity setting instead of
inheriting the one global one. In fact I don't expect any code using
those Seats to be generating any messages at all, but if that changes
later, we'll have a way to control it. (Who knows, perhaps logging in
Uppity might become a thing.)
As part of this cleanup, I've added a new flag to cmdline_tooltype,
called TOOLTYPE_NO_VERBOSE_OPTION. The unconditionally-verbose tools
now set that, and it has the effect of making cmdline.c disallow -v
completely. So where 'putty -v' would previously have been silently
ignored ("I was already verbose"), it's now an error, reminding you
that that option doesn't actually do anything.
Finally, the 'default_logpolicy' provided by uxcons.c and wincons.c
(with identical definitions) has had to move into a new file of its
own, because now it has to ask cmdline.c for the verbosity setting as
well as asking console.c for the rest of its methods. So there's a new
file clicons.c which can only be included by programs that link
against both cmdline.c _and_ one of the *cons.c, and I've renamed the
logpolicy to reflect that.
2020-01-30 06:40:21 +00:00
|
|
|
if (lp_verbose(lp))
|
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 18:26:18 +00:00
|
|
|
console_logging_error(lp, string);
|
2001-12-31 16:15:19 +00:00
|
|
|
}
|
|
|
|
|
2019-03-07 08:19:38 +00:00
|
|
|
StripCtrlChars *console_stripctrl_new(
|
|
|
|
Seat *seat, BinarySink *bs_out, SeatInteractionContext sic)
|
2019-03-05 21:13:00 +00:00
|
|
|
{
|
2019-03-07 08:19:38 +00:00
|
|
|
return stripctrl_new(bs_out, false, 0);
|
2019-03-05 21:13:00 +00:00
|
|
|
}
|
|
|
|
|
2019-03-09 15:51:38 +00:00
|
|
|
static void console_write(HANDLE hout, ptrlen data)
|
2005-10-30 20:24:09 +00:00
|
|
|
{
|
|
|
|
DWORD dummy;
|
2019-03-09 15:51:38 +00:00
|
|
|
WriteFile(hout, data.ptr, data.len, &dummy, NULL);
|
2005-10-30 20:24:09 +00:00
|
|
|
}
|
|
|
|
|
2018-05-18 06:22:56 +00:00
|
|
|
int console_get_userpass_input(prompts_t *p)
|
2001-12-31 16:15:19 +00:00
|
|
|
{
|
2018-06-03 20:48:08 +00:00
|
|
|
HANDLE hin = INVALID_HANDLE_VALUE, hout = INVALID_HANDLE_VALUE;
|
2005-10-30 20:24:09 +00:00
|
|
|
size_t curr_prompt;
|
2001-12-31 16:15:19 +00:00
|
|
|
|
2005-10-30 20:24:09 +00:00
|
|
|
/*
|
|
|
|
* Zero all the results, in case we abort half-way through.
|
|
|
|
*/
|
|
|
|
{
|
2019-09-08 19:29:00 +00:00
|
|
|
int i;
|
|
|
|
for (i = 0; i < (int)p->n_prompts; i++)
|
2011-10-02 11:50:45 +00:00
|
|
|
prompt_set_result(p->prompts[i], "");
|
2005-10-30 20:24:09 +00:00
|
|
|
}
|
|
|
|
|
2009-03-03 18:35:53 +00:00
|
|
|
/*
|
|
|
|
* The prompts_t might contain a message to be displayed but no
|
|
|
|
* actual prompt. More usually, though, it will contain
|
|
|
|
* questions that the user needs to answer, in which case we
|
|
|
|
* need to ensure that we're able to get the answers.
|
|
|
|
*/
|
|
|
|
if (p->n_prompts) {
|
2019-09-08 19:29:00 +00:00
|
|
|
if (console_batch_mode)
|
|
|
|
return 0;
|
|
|
|
hin = GetStdHandle(STD_INPUT_HANDLE);
|
|
|
|
if (hin == INVALID_HANDLE_VALUE) {
|
|
|
|
fprintf(stderr, "Cannot get standard input handle\n");
|
|
|
|
cleanup_exit(1);
|
|
|
|
}
|
2009-03-03 18:35:53 +00:00
|
|
|
}
|
2005-10-30 20:24:09 +00:00
|
|
|
|
2009-03-03 18:35:53 +00:00
|
|
|
/*
|
|
|
|
* And if we have anything to print, we need standard output.
|
|
|
|
*/
|
|
|
|
if ((p->name_reqd && p->name) || p->instruction || p->n_prompts) {
|
2019-09-08 19:29:00 +00:00
|
|
|
hout = GetStdHandle(STD_OUTPUT_HANDLE);
|
|
|
|
if (hout == INVALID_HANDLE_VALUE) {
|
|
|
|
fprintf(stderr, "Cannot get standard output handle\n");
|
|
|
|
cleanup_exit(1);
|
|
|
|
}
|
2005-10-30 20:24:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Preamble.
|
|
|
|
*/
|
|
|
|
/* We only print the `name' caption if we have to... */
|
|
|
|
if (p->name_reqd && p->name) {
|
2019-09-08 19:29:00 +00:00
|
|
|
ptrlen plname = ptrlen_from_asciz(p->name);
|
|
|
|
console_write(hout, plname);
|
2019-03-09 15:51:38 +00:00
|
|
|
if (!ptrlen_endswith(plname, PTRLEN_LITERAL("\n"), NULL))
|
2019-09-08 19:29:00 +00:00
|
|
|
console_write(hout, PTRLEN_LITERAL("\n"));
|
2005-10-30 20:24:09 +00:00
|
|
|
}
|
|
|
|
/* ...but we always print any `instruction'. */
|
|
|
|
if (p->instruction) {
|
2019-09-08 19:29:00 +00:00
|
|
|
ptrlen plinst = ptrlen_from_asciz(p->instruction);
|
|
|
|
console_write(hout, plinst);
|
2019-03-09 15:51:38 +00:00
|
|
|
if (!ptrlen_endswith(plinst, PTRLEN_LITERAL("\n"), NULL))
|
2019-09-08 19:29:00 +00:00
|
|
|
console_write(hout, PTRLEN_LITERAL("\n"));
|
2005-10-30 20:24:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
for (curr_prompt = 0; curr_prompt < p->n_prompts; curr_prompt++) {
|
|
|
|
|
2019-09-08 19:29:00 +00:00
|
|
|
DWORD savemode, newmode;
|
|
|
|
prompt_t *pr = p->prompts[curr_prompt];
|
2001-12-31 16:15:19 +00:00
|
|
|
|
2019-09-08 19:29:00 +00:00
|
|
|
GetConsoleMode(hin, &savemode);
|
|
|
|
newmode = savemode | ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT;
|
|
|
|
if (!pr->echo)
|
|
|
|
newmode &= ~ENABLE_ECHO_INPUT;
|
|
|
|
else
|
|
|
|
newmode |= ENABLE_ECHO_INPUT;
|
|
|
|
SetConsoleMode(hin, newmode);
|
2001-12-31 16:15:19 +00:00
|
|
|
|
2019-09-08 19:29:00 +00:00
|
|
|
console_write(hout, ptrlen_from_asciz(pr->prompt));
|
2005-10-30 20:24:09 +00:00
|
|
|
|
2020-01-21 20:19:47 +00:00
|
|
|
bool failed = false;
|
2011-10-02 11:50:45 +00:00
|
|
|
while (1) {
|
2020-01-26 09:50:07 +00:00
|
|
|
/*
|
|
|
|
* Amount of data to try to read from the console in one
|
|
|
|
* go. This isn't completely arbitrary: a user reported
|
|
|
|
* that trying to read more than 31366 bytes at a time
|
|
|
|
* would fail with ERROR_NOT_ENOUGH_MEMORY on Windows 7,
|
|
|
|
* and Ruby's Win32 support module has evidence of a
|
|
|
|
* similar workaround:
|
|
|
|
*
|
|
|
|
* https://github.com/ruby/ruby/blob/0aa5195262d4193d3accf3e6b9bad236238b816b/win32/win32.c#L6842
|
|
|
|
*
|
|
|
|
* To keep things simple, I stick with a nice round power
|
|
|
|
* of 2 rather than trying to go to the very limit of that
|
|
|
|
* bug. (We're typically reading user passphrases and the
|
|
|
|
* like here, so even this much is overkill really.)
|
|
|
|
*/
|
|
|
|
DWORD toread = 16384;
|
|
|
|
|
2020-01-21 20:19:47 +00:00
|
|
|
size_t prev_result_len = pr->result->len;
|
|
|
|
void *ptr = strbuf_append(pr->result, toread);
|
2011-10-02 11:50:45 +00:00
|
|
|
|
2020-01-21 20:19:47 +00:00
|
|
|
DWORD ret = 0;
|
|
|
|
if (!ReadFile(hin, ptr, toread, &ret, NULL) || ret == 0) {
|
|
|
|
failed = true;
|
2011-10-02 11:50:45 +00:00
|
|
|
break;
|
|
|
|
}
|
2020-01-21 20:19:47 +00:00
|
|
|
|
|
|
|
strbuf_shrink_to(pr->result, prev_result_len + ret);
|
2020-01-22 22:24:41 +00:00
|
|
|
if (strbuf_chomp(pr->result, '\n')) {
|
|
|
|
strbuf_chomp(pr->result, '\r');
|
2011-10-02 11:50:45 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
2001-12-31 16:15:19 +00:00
|
|
|
|
2019-09-08 19:29:00 +00:00
|
|
|
SetConsoleMode(hin, savemode);
|
2001-12-31 16:15:19 +00:00
|
|
|
|
2019-09-08 19:29:00 +00:00
|
|
|
if (!pr->echo)
|
2019-03-09 15:51:38 +00:00
|
|
|
console_write(hout, PTRLEN_LITERAL("\r\n"));
|
2001-12-31 16:15:19 +00:00
|
|
|
|
2020-01-21 20:19:47 +00:00
|
|
|
if (failed) {
|
2011-10-02 11:50:45 +00:00
|
|
|
return 0; /* failure due to read error */
|
|
|
|
}
|
2001-12-31 16:15:19 +00:00
|
|
|
}
|
2005-10-30 20:24:09 +00:00
|
|
|
|
|
|
|
return 1; /* success */
|
2001-12-31 16:15:19 +00:00
|
|
|
}
|