[u/mdw/putty] / windows / wincons.c

/*
 * console.c: various interactive-prompt routines shared between
 * the Windows console PuTTY tools
 */

#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>

#include "putty.h"
#include "storage.h"
#include "ssh.h"

int console_batch_mode = FALSE;

static void *console_logctx = NULL;

/*
 * Clean up and exit.
 */
void cleanup_exit(int code)
{
    /*
     * Clean up.
     */
    sk_cleanup();

    random_save_seed();
#ifdef MSCRYPTOAPI
    crypto_wrapup();
#endif

    exit(code);
}

void notify_remote_exit(void *frontend)
{
}

void timer_change_notify(long next)
{
}

void verify_ssh_host_key(void *frontend, char *host, int port, char *keytype,
			 char *keystr, char *fingerprint)
{
    int ret;
    HANDLE hin;
    DWORD savemode, i;

    static const char absentmsg_batch[] =
	"The server's host key is not cached in the registry. You\n"
	"have no guarantee that the server is the computer you\n"
	"think it is.\n"
	"The server's %s key fingerprint is:\n"
	"%s\n"
	"Connection abandoned.\n";
    static const char absentmsg[] =
	"The server's host key is not cached in the registry. You\n"
	"have no guarantee that the server is the computer you\n"
	"think it is.\n"
	"The server's %s key fingerprint is:\n"
	"%s\n"
	"If you trust this host, enter \"y\" to add the key to\n"
	"PuTTY's cache and carry on connecting.\n"
	"If you want to carry on connecting just once, without\n"
	"adding the key to the cache, enter \"n\".\n"
	"If you do not trust this host, press Return to abandon the\n"
	"connection.\n"
	"Store key in cache? (y/n) ";

    static const char wrongmsg_batch[] =
	"WARNING - POTENTIAL SECURITY BREACH!\n"
	"The server's host key does not match the one PuTTY has\n"
	"cached in the registry. This means that either the\n"
	"server administrator has changed the host key, or you\n"
	"have actually connected to another computer pretending\n"
	"to be the server.\n"
	"The new %s key fingerprint is:\n"
	"%s\n"
	"Connection abandoned.\n";
    static const char wrongmsg[] =
	"WARNING - POTENTIAL SECURITY BREACH!\n"
	"The server's host key does not match the one PuTTY has\n"
	"cached in the registry. This means that either the\n"
	"server administrator has changed the host key, or you\n"
	"have actually connected to another computer pretending\n"
	"to be the server.\n"
	"The new %s key fingerprint is:\n"
	"%s\n"
	"If you were expecting this change and trust the new key,\n"
	"enter \"y\" to update PuTTY's cache and continue connecting.\n"
	"If you want to carry on connecting but without updating\n"
	"the cache, enter \"n\".\n"
	"If you want to abandon the connection completely, press\n"
	"Return to cancel. Pressing Return is the ONLY guaranteed\n"
	"safe choice.\n"
	"Update cached key? (y/n, Return cancels connection) ";

    static const char abandoned[] = "Connection abandoned.\n";

    char line[32];

    /*
     * Verify the key against the registry.
     */
    ret = verify_host_key(host, port, keytype, keystr);

    if (ret == 0)		       /* success - key matched OK */
	return;

    if (ret == 2) {		       /* key was different */
	if (console_batch_mode) {
	    fprintf(stderr, wrongmsg_batch, keytype, fingerprint);
	    cleanup_exit(1);
	}
	fprintf(stderr, wrongmsg, keytype, fingerprint);
	fflush(stderr);
    }
    if (ret == 1) {		       /* key was absent */
	if (console_batch_mode) {
	    fprintf(stderr, absentmsg_batch, keytype, fingerprint);
	    cleanup_exit(1);
	}
	fprintf(stderr, absentmsg, keytype, fingerprint);
	fflush(stderr);
    }

    hin = GetStdHandle(STD_INPUT_HANDLE);
    GetConsoleMode(hin, &savemode);
    SetConsoleMode(hin, (savemode | ENABLE_ECHO_INPUT |
			 ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT));
    ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
    SetConsoleMode(hin, savemode);

    if (line[0] != '\0' && line[0] != '\r' && line[0] != '\n') {
	if (line[0] == 'y' || line[0] == 'Y')
	    store_host_key(host, port, keytype, keystr);
    } else {
	fprintf(stderr, abandoned);
	cleanup_exit(0);
    }
}

void update_specials_menu(void *frontend)
{
}

