]> cvs.zerfleddert.de Git - proxmark3-svn/blame - client/scripting.c
Moved script libraries into lualibs/folder, and added a patch to include the folder...
[proxmark3-svn] / client / scripting.c
CommitLineData
5b760b6c 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"
44fffc54 18#include "util.h"
5b760b6c 19/**
20 * The following params expected:
21 * UsbCommand c
22 *@brief l_SendCommand
23 * @param L
24 * @return
25 */
26static int l_SendCommand(lua_State *L){
27
28 /*
29 *
30 The SendCommand (native) expects the following structure:
31
32 typedef struct {
33 uint64_t cmd; //8 bytes
34 uint64_t arg[3]; // 8*3 bytes = 24 bytes
35 union {
36 uint8_t asBytes[USB_CMD_DATA_SIZE]; // 1 byte * 512 = 512 bytes (OR)
37 uint32_t asDwords[USB_CMD_DATA_SIZE/4]; // 4 byte * 128 = 512 bytes
38 } d;
39 } PACKED UsbCommand;
40
41 ==> A 544 byte buffer will do.
42 **/
43 //Pop cmd
96e7a3a5 44 size_t size;
45 const char *data = luaL_checklstring(L, 1, &size);
46 if(size != sizeof(UsbCommand))
47 {
f057bddb 48 printf("Got data size %d, expected %d" , (int) size,(int) sizeof(UsbCommand));
96e7a3a5 49 lua_pushstring(L,"Wrong data size");
50 return 1;
51 }
52
53// UsbCommand c = (*data);
42daa759 54 SendCommand((UsbCommand* )data);
44fffc54 55 return 0; // no return values
5b760b6c 56}
57/**
58 * @brief The following params expected:
59 * uint32_t cmd
60 * size_t ms_timeout
61 * @param L
62 * @return
63 */
64static int l_WaitForResponseTimeout(lua_State *L){
65
44fffc54 66 uint32_t cmd = 0;
67 size_t ms_timeout = -1;
5b760b6c 68
44fffc54 69 //Check number of arguments
70 int n = lua_gettop(L);
71 if(n == 0)
5b760b6c 72 {
44fffc54 73 //signal error by returning Nil, errorstring
74 lua_pushnil(L);
75 lua_pushstring(L,"You need to supply at least command to wait for");
76 return 2; // two return values
77 }
78 if(n >= 1)
79 {
80 //pop cmd
81 cmd = luaL_checkunsigned(L,1);
82 }
83 if(n >= 2)
84 {
85 //Did the user send a timeout ?
86 //Check if the current top of stack is an integer
5b760b6c 87 ms_timeout = luaL_checkunsigned(L,2);
44fffc54 88 //printf("Timeout set to %dms\n" , (int) ms_timeout);
5b760b6c 89 }
5b760b6c 90
44fffc54 91 UsbCommand response;
92
93 if(WaitForResponseTimeout(cmd, &response, ms_timeout))
5b760b6c 94 {
44fffc54 95 //Push it as a string
42daa759 96 lua_pushlstring(L,(const char *)&response,sizeof(UsbCommand));
44fffc54 97
98 return 1;// return 1 to signal one return value
99 }else{
5b760b6c 100 //Push a Nil instead
101 lua_pushnil(L);
44fffc54 102 return 1;// one return value
5b760b6c 103 }
104}
42daa759 105//static int l_nonce2key(lua_State *L){ return CmdHF14AMfRdSc(luaL_checkstring(L, 1));}
106//static int l_PrintAndLog(lua_State *L){ return CmdHF14AMfDump(luaL_checkstring(L, 1));}
44fffc54 107static int l_clearCommandBuffer(lua_State *L){
108 clearCommandBuffer();
42daa759 109 return 0;
44fffc54 110}
111/**
112 * @brief l_foobar is a dummy function to test lua-integration with
113 * @param L
114 * @return
115 */
116static int l_foobar(lua_State *L)
117{
118 //Check number of arguments
119 int n = lua_gettop(L);
120 printf("foobar called with %d arguments" , n);
121 lua_settop(L, 0);
122 printf("Arguments discarded, stack now contains %d elements", lua_gettop(L));
123 UsbCommand response = {CMD_MIFARE_READBL, {1337, 1338, 1339}};
124 printf("Now returning a UsbCommand as a string");
42daa759 125 lua_pushlstring(L,(const char *)&response,sizeof(UsbCommand));
44fffc54 126 return 1;
127}
128
129/**
130 * @brief Utility to check if a key has been pressed by the user. This method does not block.
131 * @param L
132 * @return boolean, true if kbhit, false otherwise.
133 */
134static int l_ukbhit(lua_State *L)
135{
136 lua_pushboolean(L,ukbhit() ? true : false);
137 return 1;
138}
5b760b6c 139
686f0a17 140/**
141 * @brief Sets the lua path to include "./lualibs/?.lua", in order for a script to be
142 * able to do "require('foobar')" if foobar.lua is within lualibs folder.
143 * Taken from http://stackoverflow.com/questions/4125971/setting-the-global-lua-path-variable-from-c-c
144 * @param L
145 * @param path
146 * @return
147 */
148int setLuaPath( lua_State* L, const char* path )
149{
150 lua_getglobal( L, "package" );
151 lua_getfield( L, -1, "path" ); // get field "path" from table at top of stack (-1)
152 const char* cur_path = lua_tostring( L, -1 ); // grab path string from top of stack
153 int requiredLength = strlen(cur_path)+ strlen(path)+10; //A few bytes too many, whatever we can afford it
154 char * buf = malloc(requiredLength);
155 snprintf(buf, requiredLength, "%s;%s", cur_path, path);
156 lua_pop( L, 1 ); // get rid of the string on the stack we just pushed on line 5
157 lua_pushstring( L, buf ); // push the new one
158 lua_setfield( L, -2, "path" ); // set the field "path" in table at -2 with value at top of stack
159 lua_pop( L, 1 ); // get rid of package table from top of stack
160 return 0; // all done!
161}
162
163
f057bddb 164int set_pm3_libraries(lua_State *L)
5b760b6c 165{
686f0a17 166
5b760b6c 167 static const luaL_Reg libs[] = {
168 {"SendCommand", l_SendCommand},
169 {"WaitForResponseTimeout", l_WaitForResponseTimeout},
42daa759 170 //{"nonce2key", l_nonce2key},
171 //{"PrintAndLog", l_PrintAndLog},
44fffc54 172 {"foobar", l_foobar},
173 {"ukbhit", l_ukbhit},
174 {"clearCommandBuffer", l_clearCommandBuffer},
5b760b6c 175 {NULL, NULL}
176 };
177
178 lua_pushglobaltable(L);
179 // Core library is in this table. Contains '
180 //this is 'pm3' table
181 lua_newtable(L);
182
183 //Put the function into the hash table.
184 for (int i = 0; libs[i].name; i++) {
185 lua_pushcfunction(L, libs[i].func);
186 lua_setfield(L, -2, libs[i].name);//set the name, pop stack
187 }
188 //Name of 'core'
189 lua_setfield(L, -2, "core");
190
191 //-- remove the global environment table from the stack
192 lua_pop(L, 1);
686f0a17 193
194 //-- Last but not least, add to the LUA_PATH (package.path in lua)
195 // so we can load libraries from the ./lualib/ - directory
196 setLuaPath(L,"./lualibs/?.lua");
197
5b760b6c 198 return 1;
199}
Impressum, Datenschutz