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 #include "nonce2key/nonce2key.h"
  20
  21 /**
  22  * The following params expected:
  23  *  UsbCommand c
  24  *@brief l_SendCommand
  25  * @param L
  26  * @return
  27  */
  28 static int l_SendCommand(lua_State *L){
  29
  30     /*
  31      *
  32      The SendCommand (native) expects the following structure:
  33
  34      typedef struct {
  35       uint64_t cmd; //8 bytes
  36       uint64_t arg[3]; // 8*3 bytes = 24 bytes
  37       union {
  38         uint8_t  asBytes[USB_CMD_DATA_SIZE]; // 1 byte * 512 = 512 bytes (OR)
  39         uint32_t asDwords[USB_CMD_DATA_SIZE/4]; // 4 byte * 128 = 512 bytes
  40       } d;
  41     } PACKED UsbCommand;
  42
  43     ==> A 544 byte buffer will do.
  44     **/
  45     //Pop cmd
  46     size_t size;
  47     const char *data = luaL_checklstring(L, 1, &size);
  48     if(size != sizeof(UsbCommand))
  49     {
  50         printf("Got data size %d, expected %d" , (int) size,(int) sizeof(UsbCommand));
  51         lua_pushstring(L,"Wrong data size");
  52         return 1;
  53     }
  54
  55 //    UsbCommand c = (*data);
  56     SendCommand((UsbCommand* )data);
  57     return 0; // no return values
  58 }
  59 /**
  60  * @brief The following params expected:
  61  * uint32_t cmd
  62  * size_t ms_timeout
  63  * @param L
  64  * @return
  65  */
  66 static int l_WaitForResponseTimeout(lua_State *L){
  67
  68     uint32_t cmd = 0;
  69     size_t ms_timeout = -1;
  70
  71     //Check number of arguments
  72     int n = lua_gettop(L);
  73     if(n == 0)
  74     {
  75         //signal error by returning Nil, errorstring
  76         lua_pushnil(L);
  77         lua_pushstring(L,"You need to supply at least command to wait for");
  78         return 2; // two return values
  79     }
  80     if(n >= 1)
  81     {
  82         //pop cmd
  83         cmd = luaL_checkunsigned(L,1);
  84     }
  85     if(n >= 2)
  86     {
  87         //Did the user send a timeout ?
  88         //Check if the current top of stack is an integer
  89         ms_timeout = luaL_checkunsigned(L,2);
  90         //printf("Timeout set to %dms\n" , (int) ms_timeout);
  91     }
  92
  93     UsbCommand response;
  94
  95     if(WaitForResponseTimeout(cmd, &response, ms_timeout))
  96     {
  97         //Push it as a string
  98          lua_pushlstring(L,(const char *)&response,sizeof(UsbCommand));
  99
 100         return 1;// return 1 to signal one return value
 101     }else{
 102         //Push a Nil instead
 103         lua_pushnil(L);
 104         return 1;// one return value
 105     }
 106 }
 107
 108 static int returnToLuaWithError(lua_State *L, const char* fmt, ...)
 109 {
 110     char buffer[200];
 111     va_list args;
 112     va_start(args,fmt);
 113     vsnprintf(buffer, sizeof(buffer), fmt,args);
 114     va_end(args);
 115
 116     lua_pushnil(L);
 117     lua_pushstring(L,buffer);
 118     return 2;
 119 }
 120
 121 static int l_nonce2key(lua_State *L){
 122
 123     size_t size;
 124     const char *p_uid = luaL_checklstring(L, 1, &size);
 125     if(size != 4)  return returnToLuaWithError(L,"Wrong size of uid, got %d bytes, expected 4", (int) size);
 126
 127     const char *p_nt = luaL_checklstring(L, 2, &size);
 128     if(size != 4)  return returnToLuaWithError(L,"Wrong size of nt, got %d bytes, expected 4", (int) size);
 129
 130     const char *p_nr = luaL_checklstring(L, 3, &size);
 131     if(size != 4)  return returnToLuaWithError(L,"Wrong size of nr, got %d bytes, expected 4", (int) size);
 132
 133     const char *p_par_info = luaL_checklstring(L, 4, &size);
 134     if(size != 8)  return returnToLuaWithError(L,"Wrong size of par_info, got %d bytes, expected 8", (int) size);
 135
 136     const char *p_pks_info = luaL_checklstring(L, 5, &size);
 137     if(size != 8)  return returnToLuaWithError(L,"Wrong size of ks_info, got %d bytes, expected 8", (int) size);
 138
 139
 140     uint32_t uid = bytes_to_num(( uint8_t *)p_uid,4);
 141     uint32_t nt = bytes_to_num(( uint8_t *)p_nt,4);
 142
 143     uint32_t nr = bytes_to_num(( uint8_t*)p_nr,4);
 144     uint64_t par_info = bytes_to_num(( uint8_t *)p_par_info,8);
 145     uint64_t ks_info = bytes_to_num(( uint8_t *)p_pks_info,8);
 146
 147     uint64_t key = 0;
 148
 149     int retval = nonce2key(uid,nt, nr, par_info,ks_info, &key);
 150
 151     //Push the retval on the stack
 152     lua_pushinteger(L,retval);
 153
 154     //Push the key onto the stack
 155     uint8_t dest_key[8];
 156     num_to_bytes(key,sizeof(dest_key),dest_key);
 157
 158     //printf("Pushing to lua stack: %012"llx"\n",key);
 159     lua_pushlstring(L,(const char *) dest_key,sizeof(dest_key));
 160
 161     return 2; //Two return values
 162 }
 163 //static int l_PrintAndLog(lua_State *L){ return CmdHF14AMfDump(luaL_checkstring(L, 1));}
 164 static int l_clearCommandBuffer(lua_State *L){
 165     clearCommandBuffer();
 166     return 0;
 167 }
 168 /**
 169  * @brief l_foobar is a dummy function to test lua-integration with
 170  * @param L
 171  * @return
 172  */
 173 static int l_foobar(lua_State *L)
 174 {
 175     //Check number of arguments
 176     int n = lua_gettop(L);
 177     printf("foobar called with %d arguments" , n);
 178     lua_settop(L, 0);
 179     printf("Arguments discarded, stack now contains %d elements", lua_gettop(L));
 180
 181     // todo: this is not used, where was it intended for?
 182     // UsbCommand response =  {CMD_MIFARE_READBL, {1337, 1338, 1339}};
 183
 184     printf("Now returning a uint64_t as a string");
 185     uint64_t x = 0xDEADBEEF;
 186     uint8_t destination[8];
 187     num_to_bytes(x,sizeof(x),destination);
 188     lua_pushlstring(L,(const char *)&x,sizeof(x));
 189     lua_pushlstring(L,(const char *)destination,sizeof(destination));
 190
 191     return 2;
 192 }
 193
 194
 195 /**
 196  * @brief Utility to check if a key has been pressed by the user. This method does not block.
 197  * @param L
 198  * @return boolean, true if kbhit, false otherwise.
 199  */
 200 static int l_ukbhit(lua_State *L)
 201 {
 202     lua_pushboolean(L,ukbhit() ? true : false);
 203     return 1;
 204 }
 205 /**
 206  * @brief Calls the command line parser to deal with the command. This enables
 207  * lua-scripts to do stuff like "core.console('hf mf mifare')"
 208  * @param L
 209  * @return
 210  */
 211 static int l_CmdConsole(lua_State *L)
 212 {
 213     CommandReceived((char *)luaL_checkstring(L, 1));
 214     return 0;
 215 }
 216
 217
 218 /**
 219  * @brief Sets the lua path to include "./lualibs/?.lua", in order for a script to be
 220  * able to do "require('foobar')" if foobar.lua is within lualibs folder.
 221  * Taken from http://stackoverflow.com/questions/4125971/setting-the-global-lua-path-variable-from-c-c
 222  * @param L
 223  * @param path
 224  * @return
 225  */
 226 int setLuaPath( lua_State* L, const char* path )
 227 {
 228     lua_getglobal( L, "package" );
 229     lua_getfield( L, -1, "path" ); // get field "path" from table at top of stack (-1)
 230     const char* cur_path = lua_tostring( L, -1 ); // grab path string from top of stack
 231     int requiredLength = strlen(cur_path)+ strlen(path)+10; //A few bytes too many, whatever we can afford it
 232     char * buf = malloc(requiredLength);
 233     snprintf(buf, requiredLength, "%s;%s", cur_path, path);
 234     lua_pop( L, 1 ); // get rid of the string on the stack we just pushed on line 5
 235     lua_pushstring( L, buf ); // push the new one
 236     lua_setfield( L, -2, "path" ); // set the field "path" in table at -2 with value at top of stack
 237     lua_pop( L, 1 ); // get rid of package table from top of stack
 238     return 0; // all done!
 239 }
 240
 241
 242 int set_pm3_libraries(lua_State *L)
 243 {
 244
 245     static const luaL_Reg libs[] = {
 246         {"SendCommand",                 l_SendCommand},
 247         {"WaitForResponseTimeout",      l_WaitForResponseTimeout},
 248         {"nonce2key",                   l_nonce2key},
 249         //{"PrintAndLog",                 l_PrintAndLog},
 250         {"foobar",                      l_foobar},
 251         {"ukbhit",                      l_ukbhit},
 252         {"clearCommandBuffer",          l_clearCommandBuffer},
 253         {"console",                      l_CmdConsole},
 254         {NULL, NULL}
 255     };
 256
 257     lua_pushglobaltable(L);
 258     // Core library is in this table. Contains '
 259     //this is 'pm3' table
 260     lua_newtable(L);
 261
 262     //Put the function into the hash table.
 263     for (int i = 0; libs[i].name; i++) {
 264         lua_pushcfunction(L, libs[i].func);
 265         lua_setfield(L, -2, libs[i].name);//set the name, pop stack
 266     }
 267     //Name of 'core'
 268     lua_setfield(L, -2, "core");
 269
 270     //-- remove the global environment table from the stack
 271     lua_pop(L, 1);
 272
 273     //-- Last but not least, add to the LUA_PATH (package.path in lua)
 274     // so we can load libraries from the ./lualib/ - directory
 275     setLuaPath(L,"./lualibs/?.lua");
 276
 277     return 1;
 278 }