1 //-----------------------------------------------------------------------------
2 // 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 //-----------------------------------------------------------------------------
9 // High frequency commands
10 //-----------------------------------------------------------------------------
15 #include "proxmark3.h"
18 #include "iso14443crc.h"
21 #include "cmdparser.h"
27 #include "cmdhflegic.h"
28 #include "cmdhficlass.h"
31 #include "cmdhftopaz.h"
32 #include "protocols.h"
33 #include "emv/cmdemv.h"
34 #include "cmdhflist.h"
36 static int CmdHelp(const char *Cmd
);
38 int CmdHFTune(const char *Cmd
)
40 UsbCommand c
={CMD_MEASURE_ANTENNA_TUNING_HF
};
46 * @brief iso14443B_CRC_check Checks CRC in command or response
50 * @return 0 : CRC-command, CRC not ok
51 * 1 : CRC-command, CRC ok
55 uint8_t iso14443B_CRC_check(bool isResponse
, uint8_t* data
, uint8_t len
)
59 if(len
<= 2) return 2;
61 ComputeCrc14443(CRC_14443_B
, data
, len
-2, &b1
, &b2
);
62 if(b1
!= data
[len
-2] || b2
!= data
[len
-1]) {
70 * @brief iclass_CRC_Ok Checks CRC in command or response
74 * @return 0 : CRC-command, CRC not ok
75 * 1 : CRC-command, CRC ok
78 uint8_t iclass_CRC_check(bool isResponse
, uint8_t* data
, uint8_t len
)
80 if(len
< 4) return 2;//CRC commands (and responses) are all at least 4 bytes
84 if(!isResponse
)//Commands to tag
87 These commands should have CRC. Total length leftmost
90 12 UPDATE - unsecured, ends with CRC16
91 14 UPDATE - secured, ends with signature instead
94 if(len
== 4 || len
== 12)//Covers three of them
96 //Don't include the command byte
97 ComputeCrc14443(CRC_ICLASS
, (data
+1), len
-3, &b1
, &b2
);
98 return b1
== data
[len
-2] && b2
== data
[len
-1];
103 These tag responses should have CRC. Total length leftmost
105 10 READ data[8] crc[2]
106 34 READ4 data[32]crc[2]
107 10 UPDATE data[8] crc[2]
108 10 SELECT csn[8] crc[2]
109 10 IDENTIFY asnb[8] crc[2]
110 10 PAGESEL block1[8] crc[2]
111 10 DETECT csn[8] crc[2]
115 4 CHECK chip_response[4]
120 In conclusion, without looking at the command; any response
121 of length 10 or 34 should have CRC
123 if(len
!= 10 && len
!= 34) return true;
125 ComputeCrc14443(CRC_ICLASS
, data
, len
-2, &b1
, &b2
);
126 return b1
== data
[len
-2] && b2
== data
[len
-1];
131 bool is_last_record(uint16_t tracepos
, uint8_t *trace
, uint16_t traceLen
)
133 return(tracepos
+ sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) >= traceLen
);
137 bool next_record_is_response(uint16_t tracepos
, uint8_t *trace
)
139 uint16_t next_records_datalen
= *((uint16_t *)(trace
+ tracepos
+ sizeof(uint32_t) + sizeof(uint16_t)));
141 return(next_records_datalen
& 0x8000);
145 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
)
148 #define MAX_TOPAZ_READER_CMD_LEN 16
150 uint32_t last_timestamp
= timestamp
+ *duration
;
152 if ((*data_len
!= 1) || (frame
[0] == TOPAZ_WUPA
) || (frame
[0] == TOPAZ_REQA
)) return false;
154 memcpy(topaz_reader_command
, frame
, *data_len
);
156 while (!is_last_record(*tracepos
, trace
, traceLen
) && !next_record_is_response(*tracepos
, trace
)) {
157 uint32_t next_timestamp
= *((uint32_t *)(trace
+ *tracepos
));
158 *tracepos
+= sizeof(uint32_t);
159 uint16_t next_duration
= *((uint16_t *)(trace
+ *tracepos
));
160 *tracepos
+= sizeof(uint16_t);
161 uint16_t next_data_len
= *((uint16_t *)(trace
+ *tracepos
)) & 0x7FFF;
162 *tracepos
+= sizeof(uint16_t);
163 uint8_t *next_frame
= (trace
+ *tracepos
);
164 *tracepos
+= next_data_len
;
165 if ((next_data_len
== 1) && (*data_len
+ next_data_len
<= MAX_TOPAZ_READER_CMD_LEN
)) {
166 memcpy(topaz_reader_command
+ *data_len
, next_frame
, next_data_len
);
167 *data_len
+= next_data_len
;
168 last_timestamp
= next_timestamp
+ next_duration
;
171 *tracepos
= *tracepos
- next_data_len
- sizeof(uint16_t) - sizeof(uint16_t) - sizeof(uint32_t);
174 uint16_t next_parity_len
= (next_data_len
-1)/8 + 1;
175 *tracepos
+= next_parity_len
;
178 *duration
= last_timestamp
- timestamp
;
184 uint16_t printTraceLine(uint16_t tracepos
, uint16_t traceLen
, uint8_t *trace
, uint8_t protocol
, bool showWaitCycles
, bool markCRCBytes
)
187 uint16_t data_len
, parity_len
;
189 uint8_t topaz_reader_command
[9];
190 uint32_t timestamp
, first_timestamp
, EndOfTransmissionTimestamp
;
191 char explanation
[30] = {0};
192 uint8_t mfData
[32] = {0};
193 size_t mfDataLen
= 0;
195 if (tracepos
+ sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) > traceLen
) return traceLen
;
197 first_timestamp
= *((uint32_t *)(trace
));
198 timestamp
= *((uint32_t *)(trace
+ tracepos
));
201 duration
= *((uint16_t *)(trace
+ tracepos
));
203 data_len
= *((uint16_t *)(trace
+ tracepos
));
206 if (data_len
& 0x8000) {
212 parity_len
= (data_len
-1)/8 + 1;
214 if (tracepos
+ data_len
+ parity_len
> traceLen
) {
217 uint8_t *frame
= trace
+ tracepos
;
218 tracepos
+= data_len
;
219 uint8_t *parityBytes
= trace
+ tracepos
;
220 tracepos
+= parity_len
;
222 if (protocol
== TOPAZ
&& !isResponse
) {
223 // topaz reader commands come in 1 or 9 separate frames with 7 or 8 Bits each.
225 if (merge_topaz_reader_frames(timestamp
, &duration
, &tracepos
, traceLen
, trace
, frame
, topaz_reader_command
, &data_len
)) {
226 frame
= topaz_reader_command
;
230 //Check the CRC status
231 uint8_t crcStatus
= 2;
236 crcStatus
= iclass_CRC_check(isResponse
, frame
, data_len
);
240 crcStatus
= iso14443B_CRC_check(isResponse
, frame
, data_len
);
243 crcStatus
= mifare_CRC_check(isResponse
, frame
, data_len
);
246 crcStatus
= iso14443A_CRC_check(isResponse
, frame
, data_len
);
252 //0 CRC-command, CRC not ok
253 //1 CRC-command, CRC ok
256 //--- Draw the data column
257 //char line[16][110];
260 for (int j
= 0; j
< data_len
&& j
/16 < 16; j
++) {
262 uint8_t parityBits
= parityBytes
[j
>>3];
263 if (protocol
!= ISO_14443B
&& (isResponse
|| protocol
== ISO_14443A
) && (oddparity8(frame
[j
]) != ((parityBits
>> (7-(j
&0x0007))) & 0x01))) {
264 snprintf(line
[j
/16]+(( j
% 16) * 4),110, "%02x! ", frame
[j
]);
266 snprintf(line
[j
/16]+(( j
% 16) * 4), 110, " %02x ", frame
[j
]);
272 if(crcStatus
== 0 || crcStatus
== 1)
274 char *pos1
= line
[(data_len
-2)/16]+(((data_len
-2) % 16) * 4);
276 char *pos2
= line
[(data_len
)/16]+(((data_len
) % 16) * 4);
277 sprintf(pos2
, "%c", ']');
284 sprintf(line
[0],"<empty trace - possible error>");
287 //--- Draw the CRC column
289 char *crc
= (crcStatus
== 0 ? "!crc" : (crcStatus
== 1 ? " ok " : " "));
291 EndOfTransmissionTimestamp
= timestamp
+ duration
;
293 if (protocol
== PROTO_MIFARE
)
294 annotateMifare(explanation
, sizeof(explanation
), frame
, data_len
, parityBytes
, parity_len
, isResponse
);
299 case ICLASS
: annotateIclass(explanation
,sizeof(explanation
),frame
,data_len
); break;
300 case ISO_14443A
: annotateIso14443a(explanation
,sizeof(explanation
),frame
,data_len
); break;
301 case ISO_14443B
: annotateIso14443b(explanation
,sizeof(explanation
),frame
,data_len
); break;
302 case TOPAZ
: annotateTopaz(explanation
,sizeof(explanation
),frame
,data_len
); break;
307 int num_lines
= MIN((data_len
- 1)/16 + 1, 16);
308 for (int j
= 0; j
< num_lines
; j
++) {
310 PrintAndLog(" %10d | %10d | %s |%-64s | %s| %s",
311 (timestamp
- first_timestamp
),
312 (EndOfTransmissionTimestamp
- first_timestamp
),
313 (isResponse
? "Tag" : "Rdr"),
315 (j
== num_lines
-1) ? crc
: " ",
316 (j
== num_lines
-1) ? explanation
: "");
318 PrintAndLog(" | | |%-64s | %s| %s",
320 (j
== num_lines
-1) ? crc
: " ",
321 (j
== num_lines
-1) ? explanation
: "");
325 if (DecodeMifareData(frame
, data_len
, parityBytes
, isResponse
, mfData
, &mfDataLen
)) {
326 memset(explanation
, 0x00, sizeof(explanation
));
328 explanation
[0] = '>';
329 annotateIso14443a(&explanation
[1], sizeof(explanation
) - 1, mfData
, mfDataLen
);
331 uint8_t crcc
= iso14443A_CRC_check(isResponse
, mfData
, mfDataLen
);
332 PrintAndLog(" | * | dec |%-64s | %-4s| %s",
333 sprint_hex(mfData
, mfDataLen
),
334 (crcc
== 0 ? "!crc" : (crcc
== 1 ? " ok " : " ")),
335 (true) ? explanation
: "");
338 if (is_last_record(tracepos
, trace
, traceLen
)) return traceLen
;
340 if (showWaitCycles
&& !isResponse
&& next_record_is_response(tracepos
, trace
)) {
341 uint32_t next_timestamp
= *((uint32_t *)(trace
+ tracepos
));
342 PrintAndLog(" %10d | %10d | %s | fdt (Frame Delay Time): %d",
343 (EndOfTransmissionTimestamp
- first_timestamp
),
344 (next_timestamp
- first_timestamp
),
346 (next_timestamp
- EndOfTransmissionTimestamp
));
353 int CmdHFList(const char *Cmd
)
355 bool showWaitCycles
= false;
356 bool markCRCBytes
= false;
357 bool loadFromFile
= false;
358 bool saveToFile
= false;
363 char filename
[FILE_PATH_SIZE
];
364 uint8_t protocol
= 0;
366 // parse command line
367 int tlen
= param_getstr(Cmd
, 0, type
, sizeof(type
));
368 if (param_getlength(Cmd
, 1) == 1) {
369 param1
= param_getchar(Cmd
, 1);
371 param_getstr(Cmd
, 1, filename
, sizeof(filename
));
373 if (param_getlength(Cmd
, 2) == 1) {
374 param2
= param_getchar(Cmd
, 2);
375 } else if (strlen(filename
) == 0) {
376 param_getstr(Cmd
, 2, filename
, sizeof(filename
));
378 if (param_getlength(Cmd
, 3) == 1) {
379 param3
= param_getchar(Cmd
, 3);
380 } else if (strlen(filename
) == 0) {
381 param_getstr(Cmd
, 3, filename
, sizeof(filename
));
392 || (param1
!= 0 && param1
!= 'f' && param1
!= 'c' && param1
!= 'l')
393 || (param2
!= 0 && param2
!= 'f' && param2
!= 'c' && param2
!= 'l')
394 || (param3
!= 0 && param3
!= 'f' && param3
!= 'c' && param3
!= 'l')) {
399 if(strcmp(type
, "iclass") == 0) {
401 } else if(strcmp(type
, "mf") == 0) {
402 protocol
= PROTO_MIFARE
;
403 } else if(strcmp(type
, "14a") == 0) {
404 protocol
= ISO_14443A
;
405 } else if(strcmp(type
, "14b") == 0) {
406 protocol
= ISO_14443B
;
407 } else if(strcmp(type
,"topaz") == 0) {
409 } else if(strcmp(type
,"raw") == 0) {
410 protocol
= -1; //No crc, no annotations
411 } else if (strcmp(type
, "save") == 0) {
418 if (param1
== 'f' || param2
== 'f' || param3
== 'f') {
419 showWaitCycles
= true;
422 if (param1
== 'c' || param2
== 'c' || param3
== 'c') {
426 if (param1
== 'l' || param2
== 'l' || param3
== 'l') {
430 if ((loadFromFile
|| saveToFile
) && strlen(filename
) == 0) {
434 if (loadFromFile
&& saveToFile
) {
439 PrintAndLog("List or save protocol data.");
440 PrintAndLog("Usage: hf list <protocol> [f] [c] [l <filename>]");
441 PrintAndLog(" hf list save <filename>");
442 PrintAndLog(" f - show frame delay times as well");
443 PrintAndLog(" c - mark CRC bytes");
444 PrintAndLog(" l - load data from file instead of trace buffer");
445 PrintAndLog(" save - save data to file");
446 PrintAndLog("Supported <protocol> values:");
447 PrintAndLog(" raw - just show raw data without annotations");
448 PrintAndLog(" 14a - interpret data as iso14443a communications");
449 PrintAndLog(" mf - interpret data as iso14443a communications and decrypt crypto1 stream");
450 PrintAndLog(" 14b - interpret data as iso14443b communications");
451 PrintAndLog(" iclass - interpret data as iclass communications");
452 PrintAndLog(" topaz - interpret data as topaz communications");
454 PrintAndLog("example: hf list 14a f");
455 PrintAndLog("example: hf list iclass");
456 PrintAndLog("example: hf list save myCardTrace.trc");
457 PrintAndLog("example: hf list 14a l myCardTrace.trc");
463 uint32_t tracepos
= 0;
464 uint32_t traceLen
= 0;
467 #define TRACE_CHUNK_SIZE (1<<16) // 64K to start with. Will be enough for BigBuf and some room for future extensions
468 FILE *tracefile
= NULL
;
470 trace
= malloc(TRACE_CHUNK_SIZE
);
472 PrintAndLog("Cannot allocate memory for trace");
475 if ((tracefile
= fopen(filename
,"rb")) == NULL
) {
476 PrintAndLog("Could not open file %s", filename
);
480 while (!feof(tracefile
)) {
481 bytes_read
= fread(trace
+traceLen
, 1, TRACE_CHUNK_SIZE
, tracefile
);
482 traceLen
+= bytes_read
;
483 if (!feof(tracefile
)) {
484 uint8_t *p
= realloc(trace
, traceLen
+ TRACE_CHUNK_SIZE
);
486 PrintAndLog("Cannot allocate memory for trace");
496 trace
= malloc(USB_CMD_DATA_SIZE
);
497 // Query for the size of the trace
499 GetFromBigBuf(trace
, USB_CMD_DATA_SIZE
, 0, &response
, -1, false);
500 traceLen
= response
.arg
[2];
501 if (traceLen
> USB_CMD_DATA_SIZE
) {
502 uint8_t *p
= realloc(trace
, traceLen
);
504 PrintAndLog("Cannot allocate memory for trace");
509 GetFromBigBuf(trace
, traceLen
, 0, NULL
, -1, false);
514 FILE *tracefile
= NULL
;
515 if ((tracefile
= fopen(filename
,"wb")) == NULL
) {
516 PrintAndLog("Could not create file %s", filename
);
519 fwrite(trace
, 1, traceLen
, tracefile
);
520 PrintAndLog("Recorded Activity (TraceLen = %d bytes) written to file %s", traceLen
, filename
);
523 PrintAndLog("Recorded Activity (TraceLen = %d bytes)", traceLen
);
525 PrintAndLog("Start = Start of Start Bit, End = End of last modulation. Src = Source of Transfer");
526 PrintAndLog("iso14443a - All times are in carrier periods (1/13.56Mhz)");
527 PrintAndLog("iClass - Timings are not as accurate");
529 PrintAndLog(" Start | End | Src | Data (! denotes parity error) | CRC | Annotation |");
530 PrintAndLog("------------|------------|-----|-----------------------------------------------------------------|-----|--------------------|");
533 while(tracepos
< traceLen
)
535 tracepos
= printTraceLine(tracepos
, traceLen
, trace
, protocol
, showWaitCycles
, markCRCBytes
);
543 int CmdHFSearch(const char *Cmd
){
546 ans
= CmdHF14AInfo("s");
548 PrintAndLog("\nValid ISO14443A Tag Found - Quiting Search\n");
551 ans
= HFiClassReader("", false, false);
553 PrintAndLog("\nValid iClass Tag (or PicoPass Tag) Found - Quiting Search\n");
556 ans
= HF15Reader("", false);
558 PrintAndLog("\nValid ISO15693 Tag Found - Quiting Search\n");
561 //14b is longest test currently (and rarest chip type) ... put last
562 ans
= HF14BInfo(false);
564 PrintAndLog("\nValid ISO14443B Tag Found - Quiting Search\n");
567 PrintAndLog("\nno known/supported 13.56 MHz tags found\n");
571 int CmdHFSnoop(const char *Cmd
)
574 UsbCommand c
= {CMD_HF_SNIFFER
, {strtol(Cmd
, &pEnd
,0),strtol(pEnd
, &pEnd
,0),0}};
579 static command_t CommandTable
[] =
581 {"help", CmdHelp
, 1, "This help"},
582 {"14a", CmdHF14A
, 1, "{ ISO14443A RFIDs... }"},
583 {"14b", CmdHF14B
, 1, "{ ISO14443B RFIDs... }"},
584 {"15", CmdHF15
, 1, "{ ISO15693 RFIDs... }"},
585 {"epa", CmdHFEPA
, 1, "{ German Identification Card... }"},
586 {"emv", CmdHFEMV
, 1, "{ EMV cards... }"},
587 {"legic", CmdHFLegic
, 0, "{ LEGIC RFIDs... }"},
588 {"iclass", CmdHFiClass
, 1, "{ ICLASS RFIDs... }"},
589 {"mf", CmdHFMF
, 1, "{ MIFARE RFIDs... }"},
590 {"mfu", CmdHFMFUltra
, 1, "{ MIFARE Ultralight RFIDs... }"},
591 {"topaz", CmdHFTopaz
, 1, "{ TOPAZ (NFC Type 1) RFIDs... }"},
592 {"tune", CmdHFTune
, 0, "Continuously measure HF antenna tuning"},
593 {"list", CmdHFList
, 1, "List protocol data in trace buffer"},
594 {"search", CmdHFSearch
, 1, "Search for known HF tags [preliminary]"},
595 {"snoop", CmdHFSnoop
, 0, "<samples to skip (10000)> <triggers to skip (1)> Generic HF Snoop"},
596 {NULL
, NULL
, 0, NULL
}
599 int CmdHF(const char *Cmd
)
601 CmdsParse(CommandTable
, Cmd
);
605 int CmdHelp(const char *Cmd
)
607 CmdsHelp(CommandTable
);