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