/*
 * Ask whether the selected cipher is acceptable (since it was
 * below the configured 'warn' threshold).
 * cs: 0 = both ways, 1 = client->server, 2 = server->client
 */
void askcipher(void *frontend, char *ciphername, int cs)
{
    HANDLE hin;
    DWORD savemode, i;

    static const char msg[] =
	"The first %scipher supported by the server is\n"
	"%s, which is below the configured warning threshold.\n"
	"Continue with connection? (y/n) ";
    static const char msg_batch[] =
	"The first %scipher supported by the server is\n"
	"%s, which is below the configured warning threshold.\n"
	"Connection abandoned.\n";
    static const char abandoned[] = "Connection abandoned.\n";

    char line[32];

    if (console_batch_mode) {
	fprintf(stderr, msg_batch,
		(cs == 0) ? "" :
		(cs == 1) ? "client-to-server " : "server-to-client ",
		ciphername);
	cleanup_exit(1);
    }

    fprintf(stderr, msg,
	    (cs == 0) ? "" :
	    (cs == 1) ? "client-to-server " : "server-to-client ",
	    ciphername);
    fflush(stderr);

    hin = GetStdHandle(STD_INPUT_HANDLE);
    GetConsoleMode(hin, &savemode);
    SetConsoleMode(hin, (savemode | ENABLE_ECHO_INPUT |
			 ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT));
    ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
    SetConsoleMode(hin, savemode);

    if (line[0] == 'y' || line[0] == 'Y') {
	return;
    } else {
	fprintf(stderr, abandoned);
	cleanup_exit(0);
    }
}

/*
 * 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).
 */
int askappend(void *frontend, Filename filename)
{
    HANDLE hin;
    DWORD savemode, i;

    static const char msgtemplate[] =
	"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) ";

    static const char msgtemplate_batch[] =
	"The session log file \"%.*s\" already exists.\n"
	"Logging will not be enabled.\n";

    char line[32];

    if (console_batch_mode) {
	fprintf(stderr, msgtemplate_batch, FILENAME_MAX, filename.path);
	fflush(stderr);
	return 0;
    }
    fprintf(stderr, msgtemplate, FILENAME_MAX, filename.path);
    fflush(stderr);

    hin = GetStdHandle(STD_INPUT_HANDLE);
    GetConsoleMode(hin, &savemode);
    SetConsoleMode(hin, (savemode | ENABLE_ECHO_INPUT |
			 ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT));
    ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
    SetConsoleMode(hin, savemode);

    if (line[0] == 'y' || line[0] == 'Y')
	return 2;
    else if (line[0] == 'n' || line[0] == 'N')
	return 1;
    else
	return 0;
}

/*
 * Warn about the obsolescent key file format.
 * 
 * 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.
 */
void old_keyfile_warning(void)
{
    static const char message[] =
	"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";

    fputs(message, stderr);
}

void console_provide_logctx(void *logctx)
{
    console_logctx = logctx;
}

void logevent(void *frontend, const char *string)
{
    if (console_logctx)
	log_eventlog(console_logctx, string);
}

int console_get_line(const char *prompt, char *str,
			    int maxlen, int is_pw)
{
    HANDLE hin, hout;
    DWORD savemode, newmode, i;

    if (console_batch_mode) {
	if (maxlen > 0)
	    str[0] = '\0';
	return 0;
    } else {
	hin = GetStdHandle(STD_INPUT_HANDLE);
	hout = GetStdHandle(STD_OUTPUT_HANDLE);
	if (hin == INVALID_HANDLE_VALUE || hout == INVALID_HANDLE_VALUE) {
	    fprintf(stderr, "Cannot get standard input/output handles\n");
	    cleanup_exit(1);
	}

	GetConsoleMode(hin, &savemode);
	newmode = savemode | ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT;
	if (is_pw)
	    newmode &= ~ENABLE_ECHO_INPUT;
	else
	    newmode |= ENABLE_ECHO_INPUT;
	SetConsoleMode(hin, newmode);

	WriteFile(hout, prompt, strlen(prompt), &i, NULL);
	ReadFile(hin, str, maxlen - 1, &i, NULL);

	SetConsoleMode(hin, savemode);

	if ((int) i > maxlen)
	    i = maxlen - 1;
	else
	    i = i - 2;
	str[i] = '\0';

	if (is_pw)
	    WriteFile(hout, "\r\n", 2, &i, NULL);

	return 1;
    }
}

