proxmark3/client/cmdscript.c

257 lines
8 KiB
C
Raw Normal View History

//-----------------------------------------------------------------------------
// Copyright (C) 2013 m h swende <martin at swende.se>
//
// This code is licensed to you under the terms of the GNU GPL, version 2 or,
// at your option, any later version. See the LICENSE.txt file for the text of
// the license.
//-----------------------------------------------------------------------------
// Some lua scripting glue to proxmark core.
//-----------------------------------------------------------------------------
// this define is needed for scandir/alphasort to work
#define _GNU_SOURCE
#include <dirent.h>
#include <stdlib.h>
#include <string.h>
#include "cmdparser.h" // command_t
#include "scripting.h"
#include "comms.h"
#include "cmdscript.h"
#include "cmdhfmf.h"
#include "pm3_binlib.h"
#include "pm3_bitlib.h"
#include "lualib.h"
#include "lauxlib.h"
#include "proxmark3.h"
#include "ui.h"
#ifdef _WIN32
#include "scandir.h"
#endif
static int CmdHelp(const char *Cmd);
2019-04-11 06:10:21 +08:00
static int str_ends_with(const char *str, const char *suffix) {
2019-03-10 07:00:59 +08:00
if (str == NULL || suffix == NULL)
return 0;
2019-03-10 07:00:59 +08:00
size_t str_len = strlen(str);
size_t suffix_len = strlen(suffix);
2019-03-10 07:00:59 +08:00
if (suffix_len > str_len)
return 0;
2019-03-10 07:00:59 +08:00
return 0 == strncmp(str + str_len - suffix_len, suffix, suffix_len);
}
/**
* Utility to check the ending of a string (used to check file suffix)
*/
2019-04-11 06:10:21 +08:00
static bool endsWith(const char *base, const char *str) {
int blen = strlen(base);
int slen = strlen(str);
return (blen >= slen) && (0 == strcmp(base + blen - slen, str));
}
2019-08-23 01:53:23 +08:00
static int scriptlist(const char *path, bool last) {
2019-03-10 06:35:06 +08:00
struct dirent **namelist;
int n;
n = scandir(path, &namelist, NULL, alphasort);
2019-03-10 06:35:06 +08:00
if (n == -1) {
2019-08-23 01:53:23 +08:00
PrintAndLogEx(NORMAL, "%s── %s => NOT FOUND", last ? "" : "", path);
return PM3_EFILE;
2019-03-10 06:35:06 +08:00
}
2019-08-23 01:53:23 +08:00
PrintAndLogEx(NORMAL, "%s── %s", last ? "" : "", path);
2019-03-10 06:35:06 +08:00
for (uint16_t i = 0; i < n; i++) {
2019-08-23 01:53:23 +08:00
if (str_ends_with(namelist[i]->d_name, ".lua")) {
PrintAndLogEx(NORMAL, "%s   %s── %-21s", last ? " ":"", i == n-1 ? "" : "", namelist[i]->d_name);
}
2019-03-10 06:35:06 +08:00
free(namelist[i]);
}
free(namelist);
return PM3_SUCCESS;
}
/**
* Generate a sorted list of available commands, what it does is
* generate a file listing of the script-directory for files
* ending with .lua
*/
static int CmdScriptList(const char *Cmd) {
(void)Cmd; // Cmd is not used so far
if (get_my_executable_directory() != NULL) {
char script_directory_path[strlen(get_my_executable_directory()) + strlen(LUA_SCRIPTS_DIRECTORY) + 1];
strcpy(script_directory_path, get_my_executable_directory());
strcat(script_directory_path, LUA_SCRIPTS_DIRECTORY);
2019-08-23 01:53:23 +08:00
scriptlist(script_directory_path, false);
}
char *userpath = getenv("HOME");
if (userpath != NULL) {
char script_directory_path[strlen(userpath) + strlen(PM3_USER_DIRECTORY) + strlen(LUA_SCRIPTS_DIRECTORY) + 1];
strcpy(script_directory_path, userpath);
strcat(script_directory_path, PM3_USER_DIRECTORY);
strcat(script_directory_path, LUA_SCRIPTS_DIRECTORY);
2019-08-23 01:53:23 +08:00
scriptlist(script_directory_path, false);
}
{
char script_directory_path[strlen(PM3_SYSTEM_DIRECTORY) + strlen(LUA_SCRIPTS_DIRECTORY) + 1];
strcpy(script_directory_path, PM3_SYSTEM_DIRECTORY);
strcat(script_directory_path, LUA_SCRIPTS_DIRECTORY);
2019-08-23 01:53:23 +08:00
scriptlist(script_directory_path, true);
}
2019-03-10 06:35:06 +08:00
return 0;
}
2017-02-08 05:26:42 +08:00
/**
* @brief CmdScriptRun - executes a script file.
* @param argc
* @param argv
* @return
*/
static int CmdScriptRun(const char *Cmd) {
// create new Lua state
lua_State *lua_state;
lua_state = luaL_newstate();
// load Lua libraries
luaL_openlibs(lua_state);
//Sets the pm3 core libraries, that go a bit 'under the hood'
set_pm3_libraries(lua_state);
//Add the 'bin' library
set_bin_library(lua_state);
2019-03-10 06:35:06 +08:00
//Add the 'bit' library
set_bit_library(lua_state);
char script_name[128] = {0};
char arguments[256] = {0};
int name_len = 0;
int arg_len = 0;
2018-01-27 03:17:56 +08:00
sscanf(Cmd, "%127s%n %255[^\n\r]%n", script_name, &name_len, arguments, &arg_len);
const char *suffix = "";
2018-01-27 03:17:56 +08:00
if (!endsWith(script_name, ".lua")) {
suffix = ".lua";
2019-03-10 06:35:06 +08:00
}
bool found = false;
int error;
2019-08-22 23:44:08 +08:00
const char* exec_path = get_my_executable_directory();
if (exec_path != NULL) {
char script_path[strlen(exec_path) + strlen(LUA_SCRIPTS_DIRECTORY) + strlen(script_name) + strlen(suffix) + 1];
strcpy(script_path, exec_path);
strcat(script_path, LUA_SCRIPTS_DIRECTORY);
strcat(script_path, script_name);
strcat(script_path, suffix);
FILE *file;
if ((file = fopen(script_path, "r")))
{
fclose(file);
PrintAndLogEx(SUCCESS, "Executing: %s, args '%s'\n", script_path, arguments);
found = true;
error = luaL_loadfile(lua_state, script_path);
}
}
char *userpath = getenv("HOME");
if ((!found) && (userpath != NULL)) {
char script_path[strlen(userpath) + strlen(PM3_USER_DIRECTORY) + strlen(LUA_SCRIPTS_DIRECTORY) + strlen(script_name) + strlen(suffix) + 1];
strcpy(script_path, userpath);
strcat(script_path, PM3_USER_DIRECTORY);
strcat(script_path, LUA_SCRIPTS_DIRECTORY);
strcat(script_path, script_name);
strcat(script_path, suffix);
FILE *file;
if ((file = fopen(script_path, "r")))
{
fclose(file);
PrintAndLogEx(SUCCESS, "Executing: %s, args '%s'\n", script_path, arguments);
found = true;
error = luaL_loadfile(lua_state, script_path);
}
}
if (!found) {
char script_path[strlen(PM3_SYSTEM_DIRECTORY) + strlen(LUA_SCRIPTS_DIRECTORY) + strlen(script_name) + strlen(suffix) + 1];
strcpy(script_path, PM3_SYSTEM_DIRECTORY);
strcat(script_path, LUA_SCRIPTS_DIRECTORY);
strcat(script_path, script_name);
strcat(script_path, suffix);
FILE *file;
if ((file = fopen(script_path, "r")))
{
fclose(file);
PrintAndLogEx(SUCCESS, "Executing: %s, args '%s'\n", script_path, arguments);
found = true;
error = luaL_loadfile(lua_state, script_path);
}
}
if (!found) {
PrintAndLogEx(FAILED, "Error - can't find script %s%s", script_name, suffix);
return PM3_EFILE;
}
if (!error) {
lua_pushstring(lua_state, arguments);
lua_setglobal(lua_state, "args");
//Call it with 0 arguments
2019-03-10 07:00:59 +08:00
error = lua_pcall(lua_state, 0, LUA_MULTRET, 0); // once again, returns non-0 on error,
}
2019-03-10 07:00:59 +08:00
if (error) { // if non-0, then an error
// the top of the stack should be the error string
if (!lua_isstring(lua_state, lua_gettop(lua_state)))
PrintAndLogEx(FAILED, "Error - but no error (?!)");
// get the top of the stack as the error and pop it off
2019-03-10 07:00:59 +08:00
const char *str = lua_tostring(lua_state, lua_gettop(lua_state));
lua_pop(lua_state, 1);
puts(str);
}
//luaL_dofile(lua_state, buf);
// close the Lua state
lua_close(lua_state);
PrintAndLogEx(SUCCESS, "\nFinished\n");
return 0;
}
static command_t CommandTable[] = {
{"help", CmdHelp, AlwaysAvailable, "This help"},
{"list", CmdScriptList, AlwaysAvailable, "List available scripts"},
{"run", CmdScriptRun, AlwaysAvailable, "<name> -- Execute a script"},
{NULL, NULL, NULL, NULL}
};
/**
* Shows some basic help
* @brief CmdHelp
* @param Cmd
* @return
*/
static int CmdHelp(const char *Cmd) {
(void)Cmd; // Cmd is not used so far
2019-08-22 05:17:01 +08:00
PrintAndLogEx(NORMAL, "This is a feature to run Lua-scripts. You can place Lua-scripts within the luascripts/-folder. ");
2019-03-10 06:35:06 +08:00
return 0;
}
/**
* Finds a matching script-file
* @brief CmdScript
* @param Cmd
* @return
*/
int CmdScript(const char *Cmd) {
clearCommandBuffer();
2019-04-19 06:47:51 +08:00
return CmdsParse(CommandTable, Cmd);
2019-03-12 07:12:26 +08:00
}