common/cli.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2000
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  *
   6  * Add to readline cmdline-editing by
   7  * (C) Copyright 2005
   8  * JinHua Luo, GuangDong Linux Center, <luo.jinhua@gd-linux.com>
   9  */
  10
  11 #include <common.h>
  12 #include <cli.h>
  13 #include <cli_hush.h>
  14 #include <command.h>
  15 #include <console.h>
  16 #include <env.h>
  17 #include <fdtdec.h>
  18 #include <malloc.h>
  19
  20 DECLARE_GLOBAL_DATA_PTR;
  21
  22 #ifdef CONFIG_CMDLINE
  23 /*
  24  * Run a command using the selected parser.
  25  *
  26  * @param cmd   Command to run
  27  * @param flag  Execution flags (CMD_FLAG_...)
  28  * @return 0 on success, or != 0 on error.
  29  */
  30 int run_command(const char *cmd, int flag)
  31 {
  32 #if !CONFIG_IS_ENABLED(HUSH_PARSER)
  33         /*
  34          * cli_run_command can return 0 or 1 for success, so clean up
  35          * its result.
  36          */
  37         if (cli_simple_run_command(cmd, flag) == -1)
  38                 return 1;
  39
  40         return 0;
  41 #else
  42         int hush_flags = FLAG_PARSE_SEMICOLON | FLAG_EXIT_FROM_LOOP;
  43
  44         if (flag & CMD_FLAG_ENV)
  45                 hush_flags |= FLAG_CONT_ON_NEWLINE;
  46         return parse_string_outer(cmd, hush_flags);
  47 #endif
  48 }
  49
  50 /*
  51  * Run a command using the selected parser, and check if it is repeatable.
  52  *
  53  * @param cmd   Command to run
  54  * @param flag  Execution flags (CMD_FLAG_...)
  55  * @return 0 (not repeatable) or 1 (repeatable) on success, -1 on error.
  56  */
  57 int run_command_repeatable(const char *cmd, int flag)
  58 {
  59 #ifndef CONFIG_HUSH_PARSER
  60         return cli_simple_run_command(cmd, flag);
  61 #else
  62         /*
  63          * parse_string_outer() returns 1 for failure, so clean up
  64          * its result.
  65          */
  66         if (parse_string_outer(cmd,
  67                                FLAG_PARSE_SEMICOLON | FLAG_EXIT_FROM_LOOP))
  68                 return -1;
  69
  70         return 0;
  71 #endif
  72 }
  73 #endif /* CONFIG_CMDLINE */
  74
  75 int run_command_list(const char *cmd, int len, int flag)
  76 {
  77         int need_buff = 1;
  78         char *buff = (char *)cmd;       /* cast away const */
  79         int rcode = 0;
  80
  81         if (len == -1) {
  82                 len = strlen(cmd);
  83 #ifdef CONFIG_HUSH_PARSER
  84                 /* hush will never change our string */
  85                 need_buff = 0;
  86 #else
  87                 /* the built-in parser will change our string if it sees \n */
  88                 need_buff = strchr(cmd, '\n') != NULL;
  89 #endif
  90         }
  91         if (need_buff) {
  92                 buff = malloc(len + 1);
  93                 if (!buff)
  94                         return 1;
  95                 memcpy(buff, cmd, len);
  96                 buff[len] = '\0';
  97         }
  98 #ifdef CONFIG_HUSH_PARSER
  99         rcode = parse_string_outer(buff, FLAG_PARSE_SEMICOLON);
 100 #else
 101         /*
 102          * This function will overwrite any \n it sees with a \0, which
 103          * is why it can't work with a const char *. Here we are making
 104          * using of internal knowledge of this function, to avoid always
 105          * doing a malloc() which is actually required only in a case that
 106          * is pretty rare.
 107          */
 108 #ifdef CONFIG_CMDLINE
 109         rcode = cli_simple_run_command_list(buff, flag);
 110 #else
 111         rcode = board_run_command(buff);
 112 #endif
 113 #endif
 114         if (need_buff)
 115                 free(buff);
 116
 117         return rcode;
 118 }
 119
 120 /****************************************************************************/
 121
 122 #if defined(CONFIG_CMD_RUN)
 123 int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 124 {
 125         int i;
 126
 127         if (argc < 2)
 128                 return CMD_RET_USAGE;
 129
 130         for (i = 1; i < argc; ++i) {
 131                 char *arg;
 132
 133                 arg = env_get(argv[i]);
 134                 if (arg == NULL) {
 135                         printf("## Error: \"%s\" not defined\n", argv[i]);
 136                         return 1;
 137                 }
 138
 139                 if (run_command(arg, flag | CMD_FLAG_ENV) != 0)
 140                         return 1;
 141         }
 142         return 0;
 143 }
 144 #endif
 145
 146 #if CONFIG_IS_ENABLED(OF_CONTROL)
 147 bool cli_process_fdt(const char **cmdp)
 148 {
 149         /* Allow the fdt to override the boot command */
 150         char *env = fdtdec_get_config_string(gd->fdt_blob, "bootcmd");
 151         if (env)
 152                 *cmdp = env;
 153         /*
 154          * If the bootsecure option was chosen, use secure_boot_cmd().
 155          * Always use 'env' in this case, since bootsecure requres that the
 156          * bootcmd was specified in the FDT too.
 157          */
 158         return fdtdec_get_config_int(gd->fdt_blob, "bootsecure", 0) != 0;
 159 }
 160
 161 /*
 162  * Runs the given boot command securely.  Specifically:
 163  * - Doesn't run the command with the shell (run_command or parse_string_outer),
 164  *   since that's a lot of code surface that an attacker might exploit.
 165  *   Because of this, we don't do any argument parsing--the secure boot command
 166  *   has to be a full-fledged u-boot command.
 167  * - Doesn't check for keypresses before booting, since that could be a
 168  *   security hole; also disables Ctrl-C.
 169  * - Doesn't allow the command to return.
 170  *
 171  * Upon any failures, this function will drop into an infinite loop after
 172  * printing the error message to console.
 173  */
 174 void cli_secure_boot_cmd(const char *cmd)
 175 {
 176 #ifdef CONFIG_CMDLINE
 177         cmd_tbl_t *cmdtp;
 178 #endif
 179         int rc;
 180
 181         if (!cmd) {
 182                 printf("## Error: Secure boot command not specified\n");
 183                 goto err;
 184         }
 185
 186         /* Disable Ctrl-C just in case some command is used that checks it. */
 187         disable_ctrlc(1);
 188
 189         /* Find the command directly. */
 190 #ifdef CONFIG_CMDLINE
 191         cmdtp = find_cmd(cmd);
 192         if (!cmdtp) {
 193                 printf("## Error: \"%s\" not defined\n", cmd);
 194                 goto err;
 195         }
 196
 197         /* Run the command, forcing no flags and faking argc and argv. */
 198         rc = (cmdtp->cmd)(cmdtp, 0, 1, (char **)&cmd);
 199
 200 #else
 201         rc = board_run_command(cmd);
 202 #endif
 203
 204         /* Shouldn't ever return from boot command. */
 205         printf("## Error: \"%s\" returned (code %d)\n", cmd, rc);
 206
 207 err:
 208         /*
 209          * Not a whole lot to do here.  Rebooting won't help much, since we'll
 210          * just end up right back here.  Just loop.
 211          */
 212         hang();
 213 }
 214 #endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
 215
 216 void cli_loop(void)
 217 {
 218         bootstage_mark(BOOTSTAGE_ID_ENTER_CLI_LOOP);
 219 #ifdef CONFIG_HUSH_PARSER
 220         parse_file_outer();
 221         /* This point is never reached */
 222         for (;;);
 223 #elif defined(CONFIG_CMDLINE)
 224         cli_simple_loop();
 225 #else
 226         printf("## U-Boot command line is disabled. Please enable CONFIG_CMDLINE\n");
 227 #endif /*CONFIG_HUSH_PARSER*/
 228 }
 229
 230 void cli_init(void)
 231 {
 232 #ifdef CONFIG_HUSH_PARSER
 233         u_boot_hush_start();
 234 #endif
 235
 236 #if defined(CONFIG_HUSH_INIT_VAR)
 237         hush_init_var();
 238 #endif
 239 }