void frontend_keypress(void *handle)
{
    /*
     * This is nothing but a stub, in console code.
     */
    return;
}
Commit	Line	Data
ff2ae367	1	/*
ff2ae367	2	* console.c: various interactive-prompt routines shared between
f4ff9455	3	* the Windows console PuTTY tools
ff2ae367	4	*/
ff2ae367	5
ff2ae367	6	#include <stdio.h>
	7	#include <stdlib.h>
	8	#include <stdarg.h>
	9
	10	#include "putty.h"
	11	#include "storage.h"
	12	#include "ssh.h"
	13
	14	int console_batch_mode = FALSE;
	15
d3fef4a5	16	static void *console_logctx = NULL;
d3fef4a5	17
93b581bd	18	/*
	19	* Clean up and exit.
	20	*/
	21	void cleanup_exit(int code)
	22	{
	23	/*
	24	* Clean up.
	25	*/
	26	sk_cleanup();
93b581bd	27
bf61b566	28	random_save_seed();
93b581bd	29	#ifdef MSCRYPTOAPI
bf61b566	30	crypto_wrapup();
93b581bd	31	#endif
93b581bd	32
	33	exit(code);
	34	}
	35
39934deb	36	void notify_remote_exit(void *frontend)
	37	{
	38	}
	39
	40	void timer_change_notify(long next)
	41	{
	42	}
	43
a8327734	44	void verify_ssh_host_key(void frontend, char host, int port, char *keytype,
ff2ae367	45	char keystr, char fingerprint)
	46	{
	47	int ret;
	48	HANDLE hin;
	49	DWORD savemode, i;
	50
	51	static const char absentmsg_batch[] =
	52	"The server's host key is not cached in the registry. You\n"
	53	"have no guarantee that the server is the computer you\n"
	54	"think it is.\n"
65f66c88	55	"The server's %s key fingerprint is:\n"
ff2ae367	56	"%s\n"
	57	"Connection abandoned.\n";
	58	static const char absentmsg[] =
	59	"The server's host key is not cached in the registry. You\n"
	60	"have no guarantee that the server is the computer you\n"
	61	"think it is.\n"
65f66c88	62	"The server's %s key fingerprint is:\n"
ff2ae367	63	"%s\n"
	64	"If you trust this host, enter \"y\" to add the key to\n"
	65	"PuTTY's cache and carry on connecting.\n"
	66	"If you want to carry on connecting just once, without\n"
	67	"adding the key to the cache, enter \"n\".\n"
	68	"If you do not trust this host, press Return to abandon the\n"
	69	"connection.\n"
	70	"Store key in cache? (y/n) ";
	71
	72	static const char wrongmsg_batch[] =
	73	"WARNING - POTENTIAL SECURITY BREACH!\n"
	74	"The server's host key does not match the one PuTTY has\n"
	75	"cached in the registry. This means that either the\n"
	76	"server administrator has changed the host key, or you\n"
	77	"have actually connected to another computer pretending\n"
	78	"to be the server.\n"
65f66c88	79	"The new %s key fingerprint is:\n"
ff2ae367	80	"%s\n"
	81	"Connection abandoned.\n";
	82	static const char wrongmsg[] =
	83	"WARNING - POTENTIAL SECURITY BREACH!\n"
	84	"The server's host key does not match the one PuTTY has\n"
	85	"cached in the registry. This means that either the\n"
	86	"server administrator has changed the host key, or you\n"
	87	"have actually connected to another computer pretending\n"
	88	"to be the server.\n"
65f66c88	89	"The new %s key fingerprint is:\n"
ff2ae367	90	"%s\n"
	91	"If you were expecting this change and trust the new key,\n"
	92	"enter \"y\" to update PuTTY's cache and continue connecting.\n"
	93	"If you want to carry on connecting but without updating\n"
	94	"the cache, enter \"n\".\n"
	95	"If you want to abandon the connection completely, press\n"
	96	"Return to cancel. Pressing Return is the ONLY guaranteed\n"
	97	"safe choice.\n"
	98	"Update cached key? (y/n, Return cancels connection) ";
	99
	100	static const char abandoned[] = "Connection abandoned.\n";
	101
	102	char line[32];
	103
	104	/*
	105	* Verify the key against the registry.
	106	*/
	107	ret = verify_host_key(host, port, keytype, keystr);
	108
	109	if (ret == 0) /* success - key matched OK */
	110	return;
	111
	112	if (ret == 2) { /* key was different */
	113	if (console_batch_mode) {
65f66c88	114	fprintf(stderr, wrongmsg_batch, keytype, fingerprint);
93b581bd	115	cleanup_exit(1);
ff2ae367	116	}
65f66c88	117	fprintf(stderr, wrongmsg, keytype, fingerprint);
ff2ae367	118	fflush(stderr);
	119	}
	120	if (ret == 1) { /* key was absent */
	121	if (console_batch_mode) {
65f66c88	122	fprintf(stderr, absentmsg_batch, keytype, fingerprint);
93b581bd	123	cleanup_exit(1);
ff2ae367	124	}
65f66c88	125	fprintf(stderr, absentmsg, keytype, fingerprint);
ff2ae367	126	fflush(stderr);
	127	}
	128
	129	hin = GetStdHandle(STD_INPUT_HANDLE);
	130	GetConsoleMode(hin, &savemode);
	131	SetConsoleMode(hin, (savemode \| ENABLE_ECHO_INPUT \|
	132	ENABLE_PROCESSED_INPUT \| ENABLE_LINE_INPUT));
	133	ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
	134	SetConsoleMode(hin, savemode);
	135
	136	if (line[0] != '\0' && line[0] != '\r' && line[0] != '\n') {
	137	if (line[0] == 'y' \|\| line[0] == 'Y')
	138	store_host_key(host, port, keytype, keystr);
	139	} else {
	140	fprintf(stderr, abandoned);
93b581bd	141	cleanup_exit(0);
ff2ae367	142	}
	143	}
	144
