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