common/autoboot.c

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