1 //-----------------------------------------------------------------------------
2 // Copyright (C) 2009 Michael Gernoth <michael at gernoth.net>
3 // Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
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 //-----------------------------------------------------------------------------
10 //-----------------------------------------------------------------------------
17 #include <readline/readline.h>
18 #include <readline/history.h>
20 #include "proxmark3.h"
21 #include "util_posix.h"
27 #include "cmdparser.h"
32 #define SERIAL_PORT_H "com3"
34 #define SERIAL_PORT_H "/dev/ttyACM0"
37 // a global mutex to prevent interlaced printing from different threads
38 pthread_mutex_t print_lock
;
40 static serial_port sp
;
41 static UsbCommand txcmd
;
42 volatile static bool txcmd_pending
= false;
44 void SendCommand(UsbCommand
*c
) {
46 printf("Sending %d bytes\n", sizeof(UsbCommand
));
50 PrintAndLog("Sending bytes to proxmark failed - offline");
54 The while-loop below causes hangups at times, when the pm3 unit is unresponsive
55 or disconnected. The main console thread is alive, but comm thread just spins here.
67 byte_t rx
[sizeof(UsbCommand
)];
72 #ifdef __has_attribute
73 #if __has_attribute(force_align_arg_pointer)
74 __attribute__((force_align_arg_pointer
))
77 *uart_receiver(void *targ
) {
78 struct receiver_arg
*arg
= (struct receiver_arg
*)targ
;
83 if (uart_receive(sp
, prx
, sizeof(UsbCommand
) - (prx
-rx
), &rxlen
) && rxlen
) {
85 if (prx
-rx
< sizeof(UsbCommand
)) {
88 UsbCommandReceived((UsbCommand
*)rx
);
93 if (!uart_send(sp
, (byte_t
*) &txcmd
, sizeof(UsbCommand
))) {
94 PrintAndLog("Sending bytes to proxmark failed");
96 txcmd_pending
= false;
106 #ifdef __has_attribute
107 #if __has_attribute(force_align_arg_pointer)
108 __attribute__((force_align_arg_pointer
))
111 main_loop(char *script_cmds_file
, char *script_cmd
, bool usb_present
) {
112 struct receiver_arg rarg
;
114 pthread_t reader_thread
;
115 bool execCommand
= (script_cmd
!= NULL
);
116 bool stdinOnPipe
= !isatty(STDIN_FILENO
);
120 pthread_create(&reader_thread
, NULL
, &uart_receiver
, &rarg
);
121 // cache Version information now:
126 FILE *script_file
= NULL
;
127 char script_cmd_buf
[256] = {0}; // iceman, needs lua script the same file_path_buffer as the rest
129 if (script_cmds_file
) {
130 script_file
= fopen(script_cmds_file
, "r");
132 printf("executing commands from file: %s\n", script_cmds_file
);
136 read_history(".history");
139 // If there is a script file
142 memset(script_cmd_buf
, 0, sizeof(script_cmd_buf
));
143 if (!fgets(script_cmd_buf
, sizeof(script_cmd_buf
), script_file
)) {
147 strcleanrn(script_cmd_buf
, sizeof(script_cmd_buf
));
149 if ((cmd
= strmcopy(script_cmd_buf
)) != NULL
) {
150 printf(PROXPROMPT
"%s\n", cmd
);
154 // If there is a script command
156 if ((cmd
= strmcopy(script_cmd
)) != NULL
) {
157 printf(PROXPROMPT
"%s\n", cmd
);
162 // exit after exec command
166 // if there is a pipe from stdin
168 memset(script_cmd_buf
, 0, sizeof(script_cmd_buf
));
169 if (!fgets(script_cmd_buf
, sizeof(script_cmd_buf
), stdin
)) {
170 printf("\nStdin end. Exit...\n");
173 strcleanrn(script_cmd_buf
, sizeof(script_cmd_buf
));
175 if ((cmd
= strmcopy(script_cmd_buf
)) != NULL
) {
176 printf(PROXPROMPT
"%s\n", cmd
);
180 // read command from command prompt
181 cmd
= readline(PROXPROMPT
);
189 while(cmd
[strlen(cmd
) - 1] == ' ')
190 cmd
[strlen(cmd
) - 1] = 0x00;
192 if (cmd
[0] != 0x00) {
193 int ret
= CommandReceived(cmd
);
195 if (ret
== 99) { // exit or quit
207 write_history(".history");
211 pthread_join(reader_thread
, NULL
);
220 static void dumpAllHelp(int markdown
)
222 printf("\n%sProxmark3 command dump%s\n\n",markdown
?"# ":"",markdown
?"":"\n======================");
223 printf("Some commands are available only if a Proxmark is actually connected.%s\n",markdown
?" ":"");
224 printf("Check column \"offline\" for their availability.\n");
226 command_t
*cmds
= getTopLevelCommandTable();
227 dumpCommandsRecursive(cmds
, markdown
);
230 static char *my_executable_path
= NULL
;
231 static char *my_executable_directory
= NULL
;
233 const char *get_my_executable_path(void)
235 return my_executable_path
;
238 const char *get_my_executable_directory(void)
240 return my_executable_directory
;
243 static void set_my_executable_path(void)
245 int path_length
= wai_getExecutablePath(NULL
, 0, NULL
);
246 if (path_length
!= -1) {
247 my_executable_path
= (char*)malloc(path_length
+ 1);
248 int dirname_length
= 0;
249 if (wai_getExecutablePath(my_executable_path
, path_length
, &dirname_length
) != -1) {
250 my_executable_path
[path_length
] = '\0';
251 my_executable_directory
= (char *)malloc(dirname_length
+ 2);
252 strncpy(my_executable_directory
, my_executable_path
, dirname_length
+1);
253 my_executable_directory
[dirname_length
+1] = '\0';
258 static void show_help(bool showFullHelp
, char *command_line
){
259 printf("syntax: %s <port> [-h|-help|-m|-f|-flush|-w|-wait|-c|-command|-l|-lua] [cmd_script_file_name] [command][lua_script_name]\n", command_line
);
260 printf("\tLinux example:'%s /dev/ttyACM0'\n", command_line
);
261 printf("\tWindows example:'%s com3'\n\n", command_line
);
264 printf("help: <-h|-help> Dump all interactive command's help at once.\n");
265 printf("\t%s -h\n\n", command_line
);
266 printf("markdown: <-m> Dump all interactive help at once in markdown syntax\n");
267 printf("\t%s -m\n\n", command_line
);
268 printf("flush: <-f|-flush> Output will be flushed after every print.\n");
269 printf("\t%s -f\n\n", command_line
);
270 printf("wait: <-w|-wait> 20sec waiting the serial port to appear in the OS\n");
271 printf("\t%s "SERIAL_PORT_H
" -w\n\n", command_line
);
272 printf("script: A script file with one proxmark3 command per line.\n\n");
273 printf("command: <-c|-command> Execute one proxmark3 command.\n");
274 printf("\t%s "SERIAL_PORT_H
" -c \"hf mf chk 1* ?\"\n", command_line
);
275 printf("\t%s "SERIAL_PORT_H
" -command \"hf mf nested 1 *\"\n\n", command_line
);
276 printf("lua: <-l|-lua> Execute lua script.\n");
277 printf("\t%s "SERIAL_PORT_H
" -l hf_read\n\n", command_line
);
281 int main(int argc
, char* argv
[]) {
284 bool usb_present
= false;
285 bool waitCOMPort
= false;
286 bool executeCommand
= false;
287 bool addLuaExec
= false;
288 char *script_cmds_file
= NULL
;
289 char *script_cmd
= NULL
;
292 show_help(true, argv
[0]);
296 for (int i
= 1; i
< argc
; i
++) {
297 if (strcmp(argv
[i
], "-h") == 0 || strcmp(argv
[i
],"-help") == 0) {
298 show_help(false, argv
[0]);
303 if (strcmp(argv
[i
], "-m") == 0) {
308 if(strcmp(argv
[i
],"-f") == 0 || strcmp(argv
[i
],"-flush") == 0){
309 printf("Output will be flushed after every print.\n");
313 if(strcmp(argv
[i
],"-w") == 0 || strcmp(argv
[i
],"-wait") == 0){
317 if(strcmp(argv
[i
],"-c") == 0 || strcmp(argv
[i
],"-command") == 0){
318 executeCommand
= true;
321 if(strcmp(argv
[i
],"-l") == 0 || strcmp(argv
[i
],"-lua") == 0){
322 executeCommand
= true;
327 // If the user passed the filename of the 'script' to execute, get it from last parameter
328 if (argc
> 2 && argv
[argc
- 1] && argv
[argc
- 1][0] != '-') {
330 script_cmd
= argv
[argc
- 1];
332 while(script_cmd
[strlen(script_cmd
) - 1] == ' ')
333 script_cmd
[strlen(script_cmd
) - 1] = 0x00;
335 if (strlen(script_cmd
) == 0) {
339 // add "script run " to command
341 int len
= strlen(script_cmd
) + 11 + 1;
342 if ((ctmp
= (char*) malloc(len
)) != NULL
) {
343 memset(ctmp
, 0, len
);
344 strcpy(ctmp
, "script run ");
345 strcpy(&ctmp
[11], script_cmd
);
350 printf("Execute command from commandline: %s\n", script_cmd
);
353 script_cmds_file
= argv
[argc
- 1];
358 if (executeCommand
&& (!script_cmd
|| strlen(script_cmd
) == 0)){
359 printf("ERROR: execute command: command not found.\n");
363 // set global variables
364 set_my_executable_path();
368 sp
= uart_open(argv
[1]);
370 printf("Waiting for Proxmark to appear on %s ", argv
[1]);
374 sp
= uart_open(argv
[1]);
378 } while(++openCount
< 20 && (sp
== INVALID_SERIAL_PORT
|| sp
== CLAIMED_SERIAL_PORT
));
382 // check result of uart opening
383 if (sp
== INVALID_SERIAL_PORT
) {
384 printf("ERROR: invalid serial port\n");
387 } else if (sp
== CLAIMED_SERIAL_PORT
) {
388 printf("ERROR: serial port is claimed by another process\n");
396 // create a mutex to avoid interlacing print commands from our different threads
397 pthread_mutex_init(&print_lock
, NULL
);
401 InitGraphics(argc
, argv
, script_cmds_file
, script_cmd
, usb_present
);
404 char* display
= getenv("DISPLAY");
406 if (display
&& strlen(display
) > 1)
408 InitGraphics(argc
, argv
, script_cmds_file
, script_cmd
, usb_present
);
413 main_loop(script_cmds_file
, script_cmd
, usb_present
);
417 main_loop(script_cmds_file
, script_cmd
, usb_present
);
426 pthread_mutex_destroy(&print_lock
);