add: save and load options in hf list (#577)
[proxmark3-svn] / client / cmdhf.c
1 //-----------------------------------------------------------------------------
2 // Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
3 // Merlok - 2017
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 // High frequency commands
10 //-----------------------------------------------------------------------------
11
12 #include <stdlib.h>
13 #include <stdio.h>
14 #include <string.h>
15 #include "proxmark3.h"
16 #include "util.h"
17 #include "data.h"
18 #include "ui.h"
19 #include "iso14443crc.h"
20 #include "parity.h"
21 #include "cmdmain.h"
22 #include "cmdparser.h"
23 #include "cmdhf.h"
24 #include "cmdhf14a.h"
25 #include "cmdhf14b.h"
26 #include "cmdhf15.h"
27 #include "cmdhfepa.h"
28 #include "cmdhflegic.h"
29 #include "cmdhficlass.h"
30 #include "cmdhfmf.h"
31 #include "cmdhfmfu.h"
32 #include "cmdhftopaz.h"
33 #include "protocols.h"
34 #include "emv/cmdemv.h"
35 #include "cmdhflist.h"
36
37 static int CmdHelp(const char *Cmd);
38
39 int CmdHFTune(const char *Cmd)
40 {
41 UsbCommand c={CMD_MEASURE_ANTENNA_TUNING_HF};
42 SendCommand(&c);
43 return 0;
44 }
45
46 /**
47 * @brief iso14443B_CRC_check Checks CRC in command or response
48 * @param isResponse
49 * @param data
50 * @param len
51 * @return 0 : CRC-command, CRC not ok
52 * 1 : CRC-command, CRC ok
53 * 2 : Not crc-command
54 */
55
56 uint8_t iso14443B_CRC_check(bool isResponse, uint8_t* data, uint8_t len)
57 {
58 uint8_t b1,b2;
59
60 if(len <= 2) return 2;
61
62 ComputeCrc14443(CRC_14443_B, data, len-2, &b1, &b2);
63 if(b1 != data[len-2] || b2 != data[len-1]) {
64 return 0;
65 } else {
66 return 1;
67 }
68 }
69
70 /**
71 * @brief iclass_CRC_Ok Checks CRC in command or response
72 * @param isResponse
73 * @param data
74 * @param len
75 * @return 0 : CRC-command, CRC not ok
76 * 1 : CRC-command, CRC ok
77 * 2 : Not crc-command
78 */
79 uint8_t iclass_CRC_check(bool isResponse, uint8_t* data, uint8_t len)
80 {
81 if(len < 4) return 2;//CRC commands (and responses) are all at least 4 bytes
82
83 uint8_t b1, b2;
84
85 if(!isResponse)//Commands to tag
86 {
87 /**
88 These commands should have CRC. Total length leftmost
89 4 READ
90 4 READ4
91 12 UPDATE - unsecured, ends with CRC16
92 14 UPDATE - secured, ends with signature instead
93 4 PAGESEL
94 **/
95 if(len == 4 || len == 12)//Covers three of them
96 {
97 //Don't include the command byte
98 ComputeCrc14443(CRC_ICLASS, (data+1), len-3, &b1, &b2);
99 return b1 == data[len -2] && b2 == data[len-1];
100 }
101 return 2;
102 }else{
103 /**
104 These tag responses should have CRC. Total length leftmost
105
106 10 READ data[8] crc[2]
107 34 READ4 data[32]crc[2]
108 10 UPDATE data[8] crc[2]
109 10 SELECT csn[8] crc[2]
110 10 IDENTIFY asnb[8] crc[2]
111 10 PAGESEL block1[8] crc[2]
112 10 DETECT csn[8] crc[2]
113
114 These should not
115
116 4 CHECK chip_response[4]
117 8 READCHECK data[8]
118 1 ACTALL sof[1]
119 1 ACT sof[1]
120
121 In conclusion, without looking at the command; any response
122 of length 10 or 34 should have CRC
123 **/
124 if(len != 10 && len != 34) return true;
125
126 ComputeCrc14443(CRC_ICLASS, data, len-2, &b1, &b2);
127 return b1 == data[len -2] && b2 == data[len-1];
128 }
129 }
130
131
132 bool is_last_record(uint16_t tracepos, uint8_t *trace, uint16_t traceLen)
133 {
134 return(tracepos + sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) >= traceLen);
135 }
136
137
138 bool next_record_is_response(uint16_t tracepos, uint8_t *trace)
139 {
140 uint16_t next_records_datalen = *((uint16_t *)(trace + tracepos + sizeof(uint32_t) + sizeof(uint16_t)));
141
142 return(next_records_datalen & 0x8000);
143 }
144
145
146 bool merge_topaz_reader_frames(uint32_t timestamp, uint32_t *duration, uint16_t *tracepos, uint16_t traceLen, uint8_t *trace, uint8_t *frame, uint8_t *topaz_reader_command, uint16_t *data_len)
147 {
148
149 #define MAX_TOPAZ_READER_CMD_LEN 16
150
151 uint32_t last_timestamp = timestamp + *duration;
152
153 if ((*data_len != 1) || (frame[0] == TOPAZ_WUPA) || (frame[0] == TOPAZ_REQA)) return false;
154
155 memcpy(topaz_reader_command, frame, *data_len);
156
157 while (!is_last_record(*tracepos, trace, traceLen) && !next_record_is_response(*tracepos, trace)) {
158 uint32_t next_timestamp = *((uint32_t *)(trace + *tracepos));
159 *tracepos += sizeof(uint32_t);
160 uint16_t next_duration = *((uint16_t *)(trace + *tracepos));
161 *tracepos += sizeof(uint16_t);
162 uint16_t next_data_len = *((uint16_t *)(trace + *tracepos)) & 0x7FFF;
163 *tracepos += sizeof(uint16_t);
164 uint8_t *next_frame = (trace + *tracepos);
165 *tracepos += next_data_len;
166 if ((next_data_len == 1) && (*data_len + next_data_len <= MAX_TOPAZ_READER_CMD_LEN)) {
167 memcpy(topaz_reader_command + *data_len, next_frame, next_data_len);
168 *data_len += next_data_len;
169 last_timestamp = next_timestamp + next_duration;
170 } else {
171 // rewind and exit
172 *tracepos = *tracepos - next_data_len - sizeof(uint16_t) - sizeof(uint16_t) - sizeof(uint32_t);
173 break;
174 }
175 uint16_t next_parity_len = (next_data_len-1)/8 + 1;
176 *tracepos += next_parity_len;
177 }
178
179 *duration = last_timestamp - timestamp;
180
181 return true;
182 }
183
184
185 uint16_t printTraceLine(uint16_t tracepos, uint16_t traceLen, uint8_t *trace, uint8_t protocol, bool showWaitCycles, bool markCRCBytes)
186 {
187 bool isResponse;
188 uint16_t data_len, parity_len;
189 uint32_t duration;
190 uint8_t topaz_reader_command[9];
191 uint32_t timestamp, first_timestamp, EndOfTransmissionTimestamp;
192 char explanation[30] = {0};
193 uint8_t mfData[32] = {0};
194 size_t mfDataLen = 0;
195
196 if (tracepos + sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) > traceLen) return traceLen;
197
198 first_timestamp = *((uint32_t *)(trace));
199 timestamp = *((uint32_t *)(trace + tracepos));
200
201 tracepos += 4;
202 duration = *((uint16_t *)(trace + tracepos));
203 tracepos += 2;
204 data_len = *((uint16_t *)(trace + tracepos));
205 tracepos += 2;
206
207 if (data_len & 0x8000) {
208 data_len &= 0x7fff;
209 isResponse = true;
210 } else {
211 isResponse = false;
212 }
213 parity_len = (data_len-1)/8 + 1;
214
215 if (tracepos + data_len + parity_len > traceLen) {
216 return traceLen;
217 }
218 uint8_t *frame = trace + tracepos;
219 tracepos += data_len;
220 uint8_t *parityBytes = trace + tracepos;
221 tracepos += parity_len;
222
223 if (protocol == TOPAZ && !isResponse) {
224 // topaz reader commands come in 1 or 9 separate frames with 7 or 8 Bits each.
225 // merge them:
226 if (merge_topaz_reader_frames(timestamp, &duration, &tracepos, traceLen, trace, frame, topaz_reader_command, &data_len)) {
227 frame = topaz_reader_command;
228 }
229 }
230
231 //Check the CRC status
232 uint8_t crcStatus = 2;
233
234 if (data_len > 2) {
235 switch (protocol) {
236 case ICLASS:
237 crcStatus = iclass_CRC_check(isResponse, frame, data_len);
238 break;
239 case ISO_14443B:
240 case TOPAZ:
241 crcStatus = iso14443B_CRC_check(isResponse, frame, data_len);
242 break;
243 case PROTO_MIFARE:
244 crcStatus = mifare_CRC_check(isResponse, frame, data_len);
245 break;
246 case ISO_14443A:
247 crcStatus = iso14443A_CRC_check(isResponse, frame, data_len);
248 break;
249 default:
250 break;
251 }
252 }
253 //0 CRC-command, CRC not ok
254 //1 CRC-command, CRC ok
255 //2 Not crc-command
256
257 //--- Draw the data column
258 //char line[16][110];
259 char line[16][110];
260
261 for (int j = 0; j < data_len && j/16 < 16; j++) {
262
263 uint8_t parityBits = parityBytes[j>>3];
264 if (protocol != ISO_14443B && (isResponse || protocol == ISO_14443A) && (oddparity8(frame[j]) != ((parityBits >> (7-(j&0x0007))) & 0x01))) {
265 snprintf(line[j/16]+(( j % 16) * 4),110, "%02x! ", frame[j]);
266 } else {
267 snprintf(line[j/16]+(( j % 16) * 4), 110, " %02x ", frame[j]);
268 }
269
270 }
271
272 if (markCRCBytes) {
273 if(crcStatus == 0 || crcStatus == 1)
274 {//CRC-command
275 char *pos1 = line[(data_len-2)/16]+(((data_len-2) % 16) * 4);
276 (*pos1) = '[';
277 char *pos2 = line[(data_len)/16]+(((data_len) % 16) * 4);
278 sprintf(pos2, "%c", ']');
279 }
280 }
281
282 if(data_len == 0)
283 {
284 if(data_len == 0){
285 sprintf(line[0],"<empty trace - possible error>");
286 }
287 }
288 //--- Draw the CRC column
289
290 char *crc = (crcStatus == 0 ? "!crc" : (crcStatus == 1 ? " ok " : " "));
291
292 EndOfTransmissionTimestamp = timestamp + duration;
293
294 if (protocol == PROTO_MIFARE)
295 annotateMifare(explanation, sizeof(explanation), frame, data_len, parityBytes, parity_len, isResponse);
296
297 if(!isResponse)
298 {
299 switch(protocol) {
300 case ICLASS: annotateIclass(explanation,sizeof(explanation),frame,data_len); break;
301 case ISO_14443A: annotateIso14443a(explanation,sizeof(explanation),frame,data_len); break;
302 case ISO_14443B: annotateIso14443b(explanation,sizeof(explanation),frame,data_len); break;
303 case TOPAZ: annotateTopaz(explanation,sizeof(explanation),frame,data_len); break;
304 default: break;
305 }
306 }
307
308 int num_lines = MIN((data_len - 1)/16 + 1, 16);
309 for (int j = 0; j < num_lines ; j++) {
310 if (j == 0) {
311 PrintAndLog(" %10d | %10d | %s |%-64s | %s| %s",
312 (timestamp - first_timestamp),
313 (EndOfTransmissionTimestamp - first_timestamp),
314 (isResponse ? "Tag" : "Rdr"),
315 line[j],
316 (j == num_lines-1) ? crc : " ",
317 (j == num_lines-1) ? explanation : "");
318 } else {
319 PrintAndLog(" | | |%-64s | %s| %s",
320 line[j],
321 (j == num_lines-1) ? crc : " ",
322 (j == num_lines-1) ? explanation : "");
323 }
324 }
325
326 if (DecodeMifareData(frame, data_len, parityBytes, isResponse, mfData, &mfDataLen)) {
327 memset(explanation, 0x00, sizeof(explanation));
328 if (!isResponse) {
329 explanation[0] = '>';
330 annotateIso14443a(&explanation[1], sizeof(explanation) - 1, mfData, mfDataLen);
331 }
332 uint8_t crcc = iso14443A_CRC_check(isResponse, mfData, mfDataLen);
333 PrintAndLog(" | * | dec |%-64s | %-4s| %s",
334 sprint_hex(mfData, mfDataLen),
335 (crcc == 0 ? "!crc" : (crcc == 1 ? " ok " : " ")),
336 (true) ? explanation : "");
337 };
338
339 if (is_last_record(tracepos, trace, traceLen)) return traceLen;
340
341 if (showWaitCycles && !isResponse && next_record_is_response(tracepos, trace)) {
342 uint32_t next_timestamp = *((uint32_t *)(trace + tracepos));
343 PrintAndLog(" %10d | %10d | %s | fdt (Frame Delay Time): %d",
344 (EndOfTransmissionTimestamp - first_timestamp),
345 (next_timestamp - first_timestamp),
346 " ",
347 (next_timestamp - EndOfTransmissionTimestamp));
348 }
349
350 return tracepos;
351 }
352
353
354 int CmdHFList(const char *Cmd)
355 {
356 bool showWaitCycles = false;
357 bool markCRCBytes = false;
358 bool loadFromFile = false;
359 bool saveToFile = false;
360 char param1 = '\0';
361 char param2 = '\0';
362 char param3 = '\0';
363 char type[40] = {0};
364 char filename[FILE_PATH_SIZE];
365 uint8_t protocol = 0;
366
367 // parse command line
368 int tlen = param_getstr(Cmd, 0, type, sizeof(type));
369 if (param_getlength(Cmd, 1) == 1) {
370 param1 = param_getchar(Cmd, 1);
371 } else {
372 param_getstr(Cmd, 1, filename, sizeof(filename));
373 }
374 if (param_getlength(Cmd, 2) == 1) {
375 param2 = param_getchar(Cmd, 2);
376 } else if (strlen(filename) == 0) {
377 param_getstr(Cmd, 2, filename, sizeof(filename));
378 }
379 if (param_getlength(Cmd, 3) == 1) {
380 param3 = param_getchar(Cmd, 3);
381 } else if (strlen(filename) == 0) {
382 param_getstr(Cmd, 3, filename, sizeof(filename));
383 }
384
385 // Validate param1
386 bool errors = false;
387
388 if(tlen == 0) {
389 errors = true;
390 }
391
392 if(param1 == 'h'
393 || (param1 != 0 && param1 != 'f' && param1 != 'c' && param1 != 'l')
394 || (param2 != 0 && param2 != 'f' && param2 != 'c' && param2 != 'l')
395 || (param3 != 0 && param3 != 'f' && param3 != 'c' && param3 != 'l')) {
396 errors = true;
397 }
398
399 if(!errors) {
400 if(strcmp(type, "iclass") == 0) {
401 protocol = ICLASS;
402 } else if(strcmp(type, "mf") == 0) {
403 protocol = PROTO_MIFARE;
404 } else if(strcmp(type, "14a") == 0) {
405 protocol = ISO_14443A;
406 } else if(strcmp(type, "14b") == 0) {
407 protocol = ISO_14443B;
408 } else if(strcmp(type,"topaz") == 0) {
409 protocol = TOPAZ;
410 } else if(strcmp(type,"raw") == 0) {
411 protocol = -1; //No crc, no annotations
412 } else if (strcmp(type, "save") == 0) {
413 saveToFile = true;
414 } else {
415 errors = true;
416 }
417 }
418
419 if (param1 == 'f' || param2 == 'f' || param3 == 'f') {
420 showWaitCycles = true;
421 }
422
423 if (param1 == 'c' || param2 == 'c' || param3 == 'c') {
424 markCRCBytes = true;
425 }
426
427 if (param1 == 'l' || param2 == 'l' || param3 == 'l') {
428 loadFromFile = true;
429 }
430
431 if ((loadFromFile || saveToFile) && strlen(filename) == 0) {
432 errors = true;
433 }
434
435 if (loadFromFile && saveToFile) {
436 errors = true;
437 }
438
439 if (errors) {
440 PrintAndLog("List or save protocol data.");
441 PrintAndLog("Usage: hf list <protocol> [f] [c] [l <filename>]");
442 PrintAndLog(" hf list save <filename>");
443 PrintAndLog(" f - show frame delay times as well");
444 PrintAndLog(" c - mark CRC bytes");
445 PrintAndLog(" l - load data from file instead of trace buffer");
446 PrintAndLog(" save - save data to file");
447 PrintAndLog("Supported <protocol> values:");
448 PrintAndLog(" raw - just show raw data without annotations");
449 PrintAndLog(" 14a - interpret data as iso14443a communications");
450 PrintAndLog(" mf - interpret data as iso14443a communications and decrypt crypto1 stream");
451 PrintAndLog(" 14b - interpret data as iso14443b communications");
452 PrintAndLog(" iclass - interpret data as iclass communications");
453 PrintAndLog(" topaz - interpret data as topaz communications");
454 PrintAndLog("");
455 PrintAndLog("example: hf list 14a f");
456 PrintAndLog("example: hf list iclass");
457 PrintAndLog("example: hf list save myCardTrace.trc");
458 PrintAndLog("example: hf list 14a l myCardTrace.trc");
459 return 0;
460 }
461
462
463 uint8_t *trace;
464 uint32_t tracepos = 0;
465 uint32_t traceLen = 0;
466
467 if (loadFromFile) {
468 #define TRACE_CHUNK_SIZE (1<<16) // 64K to start with. Will be enough for BigBuf and some room for future extensions
469 FILE *tracefile = NULL;
470 size_t bytes_read;
471 trace = malloc(TRACE_CHUNK_SIZE);
472 if (trace == NULL) {
473 PrintAndLog("Cannot allocate memory for trace");
474 return 2;
475 }
476 if ((tracefile = fopen(filename,"rb")) == NULL) {
477 PrintAndLog("Could not open file %s", filename);
478 free(trace);
479 return 0;
480 }
481 while (!feof(tracefile)) {
482 bytes_read = fread(trace+traceLen, 1, TRACE_CHUNK_SIZE, tracefile);
483 traceLen += bytes_read;
484 if (!feof(tracefile)) {
485 uint8_t *p = realloc(trace, traceLen + TRACE_CHUNK_SIZE);
486 if (p == NULL) {
487 PrintAndLog("Cannot allocate memory for trace");
488 free(trace);
489 fclose(tracefile);
490 return 2;
491 }
492 trace = p;
493 }
494 }
495 fclose(tracefile);
496 } else {
497 trace = malloc(USB_CMD_DATA_SIZE);
498 // Query for the size of the trace
499 UsbCommand response;
500 GetFromBigBuf(trace, USB_CMD_DATA_SIZE, 0);
501 WaitForResponse(CMD_ACK, &response);
502 traceLen = response.arg[2];
503 if (traceLen > USB_CMD_DATA_SIZE) {
504 uint8_t *p = realloc(trace, traceLen);
505 if (p == NULL) {
506 PrintAndLog("Cannot allocate memory for trace");
507 free(trace);
508 return 2;
509 }
510 trace = p;
511 GetFromBigBuf(trace, traceLen, 0);
512 WaitForResponse(CMD_ACK, NULL);
513 }
514 }
515
516 if (saveToFile) {
517 FILE *tracefile = NULL;
518 if ((tracefile = fopen(filename,"wb")) == NULL) {
519 PrintAndLog("Could not create file %s", filename);
520 return 1;
521 }
522 fwrite(trace, 1, traceLen, tracefile);
523 PrintAndLog("Recorded Activity (TraceLen = %d bytes) written to file %s", traceLen, filename);
524 fclose(tracefile);
525 } else {
526 PrintAndLog("Recorded Activity (TraceLen = %d bytes)", traceLen);
527 PrintAndLog("");
528 PrintAndLog("Start = Start of Start Bit, End = End of last modulation. Src = Source of Transfer");
529 PrintAndLog("iso14443a - All times are in carrier periods (1/13.56Mhz)");
530 PrintAndLog("iClass - Timings are not as accurate");
531 PrintAndLog("");
532 PrintAndLog(" Start | End | Src | Data (! denotes parity error) | CRC | Annotation |");
533 PrintAndLog("------------|------------|-----|-----------------------------------------------------------------|-----|--------------------|");
534
535 ClearAuthData();
536 while(tracepos < traceLen)
537 {
538 tracepos = printTraceLine(tracepos, traceLen, trace, protocol, showWaitCycles, markCRCBytes);
539 }
540 }
541
542 free(trace);
543 return 0;
544 }
545
546 int CmdHFSearch(const char *Cmd){
547 int ans = 0;
548 PrintAndLog("");
549 ans = CmdHF14AInfo("s");
550 if (ans > 0) {
551 PrintAndLog("\nValid ISO14443A Tag Found - Quiting Search\n");
552 return ans;
553 }
554 ans = HFiClassReader("", false, false);
555 if (ans) {
556 PrintAndLog("\nValid iClass Tag (or PicoPass Tag) Found - Quiting Search\n");
557 return ans;
558 }
559 ans = HF15Reader("", false);
560 if (ans) {
561 PrintAndLog("\nValid ISO15693 Tag Found - Quiting Search\n");
562 return ans;
563 }
564 //14b is longest test currently (and rarest chip type) ... put last
565 ans = HF14BInfo(false);
566 if (ans) {
567 PrintAndLog("\nValid ISO14443B Tag Found - Quiting Search\n");
568 return ans;
569 }
570 PrintAndLog("\nno known/supported 13.56 MHz tags found\n");
571 return 0;
572 }
573
574 int CmdHFSnoop(const char *Cmd)
575 {
576 char * pEnd;
577 UsbCommand c = {CMD_HF_SNIFFER, {strtol(Cmd, &pEnd,0),strtol(pEnd, &pEnd,0),0}};
578 SendCommand(&c);
579 return 0;
580 }
581
582 static command_t CommandTable[] =
583 {
584 {"help", CmdHelp, 1, "This help"},
585 {"14a", CmdHF14A, 1, "{ ISO14443A RFIDs... }"},
586 {"14b", CmdHF14B, 1, "{ ISO14443B RFIDs... }"},
587 {"15", CmdHF15, 1, "{ ISO15693 RFIDs... }"},
588 {"epa", CmdHFEPA, 1, "{ German Identification Card... }"},
589 {"emv", CmdHFEMV, 1, "{ EMV cards... }"},
590 {"legic", CmdHFLegic, 0, "{ LEGIC RFIDs... }"},
591 {"iclass", CmdHFiClass, 1, "{ ICLASS RFIDs... }"},
592 {"mf", CmdHFMF, 1, "{ MIFARE RFIDs... }"},
593 {"mfu", CmdHFMFUltra, 1, "{ MIFARE Ultralight RFIDs... }"},
594 {"topaz", CmdHFTopaz, 1, "{ TOPAZ (NFC Type 1) RFIDs... }"},
595 {"tune", CmdHFTune, 0, "Continuously measure HF antenna tuning"},
596 {"list", CmdHFList, 1, "List protocol data in trace buffer"},
597 {"search", CmdHFSearch, 1, "Search for known HF tags [preliminary]"},
598 {"snoop", CmdHFSnoop, 0, "<samples to skip (10000)> <triggers to skip (1)> Generic HF Snoop"},
599 {NULL, NULL, 0, NULL}
600 };
601
602 int CmdHF(const char *Cmd)
603 {
604 CmdsParse(CommandTable, Cmd);
605 return 0;
606 }
607
608 int CmdHelp(const char *Cmd)
609 {
610 CmdsHelp(CommandTable);
611 return 0;
612 }
Impressum, Datenschutz