doc: replace @return by Return:
[platform/kernel/u-boot.git] / common / autoboot.c
index 94133ea..b8861d5 100644 (file)
@@ -8,16 +8,27 @@
 #include <autoboot.h>
 #include <bootretry.h>
 #include <cli.h>
+#include <command.h>
 #include <console.h>
+#include <env.h>
 #include <fdtdec.h>
+#include <hash.h>
+#include <log.h>
+#include <malloc.h>
+#include <memalign.h>
 #include <menu.h>
 #include <post.h>
+#include <time.h>
+#include <asm/global_data.h>
+#include <linux/delay.h>
 #include <u-boot/sha256.h>
 #include <bootcount.h>
+#include <crypt.h>
+#include <dm/ofnode.h>
 
 DECLARE_GLOBAL_DATA_PTR;
 
-#define MAX_DELAY_STOP_STR 32
+#define DELAY_STOP_STR_MAX_LENGTH 64
 
 #ifndef DEBUG_BOOTKEYS
 #define DEBUG_BOOTKEYS 0
@@ -27,9 +38,87 @@ DECLARE_GLOBAL_DATA_PTR;
 
 /* Stored value of bootdelay, used by autoboot_command() */
 static int stored_bootdelay;
+static int menukey;
+
+#if !defined(CONFIG_AUTOBOOT_STOP_STR_CRYPT)
+#define CONFIG_AUTOBOOT_STOP_STR_CRYPT ""
+#endif
+#if !defined(CONFIG_AUTOBOOT_STOP_STR_SHA256)
+#define CONFIG_AUTOBOOT_STOP_STR_SHA256 ""
+#endif
+
+#ifdef CONFIG_AUTOBOOT_USE_MENUKEY
+#define AUTOBOOT_MENUKEY CONFIG_AUTOBOOT_MENUKEY
+#else
+#define AUTOBOOT_MENUKEY 0
+#endif
+
+/**
+ * passwd_abort_crypt() - check for a crypt-style hashed key sequence to abort booting
+ *
+ * This checks for the user entering a password within a given time.
+ *
+ * The entered password is hashed via one of the crypt-style hash methods
+ * and compared to the pre-defined value from either
+ *   the environment variable "bootstopkeycrypt"
+ * or
+ *   the config value CONFIG_AUTOBOOT_STOP_STR_CRYPT
+ *
+ * In case the config value CONFIG_AUTOBOOT_NEVER_TIMEOUT has been enabled
+ * this function never times out if the user presses the <Enter> key
+ * before starting to enter the password.
+ *
+ * @etime: Timeout value ticks (stop when get_ticks() reachs this)
+ * Return: 0 if autoboot should continue, 1 if it should stop
+ */
+static int passwd_abort_crypt(uint64_t etime)
+{
+       const char *crypt_env_str = env_get("bootstopkeycrypt");
+       char presskey[DELAY_STOP_STR_MAX_LENGTH];
+       u_int presskey_len = 0;
+       int abort = 0;
+       int never_timeout = 0;
+       int err;
 
-#if defined(CONFIG_AUTOBOOT_KEYED)
-#if defined(CONFIG_AUTOBOOT_STOP_STR_SHA256)
+       if (IS_ENABLED(CONFIG_AUTOBOOT_STOP_STR_ENABLE) && !crypt_env_str)
+               crypt_env_str = CONFIG_AUTOBOOT_STOP_STR_CRYPT;
+
+       if (!crypt_env_str)
+               return 0;
+
+       /* We expect the stop-string to be newline-terminated */
+       do {
+               if (tstc()) {
+                       /* Check for input string overflow */
+                       if (presskey_len >= sizeof(presskey))
+                               return 0;
+
+                       presskey[presskey_len] = getchar();
+
+                       if ((presskey[presskey_len] == '\r') ||
+                           (presskey[presskey_len] == '\n')) {
+                               if (IS_ENABLED(CONFIG_AUTOBOOT_NEVER_TIMEOUT) &&
+                                   !presskey_len) {
+                                       never_timeout = 1;
+                                       continue;
+                               }
+                               presskey[presskey_len] = '\0';
+                               err = crypt_compare(crypt_env_str, presskey,
+                                                   &abort);
+                               if (err)
+                                       debug_bootkeys(
+                                               "crypt_compare() failed with: %s\n",
+                                               errno_str(err));
+                               /* you had one chance */
+                               break;
+                       } else {
+                               presskey_len++;
+                       }
+               }
+       } while (never_timeout || get_ticks() <= etime);
+
+       return abort;
+}
 
 /*
  * Use a "constant-length" time compare function for this
@@ -48,12 +137,21 @@ static int slow_equals(u8 *a, u8 *b, int len)
        return diff == 0;
 }
 
-static int passwd_abort(uint64_t etime)
+/**
+ * passwd_abort_sha256() - check for a hashed key sequence to abort booting
+ *
+ * This checks for the user entering a SHA256 hash within a given time.
+ *
+ * @etime: Timeout value ticks (stop when get_ticks() reachs this)
+ * Return: 0 if autoboot should continue, 1 if it should stop
+ */
+static int passwd_abort_sha256(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];
+       u8 *sha;
+       char *presskey;
+       char *c;
        const char *algo_name = "sha256";
        u_int presskey_len = 0;
        int abort = 0;