125105d1	145	void update_specials_menu(void *frontend)
	146	{
	147	}
	148
ff2ae367	149	/*
	150	* Ask whether the selected cipher is acceptable (since it was
	151	* below the configured 'warn' threshold).
	152	* cs: 0 = both ways, 1 = client->server, 2 = server->client
	153	*/
a8327734	154	void askcipher(void frontend, char ciphername, int cs)
ff2ae367	155	{
	156	HANDLE hin;
	157	DWORD savemode, i;
	158
	159	static const char msg[] =
	160	"The first %scipher supported by the server is\n"
	161	"%s, which is below the configured warning threshold.\n"
	162	"Continue with connection? (y/n) ";
	163	static const char msg_batch[] =
	164	"The first %scipher supported by the server is\n"
	165	"%s, which is below the configured warning threshold.\n"
	166	"Connection abandoned.\n";
	167	static const char abandoned[] = "Connection abandoned.\n";
	168
	169	char line[32];
	170
	171	if (console_batch_mode) {
	172	fprintf(stderr, msg_batch,
	173	(cs == 0) ? "" :
	174	(cs == 1) ? "client-to-server " : "server-to-client ",
	175	ciphername);
93b581bd	176	cleanup_exit(1);
ff2ae367	177	}
	178
	179	fprintf(stderr, msg,
	180	(cs == 0) ? "" :
	181	(cs == 1) ? "client-to-server " : "server-to-client ",
	182	ciphername);
	183	fflush(stderr);
	184
	185	hin = GetStdHandle(STD_INPUT_HANDLE);
	186	GetConsoleMode(hin, &savemode);
	187	SetConsoleMode(hin, (savemode \| ENABLE_ECHO_INPUT \|
	188	ENABLE_PROCESSED_INPUT \| ENABLE_LINE_INPUT));
	189	ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
	190	SetConsoleMode(hin, savemode);
	191
	192	if (line[0] == 'y' \|\| line[0] == 'Y') {
	193	return;
	194	} else {
	195	fprintf(stderr, abandoned);
93b581bd	196	cleanup_exit(0);
ff2ae367	197	}
	198	}
	199
	200	/*
	201	* Ask whether to wipe a session log file before writing to it.
	202	* Returns 2 for wipe, 1 for append, 0 for cancel (don't log).
	203	*/
