cvs.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 <stdlib.h>
  12 #include <lua.h>
  13 #include <lualib.h>
  14 #include <lauxlib.h>
  15 #include "proxmark3.h"
  16 #include "usb_cmd.h"
  17 #include "cmdmain.h"
  18 #include "scripting.h"
  19 #include "util.h"
  20 #include "nonce2key/nonce2key.h"
  21 #include "../common/iso15693tools.h"
  22 #include "iso14443crc.h"
  23 #include "../common/crc16.h"
  24 #include "../common/crc64.h"
  25 #include "../common/sha1.h"
  26 #include "aes.h"
  27 #include "cmdcrc.h"
  28 /**
  29  * The following params expected:
  30  *  UsbCommand c
  31  *@brief l_SendCommand
  32  * @param L
  33  * @return
  34  */
  35 static int l_SendCommand(lua_State *L){
  36
  37         /*
  38          *
  39          The SendCommand (native) expects the following structure:
  40
  41          typedef struct {
  42           uint64_t cmd; //8 bytes
  43           uint64_t arg[3]; // 8*3 bytes = 24 bytes
  44           union {
  45                 uint8_t  asBytes[USB_CMD_DATA_SIZE]; // 1 byte * 512 = 512 bytes (OR)
  46                 uint32_t asDwords[USB_CMD_DATA_SIZE/4]; // 4 byte * 128 = 512 bytes
  47           } d;
  48         } PACKED UsbCommand;
  49
  50         ==> A 544 byte buffer will do.
  51         **/
  52         //Pop cmd
  53         size_t size;
  54         const char *data = luaL_checklstring(L, 1, &size);
  55         if(size != sizeof(UsbCommand))
  56         {
  57                 printf("Got data size %d, expected %d" , (int) size,(int) sizeof(UsbCommand));
  58                 lua_pushstring(L,"Wrong data size");
  59                 return 1;
  60         }
  61
  62 //    UsbCommand c = (*data);
  63         SendCommand((UsbCommand* )data);
  64         return 0; // no return values
  65 }
  66 /**
  67  * @brief The following params expected:
  68  * uint32_t cmd
  69  * size_t ms_timeout
  70  * @param L
  71  * @return
  72  */
  73 static int l_WaitForResponseTimeout(lua_State *L){
  74
  75         uint32_t cmd = 0;
  76         size_t ms_timeout = -1;
  77
  78         //Check number of arguments
  79         int n = lua_gettop(L);
  80         if(n == 0)
  81         {
  82                 //signal error by returning Nil, errorstring
  83                 lua_pushnil(L);
  84                 lua_pushstring(L,"You need to supply at least command to wait for");
  85                 return 2; // two return values
  86         }
  87         if(n >= 1)
  88         {
  89                 //pop cmd
  90                 cmd = luaL_checkunsigned(L,1);
  91         }
  92         if(n >= 2)
  93         {
  94                 //Did the user send a timeout ?
  95                 //Check if the current top of stack is an integer
  96                 ms_timeout = luaL_checkunsigned(L,2);
  97                 //printf("Timeout set to %dms\n" , (int) ms_timeout);
  98         }
  99
 100         UsbCommand response;
 101
 102         if(WaitForResponseTimeout(cmd, &response, ms_timeout))
 103         {
 104                 //Push it as a string
 105                 lua_pushlstring(L,(const char *)&response,sizeof(UsbCommand));
 106
 107                 return 1;// return 1 to signal one return value
 108         }else{
 109                 //Push a Nil instead
 110                 lua_pushnil(L);
 111                 return 1;// one return value
 112         }
 113 }
 114
 115 static int returnToLuaWithError(lua_State *L, const char* fmt, ...)
 116 {
 117         char buffer[200];
 118         va_list args;
 119         va_start(args,fmt);
 120         vsnprintf(buffer, sizeof(buffer), fmt,args);
 121         va_end(args);
 122
 123         lua_pushnil(L);
 124         lua_pushstring(L,buffer);
 125         return 2;
 126 }
 127
 128 static int l_nonce2key(lua_State *L){
 129
 130         size_t size;
 131         const char *p_uid = luaL_checklstring(L, 1, &size);
 132         if(size != 4)  return returnToLuaWithError(L,"Wrong size of uid, got %d bytes, expected 4", (int) size);
 133
 134         const char *p_nt = luaL_checklstring(L, 2, &size);
 135         if(size != 4)  return returnToLuaWithError(L,"Wrong size of nt, got %d bytes, expected 4", (int) size);
 136
 137         const char *p_nr = luaL_checklstring(L, 3, &size);
 138         if(size != 4)  return returnToLuaWithError(L,"Wrong size of nr, got %d bytes, expected 4", (int) size);
 139
 140         const char *p_par_info = luaL_checklstring(L, 4, &size);
 141         if(size != 8)  return returnToLuaWithError(L,"Wrong size of par_info, got %d bytes, expected 8", (int) size);
 142
 143         const char *p_pks_info = luaL_checklstring(L, 5, &size);
 144         if(size != 8)  return returnToLuaWithError(L,"Wrong size of ks_info, got %d bytes, expected 8", (int) size);
 145
 146
 147         uint32_t uid = bytes_to_num(( uint8_t *)p_uid,4);
 148         uint32_t nt = bytes_to_num(( uint8_t *)p_nt,4);
 149
 150         uint32_t nr = bytes_to_num(( uint8_t*)p_nr,4);
 151         uint64_t par_info = bytes_to_num(( uint8_t *)p_par_info,8);
 152         uint64_t ks_info = bytes_to_num(( uint8_t *)p_pks_info,8);
 153
 154         uint64_t key = 0;
 155
 156         int retval = nonce2key(uid,nt, nr, par_info,ks_info, &key);
 157
 158         //Push the retval on the stack
 159         lua_pushinteger(L,retval);
 160
 161         //Push the key onto the stack
 162         uint8_t dest_key[8];
 163         num_to_bytes(key,sizeof(dest_key),dest_key);
 164
 165         //printf("Pushing to lua stack: %012" PRIx64 "\n",key);
 166         lua_pushlstring(L,(const char *) dest_key,sizeof(dest_key));
 167
 168         return 2; //Two return values
 169 }
 170 //static int l_PrintAndLog(lua_State *L){ return CmdHF14AMfDump(luaL_checkstring(L, 1));}
 171 static int l_clearCommandBuffer(lua_State *L){
 172         clearCommandBuffer();
 173         return 0;
 174 }
 175 /**
 176  * @brief l_foobar is a dummy function to test lua-integration with
 177  * @param L
 178  * @return
 179  */
 180 static int l_foobar(lua_State *L)
 181 {
 182         //Check number of arguments
 183         int n = lua_gettop(L);
 184         printf("foobar called with %d arguments" , n);
 185         lua_settop(L, 0);
 186         printf("Arguments discarded, stack now contains %d elements", lua_gettop(L));
 187
 188         // todo: this is not used, where was it intended for?
 189         // UsbCommand response =  {CMD_MIFARE_READBL, {1337, 1338, 1339}};
 190
 191         printf("Now returning a uint64_t as a string");
 192         uint64_t x = 0xDEADBEEF;
 193         uint8_t destination[8];
 194         num_to_bytes(x,sizeof(x),destination);
 195         lua_pushlstring(L,(const char *)&x,sizeof(x));
 196         lua_pushlstring(L,(const char *)destination,sizeof(destination));
 197
 198         return 2;
 199 }
 200
 201
 202 /**
 203  * @brief Utility to check if a key has been pressed by the user. This method does not block.
 204  * @param L
 205  * @return boolean, true if kbhit, false otherwise.
 206  */
 207 static int l_ukbhit(lua_State *L)
 208 {
 209         lua_pushboolean(L,ukbhit() ? true : false);
 210         return 1;
 211 }
 212 /**
 213  * @brief Calls the command line parser to deal with the command. This enables
 214  * lua-scripts to do stuff like "core.console('hf mf mifare')"
 215  * @param L
 216  * @return
 217  */
 218 static int l_CmdConsole(lua_State *L)
 219 {
 220         CommandReceived((char *)luaL_checkstring(L, 1));
 221         return 0;
 222 }
 223
 224 static int l_iso15693_crc(lua_State *L)
 225 {
 226         //    uint16_t Iso15693Crc(uint8_t *v, int n);
 227         size_t size;
 228         const char *v = luaL_checklstring(L, 1, &size);
 229         uint16_t retval = Iso15693Crc((uint8_t *) v, size);
 230         lua_pushinteger(L, (int) retval);
 231         return 1;
 232 }
 233
 234 static int l_iso14443b_crc(lua_State *L)
 235 {
 236         /* void ComputeCrc14443(int CrcType,
 237                      const unsigned char *Data, int Length,
 238                      unsigned char *TransmitFirst,
 239                      unsigned char *TransmitSecond)
 240         */
 241         unsigned char buf[USB_CMD_DATA_SIZE];
 242         size_t len = 0;
 243         const char *data = luaL_checklstring(L, 1, &len);
 244         if (USB_CMD_DATA_SIZE < len)
 245                 len =  USB_CMD_DATA_SIZE-2;
 246
 247         for (int i = 0; i < len; i += 2) {
 248                 sscanf(&data[i], "%02x", (unsigned int *)&buf[i / 2]);
 249         }
 250         ComputeCrc14443(CRC_14443_B, buf, len, &buf[len], &buf[len+1]);
 251
 252         lua_pushlstring(L, (const char *)&buf, len+2);
 253         return 1;
 254 }
 255 /*
 256  Simple AES 128 cbc hook up to OpenSSL.
 257  params:  key, input
 258 */
 259 static int l_aes128decrypt_cbc(lua_State *L)
 260 {
 261         //Check number of arguments
 262         int i;
 263         size_t size;
 264         const char *p_key = luaL_checklstring(L, 1, &size);
 265         if(size != 32)  return returnToLuaWithError(L,"Wrong size of key, got %d bytes, expected 32", (int) size);
 266
 267         const char *p_encTxt = luaL_checklstring(L, 2, &size);
 268
 269         unsigned char indata[16] = {0x00};
 270         unsigned char outdata[16] = {0x00};
 271         unsigned char aes_key[16] = {0x00};
 272         unsigned char iv[16] = {0x00};
 273
 274         // convert key to bytearray and convert input to bytearray
 275         for (i = 0; i < 32; i += 2) {
 276                 sscanf(&p_encTxt[i], "%02x", (unsigned int *)&indata[i / 2]);
 277                 sscanf(&p_key[i], "%02x", (unsigned int *)&aes_key[i / 2]);
 278         }
 279
 280         aes_context ctx;
 281         aes_init(&ctx);
 282         aes_setkey_dec(&ctx, aes_key, 128);
 283         aes_crypt_cbc(&ctx,AES_DECRYPT,sizeof(indata), iv, indata,outdata );
 284         //Push decrypted array as a string
 285         lua_pushlstring(L,(const char *)&outdata, sizeof(outdata));
 286         return 1;// return 1 to signal one return value
 287 }
 288 static int l_aes128decrypt_ecb(lua_State *L)
 289 {
 290         //Check number of arguments
 291         int i;
 292         size_t size;
 293         const char *p_key = luaL_checklstring(L, 1, &size);
 294         if(size != 32)  return returnToLuaWithError(L,"Wrong size of key, got %d bytes, expected 32", (int) size);
 295
 296         const char *p_encTxt = luaL_checklstring(L, 2, &size);
 297
 298         unsigned char indata[16] = {0x00};
 299         unsigned char outdata[16] = {0x00};
 300         unsigned char aes_key[16] = {0x00};
 301
 302         // convert key to bytearray and convert input to bytearray
 303         for (i = 0; i < 32; i += 2) {
 304                 sscanf(&p_encTxt[i], "%02x", (unsigned int *)&indata[i / 2]);
 305                 sscanf(&p_key[i], "%02x", (unsigned int *)&aes_key[i / 2]);
 306         }
 307         aes_context ctx;
 308         aes_init(&ctx);
 309         aes_setkey_dec(&ctx, aes_key, 128);
 310         aes_crypt_ecb(&ctx, AES_DECRYPT, indata, outdata );
 311
 312         //Push decrypted array as a string
 313         lua_pushlstring(L,(const char *)&outdata, sizeof(outdata));
 314         return 1;// return 1 to signal one return value
 315 }
 316
 317 static int l_aes128encrypt_cbc(lua_State *L)
 318 {
 319         //Check number of arguments
 320         int i;
 321         size_t size;
 322         const char *p_key = luaL_checklstring(L, 1, &size);
 323         if(size != 32)  return returnToLuaWithError(L,"Wrong size of key, got %d bytes, expected 32", (int) size);
 324
 325         const char *p_txt = luaL_checklstring(L, 2, &size);
 326
 327         unsigned char indata[16] = {0x00};
 328         unsigned char outdata[16] = {0x00};
 329         unsigned char aes_key[16] = {0x00};
 330         unsigned char iv[16] = {0x00};
 331
 332         for (i = 0; i < 32; i += 2) {
 333                 sscanf(&p_txt[i], "%02x", (unsigned int *)&indata[i / 2]);
 334                 sscanf(&p_key[i], "%02x", (unsigned int *)&aes_key[i / 2]);
 335         }
 336
 337         aes_context ctx;
 338         aes_init(&ctx);
 339         aes_setkey_enc(&ctx, aes_key, 128);
 340         aes_crypt_cbc(&ctx, AES_ENCRYPT, sizeof(indata), iv, indata, outdata );
 341         //Push encrypted array as a string
 342         lua_pushlstring(L,(const char *)&outdata, sizeof(outdata));
 343         return 1;// return 1 to signal one return value
 344 }
 345
 346 static int l_aes128encrypt_ecb(lua_State *L)
 347 {
 348         //Check number of arguments
 349         int i;
 350         size_t size;
 351         const char *p_key = luaL_checklstring(L, 1, &size);
 352         if(size != 32)  return returnToLuaWithError(L,"Wrong size of key, got %d bytes, expected 32", (int) size);
 353
 354         const char *p_txt = luaL_checklstring(L, 2, &size);
 355
 356         unsigned char indata[16] = {0x00};
 357         unsigned char outdata[16] = {0x00};
 358         unsigned char aes_key[16] = {0x00};
 359
 360         for (i = 0; i < 32; i += 2) {
 361                 sscanf(&p_txt[i], "%02x", (unsigned int *)&indata[i / 2]);
 362                 sscanf(&p_key[i], "%02x", (unsigned int *)&aes_key[i / 2]);
 363         }
 364         aes_context ctx;
 365         aes_init(&ctx);
 366         aes_setkey_enc(&ctx, aes_key, 128);
 367         aes_crypt_ecb(&ctx, AES_ENCRYPT, indata, outdata );
 368         //Push encrypted array as a string
 369         lua_pushlstring(L,(const char *)&outdata, sizeof(outdata));
 370         return 1;// return 1 to signal one return value
 371 }
 372
 373 static int l_crc16(lua_State *L)
 374 {
 375         size_t size;
 376         const char *p_str = luaL_checklstring(L, 1, &size);
 377
 378         uint16_t retval = crc16_ccitt( (uint8_t*) p_str, size);
 379         lua_pushinteger(L, (int) retval);
 380         return 1;
 381 }
 382
 383 static int l_crc64(lua_State *L)
 384 {
 385         size_t size;
 386         uint64_t crc = 0;
 387         unsigned char outdata[8] = {0x00};
 388
 389         const char *p_str = luaL_checklstring(L, 1, &size);
 390
 391         crc64( (uint8_t*) p_str, size, &crc);
 392
 393         outdata[0] = (uint8_t)(crc >> 56) & 0xff;
 394         outdata[1] = (uint8_t)(crc >> 48) & 0xff;
 395         outdata[2] = (uint8_t)(crc >> 40) & 0xff;
 396         outdata[3] = (uint8_t)(crc >> 32) & 0xff;
 397         outdata[4] = (uint8_t)(crc >> 24) & 0xff;
 398         outdata[5] = (uint8_t)(crc >> 16) & 0xff;
 399         outdata[6] = (uint8_t)(crc >> 8) & 0xff;
 400         outdata[7] = crc & 0xff;
 401         lua_pushlstring(L,(const char *)&outdata, sizeof(outdata));
 402         return 1;
 403 }
 404
 405 static int l_sha1(lua_State *L)
 406 {
 407         size_t size;
 408         const char *p_str = luaL_checklstring(L, 1, &size);
 409         unsigned char outdata[20] = {0x00};
 410         sha1( (uint8_t*) p_str, size, outdata);
 411         lua_pushlstring(L,(const char *)&outdata, sizeof(outdata));
 412         return 1;
 413 }
 414
 415 static int l_reveng_models(lua_State *L){
 416
 417         char *models[80];
 418         int count = 0;
 419         int in_width = luaL_checkinteger(L, 1);
 420
 421         if( in_width > 89 ) return returnToLuaWithError(L,"Width cannot exceed 89, got %d", in_width);
 422
 423         uint8_t width[80];
 424         width[0] = (uint8_t)in_width;
 425         int ans = GetModels(models, &count, width);
 426         if (!ans) return 0;
 427
 428         lua_newtable(L);
 429
 430         for (int i = 0; i < count; i++){
 431                 lua_pushstring(L,  (const char*)models[i]);
 432                 lua_rawseti(L,-2,i+1);
 433                 free(models[i]);
 434         }
 435
 436         return 1;
 437 }
 438
 439 //Called with 4 parameters.
 440 // inModel   ,string containing the crc model name: 'CRC-8'
 441 // inHexStr  ,string containing the hex representation of the data that will be used for CRC calculations.
 442 // reverse   ,int 0/1  (bool) if 1, calculate the reverse CRC
 443 // endian    ,char,  'B','b','L','l','t','r' describing if Big-Endian or Little-Endian should be used in different combinations.
 444 //
 445 // outputs:  string with hex representation of the CRC result
 446 static int l_reveng_RunModel(lua_State *L){
 447         //-c || -v
 448         //inModel = valid model name string - CRC-8
 449         //inHexStr = input hex string to calculate crc on
 450         //reverse = reverse calc option if true
 451         //endian = {0 = calc default endian input and output, b = big endian input and output, B = big endian output, r = right justified
 452         //          l = little endian input and output, L = little endian output only, t = left justified}
 453         //result = calculated crc hex string
 454         char result[50];
 455
 456         const char *inModel = luaL_checkstring(L, 1);
 457         const char *inHexStr = luaL_checkstring(L, 2);
 458         bool reverse =  lua_toboolean(L, 3);
 459         const char endian = luaL_checkstring(L, 4)[0];
 460
 461         //PrintAndLog("mod: %s, hex: %s, rev %d", inModel, inHexStr, reverse);
 462         //int RunModel(char *inModel, char *inHexStr, bool reverse, char endian, char *result)
 463         int ans = RunModel( (char *)inModel, (char *)inHexStr, reverse, endian, result);
 464         if (!ans)
 465                 return returnToLuaWithError(L,"Reveng failed");
 466
 467         lua_pushstring(L, (const char*)result);
 468         return 1;
 469 }
 470
 471 /**
 472  * @brief Sets the lua path to include "./lualibs/?.lua", in order for a script to be
 473  * able to do "require('foobar')" if foobar.lua is within lualibs folder.
 474  * Taken from http://stackoverflow.com/questions/4125971/setting-the-global-lua-path-variable-from-c-c
 475  * @param L
 476  * @param path
 477  * @return
 478  */
 479 int setLuaPath( lua_State* L, const char* path )
 480 {
 481         lua_getglobal( L, "package" );
 482         lua_getfield( L, -1, "path" ); // get field "path" from table at top of stack (-1)
 483         const char* cur_path = lua_tostring( L, -1 ); // grab path string from top of stack
 484         int requiredLength = strlen(cur_path)+ strlen(path)+10; //A few bytes too many, whatever we can afford it
 485         char * buf = malloc(requiredLength);
 486         snprintf(buf, requiredLength, "%s;%s", cur_path, path);
 487         lua_pop( L, 1 ); // get rid of the string on the stack we just pushed on line 5
 488         lua_pushstring( L, buf ); // push the new one
 489         lua_setfield( L, -2, "path" ); // set the field "path" in table at -2 with value at top of stack
 490         lua_pop( L, 1 ); // get rid of package table from top of stack
 491         free(buf);
 492         return 0; // all done!
 493 }
 494
 495
 496 int set_pm3_libraries(lua_State *L)
 497 {
 498
 499         static const luaL_Reg libs[] = {
 500                 {"SendCommand",                 l_SendCommand},
 501                 {"WaitForResponseTimeout",      l_WaitForResponseTimeout},
 502                 {"nonce2key",                   l_nonce2key},
 503                 //{"PrintAndLog",                 l_PrintAndLog},
 504                 {"foobar",                      l_foobar},
 505                 {"ukbhit",                      l_ukbhit},
 506                 {"clearCommandBuffer",          l_clearCommandBuffer},
 507                 {"console",                     l_CmdConsole},
 508                 {"iso15693_crc",                l_iso15693_crc},
 509                 {"iso14443b_crc",               l_iso14443b_crc},
 510                 {"aes128_decrypt",              l_aes128decrypt_cbc},
 511                 {"aes128_decrypt_ecb",          l_aes128decrypt_ecb},
 512                 {"aes128_encrypt",              l_aes128encrypt_cbc},
 513                 {"aes128_encrypt_ecb",          l_aes128encrypt_ecb},
 514                 {"crc16",                       l_crc16},
 515                 {"crc64",                       l_crc64},
 516                 {"sha1",                        l_sha1},
 517                 {"reveng_models",               l_reveng_models},
 518                 {"reveng_runmodel",             l_reveng_RunModel},
 519                 {NULL, NULL}
 520         };
 521
 522         lua_pushglobaltable(L);
 523         // Core library is in this table. Contains '
 524         //this is 'pm3' table
 525         lua_newtable(L);
 526
 527         //Put the function into the hash table.
 528         for (int i = 0; libs[i].name; i++) {
 529                 lua_pushcfunction(L, libs[i].func);
 530                 lua_setfield(L, -2, libs[i].name);//set the name, pop stack
 531         }
 532         //Name of 'core'
 533         lua_setfield(L, -2, "core");
 534
 535         //-- remove the global environment table from the stack
 536         lua_pop(L, 1);
 537
 538         //-- Last but not least, add to the LUA_PATH (package.path in lua)
 539         // so we can load libraries from the ./lualib/ - directory
 540         char libraries_path[strlen(get_my_executable_directory()) + strlen(LUA_LIBRARIES_DIRECTORY) + strlen(LUA_LIBRARIES_WILDCARD) + 1];
 541         strcpy(libraries_path, get_my_executable_directory());
 542         strcat(libraries_path, LUA_LIBRARIES_DIRECTORY);
 543         strcat(libraries_path, LUA_LIBRARIES_WILDCARD);
 544         setLuaPath(L, libraries_path);
 545
 546         return 1;
 547 }