@@ -63,6 +161,14 @@ static int passwd_abort(uint64_t etime)
        if (sha_env_str == NULL)
                sha_env_str = CONFIG_AUTOBOOT_STOP_STR_SHA256;
 
+       presskey = malloc_cache_aligned(DELAY_STOP_STR_MAX_LENGTH);
+       c = strstr(sha_env_str, ":");
+       if (c && (c - sha_env_str < DELAY_STOP_STR_MAX_LENGTH)) {
+               /* preload presskey with salt */
+               memcpy(presskey, sha_env_str, c - sha_env_str);
+               presskey_len = c - sha_env_str;
+               sha_env_str = c + 1;
+       }
        /*
         * Generate the binary value from the environment hash value
         * so that we can compare this value with the computed hash
@@ -74,6 +180,8 @@ static int passwd_abort(uint64_t etime)
                return 0;
        }
 
+       sha = malloc_cache_aligned(SHA256_SUM_LEN);
+       size = SHA256_SUM_LEN;
        /*
         * We don't know how long the stop-string is, so we need to
         * generate the sha256 hash upon each input character and
@@ -82,10 +190,13 @@ static int passwd_abort(uint64_t etime)
        do {
                if (tstc()) {
                        /* Check for input string overflow */
-                       if (presskey_len >= MAX_DELAY_STOP_STR)
+                       if (presskey_len >= DELAY_STOP_STR_MAX_LENGTH) {
+                               free(presskey);
+                               free(sha);
                                return 0;
+                       }
 
-                       presskey[presskey_len++] = getc();
+                       presskey[presskey_len++] = getchar();
 
                        /* Calculate sha256 upon each new char */
                        hash_block(algo_name, (const void *)presskey,
@@ -97,10 +208,20 @@ static int passwd_abort(uint64_t etime)
                }
        } while (!abort && get_ticks() <= etime);
 
+       free(presskey);
+       free(sha);
        return abort;
 }