9a30e26b	204	int askappend(void *frontend, Filename filename)
ff2ae367	205	{
	206	HANDLE hin;
	207	DWORD savemode, i;
	208
	209	static const char msgtemplate[] =
	210	"The session log file \"%.*s\" already exists.\n"
	211	"You can overwrite it with a new session log,\n"
	212	"append your session log to the end of it,\n"
	213	"or disable session logging for this session.\n"
	214	"Enter \"y\" to wipe the file, \"n\" to append to it,\n"
	215	"or just press Return to disable logging.\n"
	216	"Wipe the log file? (y/n, Return cancels logging) ";
	217
	218	static const char msgtemplate_batch[] =
	219	"The session log file \"%.*s\" already exists.\n"
	220	"Logging will not be enabled.\n";
	221
	222	char line[32];
	223
	224	if (console_batch_mode) {
9a30e26b	225	fprintf(stderr, msgtemplate_batch, FILENAME_MAX, filename.path);
ff2ae367	226	fflush(stderr);
	227	return 0;
	228	}
9a30e26b	229	fprintf(stderr, msgtemplate, FILENAME_MAX, filename.path);
ff2ae367	230	fflush(stderr);
	231
	232	hin = GetStdHandle(STD_INPUT_HANDLE);
	233	GetConsoleMode(hin, &savemode);
	234	SetConsoleMode(hin, (savemode \| ENABLE_ECHO_INPUT \|
	235	ENABLE_PROCESSED_INPUT \| ENABLE_LINE_INPUT));
	236	ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
	237	SetConsoleMode(hin, savemode);
	238
	239	if (line[0] == 'y' \|\| line[0] == 'Y')
	240	return 2;
	241	else if (line[0] == 'n' \|\| line[0] == 'N')
	242	return 1;
	243	else
	244	return 0;
	245	}
	246
	247	/*
	248	* Warn about the obsolescent key file format.
a8327734	249	*
	250	* Uniquely among these functions, this one does _not_ expect a
	251	* frontend handle. This means that if PuTTY is ported to a
	252	* platform which requires frontend handles, this function will be
	253	* an anomaly. Fortunately, the problem it addresses will not have
	254	* been present on that platform, so it can plausibly be
	255	* implemented as an empty function.
ff2ae367	256	*/
	257	void old_keyfile_warning(void)
	258	{
	259	static const char message[] =
	260	"You are loading an SSH 2 private key which has an\n"
	261	"old version of the file format. This means your key\n"
	262	"file is not fully tamperproof. Future versions of\n"
	263	"PuTTY may stop supporting this private key format,\n"
	264	"so we recommend you convert your key to the new\n"
	265	"format.\n"
	266	"\n"
	267	"Once the key is loaded into PuTTYgen, you can perform\n"
	268	"this conversion simply by saving it again.\n";
	269
	270	fputs(message, stderr);
	271	}
	272
d3fef4a5	273	void console_provide_logctx(void *logctx)
	274	{
	275	console_logctx = logctx;
	276	}
	277
cbe2d68f	278	void logevent(void frontend, const char string)
ff2ae367	279	{
d3fef4a5	280	if (console_logctx)
d3fef4a5	281	log_eventlog(console_logctx, string);
ff2ae367	282	}
ff2ae367	283
ff2ae367	284	int console_get_line(const char prompt, char str,
	285	int maxlen, int is_pw)
	286	{
	287	HANDLE hin, hout;
	288	DWORD savemode, newmode, i;
	289
ff2ae367	290	if (console_batch_mode) {
	291	if (maxlen > 0)
	292	str[0] = '\0';
a21a6a9a	293	return 0;
ff2ae367	294	} else {
	295	hin = GetStdHandle(STD_INPUT_HANDLE);
	296	hout = GetStdHandle(STD_OUTPUT_HANDLE);
	297	if (hin == INVALID_HANDLE_VALUE \|\| hout == INVALID_HANDLE_VALUE) {
	298	fprintf(stderr, "Cannot get standard input/output handles\n");
93b581bd	299	cleanup_exit(1);
ff2ae367	300	}
	301
	302	GetConsoleMode(hin, &savemode);
	303	newmode = savemode \| ENABLE_PROCESSED_INPUT \| ENABLE_LINE_INPUT;
	304	if (is_pw)
	305	newmode &= ~ENABLE_ECHO_INPUT;
	306	else
	307	newmode \|= ENABLE_ECHO_INPUT;
	308	SetConsoleMode(hin, newmode);
	309
	310	WriteFile(hout, prompt, strlen(prompt), &i, NULL);
	311	ReadFile(hin, str, maxlen - 1, &i, NULL);
	312
	313	SetConsoleMode(hin, savemode);
	314
	315	if ((int) i > maxlen)
	316	i = maxlen - 1;
	317	else
	318	i = i - 2;
	319	str[i] = '\0';
	320
	321	if (is_pw)
	322	WriteFile(hout, "\r\n", 2, &i, NULL);
	323
a21a6a9a	324	return 1;
ff2ae367	325	}
ff2ae367	326	}
f8255dce	327
b9d7bcad	328	void frontend_keypress(void *handle)
f8255dce	329	{
	330	/*
	331	* This is nothing but a stub, in console code.
	332	*/
	333	return;
	334	}