]>
git.zerfleddert.de Git - proxmark3-svn/blob - client/scripting.c
1 //-----------------------------------------------------------------------------
2 // Copyright (C) 2013 m h swende <martin at swende.se>
3 // Modified 2015,2016, iceman
5 // This code is licensed to you under the terms of the GNU GPL, version 2 or,
6 // at your option, any later version. See the LICENSE.txt file for the text of
8 //-----------------------------------------------------------------------------
9 // Some lua scripting glue to proxmark core.
10 //-----------------------------------------------------------------------------
11 #include "scripting.h"
14 * The following params expected:
20 static int l_SendCommand(lua_State
*L
){
24 The SendCommand (native) expects the following structure:
27 uint64_t cmd; //8 bytes
28 uint64_t arg[3]; // 8*3 bytes = 24 bytes
30 uint8_t asBytes[USB_CMD_DATA_SIZE]; // 1 byte * 512 = 512 bytes (OR)
31 uint32_t asDwords[USB_CMD_DATA_SIZE/4]; // 4 byte * 128 = 512 bytes
35 ==> A 544 byte buffer will do.
39 const char *data
= luaL_checklstring(L
, 1, &size
);
40 if(size
!= sizeof(UsbCommand
))
42 printf("Got data size %d, expected %d" , (int) size
,(int) sizeof(UsbCommand
));
43 lua_pushstring(L
,"Wrong data size");
47 SendCommand((UsbCommand
* )data
);
48 return 0; // no return values
51 * @brief The following params expected:
57 static int l_WaitForResponseTimeout(lua_State
*L
){
60 size_t ms_timeout
= -1;
62 //Check number of arguments
63 int n
= lua_gettop(L
);
66 //signal error by returning Nil, errorstring
68 lua_pushstring(L
,"You need to supply at least command to wait for");
69 return 2; // two return values
74 cmd
= luaL_checkunsigned(L
,1);
78 //Did the user send a timeout ?
79 //Check if the current top of stack is an integer
80 ms_timeout
= luaL_checkunsigned(L
,2);
81 //printf("Timeout set to %dms\n" , (int) ms_timeout);
85 if(WaitForResponseTimeout(cmd
, &response
, ms_timeout
))
88 lua_pushlstring(L
,(const char *)&response
, sizeof(UsbCommand
));
90 return 1;// return 1 to signal one return value
94 return 1;// one return value
98 static int returnToLuaWithError(lua_State
*L
, const char* fmt
, ...)
103 vsnprintf(buffer
, sizeof(buffer
), fmt
,args
);
107 lua_pushstring(L
,buffer
);
111 static int l_nonce2key(lua_State
*L
){
114 const char *p_uid
= luaL_checklstring(L
, 1, &size
);
115 if(size
!= 4) return returnToLuaWithError(L
,"Wrong size of uid, got %d bytes, expected 4", (int) size
);
117 const char *p_nt
= luaL_checklstring(L
, 2, &size
);
118 if(size
!= 4) return returnToLuaWithError(L
,"Wrong size of nt, got %d bytes, expected 4", (int) size
);
120 const char *p_nr
= luaL_checklstring(L
, 3, &size
);
121 if(size
!= 4) return returnToLuaWithError(L
,"Wrong size of nr, got %d bytes, expected 4", (int) size
);
123 const char *p_par_info
= luaL_checklstring(L
, 4, &size
);
124 if(size
!= 8) return returnToLuaWithError(L
,"Wrong size of par_info, got %d bytes, expected 8", (int) size
);
126 const char *p_pks_info
= luaL_checklstring(L
, 5, &size
);
127 if(size
!= 8) return returnToLuaWithError(L
,"Wrong size of ks_info, got %d bytes, expected 8", (int) size
);
130 uint32_t uid
= bytes_to_num(( uint8_t *)p_uid
,4);
131 uint32_t nt
= bytes_to_num(( uint8_t *)p_nt
,4);
133 uint32_t nr
= bytes_to_num(( uint8_t*)p_nr
,4);
134 uint64_t par_info
= bytes_to_num(( uint8_t *)p_par_info
,8);
135 uint64_t ks_info
= bytes_to_num(( uint8_t *)p_pks_info
,8);
139 int retval
= nonce2key(uid
,nt
, nr
, par_info
,ks_info
, &key
);
141 //Push the retval on the stack
142 lua_pushinteger(L
,retval
);
144 //Push the key onto the stack
146 num_to_bytes(key
,sizeof(dest_key
),dest_key
);
148 //printf("Pushing to lua stack: %012"llx"\n",key);
149 lua_pushlstring(L
,(const char *) dest_key
,sizeof(dest_key
));
151 return 2; //Two return values
153 //static int l_PrintAndLog(lua_State *L){ return CmdHF14AMfDump(luaL_checkstring(L, 1));}
154 static int l_clearCommandBuffer(lua_State
*L
){
155 clearCommandBuffer();
159 * @brief l_foobar is a dummy function to test lua-integration with
163 static int l_foobar(lua_State
*L
)
165 //Check number of arguments
166 int n
= lua_gettop(L
);
167 printf("foobar called with %d arguments" , n
);
169 printf("Arguments discarded, stack now contains %d elements", lua_gettop(L
));
171 // todo: this is not used, where was it intended for?
172 // UsbCommand response = {CMD_MIFARE_READBL, {1337, 1338, 1339}};
174 printf("Now returning a uint64_t as a string");
175 uint64_t x
= 0xDEADBEEF;
176 uint8_t destination
[8];
177 num_to_bytes(x
,sizeof(x
),destination
);
178 lua_pushlstring(L
,(const char *)&x
,sizeof(x
));
179 lua_pushlstring(L
,(const char *)destination
,sizeof(destination
));
186 * @brief Utility to check if a key has been pressed by the user. This method does not block.
188 * @return boolean, true if kbhit, false otherwise.
190 static int l_ukbhit(lua_State
*L
)
192 lua_pushboolean(L
,ukbhit() ? true : false);
196 * @brief Calls the command line parser to deal with the command. This enables
197 * lua-scripts to do stuff like "core.console('hf mf mifare')"
201 static int l_CmdConsole(lua_State
*L
)
203 CommandReceived((char *)luaL_checkstring(L
, 1));
207 static int l_iso15693_crc(lua_State
*L
)
209 // uint16_t Iso15693Crc(uint8_t *v, int n);
211 const char *v
= luaL_checklstring(L
, 1, &size
);
212 uint16_t retval
= Iso15693Crc((uint8_t *) v
, size
);
213 lua_pushinteger(L
, (int) retval
);
217 static int l_iso14443b_crc(lua_State
*L
)
219 /* void ComputeCrc14443(int CrcType,
220 const unsigned char *Data, int Length,
221 unsigned char *TransmitFirst,
222 unsigned char *TransmitSecond)
225 const char *data
= luaL_checklstring(L
, 1, &size
);
227 unsigned char buf
[USB_CMD_DATA_SIZE
] = {0x00};
229 for (int i
= 0; i
< size
; i
+= 2)
230 sscanf(&data
[i
], "%02x", (unsigned int *)&buf
[i
/ 2]);
233 ComputeCrc14443(CRC_14443_B
, buf
, size
, &buf
[size
], &buf
[size
+1]);
234 lua_pushlstring(L
, (const char *)&buf
, size
+2);
239 Simple AES 128 cbc hook up to OpenSSL.
242 static int l_aes128decrypt_cbc(lua_State
*L
)
244 //Check number of arguments
247 const char *p_key
= luaL_checklstring(L
, 1, &size
);
248 if(size
!= 32) return returnToLuaWithError(L
,"Wrong size of key, got %d bytes, expected 32", (int) size
);
250 const char *p_encTxt
= luaL_checklstring(L
, 2, &size
);
252 unsigned char indata
[16] = {0x00};
253 unsigned char outdata
[16] = {0x00};
254 unsigned char aes_key
[16] = {0x00};
255 unsigned char iv
[16] = {0x00};
257 // convert key to bytearray and convert input to bytearray
258 for (i
= 0; i
< 32; i
+= 2) {
259 sscanf(&p_encTxt
[i
], "%02x", (unsigned int *)&indata
[i
/ 2]);
260 sscanf(&p_key
[i
], "%02x", (unsigned int *)&aes_key
[i
/ 2]);
265 aes_setkey_dec(&ctx
, aes_key
, 128);
266 aes_crypt_cbc(&ctx
, AES_DECRYPT
, sizeof(indata
), iv
, indata
, outdata
);
267 //Push decrypted array as a string
268 lua_pushlstring(L
,(const char *)&outdata
, sizeof(outdata
));
269 return 1;// return 1 to signal one return value
271 static int l_aes128decrypt_ecb(lua_State
*L
)
273 //Check number of arguments
276 const char *p_key
= luaL_checklstring(L
, 1, &size
);
277 if(size
!= 32) return returnToLuaWithError(L
,"Wrong size of key, got %d bytes, expected 32", (int) size
);
279 const char *p_encTxt
= luaL_checklstring(L
, 2, &size
);
281 unsigned char indata
[16] = {0x00};
282 unsigned char outdata
[16] = {0x00};
283 unsigned char aes_key
[16] = {0x00};
285 // convert key to bytearray and convert input to bytearray
286 for (i
= 0; i
< 32; i
+= 2) {
287 sscanf(&p_encTxt
[i
], "%02x", (unsigned int *)&indata
[i
/ 2]);
288 sscanf(&p_key
[i
], "%02x", (unsigned int *)&aes_key
[i
/ 2]);
292 aes_setkey_dec(&ctx
, aes_key
, 128);
293 aes_crypt_ecb(&ctx
, AES_DECRYPT
, indata
, outdata
);
295 //Push decrypted array as a string
296 lua_pushlstring(L
,(const char *)&outdata
, sizeof(outdata
));
297 return 1;// return 1 to signal one return value
300 static int l_aes128encrypt_cbc(lua_State
*L
)
302 //Check number of arguments
305 const char *p_key
= luaL_checklstring(L
, 1, &size
);
306 if(size
!= 32) return returnToLuaWithError(L
,"Wrong size of key, got %d bytes, expected 32", (int) size
);
308 const char *p_txt
= luaL_checklstring(L
, 2, &size
);
310 unsigned char indata
[16] = {0x00};
311 unsigned char outdata
[16] = {0x00};
312 unsigned char aes_key
[16] = {0x00};
313 unsigned char iv
[16] = {0x00};
315 for (i
= 0; i
< 32; i
+= 2) {
316 sscanf(&p_txt
[i
], "%02x", (unsigned int *)&indata
[i
/ 2]);
317 sscanf(&p_key
[i
], "%02x", (unsigned int *)&aes_key
[i
/ 2]);
322 aes_setkey_enc(&ctx
, aes_key
, 128);
323 aes_crypt_cbc(&ctx
, AES_ENCRYPT
, sizeof(indata
), iv
, indata
, outdata
);
324 //Push encrypted array as a string
325 lua_pushlstring(L
,(const char *)&outdata
, sizeof(outdata
));
326 return 1;// return 1 to signal one return value
329 static int l_aes128encrypt_ecb(lua_State
*L
)
331 //Check number of arguments
334 const char *p_key
= luaL_checklstring(L
, 1, &size
);
335 if(size
!= 32) return returnToLuaWithError(L
,"Wrong size of key, got %d bytes, expected 32", (int) size
);
337 const char *p_txt
= luaL_checklstring(L
, 2, &size
);
339 unsigned char indata
[16] = {0x00};
340 unsigned char outdata
[16] = {0x00};
341 unsigned char aes_key
[16] = {0x00};
343 for (i
= 0; i
< 32; i
+= 2) {
344 sscanf(&p_txt
[i
], "%02x", (unsigned int *)&indata
[i
/ 2]);
345 sscanf(&p_key
[i
], "%02x", (unsigned int *)&aes_key
[i
/ 2]);
349 aes_setkey_enc(&ctx
, aes_key
, 128);
350 aes_crypt_ecb(&ctx
, AES_ENCRYPT
, indata
, outdata
);
351 //Push encrypted array as a string
352 lua_pushlstring(L
,(const char *)&outdata
, sizeof(outdata
));
353 return 1;// return 1 to signal one return value
356 static int l_crc8legic(lua_State
*L
)
359 const char *p_str
= luaL_checklstring(L
, 1, &size
);
361 uint16_t retval
= CRC8Legic( (uint8_t*) p_str
, size
);
362 lua_pushinteger(L
, (int) retval
);
366 static int l_crc16(lua_State
*L
)
369 const char *p_str
= luaL_checklstring(L
, 1, &size
);
371 uint16_t retval
= crc16_ccitt( (uint8_t*) p_str
, size
);
372 lua_pushinteger(L
, (int) retval
);
376 static int l_crc64(lua_State
*L
)
380 unsigned char outdata
[8] = {0x00};
382 const char *p_str
= luaL_checklstring(L
, 1, &size
);
384 crc64( (uint8_t*) p_str
, size
, &crc
);
386 outdata
[0] = (uint8_t)(crc
>> 56) & 0xff;
387 outdata
[1] = (uint8_t)(crc
>> 48) & 0xff;
388 outdata
[2] = (uint8_t)(crc
>> 40) & 0xff;
389 outdata
[3] = (uint8_t)(crc
>> 32) & 0xff;
390 outdata
[4] = (uint8_t)(crc
>> 24) & 0xff;
391 outdata
[5] = (uint8_t)(crc
>> 16) & 0xff;
392 outdata
[6] = (uint8_t)(crc
>> 8) & 0xff;
393 outdata
[7] = crc
& 0xff;
394 lua_pushlstring(L
,(const char *)&outdata
, sizeof(outdata
));
398 static int l_sha1(lua_State
*L
)
401 const char *p_str
= luaL_checklstring(L
, 1, &size
);
402 unsigned char outdata
[20] = {0x00};
403 sha1( (uint8_t*) p_str
, size
, outdata
);
404 lua_pushlstring(L
,(const char *)&outdata
, sizeof(outdata
));
408 static int l_reveng_models(lua_State
*L
){
410 // This array needs to be adjusted if RevEng adds more crc-models.
413 int in_width
= luaL_checkinteger(L
, 1);
415 if( in_width
> 89 ) return returnToLuaWithError(L
,"Width cannot exceed 89, got %d", in_width
);
417 // This array needs to be adjusted if RevEng adds more crc-models.
419 width
[0] = (uint8_t)in_width
;
420 int ans
= GetModels(models
, &count
, width
);
425 for (int i
= 0; i
< count
; i
++){
426 lua_pushstring(L
, (const char*)models
[i
]);
427 lua_rawseti(L
,-2,i
+1);
434 //Called with 4 parameters.
435 // inModel ,string containing the crc model name: 'CRC-8'
436 // inHexStr ,string containing the hex representation of the data that will be used for CRC calculations.
437 // reverse ,int 0/1 (bool) if 1, calculate the reverse CRC
438 // endian ,char, 'B','b','L','l','t','r' describing if Big-Endian or Little-Endian should be used in different combinations.
440 // outputs: string with hex representation of the CRC result
441 static int l_reveng_RunModel(lua_State
*L
){
443 //inModel = valid model name string - CRC-8
444 //inHexStr = input hex string to calculate crc on
445 //reverse = reverse calc option if true
446 //endian = {0 = calc default endian input and output, b = big endian input and output, B = big endian output, r = right justified
447 // l = little endian input and output, L = little endian output only, t = left justified}
448 //result = calculated crc hex string
451 const char *inModel
= luaL_checkstring(L
, 1);
452 const char *inHexStr
= luaL_checkstring(L
, 2);
453 bool reverse
= lua_toboolean(L
, 3);
454 const char endian
= luaL_checkstring(L
, 4)[0];
456 //PrintAndLog("mod: %s, hex: %s, rev %d", inModel, inHexStr, reverse);
457 // int RunModel(char *inModel, char *inHexStr, bool reverse, char endian, char *result)
458 int ans
= RunModel( (char *)inModel
, (char *)inHexStr
, reverse
, endian
, result
);
460 return returnToLuaWithError(L
,"Reveng failed");
462 lua_pushstring(L
, (const char*)result
);
466 static int l_hardnested(lua_State
*L
){
468 bool haveTarget
= TRUE
;
470 const char *p_blockno
= luaL_checklstring(L
, 1, &size
);
471 if(size
!= 2) return returnToLuaWithError(L
,"Wrong size of blockNo, got %d bytes, expected 2", (int) size
);
473 const char *p_keytype
= luaL_checklstring(L
, 2, &size
);
474 if(size
!= 1) return returnToLuaWithError(L
,"Wrong size of keyType, got %d bytes, expected 1", (int) size
);
476 const char *p_key
= luaL_checklstring(L
, 3, &size
);
477 if(size
!= 12) return returnToLuaWithError(L
,"Wrong size of key, got %d bytes, expected 12", (int) size
);
479 const char *p_trg_blockno
= luaL_checklstring(L
, 4, &size
);
480 if(size
!= 2) return returnToLuaWithError(L
,"Wrong size of trgBlockNo, got %d bytes, expected 2", (int) size
);
482 const char *p_trg_keytype
= luaL_checklstring(L
, 5, &size
);
483 if(size
!= 1) return returnToLuaWithError(L
,"Wrong size of trgKeyType, got %d bytes, expected 1", (int) size
);
485 const char *p_trgkey
= luaL_checklstring(L
, 6, &size
);
489 const char *p_nonce_file_read
= luaL_checklstring(L
, 7, &size
);
490 if(size
!= 1) return returnToLuaWithError(L
,"Wrong size of nonce_file_read, got %d bytes, expected 1", (int) size
);
492 const char *p_nonce_file_write
= luaL_checklstring(L
, 8, &size
);
493 if(size
!= 1) return returnToLuaWithError(L
,"Wrong size of nonce_file_write, got %d bytes, expected 1", (int) size
);
495 const char *p_slow
= luaL_checklstring(L
, 9, &size
);
496 if(size
!= 1) return returnToLuaWithError(L
,"Wrong size of slow, got %d bytes, expected 1", (int) size
);
498 const char *p_tests
= luaL_checklstring(L
, 10, &size
);
499 if(size
!= 1) return returnToLuaWithError(L
,"Wrong size of tests, got %d bytes, expected 1", (int) size
);
501 uint32_t blockNo
= 0, keyType
= 0;
502 uint32_t trgBlockNo
= 0, trgKeyType
= 0;
503 uint32_t slow
= 0, tests
= 0;
504 uint32_t nonce_file_read
= 0, nonce_file_write
= 0;
506 sscanf(p_blockno
, "%02x", &blockNo
);
507 sscanf(p_keytype
, "%x", &keyType
);
508 sscanf(p_trg_blockno
, "%02x", &trgBlockNo
);
509 sscanf(p_trg_keytype
, "%x", &trgKeyType
);
510 sscanf(p_nonce_file_read
, "%x", &nonce_file_read
);
511 sscanf(p_nonce_file_write
, "%x", &nonce_file_write
);
513 sscanf(p_slow
, "%x", &slow
);
514 sscanf(p_tests
, "%x", &tests
);
516 uint8_t key
[6] = {0,0,0,0,0,0};
517 uint8_t trgkey
[6] = {0,0,0,0,0,0};
518 for (int i
= 0; i
< 32; i
+= 2) {
519 sscanf(&p_key
[i
], "%02x", (unsigned int *)&key
[i
/ 2]);
521 sscanf(&p_trgkey
[i
], "%02x", (unsigned int *)&trgkey
[i
/ 2]);
524 uint64_t foundkey
= 0;
525 int retval
= mfnestedhard(blockNo
, keyType
, key
, trgBlockNo
, trgKeyType
, haveTarget
? trgkey
: NULL
, nonce_file_read
, nonce_file_write
, slow
, tests
, &foundkey
);
527 //Push the retval on the stack
528 lua_pushinteger(L
,retval
);
530 //Push the key onto the stack
532 num_to_bytes(foundkey
, sizeof(dest_key
), dest_key
);
534 //printf("Pushing to lua stack: %012"llx"\n",key);
535 lua_pushlstring(L
, (const char *) dest_key
, sizeof(dest_key
));
536 return 2; //Two return values
540 * @brief Sets the lua path to include "./lualibs/?.lua", in order for a script to be
541 * able to do "require('foobar')" if foobar.lua is within lualibs folder.
542 * Taken from http://stackoverflow.com/questions/4125971/setting-the-global-lua-path-variable-from-c-c
547 int setLuaPath( lua_State
* L
, const char* path
)
549 lua_getglobal( L
, "package" );
550 lua_getfield( L
, -1, "path" ); // get field "path" from table at top of stack (-1)
551 const char* cur_path
= lua_tostring( L
, -1 ); // grab path string from top of stack
552 int requiredLength
= strlen(cur_path
)+ strlen(path
)+10; //A few bytes too many, whatever we can afford it
553 char * buf
= malloc(requiredLength
);
554 snprintf(buf
, requiredLength
, "%s;%s", cur_path
, path
);
555 lua_pop( L
, 1 ); // get rid of the string on the stack we just pushed on line 5
556 lua_pushstring( L
, buf
); // push the new one
557 lua_setfield( L
, -2, "path" ); // set the field "path" in table at -2 with value at top of stack
558 lua_pop( L
, 1 ); // get rid of package table from top of stack
560 return 0; // all done!
563 int set_pm3_libraries(lua_State
*L
)
565 static const luaL_Reg libs
[] = {
566 {"SendCommand", l_SendCommand
},
567 {"WaitForResponseTimeout", l_WaitForResponseTimeout
},
568 {"nonce2key", l_nonce2key
},
569 //{"PrintAndLog", l_PrintAndLog},
570 {"foobar", l_foobar
},
571 {"ukbhit", l_ukbhit
},
572 {"clearCommandBuffer", l_clearCommandBuffer
},
573 {"console", l_CmdConsole
},
574 {"iso15693_crc", l_iso15693_crc
},
575 {"iso14443b_crc", l_iso14443b_crc
},
576 {"aes128_decrypt", l_aes128decrypt_cbc
},
577 {"aes128_decrypt_ecb", l_aes128decrypt_ecb
},
578 {"aes128_encrypt", l_aes128encrypt_cbc
},
579 {"aes128_encrypt_ecb", l_aes128encrypt_ecb
},
580 {"crc8legic", l_crc8legic
},
584 {"reveng_models", l_reveng_models
},
585 {"reveng_runmodel", l_reveng_RunModel
},
586 {"hardnested", l_hardnested
},
590 lua_pushglobaltable(L
);
591 // Core library is in this table. Contains '
592 //this is 'pm3' table
595 //Put the function into the hash table.
596 for (int i
= 0; libs
[i
].name
; i
++) {
597 lua_pushcfunction(L
, libs
[i
].func
);
598 lua_setfield(L
, -2, libs
[i
].name
);//set the name, pop stack
601 lua_setfield(L
, -2, "core");
603 //-- remove the global environment table from the stack
606 //-- Last but not least, add to the LUA_PATH (package.path in lua)
607 // so we can load libraries from the ./lualib/ - directory
608 setLuaPath(L
,"./lualibs/?.lua");