3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
10 #include <bootretry.h>
16 #include <u-boot/sha256.h>
18 DECLARE_GLOBAL_DATA_PTR;
20 #define MAX_DELAY_STOP_STR 32
22 #ifndef DEBUG_BOOTKEYS
23 #define DEBUG_BOOTKEYS 0
25 #define debug_bootkeys(fmt, args...) \
26 debug_cond(DEBUG_BOOTKEYS, fmt, ##args)
28 /* Stored value of bootdelay, used by autoboot_command() */
29 static int stored_bootdelay;
31 #if defined(CONFIG_AUTOBOOT_KEYED)
32 #if defined(CONFIG_AUTOBOOT_STOP_STR_SHA256)
35 * Use a "constant-length" time compare function for this
38 * https://crackstation.net/hashing-security.htm
40 static int slow_equals(u8 *a, u8 *b, int len)
45 for (i = 0; i < len; i++)
51 static int passwd_abort(uint64_t etime)
53 const char *sha_env_str = env_get("bootstopkeysha256");
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;
60 int size = sizeof(sha);
63 if (sha_env_str == NULL)
64 sha_env_str = CONFIG_AUTOBOOT_STOP_STR_SHA256;
67 * Generate the binary value from the environment hash value
68 * so that we can compare this value with the computed hash
71 ret = hash_parse_string(algo_name, sha_env_str, sha_env);
73 printf("Hash %s not supported!\n", algo_name);
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
84 /* Check for input string overflow */
85 if (presskey_len >= MAX_DELAY_STOP_STR)
88 presskey[presskey_len++] = getc();
90 /* Calculate sha256 upon each new char */
91 hash_block(algo_name, (const void *)presskey,
92 presskey_len, sha, &size);
94 /* And check if sha matches saved value in env */
95 if (slow_equals(sha, sha_env, SHA256_SUM_LEN))
98 } while (!abort && get_ticks() <= etime);
103 static int passwd_abort(uint64_t etime)
112 { .str = env_get("bootdelaykey"), .retry = 1 },
113 { .str = env_get("bootstopkey"), .retry = 0 },
116 char presskey[MAX_DELAY_STOP_STR];
117 u_int presskey_len = 0;
118 u_int presskey_max = 0;
121 # ifdef CONFIG_AUTOBOOT_DELAY_STR
122 if (delaykey[0].str == NULL)
123 delaykey[0].str = CONFIG_AUTOBOOT_DELAY_STR;
125 # ifdef CONFIG_AUTOBOOT_STOP_STR
126 if (delaykey[1].str == NULL)
127 delaykey[1].str = CONFIG_AUTOBOOT_STOP_STR;
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;
136 presskey_max = presskey_max > delaykey[i].len ?
137 presskey_max : delaykey[i].len;
139 debug_bootkeys("%s key:<%s>\n",
140 delaykey[i].retry ? "delay" : "stop",
141 delaykey[i].str ? delaykey[i].str : "NULL");
144 /* In order to keep up with incoming data, check timeout only
149 if (presskey_len < presskey_max) {
150 presskey[presskey_len++] = getc();
152 for (i = 0; i < presskey_max - 1; i++)
153 presskey[i] = presskey[i + 1];
155 presskey[i] = getc();
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" :
169 /* don't retry auto boot */
170 if (!delaykey[i].retry)
171 bootretry_dont_retry();
175 } while (!abort && get_ticks() <= etime);
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
185 static int __abortboot(int bootdelay)
188 uint64_t etime = endtick(bootdelay);
190 # ifdef CONFIG_AUTOBOOT_PROMPT
192 * CONFIG_AUTOBOOT_PROMPT includes the %d for all boards.
193 * To print the bootdelay value upon bootup.
195 printf(CONFIG_AUTOBOOT_PROMPT, bootdelay);
198 abort = passwd_abort(etime);
200 debug_bootkeys("key timeout\n");
205 # else /* !defined(CONFIG_AUTOBOOT_KEYED) */
207 #ifdef CONFIG_MENUKEY
211 static int __abortboot(int bootdelay)
216 #ifdef CONFIG_MENUPROMPT
217 printf(CONFIG_MENUPROMPT);
219 printf("Hit any key to stop autoboot: %2d ", bootdelay);
223 * Check if key already pressed
225 if (tstc()) { /* we got a key press */
226 (void) getc(); /* consume input */
228 abort = 1; /* don't auto boot */
231 while ((bootdelay > 0) && (!abort)) {
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
242 (void) getc(); /* consume input */
247 } while (!abort && get_timer(ts) < 1000);
249 printf("\b\b\b%2d ", bootdelay);
256 # endif /* CONFIG_AUTOBOOT_KEYED */
258 static int abortboot(int bootdelay)
263 abort = __abortboot(bootdelay);
265 #ifdef CONFIG_SILENT_CONSOLE
267 gd->flags &= ~GD_FLG_SILENT;
273 static void process_fdt_options(const void *blob)
275 #if defined(CONFIG_OF_CONTROL) && defined(CONFIG_SYS_TEXT_BASE)
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);
281 env_set_addr("kernaddr", (void *)(CONFIG_SYS_TEXT_BASE + addr));
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);
286 env_set_addr("rootaddr", (void *)(CONFIG_SYS_TEXT_BASE + addr));
287 #endif /* CONFIG_OF_CONTROL && CONFIG_SYS_TEXT_BASE */
290 const char *bootdelay_process(void)
294 #ifdef CONFIG_BOOTCOUNT_LIMIT
295 unsigned long bootcount = 0;
296 unsigned long bootlimit = 0;
297 #endif /* CONFIG_BOOTCOUNT_LIMIT */
299 #ifdef CONFIG_BOOTCOUNT_LIMIT
300 bootcount = bootcount_load();
302 bootcount_store(bootcount);
303 env_set_ulong("bootcount", bootcount);
304 bootlimit = env_get_ulong("bootlimit", 10, 0);
305 #endif /* CONFIG_BOOTCOUNT_LIMIT */
307 s = env_get("bootdelay");
308 bootdelay = s ? (int)simple_strtol(s, NULL, 10) : CONFIG_BOOTDELAY;
310 #ifdef CONFIG_OF_CONTROL
311 bootdelay = fdtdec_get_config_int(gd->fdt_blob, "bootdelay",
315 debug("### main_loop entered: bootdelay=%d\n\n", bootdelay);
317 #if defined(CONFIG_MENU_SHOW)
318 bootdelay = menu_show(bootdelay);
320 bootretry_init_cmd_timeout();
323 if (gd->flags & GD_FLG_POSTFAIL) {
324 s = env_get("failbootcmd");
326 #endif /* CONFIG_POST */
327 #ifdef CONFIG_BOOTCOUNT_LIMIT
328 if (bootlimit && (bootcount > bootlimit)) {
329 printf("Warning: Bootlimit (%u) exceeded. Using altbootcmd.\n",
330 (unsigned)bootlimit);
331 s = env_get("altbootcmd");
333 #endif /* CONFIG_BOOTCOUNT_LIMIT */
334 s = env_get("bootcmd");
336 process_fdt_options(gd->fdt_blob);
337 stored_bootdelay = bootdelay;
342 void autoboot_command(const char *s)
344 debug("### main_loop: bootcmd=\"%s\"\n", s ? s : "<UNDEFINED>");
346 if (stored_bootdelay != -1 && s && !abortboot(stored_bootdelay)) {
347 #if defined(CONFIG_AUTOBOOT_KEYED) && !defined(CONFIG_AUTOBOOT_KEYED_CTRLC)
348 int prev = disable_ctrlc(1); /* disable Control C checking */
351 run_command_list(s, -1, 0);
353 #if defined(CONFIG_AUTOBOOT_KEYED) && !defined(CONFIG_AUTOBOOT_KEYED_CTRLC)
354 disable_ctrlc(prev); /* restore Control C checking */
358 #ifdef CONFIG_MENUKEY
359 if (menukey == CONFIG_MENUKEY) {
360 s = env_get("menucmd");
362 run_command_list(s, -1, 0);
364 #endif /* CONFIG_MENUKEY */