common/autoboot.c

   1 /*
   2  * (C) Copyright 2000
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #include <common.h>
   9 #include <autoboot.h>
  10 #include <bootretry.h>
  11 #include <cli.h>
  12 #include <console.h>
  13 #include <fdtdec.h>
  14 #include <menu.h>
  15 #include <post.h>
  16 #include <u-boot/sha256.h>
  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
  28 /* Stored value of bootdelay, used by autoboot_command() */
  29 static int stored_bootdelay;
  30
  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
  39  */
  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 {
  53         const char *sha_env_str = getenv("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;
  59         int abort = 0;
  60         int size;
  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)
 104 {
 105         int abort = 0;
 106         struct {
 107                 char *str;
 108                 u_int len;
 109                 int retry;
 110         }
 111         delaykey[] = {
 112                 { .str = getenv("bootdelaykey"),  .retry = 1 },
 113                 { .str = getenv("bootstopkey"),   .retry = 0 },
 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
 121 #  ifdef CONFIG_AUTOBOOT_DELAY_STR
 122         if (delaykey[0].str == NULL)
 123                 delaykey[0].str = CONFIG_AUTOBOOT_DELAY_STR;
 124 #  endif
 125 #  ifdef CONFIG_AUTOBOOT_STOP_STR
 126         if (delaykey[1].str == NULL)
 127                 delaykey[1].str = CONFIG_AUTOBOOT_STOP_STR;
 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
 169                                 /* don't retry auto boot */
 170                                 if (!delaykey[i].retry)
 171                                         bootretry_dont_retry();
 172                                 abort = 1;
 173                         }
 174                 }
 175         } while (!abort && get_ticks() <= etime);
 176
 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  */
 185 static int __abortboot(int bootdelay)
 186 {
 187         int abort;
 188         uint64_t etime = endtick(bootdelay);
 189
 190         if (bootdelay < 0)
 191                 return 0;
 192
 193 #  ifdef CONFIG_AUTOBOOT_PROMPT
 194         /*
 195          * CONFIG_AUTOBOOT_PROMPT includes the %d for all boards.
 196          * To print the bootdelay value upon bootup.
 197          */
 198         printf(CONFIG_AUTOBOOT_PROMPT, bootdelay);
 199 #  endif
 200
 201         abort = passwd_abort(etime);
 202         if (!abort)
 203                 debug_bootkeys("key timeout\n");
 204
 205         return abort;
 206 }
 207
 208 # else  /* !defined(CONFIG_AUTOBOOT_KEYED) */
 209
 210 #ifdef CONFIG_MENUKEY
 211 static int menukey;
 212 #endif
 213
 214 static int __abortboot(int bootdelay)
 215 {
 216         int abort = 0;
 217         unsigned long ts;
 218
 219 #ifdef CONFIG_MENUPROMPT
 220         printf(CONFIG_MENUPROMPT);
 221 #else
 222         if (bootdelay >= 0)
 223                 printf("Hit any key to stop autoboot: %2d ", bootdelay);
 224 #endif
 225
 226         /*
 227          * Check if key already pressed
 228          * Don't check if bootdelay < 0
 229          */
 230         if (bootdelay >= 0) {
 231                 if (tstc()) {   /* we got a key press   */
 232                         (void) getc();  /* consume input        */
 233                         puts("\b\b\b 0");
 234                         abort = 1;      /* don't auto boot      */
 235                 }
 236         }
 237
 238         while ((bootdelay > 0) && (!abort)) {
 239                 --bootdelay;
 240                 /* delay 1000 ms */
 241                 ts = get_timer(0);
 242                 do {
 243                         if (tstc()) {   /* we got a key press   */
 244                                 abort  = 1;     /* don't auto boot      */
 245                                 bootdelay = 0;  /* no more delay        */
 246 # ifdef CONFIG_MENUKEY
 247                                 menukey = getc();
 248 # else
 249                                 (void) getc();  /* consume input        */
 250 # endif
 251                                 break;
 252                         }
 253                         udelay(10000);
 254                 } while (!abort && get_timer(ts) < 1000);
 255
 256                 printf("\b\b\b%2d ", bootdelay);
 257         }
 258
 259         putc('\n');
 260
 261         return abort;
 262 }
 263 # endif /* CONFIG_AUTOBOOT_KEYED */
 264
 265 static int abortboot(int bootdelay)
 266 {
 267         int abort;
 268
 269         abort = __abortboot(bootdelay);
 270
 271 #ifdef CONFIG_SILENT_CONSOLE
 272         if (abort)
 273                 gd->flags &= ~GD_FLG_SILENT;
 274 #endif
 275
 276         return abort;
 277 }
 278
 279 static void process_fdt_options(const void *blob)
 280 {
 281 #if defined(CONFIG_OF_CONTROL) && defined(CONFIG_SYS_TEXT_BASE)
 282         ulong addr;
 283
 284         /* Add an env variable to point to a kernel payload, if available */
 285         addr = fdtdec_get_config_int(gd->fdt_blob, "kernel-offset", 0);
 286         if (addr)
 287                 setenv_addr("kernaddr", (void *)(CONFIG_SYS_TEXT_BASE + addr));
 288
 289         /* Add an env variable to point to a root disk, if available */
 290         addr = fdtdec_get_config_int(gd->fdt_blob, "rootdisk-offset", 0);
 291         if (addr)
 292                 setenv_addr("rootaddr", (void *)(CONFIG_SYS_TEXT_BASE + addr));
 293 #endif /* CONFIG_OF_CONTROL && CONFIG_SYS_TEXT_BASE */
 294 }
 295
 296 const char *bootdelay_process(void)
 297 {
 298         char *s;
 299         int bootdelay;
 300 #ifdef CONFIG_BOOTCOUNT_LIMIT
 301         unsigned long bootcount = 0;
 302         unsigned long bootlimit = 0;
 303 #endif /* CONFIG_BOOTCOUNT_LIMIT */
 304
 305 #ifdef CONFIG_BOOTCOUNT_LIMIT
 306         bootcount = bootcount_load();
 307         bootcount++;
 308         bootcount_store(bootcount);
 309         setenv_ulong("bootcount", bootcount);
 310         bootlimit = getenv_ulong("bootlimit", 10, 0);
 311 #endif /* CONFIG_BOOTCOUNT_LIMIT */
 312
 313         s = getenv("bootdelay");
 314         bootdelay = s ? (int)simple_strtol(s, NULL, 10) : CONFIG_BOOTDELAY;
 315
 316 #ifdef CONFIG_OF_CONTROL
 317         bootdelay = fdtdec_get_config_int(gd->fdt_blob, "bootdelay",
 318                         bootdelay);
 319 #endif
 320
 321         debug("### main_loop entered: bootdelay=%d\n\n", bootdelay);
 322
 323 #if defined(CONFIG_MENU_SHOW)
 324         bootdelay = menu_show(bootdelay);
 325 #endif
 326         bootretry_init_cmd_timeout();
 327
 328 #ifdef CONFIG_POST
 329         if (gd->flags & GD_FLG_POSTFAIL) {
 330                 s = getenv("failbootcmd");
 331         } else
 332 #endif /* CONFIG_POST */
 333 #ifdef CONFIG_BOOTCOUNT_LIMIT
 334         if (bootlimit && (bootcount > bootlimit)) {
 335                 printf("Warning: Bootlimit (%u) exceeded. Using altbootcmd.\n",
 336                        (unsigned)bootlimit);
 337                 s = getenv("altbootcmd");
 338         } else
 339 #endif /* CONFIG_BOOTCOUNT_LIMIT */
 340                 s = getenv("bootcmd");
 341
 342         process_fdt_options(gd->fdt_blob);
 343         stored_bootdelay = bootdelay;
 344
 345         return s;
 346 }
 347
 348 void autoboot_command(const char *s)
 349 {
 350         debug("### main_loop: bootcmd=\"%s\"\n", s ? s : "<UNDEFINED>");
 351
 352         if (stored_bootdelay != -1 && s && !abortboot(stored_bootdelay)) {
 353 #if defined(CONFIG_AUTOBOOT_KEYED) && !defined(CONFIG_AUTOBOOT_KEYED_CTRLC)
 354                 int prev = disable_ctrlc(1);    /* disable Control C checking */
 355 #endif
 356
 357                 run_command_list(s, -1, 0);
 358
 359 #if defined(CONFIG_AUTOBOOT_KEYED) && !defined(CONFIG_AUTOBOOT_KEYED_CTRLC)
 360                 disable_ctrlc(prev);    /* restore Control C checking */
 361 #endif
 362         }
 363
 364 #ifdef CONFIG_MENUKEY
 365         if (menukey == CONFIG_MENUKEY) {
 366                 s = getenv("menucmd");
 367                 if (s)
 368                         run_command_list(s, -1, 0);
 369         }
 370 #endif /* CONFIG_MENUKEY */
 371 }