michaelh/zephyr
1
0
Fork 0
Code Releases Activity

shell: sample: add login example

Browse source 
Using the new obscured user shell input feature,
provide examples of using it in login and logout commands.

Signed-off-by: Pete Skeggs <peter.skeggs@nordicsemi.no>
This commit is contained in:
Pete Skeggs 2021-03-04 13:38:14 -08:00 • committed by Anas Nashif
commit 1fcf7687dd
3 changed files with 80 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
samples/subsys/shell/shell_module/prj_login.conf Normal file
View file

@ -0,0 +1,17 @@
CONFIG_PRINTK=y
CONFIG_SHELL=y
CONFIG_LOG=y
CONFIG_INIT_STACKS=y
CONFIG_THREAD_STACK_INFO=y
CONFIG_KERNEL_SHELL=y
CONFIG_THREAD_MONITOR=y
CONFIG_BOOT_BANNER=n
CONFIG_THREAD_NAME=y
CONFIG_DEVICE_SHELL=y
CONFIG_POSIX_CLOCK=y
CONFIG_DATE_SHELL=y
CONFIG_THREAD_RUNTIME_STATS=y
CONFIG_SHELL_CMDS_SELECT=y
CONFIG_SHELL_START_OBSCURED=y
CONFIG_SHELL_PROMPT_UART="login: "

6
samples/subsys/shell/shell_module/sample.yaml
View file

@ -31,3 +31,9 @@ tests:
tags: shell
harness: keyboard
extra_args: CONF_FILE="prj_minimal_rtt.conf"
sample.shell.shell_module.login:
filter: ( CONFIG_SERIAL and CONFIG_UART_SHELL_ON_DEV_NAME )
tags: shell
harness: keyboard
min_ram: 40
extra_args: CONF_FILE="prj_login.conf"

57
samples/subsys/shell/shell_module/src/main.c
View file

@ -173,6 +173,53 @@ static int cmd_version(const struct shell *shell, size_t argc, char **argv)
return 0;
}
#define DEFAULT_PASSWORD "zephyr"
static void login_init(void)
{
printk("Shell Login Demo\nHint: password = %s\n", DEFAULT_PASSWORD);
shell_set_root_cmd("login");
}
static int check_passwd(char *passwd)
{
/* example only -- not recommended for production use */
return strcmp(passwd, DEFAULT_PASSWORD);
}
static int cmd_login(const struct shell *shell, size_t argc, char **argv)
{
static uint32_t attempts;
if (check_passwd(argv[1]) != 0) {
shell_error(shell, "Incorrect password!");
attempts++;
if (attempts > 3) {
k_sleep(K_SECONDS(attempts));
}
return -EINVAL;
}
/* clear history so password not visible there */
z_shell_history_purge(shell->history);
shell_obscure_set(shell, false);
shell_set_root_cmd(NULL);
shell_prompt_change(shell, "uart:~$ ");
shell_print(shell, "Shell Login Demo\n");
shell_print(shell, "Hit tab for help.\n");
attempts = 0;
return 0;
}
static int cmd_logout(const struct shell *shell, size_t argc, char **argv)
{
shell_set_root_cmd("login");
shell_obscure_set(shell, true);
shell_prompt_change(shell, "login: ");
shell_print(shell, "\n");
return 0;
}
static int cmd_dict(const struct shell *shell, size_t argc, char **argv,
void *data)
{
@ -202,8 +249,18 @@ SHELL_CMD_REGISTER(demo, &sub_demo, "Demo commands", NULL);
SHELL_CMD_ARG_REGISTER(version, NULL, "Show kernel version", cmd_version, 1, 0);
SHELL_COND_CMD_ARG_REGISTER(CONFIG_SHELL_START_OBSCURED, login, NULL,
"<password>", cmd_login, 2, 0);
SHELL_COND_CMD_REGISTER(CONFIG_SHELL_START_OBSCURED, logout, NULL,
"Log out.", cmd_logout);
void main(void)
{
if (IS_ENABLED(CONFIG_SHELL_START_OBSCURED)) {
login_init();
}
#if defined(CONFIG_USB_UART_CONSOLE)
const struct device *dev;
uint32_t dtr = 0;