-#else
-static int passwd_abort(uint64_t etime)
+
+/**
+ * passwd_abort_key() - check for a key sequence to aborted booting
+ *
+ * This checks for the user entering a string within a given time.
+ *
+ * @etime: Timeout value ticks (stop when get_ticks() reachs this)
+ * Return: 0 if autoboot should continue, 1 if it should stop
+ */
+static int passwd_abort_key(uint64_t etime)
 {
        int abort = 0;
        struct {
@@ -113,10 +234,10 @@ static int passwd_abort(uint64_t etime)
                { .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;
+       char presskey[DELAY_STOP_STR_MAX_LENGTH];
+       int presskey_len = 0;
+       int presskey_max = 0;
+       int i;
 
 #  ifdef CONFIG_AUTOBOOT_DELAY_STR
        if (delaykey[0].str == NULL)
@@ -130,8 +251,8 @@ static int passwd_abort(uint64_t etime)
        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;
+               delaykey[i].len = delaykey[i].len > DELAY_STOP_STR_MAX_LENGTH ?
+                                   DELAY_STOP_STR_MAX_LENGTH : delaykey[i].len;
 
                presskey_max = presskey_max > delaykey[i].len ?
                                    presskey_max : delaykey[i].len;
@@ -147,12 +268,12 @@ static int passwd_abort(uint64_t etime)
        do {
                if (tstc()) {
                        if (presskey_len < presskey_max) {
-                               presskey[presskey_len++] = getc();
+                               presskey[presskey_len++] = getchar();
                        } else {
                                for (i = 0; i < presskey_max - 1; i++)
                                        presskey[i] = presskey[i + 1];
 
-                               presskey[i] = getc();
+                               presskey[i] = getchar();
                        }
                }
 
@@ -176,17 +297,47 @@ static int passwd_abort(uint64_t etime)
 
        return abort;
 }
-#endif
+
+/**
+ * flush_stdin() - drops all pending characters from stdin
+ */
+static void flush_stdin(void)
+{
+       while (tstc())
+               (void)getchar();
+}
+
+/**
+ * fallback_to_sha256() - check whether we should fall back to sha256
+ *                        password checking
+ *
+ * This checks for the environment variable `bootstopusesha256` in case
+ * sha256-fallback has been enabled via the config setting
+ * `AUTOBOOT_SHA256_FALLBACK`.
+ *
+ * Return: `false` if we must not fall-back, `true` if plain sha256 should be tried
+ */
+static bool fallback_to_sha256(void)
+{
+       if (IS_ENABLED(CONFIG_AUTOBOOT_SHA256_FALLBACK))
+               return env_get_yesno("bootstopusesha256") == 1;
+       else if (IS_ENABLED(CONFIG_CRYPT_PW))
+               return false;
+       else
+               return true;
+}
 
 /***************************************************************************
  * 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)
+static int abortboot_key_sequence(int bootdelay)
 {
        int abort;
        uint64_t etime = endtick(bootdelay);
 
+       if (IS_ENABLED(CONFIG_AUTOBOOT_FLUSH_STDIN))
+               flush_stdin();
 #  ifdef CONFIG_AUTOBOOT_PROMPT
        /*
         * CONFIG_AUTOBOOT_PROMPT includes the %d for all boards.
@@ -195,35 +346,32 @@ static int __abortboot(int bootdelay)
        printf(CONFIG_AUTOBOOT_PROMPT, bootdelay);
 #  endif
 
-       abort = passwd_abort(etime);
+       if (IS_ENABLED(CONFIG_AUTOBOOT_ENCRYPTION)) {
+               if (IS_ENABLED(CONFIG_CRYPT_PW) && !fallback_to_sha256())
+                       abort = passwd_abort_crypt(etime);
+               else
+                       abort = passwd_abort_sha256(etime);
+       } else {
+               abort = passwd_abort_key(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)
+static int abortboot_single_key(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        */
+               getchar();      /* consume input        */
                puts("\b\b\b 0");
                abort = 1;      /* don't auto boot      */
        }
@@ -234,13 +382,13 @@ static int __abortboot(int bootdelay)
                ts = get_timer(0);
                do {
                        if (tstc()) {   /* we got a key press   */
+                               int key;
+
                                abort  = 1;     /* don't auto boot      */
                                bootdelay = 0;  /* no more delay        */
-# ifdef CONFIG_MENUKEY
-                               menukey = getc();
-# else
-                               (void) getc();  /* consume input        */
-# endif
+                               key = getchar();/* consume input        */
+                               if (IS_ENABLED(CONFIG_AUTOBOOT_USE_MENUKEY))
+                                       menukey = key;
                                break;
                        }
                        udelay(10000);
@@ -253,38 +401,39 @@ static int __abortboot(int bootdelay)
 
        return abort;
 }
-# endif        /* CONFIG_AUTOBOOT_KEYED */
 
 static int abortboot(int bootdelay)
 {
        int abort = 0;
 
-       if (bootdelay >= 0)
-               abort = __abortboot(bootdelay);
+       if (bootdelay >= 0) {
+               if (autoboot_keyed())
+                       abort = abortboot_key_sequence(bootdelay);
+               else
+                       abort = abortboot_single_key(bootdelay);
+       }
 
-#ifdef CONFIG_SILENT_CONSOLE
-       if (abort)
+       if (IS_ENABLED(CONFIG_SILENT_CONSOLE) && 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)
+#ifdef 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);
+       addr = ofnode_conf_read_int("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);
+       addr = ofnode_conf_read_int("rootdisk-offset", 0);
        if (addr)
                env_set_addr("rootaddr", (void *)(CONFIG_SYS_TEXT_BASE + addr));
-#endif /* CONFIG_OF_CONTROL && CONFIG_SYS_TEXT_BASE */
+#endif /* CONFIG_SYS_TEXT_BASE */
 }
 
 const char *bootdelay_process(void)
@@ -297,16 +446,13 @@ const char *bootdelay_process(void)
        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
+       if (IS_ENABLED(CONFIG_OF_CONTROL))
+               bootdelay = ofnode_conf_read_int("bootdelay", bootdelay);
 
        debug("### main_loop entered: bootdelay=%d\n\n", bootdelay);
 
-#if defined(CONFIG_MENU_SHOW)
-       bootdelay = menu_show(bootdelay);
-#endif
+       if (IS_ENABLED(CONFIG_AUTOBOOT_MENU_SHOW))
+               bootdelay = menu_show(bootdelay);
        bootretry_init_cmd_timeout();
 
 #ifdef CONFIG_POST
@@ -319,7 +465,8 @@ const char *bootdelay_process(void)
        else
                s = env_get("bootcmd");
 
-       process_fdt_options(gd->fdt_blob);
+       if (IS_ENABLED(CONFIG_OF_CONTROL))
+               process_fdt_options(gd->fdt_blob);
        stored_bootdelay = bootdelay;
 
        return s;
@@ -329,23 +476,26 @@ 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
+       if (s && (stored_bootdelay == -2 ||
+                (stored_bootdelay != -1 && !abortboot(stored_bootdelay)))) {
+               bool lock;
+               int prev;
+
+               lock = autoboot_keyed() &&
+                       !IS_ENABLED(CONFIG_AUTOBOOT_KEYED_CTRLC);
+               if (lock)
+                       prev = disable_ctrlc(1); /* disable Ctrl-C checking */
 
                run_command_list(s, -1, 0);
 
-#if defined(CONFIG_AUTOBOOT_KEYED) && !defined(CONFIG_AUTOBOOT_KEYED_CTRLC)
-               disable_ctrlc(prev);    /* restore Control C checking */
-#endif
+               if (lock)
+                       disable_ctrlc(prev);    /* restore Ctrl-C checking */
        }
 
-#ifdef CONFIG_MENUKEY
-       if (menukey == CONFIG_MENUKEY) {
+       if (IS_ENABLED(CONFIG_AUTOBOOT_USE_MENUKEY) &&
+           menukey == AUTOBOOT_MENUKEY) {
                s = env_get("menucmd");
                if (s)
                        run_command_list(s, -1, 0);
        }
-#endif /* CONFIG_MENUKEY */
 }