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