git.zerfleddert.de Git - proxmark3-svn/blob - client/scripting.c

   1 //-----------------------------------------------------------------------------
   2 // Copyright (C) 2013 m h swende <martin at swende.se>
   3 //
   4 // This code is licensed to you under the terms of the GNU GPL, version 2 or,
   5 // at your option, any later version. See the LICENSE.txt file for the text of
   6 // the license.
   7 //-----------------------------------------------------------------------------
   8 // Some lua scripting glue to proxmark core.
   9 //-----------------------------------------------------------------------------
  10
  11 #include <lua.h>
  12 #include <lualib.h>
  13 #include <lauxlib.h>
  14 #include "proxmark3.h"
  15 #include "usb_cmd.h"
  16 #include "cmdmain.h"
  17 #include "scripting.h"
  18 #include "util.h"
  19 /**
  20  * The following params expected:
  21  *  UsbCommand c
  22  *@brief l_SendCommand
  23  * @param L
  24  * @return
  25  */
  26 static int l_SendCommand(lua_State *L){
  27
  28     /*
  29      *
  30      The SendCommand (native) expects the following structure:
  31
  32      typedef struct {
  33       uint64_t cmd; //8 bytes
  34       uint64_t arg[3]; // 8*3 bytes = 24 bytes
  35       union {
  36         uint8_t  asBytes[USB_CMD_DATA_SIZE]; // 1 byte * 512 = 512 bytes (OR)
  37         uint32_t asDwords[USB_CMD_DATA_SIZE/4]; // 4 byte * 128 = 512 bytes
  38       } d;
  39     } PACKED UsbCommand;
  40
  41     ==> A 544 byte buffer will do.
  42     **/
  43     //Pop cmd
  44     size_t size;
  45     const char *data = luaL_checklstring(L, 1, &size);
  46     if(size != sizeof(UsbCommand))
  47     {
  48         printf("Got data size %d, expected %d" , (int) size,(int) sizeof(UsbCommand));
  49         lua_pushstring(L,"Wrong data size");
  50         return 1;
  51     }
  52
  53 //    UsbCommand c = (*data);
  54     SendCommand((UsbCommand* )data);
  55     return 0; // no return values
  56 }
  57 /**
  58  * @brief The following params expected:
  59  * uint32_t cmd
  60  * size_t ms_timeout
  61  * @param L
  62  * @return
  63  */
  64 static int l_WaitForResponseTimeout(lua_State *L){
  65
  66     uint32_t cmd = 0;
  67     size_t ms_timeout = -1;
  68
  69     //Check number of arguments
  70     int n = lua_gettop(L);
  71     if(n == 0)
  72     {
  73         //signal error by returning Nil, errorstring
  74         lua_pushnil(L);
  75         lua_pushstring(L,"You need to supply at least command to wait for");
  76         return 2; // two return values
  77     }
  78     if(n >= 1)
  79     {
  80         //pop cmd
  81         cmd = luaL_checkunsigned(L,1);
  82     }
  83     if(n >= 2)
  84     {
  85         //Did the user send a timeout ?
  86         //Check if the current top of stack is an integer
  87         ms_timeout = luaL_checkunsigned(L,2);
  88         //printf("Timeout set to %dms\n" , (int) ms_timeout);
  89     }
  90
  91     UsbCommand response;
  92
  93     if(WaitForResponseTimeout(cmd, &response, ms_timeout))
  94     {
  95         //Push it as a string
  96          lua_pushlstring(L,(const char *)&response,sizeof(UsbCommand));
  97
  98         return 1;// return 1 to signal one return value
  99     }else{
 100         //Push a Nil instead
 101         lua_pushnil(L);
 102         return 1;// one return value
 103     }
 104 }
 105 //static int l_nonce2key(lua_State *L){ return CmdHF14AMfRdSc(luaL_checkstring(L, 1));}
 106 //static int l_PrintAndLog(lua_State *L){ return CmdHF14AMfDump(luaL_checkstring(L, 1));}
 107 static int l_clearCommandBuffer(lua_State *L){
 108     clearCommandBuffer();
 109     return 0;
 110 }
 111 /**
 112  * @brief l_foobar is a dummy function to test lua-integration with
 113  * @param L
 114  * @return
 115  */
 116 static int l_foobar(lua_State *L)
 117 {
 118     //Check number of arguments
 119     int n = lua_gettop(L);
 120     printf("foobar called with %d arguments" , n);
 121     lua_settop(L, 0);
 122     printf("Arguments discarded, stack now contains %d elements", lua_gettop(L));
 123     UsbCommand response =  {CMD_MIFARE_READBL, {1337, 1338, 1339}};
 124     printf("Now returning a UsbCommand as a string");
 125     lua_pushlstring(L,(const char *)&response,sizeof(UsbCommand));
 126     return 1;
 127 }
 128
 129 /**
 130  * @brief Utility to check if a key has been pressed by the user. This method does not block.
 131  * @param L
 132  * @return boolean, true if kbhit, false otherwise.
 133  */
 134 static int l_ukbhit(lua_State *L)
 135 {
 136     lua_pushboolean(L,ukbhit() ? true : false);
 137     return 1;
 138 }
 139 /**
 140  * @brief Calls the command line parser to deal with the command. This enables
 141  * lua-scripts to do stuff like "core.console('hf mf mifare')"
 142  * @param L
 143  * @return
 144  */
 145 static int l_CmdConsole(lua_State *L)
 146 {
 147     CommandReceived((char *)luaL_checkstring(L, 1));
 148     return 0;
 149 }
 150
 151
 152 /**
 153  * @brief Sets the lua path to include "./lualibs/?.lua", in order for a script to be
 154  * able to do "require('foobar')" if foobar.lua is within lualibs folder.
 155  * Taken from http://stackoverflow.com/questions/4125971/setting-the-global-lua-path-variable-from-c-c
 156  * @param L
 157  * @param path
 158  * @return
 159  */
 160 int setLuaPath( lua_State* L, const char* path )
 161 {
 162     lua_getglobal( L, "package" );
 163     lua_getfield( L, -1, "path" ); // get field "path" from table at top of stack (-1)
 164     const char* cur_path = lua_tostring( L, -1 ); // grab path string from top of stack
 165     int requiredLength = strlen(cur_path)+ strlen(path)+10; //A few bytes too many, whatever we can afford it
 166     char * buf = malloc(requiredLength);
 167     snprintf(buf, requiredLength, "%s;%s", cur_path, path);
 168     lua_pop( L, 1 ); // get rid of the string on the stack we just pushed on line 5
 169     lua_pushstring( L, buf ); // push the new one
 170     lua_setfield( L, -2, "path" ); // set the field "path" in table at -2 with value at top of stack
 171     lua_pop( L, 1 ); // get rid of package table from top of stack
 172     return 0; // all done!
 173 }
 174
 175
 176 int set_pm3_libraries(lua_State *L)
 177 {
 178
 179     static const luaL_Reg libs[] = {
 180         {"SendCommand",                 l_SendCommand},
 181         {"WaitForResponseTimeout",      l_WaitForResponseTimeout},
 182         //{"nonce2key",                   l_nonce2key},
 183         //{"PrintAndLog",                 l_PrintAndLog},
 184         {"foobar",                      l_foobar},
 185         {"ukbhit",                      l_ukbhit},
 186         {"clearCommandBuffer",          l_clearCommandBuffer},
 187         {"console",                      l_CmdConsole},
 188         {NULL, NULL}
 189     };
 190
 191     lua_pushglobaltable(L);
 192     // Core library is in this table. Contains '
 193     //this is 'pm3' table
 194     lua_newtable(L);
 195
 196     //Put the function into the hash table.
 197     for (int i = 0; libs[i].name; i++) {
 198         lua_pushcfunction(L, libs[i].func);
 199         lua_setfield(L, -2, libs[i].name);//set the name, pop stack
 200     }
 201     //Name of 'core'
 202     lua_setfield(L, -2, "core");
 203
 204     //-- remove the global environment table from the stack
 205     lua_pop(L, 1);
 206
 207     //-- Last but not least, add to the LUA_PATH (package.path in lua)
 208     // so we can load libraries from the ./lualib/ - directory
 209     setLuaPath(L,"./lualibs/?.lua");
 210
 211     return 1;
 212 }