]> cvs.zerfleddert.de Git - proxmark3-svn/blame - client/proxmark3.c
fix: usage and sample text of hf mf cwipe
[proxmark3-svn] / client / proxmark3.c
CommitLineData
a553f267 1//-----------------------------------------------------------------------------
212ef3a0 2// Copyright (C) 2009 Michael Gernoth <michael at gernoth.net>
a553f267 3// Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
4//
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
7// the license.
8//-----------------------------------------------------------------------------
9// Main binary
10//-----------------------------------------------------------------------------
11
6658905f 12#include <stdio.h>
590f8ff9 13#include <stdlib.h>
6658905f 14#include <string.h>
7fe9b0b7 15#include <pthread.h>
8556b852 16#include <unistd.h>
6658905f 17#include <readline/readline.h>
18#include <readline/history.h>
9484ff3d 19
6658905f 20#include "proxmark3.h"
aa757f71 21#include "util_posix.h"
6658905f 22#include "proxgui.h"
7fe9b0b7 23#include "cmdmain.h"
902cb3c0 24#include "uart.h"
902cb3c0 25#include "ui.h"
aa757f71 26#include "util.h"
57c69556 27#include "cmdparser.h"
8e074056 28#include "cmdhw.h"
4197a3f6 29#include "whereami.h"
30
aa757f71
OM
31#ifdef _WIN32
32#define SERIAL_PORT_H "com3"
33#else
34#define SERIAL_PORT_H "/dev/ttyACM0"
35#endif
902cb3c0 36
3851172d 37// a global mutex to prevent interlaced printing from different threads
38pthread_mutex_t print_lock;
39
40static serial_port sp;
41static UsbCommand txcmd;
42volatile static bool txcmd_pending = false;
43
44void SendCommand(UsbCommand *c) {
45 #if 0
46 printf("Sending %d bytes\n", sizeof(UsbCommand));
47 #endif
48
49 if (offline) {
50 PrintAndLog("Sending bytes to proxmark failed - offline");
51 return;
52 }
53 /**
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.
56 Not good.../holiman
57 **/
58 while(txcmd_pending);
59 txcmd = *c;
60 txcmd_pending = true;
61}
62
63struct receiver_arg {
64 int run;
65};
66
67byte_t rx[sizeof(UsbCommand)];
68byte_t* prx = rx;
69
70static void *uart_receiver(void *targ) {
71 struct receiver_arg *arg = (struct receiver_arg*)targ;
72 size_t rxlen;
73
74 while (arg->run) {
75 rxlen = 0;
76 if (uart_receive(sp, prx, sizeof(UsbCommand) - (prx-rx), &rxlen) && rxlen) {
77 prx += rxlen;
78 if (prx-rx < sizeof(UsbCommand)) {
79 continue;
80 }
81 UsbCommandReceived((UsbCommand*)rx);
82 }
83 prx = rx;
afdcb8c1 84
3851172d 85 if(txcmd_pending) {
86 if (!uart_send(sp, (byte_t*) &txcmd, sizeof(UsbCommand))) {
87 PrintAndLog("Sending bytes to proxmark failed");
88 }
89 txcmd_pending = false;
90 }
91 }
afdcb8c1 92
3851172d 93 pthread_exit(NULL);
94 return NULL;
95}
afdcb8c1 96
afdcb8c1 97
3851172d 98void main_loop(char *script_cmds_file, char *script_cmd, bool usb_present) {
99 struct receiver_arg rarg;
100 char *cmd = NULL;
101 pthread_t reader_thread;
102 bool execCommand = (script_cmd != NULL);
103 bool stdinOnPipe = !isatty(STDIN_FILENO);
104
5acd195d 105 if (usb_present) {
3851172d 106 rarg.run = 1;
107 pthread_create(&reader_thread, NULL, &uart_receiver, &rarg);
8e074056 108 // cache Version information now:
109 CmdVersion(NULL);
9484ff3d 110 }
111
aa757f71 112 // file with script
9484ff3d 113 FILE *script_file = NULL;
aa757f71 114 char script_cmd_buf[256] = {0}; // iceman, needs lua script the same file_path_buffer as the rest
9484ff3d 115
5acd195d 116 if (script_cmds_file) {
117 script_file = fopen(script_cmds_file, "r");
9484ff3d 118 if (script_file) {
aa757f71 119 printf("executing commands from file: %s\n", script_cmds_file);
9484ff3d 120 }
121 }
aa757f71 122
8556b852 123 read_history(".history");
9484ff3d 124
3851172d 125 while(1) {
9484ff3d 126 // If there is a script file
127 if (script_file)
1f947c4b 128 {
aa757f71 129 memset(script_cmd_buf, 0, sizeof(script_cmd_buf));
9484ff3d 130 if (!fgets(script_cmd_buf, sizeof(script_cmd_buf), script_file)) {
131 fclose(script_file);
132 script_file = NULL;
133 } else {
aa757f71 134 strcleanrn(script_cmd_buf, sizeof(script_cmd_buf));
9484ff3d 135
aa757f71
OM
136 if ((cmd = strmcopy(script_cmd_buf)) != NULL) {
137 printf(PROXPROMPT"%s\n", cmd);
138 }
139 }
140 } else {
141 // If there is a script command
142 if (execCommand){
143 if ((cmd = strmcopy(script_cmd)) != NULL) {
144 printf(PROXPROMPT"%s\n", cmd);
145 }
146
147 execCommand = false;
148 } else {
149 // exit after exec command
150 if (script_cmd)
151 break;
152
153 // if there is a pipe from stdin
154 if (stdinOnPipe) {
155 memset(script_cmd_buf, 0, sizeof(script_cmd_buf));
156 if (!fgets(script_cmd_buf, sizeof(script_cmd_buf), stdin)) {
157 printf("\nStdin end. Exit...\n");
158 break;
159 }
160 strcleanrn(script_cmd_buf, sizeof(script_cmd_buf));
161
162 if ((cmd = strmcopy(script_cmd_buf)) != NULL) {
163 printf(PROXPROMPT"%s\n", cmd);
164 }
165
166 } else {
167 // read command from command prompt
168 cmd = readline(PROXPROMPT);
9484ff3d 169 }
170 }
1f947c4b 171 }
172
aa757f71 173 // execute command
8556b852 174 if (cmd) {
9484ff3d 175
8556b852 176 while(cmd[strlen(cmd) - 1] == ' ')
9484ff3d 177 cmd[strlen(cmd) - 1] = 0x00;
8556b852
M
178
179 if (cmd[0] != 0x00) {
2487dfeb 180 int ret = CommandReceived(cmd);
181 add_history(cmd);
182 if (ret == 99) { // exit or quit
8556b852
M
183 break;
184 }
8556b852
M
185 }
186 free(cmd);
aa757f71 187 cmd = NULL;
8556b852
M
188 } else {
189 printf("\n");
190 break;
191 }
192 }
aa757f71 193
51969283 194 write_history(".history");
902cb3c0 195
5acd195d 196 if (usb_present) {
3851172d 197 rarg.run = 0;
9484ff3d 198 pthread_join(reader_thread, NULL);
199 }
1a3c0064 200
9484ff3d 201 if (script_file) {
202 fclose(script_file);
203 script_file = NULL;
204 }
6658905f 205}
206
dec8e8bd 207static void dumpAllHelp(int markdown)
ae7aa73d 208{
dec8e8bd
PT
209 printf("\n%sProxmark3 command dump%s\n\n",markdown?"# ":"",markdown?"":"\n======================");
210 printf("Some commands are available only if a Proxmark is actually connected.%s\n",markdown?" ":"");
6f5dd601 211 printf("Check column \"offline\" for their availability.\n");
ae7aa73d 212 printf("\n");
57c69556 213 command_t *cmds = getTopLevelCommandTable();
dec8e8bd 214 dumpCommandsRecursive(cmds, markdown);
ae7aa73d
PT
215}
216
4197a3f6 217static char *my_executable_path = NULL;
218static char *my_executable_directory = NULL;
219
4a6bc37e 220const char *get_my_executable_path(void)
4197a3f6 221{
222 return my_executable_path;
223}
224
4a6bc37e 225const char *get_my_executable_directory(void)
4197a3f6 226{
227 return my_executable_directory;
228}
229
230static void set_my_executable_path(void)
231{
232 int path_length = wai_getExecutablePath(NULL, 0, NULL);
233 if (path_length != -1) {
234 my_executable_path = (char*)malloc(path_length + 1);
235 int dirname_length = 0;
236 if (wai_getExecutablePath(my_executable_path, path_length, &dirname_length) != -1) {
237 my_executable_path[path_length] = '\0';
238 my_executable_directory = (char *)malloc(dirname_length + 2);
239 strncpy(my_executable_directory, my_executable_path, dirname_length+1);
4a6bc37e 240 my_executable_directory[dirname_length+1] = '\0';
4197a3f6 241 }
242 }
243}
244
aa757f71
OM
245static void show_help(bool showFullHelp, char *command_line){
246 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);
247 printf("\tLinux example:'%s /dev/ttyACM0'\n", command_line);
248 printf("\tWindows example:'%s com3'\n\n", command_line);
249
250 if (showFullHelp){
251 printf("help: <-h|-help> Dump all interactive command's help at once.\n");
252 printf("\t%s -h\n\n", command_line);
253 printf("markdown: <-m> Dump all interactive help at once in markdown syntax\n");
254 printf("\t%s -m\n\n", command_line);
255 printf("flush: <-f|-flush> Output will be flushed after every print.\n");
256 printf("\t%s -f\n\n", command_line);
257 printf("wait: <-w|-wait> 20sec waiting the serial port to appear in the OS\n");
258 printf("\t%s "SERIAL_PORT_H" -w\n\n", command_line);
259 printf("script: A script file with one proxmark3 command per line.\n\n");
260 printf("command: <-c|-command> Execute one proxmark3 command.\n");
261 printf("\t%s "SERIAL_PORT_H" -c \"hf mf chk 1* ?\"\n", command_line);
262 printf("\t%s "SERIAL_PORT_H" -command \"hf mf nested 1 *\"\n\n", command_line);
263 printf("lua: <-l|-lua> Execute lua script.\n");
264 printf("\t%s "SERIAL_PORT_H" -l hf_read\n\n", command_line);
265 }
266}
5acd195d 267
902cb3c0 268int main(int argc, char* argv[]) {
9492e0b0 269 srand(time(0));
125a98a1 270
aa757f71
OM
271 bool usb_present = false;
272 bool waitCOMPort = false;
273 bool executeCommand = false;
274 bool addLuaExec = false;
275 char *script_cmds_file = NULL;
276 char *script_cmd = NULL;
277
9492e0b0 278 if (argc < 2) {
aa757f71 279 show_help(true, argv[0]);
9492e0b0 280 return 1;
281 }
aa757f71
OM
282
283 for (int i = 1; i < argc; i++) {
284 if (strcmp(argv[i], "-h") == 0 || strcmp(argv[i],"-help") == 0) {
285 show_help(false, argv[0]);
286 dumpAllHelp(0);
287 return 0;
288 }
289
290 if (strcmp(argv[i], "-m") == 0) {
291 dumpAllHelp(1);
292 return 0;
293 }
294
295 if(strcmp(argv[i],"-f") == 0 || strcmp(argv[i],"-flush") == 0){
296 printf("Output will be flushed after every print.\n");
297 flushAfterWrite = 1;
298 }
299
300 if(strcmp(argv[i],"-w") == 0 || strcmp(argv[i],"-wait") == 0){
301 waitCOMPort = true;
302 }
303
304 if(strcmp(argv[i],"-c") == 0 || strcmp(argv[i],"-command") == 0){
305 executeCommand = true;
306 }
307
308 if(strcmp(argv[i],"-l") == 0 || strcmp(argv[i],"-lua") == 0){
309 executeCommand = true;
310 addLuaExec = true;
311 }
dec8e8bd 312 }
aa757f71
OM
313
314 // If the user passed the filename of the 'script' to execute, get it from last parameter
315 if (argc > 2 && argv[argc - 1] && argv[argc - 1][0] != '-') {
316 if (executeCommand){
317 script_cmd = argv[argc - 1];
318
319 while(script_cmd[strlen(script_cmd) - 1] == ' ')
320 script_cmd[strlen(script_cmd) - 1] = 0x00;
321
322 if (strlen(script_cmd) == 0) {
323 script_cmd = NULL;
324 } else {
325 if (addLuaExec){
326 // add "script run " to command
327 char *ctmp = NULL;
328 int len = strlen(script_cmd) + 11 + 1;
329 if ((ctmp = (char*) malloc(len)) != NULL) {
330 memset(ctmp, 0, len);
331 strcpy(ctmp, "script run ");
332 strcpy(&ctmp[11], script_cmd);
333 script_cmd = ctmp;
334 }
335 }
336
337 printf("Execute command from commandline: %s\n", script_cmd);
338 }
339 } else {
340 script_cmds_file = argv[argc - 1];
341 }
dec8e8bd 342 }
4197a3f6 343
aa757f71
OM
344 // check command
345 if (executeCommand && (!script_cmd || strlen(script_cmd) == 0)){
346 printf("ERROR: execute command: command not found.\n");
347 return 2;
348 }
349
350 // set global variables
4197a3f6 351 set_my_executable_path();
352
aa757f71
OM
353 // open uart
354 if (!waitCOMPort) {
355 sp = uart_open(argv[1]);
356 } else {
357 printf("Waiting for Proxmark to appear on %s ", argv[1]);
8a50d606 358 fflush(stdout);
aa757f71
OM
359 int openCount = 0;
360 do {
361 sp = uart_open(argv[1]);
362 msleep(1000);
363 printf(".");
8a50d606 364 fflush(stdout);
aa757f71
OM
365 } while(++openCount < 20 && (sp == INVALID_SERIAL_PORT || sp == CLAIMED_SERIAL_PORT));
366 printf("\n");
367 }
368
369 // check result of uart opening
9492e0b0 370 if (sp == INVALID_SERIAL_PORT) {
371 printf("ERROR: invalid serial port\n");
5acd195d 372 usb_present = false;
3851172d 373 offline = 1;
9492e0b0 374 } else if (sp == CLAIMED_SERIAL_PORT) {
375 printf("ERROR: serial port is claimed by another process\n");
5acd195d 376 usb_present = false;
3851172d 377 offline = 1;
9492e0b0 378 } else {
5acd195d 379 usb_present = true;
3851172d 380 offline = 0;
9492e0b0 381 }
aa757f71 382
9492e0b0 383 // create a mutex to avoid interlacing print commands from our different threads
384 pthread_mutex_init(&print_lock, NULL);
7fe9b0b7 385
5acd195d 386#ifdef HAVE_GUI
c6c04491 387#ifdef _WIN32
3851172d 388 InitGraphics(argc, argv, script_cmds_file, script_cmd, usb_present);
9492e0b0 389 MainGraphics();
c6c04491 390#else
391 char* display = getenv("DISPLAY");
392
393 if (display && strlen(display) > 1)
394 {
3851172d 395 InitGraphics(argc, argv, script_cmds_file, script_cmd, usb_present);
c6c04491 396 MainGraphics();
397 }
398 else
399 {
3851172d 400 main_loop(script_cmds_file, script_cmd, usb_present);
c6c04491 401 }
402#endif
5acd195d 403#else
3851172d 404 main_loop(script_cmds_file, script_cmd, usb_present);
5acd195d 405#endif
7fe9b0b7 406
9492e0b0 407 // Clean up the port
5acd195d 408 if (usb_present) {
2487dfeb 409 uart_close(sp);
410 }
411
9492e0b0 412 // clean up mutex
413 pthread_mutex_destroy(&print_lock);
2487dfeb 414
415 exit(0);
6658905f 416}
Impressum, Datenschutz