[u-boot.git] / common / autoboot.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * (C) Copyright 2000
 * Wolfgang Denk, DENX Software Engineering, [email protected].
 */

#include <common.h>
#include <autoboot.h>
#include <bootretry.h>
#include <cli.h>
#include <console.h>
#include <fdtdec.h>
#include <menu.h>
#include <post.h>
#include <u-boot/sha256.h>
#include <bootcount.h>

DECLARE_GLOBAL_DATA_PTR;

#define MAX_DELAY_STOP_STR 32

#ifndef DEBUG_BOOTKEYS
#define DEBUG_BOOTKEYS 0
#endif
#define debug_bootkeys(fmt, args...)		\
	debug_cond(DEBUG_BOOTKEYS, fmt, ##args)

/* Stored value of bootdelay, used by autoboot_command() */
static int stored_bootdelay;

#if defined(CONFIG_AUTOBOOT_KEYED)
#if defined(CONFIG_AUTOBOOT_STOP_STR_SHA256)

/*
 * Use a "constant-length" time compare function for this
 * hash compare:
 *
 * https://crackstation.net/hashing-security.htm
 */
static int slow_equals(u8 *a, u8 *b, int len)
{
	int diff = 0;
	int i;

	for (i = 0; i < len; i++)
		diff |= a[i] ^ b[i];

	return diff == 0;
}

static int passwd_abort(uint64_t etime)
{
	const char *sha_env_str = env_get("bootstopkeysha256");
	u8 sha_env[SHA256_SUM_LEN];
	u8 sha[SHA256_SUM_LEN];
	char presskey[MAX_DELAY_STOP_STR];
	const char *algo_name = "sha256";
	u_int presskey_len = 0;
	int abort = 0;
	int size = sizeof(sha);
	int ret;

	if (sha_env_str == NULL)
		sha_env_str = CONFIG_AUTOBOOT_STOP_STR_SHA256;

	/*
	 * Generate the binary value from the environment hash value
	 * so that we can compare this value with the computed hash
	 * from the user input
	 */
	ret = hash_parse_string(algo_name, sha_env_str, sha_env);
	if (ret) {
		printf("Hash %s not supported!\n", algo_name);
		return 0;
	}

	/*
	 * We don't know how long the stop-string is, so we need to
	 * generate the sha256 hash upon each input character and
	 * compare the value with the one saved in the environment
	 */
	do {
		if (tstc()) {
			/* Check for input string overflow */
			if (presskey_len >= MAX_DELAY_STOP_STR)
				return 0;

			presskey[presskey_len++] = getc();

			/* Calculate sha256 upon each new char */
			hash_block(algo_name, (const void *)presskey,
				   presskey_len, sha, &size);

			/* And check if sha matches saved value in env */
			if (slow_equals(sha, sha_env, SHA256_SUM_LEN))
				abort = 1;
		}
	} while (!abort && get_ticks() <= etime);

	return abort;
}
#else
static int passwd_abort(uint64_t etime)
{
	int abort = 0;
	struct {
		char *str;
		u_int len;
		int retry;
	}
	delaykey[] = {
		{ .str = env_get("bootdelaykey"),  .retry = 1 },
		{ .str = env_get("bootstopkey"),   .retry = 0 },
	};

	char presskey[MAX_DELAY_STOP_STR];
	u_int presskey_len = 0;
	u_int presskey_max = 0;
	u_int i;

#  ifdef CONFIG_AUTOBOOT_DELAY_STR
	if (delaykey[0].str == NULL)
		delaykey[0].str = CONFIG_AUTOBOOT_DELAY_STR;
#  endif
#  ifdef CONFIG_AUTOBOOT_STOP_STR
	if (delaykey[1].str == NULL)
		delaykey[1].str = CONFIG_AUTOBOOT_STOP_STR;
#  endif

	for (i = 0; i < sizeof(delaykey) / sizeof(delaykey[0]); i++) {
		delaykey[i].len = delaykey[i].str == NULL ?
				    0 : strlen(delaykey[i].str);
		delaykey[i].len = delaykey[i].len > MAX_DELAY_STOP_STR ?
				    MAX_DELAY_STOP_STR : delaykey[i].len;

		presskey_max = presskey_max > delaykey[i].len ?
				    presskey_max : delaykey[i].len;

		debug_bootkeys("%s key:<%s>\n",
			       delaykey[i].retry ? "delay" : "stop",
			       delaykey[i].str ? delaykey[i].str : "NULL");
	}

	/* In order to keep up with incoming data, check timeout only
	 * when catch up.
	 */
	do {
		if (tstc()) {
			if (presskey_len < presskey_max) {
				presskey[presskey_len++] = getc();
			} else {
				for (i = 0; i < presskey_max - 1; i++)
					presskey[i] = presskey[i + 1];

				presskey[i] = getc();
			}
		}

		for (i = 0; i < sizeof(delaykey) / sizeof(delaykey[0]); i++) {
			if (delaykey[i].len > 0 &&
			    presskey_len >= delaykey[i].len &&
				memcmp(presskey + presskey_len -
					delaykey[i].len, delaykey[i].str,
					delaykey[i].len) == 0) {
					debug_bootkeys("got %skey\n",
						delaykey[i].retry ? "delay" :
						"stop");

				/* don't retry auto boot */
				if (!delaykey[i].retry)
					bootretry_dont_retry();
				abort = 1;
			}
		}
	} while (!abort && get_ticks() <= etime);

	return abort;
}
#endif

/***************************************************************************
 * Watch for 'delay' seconds for autoboot stop or autoboot delay string.
 * returns: 0 -  no key string, allow autoboot 1 - got key string, abort
 */
static int __abortboot(int bootdelay)
{
	int abort;
	uint64_t etime = endtick(bootdelay);

#  ifdef CONFIG_AUTOBOOT_PROMPT
	/*
	 * CONFIG_AUTOBOOT_PROMPT includes the %d for all boards.
	 * To print the bootdelay value upon bootup.
	 */
	printf(CONFIG_AUTOBOOT_PROMPT, bootdelay);
#  endif

	abort = passwd_abort(etime);
	if (!abort)
		debug_bootkeys("key timeout\n");

	return abort;
}

# else	/* !defined(CONFIG_AUTOBOOT_KEYED) */

#ifdef CONFIG_MENUKEY
static int menukey;
#endif

static int __abortboot(int bootdelay)
{
	int abort = 0;
	unsigned long ts;

#ifdef CONFIG_MENUPROMPT
	printf(CONFIG_MENUPROMPT);
#else
	printf("Hit any key to stop autoboot: %2d ", bootdelay);
#endif

	/*
	 * Check if key already pressed
	 */
	if (tstc()) {	/* we got a key press	*/
		(void) getc();  /* consume input	*/
		puts("\b\b\b 0");
		abort = 1;	/* don't auto boot	*/
	}

	while ((bootdelay > 0) && (!abort)) {
		--bootdelay;
		/* delay 1000 ms */
		ts = get_timer(0);
		do {
			if (tstc()) {	/* we got a key press	*/
				abort  = 1;	/* don't auto boot	*/
				bootdelay = 0;	/* no more delay	*/
# ifdef CONFIG_MENUKEY
				menukey = getc();
# else
				(void) getc();  /* consume input	*/
# endif
				break;
			}
			udelay(10000);
		} while (!abort && get_timer(ts) < 1000);

		printf("\b\b\b%2d ", bootdelay);
	}

	putc('\n');

	return abort;
}
# endif	/* CONFIG_AUTOBOOT_KEYED */

static int abortboot(int bootdelay)
{
	int abort = 0;

	if (bootdelay >= 0)
		abort = __abortboot(bootdelay);

#ifdef CONFIG_SILENT_CONSOLE
	if (abort)
		gd->flags &= ~GD_FLG_SILENT;
#endif

	return abort;
}

static void process_fdt_options(const void *blob)
{
#if defined(CONFIG_OF_CONTROL) && defined(CONFIG_SYS_TEXT_BASE)
	ulong addr;

	/* Add an env variable to point to a kernel payload, if available */
	addr = fdtdec_get_config_int(gd->fdt_blob, "kernel-offset", 0);
	if (addr)
		env_set_addr("kernaddr", (void *)(CONFIG_SYS_TEXT_BASE + addr));

	/* Add an env variable to point to a root disk, if available */
	addr = fdtdec_get_config_int(gd->fdt_blob, "rootdisk-offset", 0);
	if (addr)
		env_set_addr("rootaddr", (void *)(CONFIG_SYS_TEXT_BASE + addr));
#endif /* CONFIG_OF_CONTROL && CONFIG_SYS_TEXT_BASE */
}

const char *bootdelay_process(void)
{
	char *s;
	int bootdelay;

	bootcount_inc();

	s = env_get("bootdelay");
	bootdelay = s ? (int)simple_strtol(s, NULL, 10) : CONFIG_BOOTDELAY;

#ifdef CONFIG_OF_CONTROL
	bootdelay = fdtdec_get_config_int(gd->fdt_blob, "bootdelay",
			bootdelay);
#endif

	debug("### main_loop entered: bootdelay=%d\n\n", bootdelay);

#if defined(CONFIG_MENU_SHOW)
	bootdelay = menu_show(bootdelay);
#endif
	bootretry_init_cmd_timeout();

#ifdef CONFIG_POST
	if (gd->flags & GD_FLG_POSTFAIL) {
		s = env_get("failbootcmd");
	} else
#endif /* CONFIG_POST */
	if (bootcount_error())
		s = env_get("altbootcmd");
	else
		s = env_get("bootcmd");

	process_fdt_options(gd->fdt_blob);
	stored_bootdelay = bootdelay;

	return s;
}

void autoboot_command(const char *s)
{
	debug("### main_loop: bootcmd=\"%s\"\n", s ? s : "<UNDEFINED>");

	if (stored_bootdelay != -1 && s && !abortboot(stored_bootdelay)) {
#if defined(CONFIG_AUTOBOOT_KEYED) && !defined(CONFIG_AUTOBOOT_KEYED_CTRLC)
		int prev = disable_ctrlc(1);	/* disable Control C checking */
#endif

		run_command_list(s, -1, 0);

#if defined(CONFIG_AUTOBOOT_KEYED) && !defined(CONFIG_AUTOBOOT_KEYED_CTRLC)
		disable_ctrlc(prev);	/* restore Control C checking */
#endif
	}

#ifdef CONFIG_MENUKEY
	if (menukey == CONFIG_MENUKEY) {
		s = env_get("menucmd");
		if (s)
			run_command_list(s, -1, 0);
	}
#endif /* CONFIG_MENUKEY */
}
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
66ded17d SG	2	/*
	3	* (C) Copyright 2000
	4	* Wolfgang Denk, DENX Software Engineering, [email protected].
66ded17d SG	5	*/
	6
	7	#include <common.h>
39e1230e	8	#include <autoboot.h>
0098e179	9	#include <bootretry.h>
66ded17d	10	#include <cli.h>
24b852a7	11	#include <console.h>
66ded17d SG	12	#include <fdtdec.h>
	13	#include <menu.h>
	14	#include <post.h>
8f0b1e24	15	#include <u-boot/sha256.h>
bc8c440f	16	#include <bootcount.h>
66ded17d SG	17
	18	DECLARE_GLOBAL_DATA_PTR;
	19
	20	#define MAX_DELAY_STOP_STR 32
	21
	22	#ifndef DEBUG_BOOTKEYS
	23	#define DEBUG_BOOTKEYS 0
	24	#endif
	25	#define debug_bootkeys(fmt, args...) \
	26	debug_cond(DEBUG_BOOTKEYS, fmt, ##args)
	27
affb2156 SG	28	/* Stored value of bootdelay, used by autoboot_command() */
	29	static int stored_bootdelay;
	30
8f0b1e24 SR	31	#if defined(CONFIG_AUTOBOOT_KEYED)
	32	#if defined(CONFIG_AUTOBOOT_STOP_STR_SHA256)
	33
	34	/*
	35	* Use a "constant-length" time compare function for this
	36	* hash compare:
	37	*
	38	* https://crackstation.net/hashing-security.htm
66ded17d	39	*/
8f0b1e24 SR	40	static int slow_equals(u8 a, u8 b, int len)
	41	{
	42	int diff = 0;
	43	int i;
	44
	45	for (i = 0; i < len; i++)
	46	diff \|= a[i] ^ b[i];
	47
	48	return diff == 0;
	49	}
	50
	51	static int passwd_abort(uint64_t etime)
	52	{
00caae6d	53	const char *sha_env_str = env_get("bootstopkeysha256");
8f0b1e24 SR	54	u8 sha_env[SHA256_SUM_LEN];
	55	u8 sha[SHA256_SUM_LEN];
	56	char presskey[MAX_DELAY_STOP_STR];
	57	const char *algo_name = "sha256";
	58	u_int presskey_len = 0;
	59	int abort = 0;
2d06fd83	60	int size = sizeof(sha);
8f0b1e24 SR	61	int ret;
	62
	63	if (sha_env_str == NULL)
	64	sha_env_str = CONFIG_AUTOBOOT_STOP_STR_SHA256;
	65
	66	/*
	67	* Generate the binary value from the environment hash value
	68	* so that we can compare this value with the computed hash
	69	* from the user input
	70	*/
	71	ret = hash_parse_string(algo_name, sha_env_str, sha_env);
	72	if (ret) {
	73	printf("Hash %s not supported!\n", algo_name);
	74	return 0;
	75	}
	76
	77	/*
	78	* We don't know how long the stop-string is, so we need to
	79	* generate the sha256 hash upon each input character and
	80	* compare the value with the one saved in the environment
	81	*/
	82	do {
	83	if (tstc()) {
	84	/* Check for input string overflow */
	85	if (presskey_len >= MAX_DELAY_STOP_STR)
	86	return 0;
	87
	88	presskey[presskey_len++] = getc();
	89
	90	/* Calculate sha256 upon each new char */
	91	hash_block(algo_name, (const void *)presskey,
	92	presskey_len, sha, &size);
	93
	94	/* And check if sha matches saved value in env */
	95	if (slow_equals(sha, sha_env, SHA256_SUM_LEN))
	96	abort = 1;
	97	}
	98	} while (!abort && get_ticks() <= etime);
	99
	100	return abort;
	101	}
	102	#else
	103	static int passwd_abort(uint64_t etime)
66ded17d SG	104	{
66ded17d SG	105	int abort = 0;
66ded17d SG	106	struct {
	107	char *str;
	108	u_int len;
	109	int retry;
	110	}
	111	delaykey[] = {
00caae6d SG	112	{ .str = env_get("bootdelaykey"), .retry = 1 },
00caae6d SG	113	{ .str = env_get("bootstopkey"), .retry = 0 },
66ded17d SG	114	};
	115
	116	char presskey[MAX_DELAY_STOP_STR];
	117	u_int presskey_len = 0;
	118	u_int presskey_max = 0;
	119	u_int i;
	120
66ded17d SG	121	# ifdef CONFIG_AUTOBOOT_DELAY_STR
	122	if (delaykey[0].str == NULL)
	123	delaykey[0].str = CONFIG_AUTOBOOT_DELAY_STR;
	124	# endif
66ded17d	125	# ifdef CONFIG_AUTOBOOT_STOP_STR
2d908fa0 SR	126	if (delaykey[1].str == NULL)
2d908fa0 SR	127	delaykey[1].str = CONFIG_AUTOBOOT_STOP_STR;
66ded17d SG	128	# endif
	129
	130	for (i = 0; i < sizeof(delaykey) / sizeof(delaykey[0]); i++) {
	131	delaykey[i].len = delaykey[i].str == NULL ?
	132	0 : strlen(delaykey[i].str);
	133	delaykey[i].len = delaykey[i].len > MAX_DELAY_STOP_STR ?
	134	MAX_DELAY_STOP_STR : delaykey[i].len;
	135
	136	presskey_max = presskey_max > delaykey[i].len ?
	137	presskey_max : delaykey[i].len;
	138
	139	debug_bootkeys("%s key:<%s>\n",
	140	delaykey[i].retry ? "delay" : "stop",
	141	delaykey[i].str ? delaykey[i].str : "NULL");
	142	}
	143
	144	/* In order to keep up with incoming data, check timeout only
	145	* when catch up.
	146	*/
	147	do {
	148	if (tstc()) {
	149	if (presskey_len < presskey_max) {
	150	presskey[presskey_len++] = getc();
	151	} else {
	152	for (i = 0; i < presskey_max - 1; i++)
	153	presskey[i] = presskey[i + 1];
	154
	155	presskey[i] = getc();
	156	}
	157	}
	158
	159	for (i = 0; i < sizeof(delaykey) / sizeof(delaykey[0]); i++) {
	160	if (delaykey[i].len > 0 &&
	161	presskey_len >= delaykey[i].len &&
	162	memcmp(presskey + presskey_len -
	163	delaykey[i].len, delaykey[i].str,
	164	delaykey[i].len) == 0) {
	165	debug_bootkeys("got %skey\n",
	166	delaykey[i].retry ? "delay" :
	167	"stop");
	168
66ded17d SG	169	/* don't retry auto boot */
	170	if (!delaykey[i].retry)
	171	bootretry_dont_retry();
66ded17d SG	172	abort = 1;
	173	}
	174	}
	175	} while (!abort && get_ticks() <= etime);
	176
8f0b1e24 SR	177	return abort;
	178	}
	179	#endif
	180
	181	/***************************************************************************
	182	* Watch for 'delay' seconds for autoboot stop or autoboot delay string.
	183	* returns: 0 - no key string, allow autoboot 1 - got key string, abort
	184	*/
d8da8298	185	static int __abortboot(int bootdelay)
8f0b1e24 SR	186	{
	187	int abort;
	188	uint64_t etime = endtick(bootdelay);
	189
8f0b1e24 SR	190	# ifdef CONFIG_AUTOBOOT_PROMPT
	191	/*
	192	* CONFIG_AUTOBOOT_PROMPT includes the %d for all boards.
	193	* To print the bootdelay value upon bootup.
	194	*/
	195	printf(CONFIG_AUTOBOOT_PROMPT, bootdelay);
	196	# endif
	197
	198	abort = passwd_abort(etime);
66ded17d SG	199	if (!abort)
	200	debug_bootkeys("key timeout\n");
	201
66ded17d SG	202	return abort;
	203	}
	204
	205	# else /* !defined(CONFIG_AUTOBOOT_KEYED) */
	206
	207	#ifdef CONFIG_MENUKEY
	208	static int menukey;
	209	#endif
	210
d8da8298	211	static int __abortboot(int bootdelay)
66ded17d SG	212	{
	213	int abort = 0;
	214	unsigned long ts;
	215
	216	#ifdef CONFIG_MENUPROMPT
	217	printf(CONFIG_MENUPROMPT);
	218	#else
46327392	219	printf("Hit any key to stop autoboot: %2d ", bootdelay);
66ded17d SG	220	#endif
66ded17d SG	221
66ded17d SG	222	/*
66ded17d SG	223	* Check if key already pressed
66ded17d	224	*/
46327392 MY	225	if (tstc()) { /* we got a key press */
	226	(void) getc(); /* consume input */
	227	puts("\b\b\b 0");
	228	abort = 1; /* don't auto boot */
66ded17d	229	}
66ded17d SG	230
	231	while ((bootdelay > 0) && (!abort)) {
	232	--bootdelay;
	233	/* delay 1000 ms */
	234	ts = get_timer(0);
	235	do {
	236	if (tstc()) { /* we got a key press */
	237	abort = 1; /* don't auto boot */
	238	bootdelay = 0; /* no more delay */
	239	# ifdef CONFIG_MENUKEY
	240	menukey = getc();
	241	# else
	242	(void) getc(); /* consume input */
	243	# endif
	244	break;
	245	}
	246	udelay(10000);
	247	} while (!abort && get_timer(ts) < 1000);
	248
	249	printf("\b\b\b%2d ", bootdelay);
	250	}
	251
	252	putc('\n');
	253
66ded17d SG	254	return abort;
	255	}
	256	# endif /* CONFIG_AUTOBOOT_KEYED */
	257
	258	static int abortboot(int bootdelay)
	259	{
46327392	260	int abort = 0;
09b9d9e5	261
46327392 MY	262	if (bootdelay >= 0)
46327392 MY	263	abort = __abortboot(bootdelay);
09b9d9e5 MY	264
	265	#ifdef CONFIG_SILENT_CONSOLE
	266	if (abort)
	267	gd->flags &= ~GD_FLG_SILENT;
	268	#endif
	269
	270	return abort;
66ded17d SG	271	}
66ded17d SG	272
66ded17d SG	273	static void process_fdt_options(const void *blob)
66ded17d SG	274	{
9f73690c	275	#if defined(CONFIG_OF_CONTROL) && defined(CONFIG_SYS_TEXT_BASE)
66ded17d SG	276	ulong addr;
	277
	278	/* Add an env variable to point to a kernel payload, if available */
	279	addr = fdtdec_get_config_int(gd->fdt_blob, "kernel-offset", 0);
	280	if (addr)
018f5303	281	env_set_addr("kernaddr", (void *)(CONFIG_SYS_TEXT_BASE + addr));
66ded17d SG	282
	283	/* Add an env variable to point to a root disk, if available */
	284	addr = fdtdec_get_config_int(gd->fdt_blob, "rootdisk-offset", 0);
	285	if (addr)
018f5303	286	env_set_addr("rootaddr", (void *)(CONFIG_SYS_TEXT_BASE + addr));
9f73690c	287	#endif /* CONFIG_OF_CONTROL && CONFIG_SYS_TEXT_BASE */
affb2156	288	}
66ded17d	289
affb2156	290	const char *bootdelay_process(void)
66ded17d	291	{
66ded17d SG	292	char *s;
66ded17d SG	293	int bootdelay;
bc8c440f LM	294
bc8c440f LM	295	bootcount_inc();
66ded17d	296
00caae6d	297	s = env_get("bootdelay");
66ded17d SG	298	bootdelay = s ? (int)simple_strtol(s, NULL, 10) : CONFIG_BOOTDELAY;
	299
	300	#ifdef CONFIG_OF_CONTROL
	301	bootdelay = fdtdec_get_config_int(gd->fdt_blob, "bootdelay",
	302	bootdelay);
	303	#endif
	304
	305	debug("### main_loop entered: bootdelay=%d\n\n", bootdelay);
	306
	307	#if defined(CONFIG_MENU_SHOW)
	308	bootdelay = menu_show(bootdelay);
	309	#endif
b26440f1	310	bootretry_init_cmd_timeout();
66ded17d SG	311
	312	#ifdef CONFIG_POST
	313	if (gd->flags & GD_FLG_POSTFAIL) {
00caae6d	314	s = env_get("failbootcmd");
66ded17d SG	315	} else
66ded17d SG	316	#endif /* CONFIG_POST */
bc8c440f	317	if (bootcount_error())
00caae6d	318	s = env_get("altbootcmd");
bc8c440f	319	else
00caae6d	320	s = env_get("bootcmd");
66ded17d SG	321
66ded17d SG	322	process_fdt_options(gd->fdt_blob);
affb2156	323	stored_bootdelay = bootdelay;
66ded17d	324
affb2156 SG	325	return s;
affb2156 SG	326	}
66ded17d	327
affb2156 SG	328	void autoboot_command(const char *s)
affb2156 SG	329	{
66ded17d SG	330	debug("### main_loop: bootcmd=\"%s\"\n", s ? s : "<UNDEFINED>");
66ded17d SG	331
affb2156	332	if (stored_bootdelay != -1 && s && !abortboot(stored_bootdelay)) {
66ded17d SG	333	#if defined(CONFIG_AUTOBOOT_KEYED) && !defined(CONFIG_AUTOBOOT_KEYED_CTRLC)
	334	int prev = disable_ctrlc(1); /* disable Control C checking */
	335	#endif
	336
	337	run_command_list(s, -1, 0);
	338
	339	#if defined(CONFIG_AUTOBOOT_KEYED) && !defined(CONFIG_AUTOBOOT_KEYED_CTRLC)
	340	disable_ctrlc(prev); /* restore Control C checking */
	341	#endif
	342	}
	343
	344	#ifdef CONFIG_MENUKEY
	345	if (menukey == CONFIG_MENUKEY) {
00caae6d	346	s = env_get("menucmd");
66ded17d SG	347	if (s)
	348	run_command_list(s, -1, 0);
	349	}
	350	#endif /* CONFIG_MENUKEY */
	351	}