1 //-----------------------------------------------------------------------------
2 // Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
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
7 //-----------------------------------------------------------------------------
8 // High frequency commands
9 //-----------------------------------------------------------------------------
13 #include "proxmark3.h"
16 #include "cmdparser.h"
22 #include "cmdhflegic.h"
23 #include "cmdhficlass.h"
26 #include "protocols.h"
28 static int CmdHelp(const char *Cmd
);
30 int CmdHFTune(const char *Cmd
)
32 UsbCommand c
={CMD_MEASURE_ANTENNA_TUNING_HF
};
38 void annotateIso14443a(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
42 case ISO14443A_CMD_WUPA
: snprintf(exp
,size
,"WUPA"); break;
43 case ISO14443A_CMD_ANTICOLL_OR_SELECT
:{
44 // 93 20 = Anticollision (usage: 9320 - answer: 4bytes UID+1byte UID-bytes-xor)
45 // 93 70 = Select (usage: 9370+5bytes 9320 answer - answer: 1byte SAK)
48 snprintf(exp
,size
,"SELECT_UID"); break;
51 snprintf(exp
,size
,"ANTICOLL"); break;
54 case ISO14443A_CMD_ANTICOLL_OR_SELECT_2
:{
55 //95 20 = Anticollision of cascade level2
56 //95 70 = Select of cascade level2
59 snprintf(exp
,size
,"SELECT_UID-2"); break;
62 snprintf(exp
,size
,"ANTICOLL-2"); break;
65 case ISO14443A_CMD_REQA
: snprintf(exp
,size
,"REQA"); break;
66 case ISO14443A_CMD_READBLOCK
: snprintf(exp
,size
,"READBLOCK(%d)",cmd
[1]); break;
67 case ISO14443A_CMD_WRITEBLOCK
: snprintf(exp
,size
,"WRITEBLOCK(%d)",cmd
[1]); break;
68 case ISO14443A_CMD_HALT
: snprintf(exp
,size
,"HALT"); break;
69 case ISO14443A_CMD_RATS
: snprintf(exp
,size
,"RATS"); break;
70 case MIFARE_CMD_INC
: snprintf(exp
,size
,"INC(%d)",cmd
[1]); break;
71 case MIFARE_CMD_DEC
: snprintf(exp
,size
,"DEC(%d)",cmd
[1]); break;
72 case MIFARE_CMD_RESTORE
: snprintf(exp
,size
,"RESTORE(%d)",cmd
[1]); break;
73 case MIFARE_CMD_TRANSFER
: snprintf(exp
,size
,"TRANSFER(%d)",cmd
[1]); break;
74 case MIFARE_AUTH_KEYA
: snprintf(exp
,size
,"AUTH-A(%d)",cmd
[1]); break;
75 case MIFARE_AUTH_KEYB
: snprintf(exp
,size
,"AUTH-B(%d)",cmd
[1]); break;
76 case MIFARE_MAGICWUPC1
: snprintf(exp
,size
,"MAGIC WUPC1"); break;
77 case MIFARE_MAGICWUPC2
: snprintf(exp
,size
,"MAGIC WUPC2"); break;
78 case MIFARE_MAGICWIPEC
: snprintf(exp
,size
,"MAGIC WIPEC"); break;
79 default: snprintf(exp
,size
,"?"); break;
84 void annotateIclass(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
88 case ICLASS_CMD_ACTALL
: snprintf(exp
,size
,"ACTALL"); break;
89 case ICLASS_CMD_READ_OR_IDENTIFY
:{
91 snprintf(exp
,size
,"READ(%d)",cmd
[1]);
93 snprintf(exp
,size
,"IDENTIFY");
97 case ICLASS_CMD_SELECT
: snprintf(exp
,size
,"SELECT"); break;
98 case ICLASS_CMD_PAGESEL
: snprintf(exp
,size
,"PAGESEL(%d)", cmd
[1]); break;
99 case ICLASS_CMD_READCHECK_KC
:snprintf(exp
,size
,"READCHECK[Kc](%d)", cmd
[1]); break;
100 case ICLASS_CMD_READCHECK_KD
:snprintf(exp
,size
,"READCHECK[Kd](%d)", cmd
[1]); break;
101 case ICLASS_CMD_CHECK
: snprintf(exp
,size
,"CHECK"); break;
102 case ICLASS_CMD_DETECT
: snprintf(exp
,size
,"DETECT"); break;
103 case ICLASS_CMD_HALT
: snprintf(exp
,size
,"HALT"); break;
104 case ICLASS_CMD_UPDATE
: snprintf(exp
,size
,"UPDATE(%d)",cmd
[1]); break;
105 case ICLASS_CMD_ACT
: snprintf(exp
,size
,"ACT"); break;
106 case ICLASS_CMD_READ4
: snprintf(exp
,size
,"READ4(%d)",cmd
[1]); break;
107 default: snprintf(exp
,size
,"?"); break;
112 void annotateIso15693(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
118 case ISO15693_INVENTORY
:snprintf(exp
, size
, "INVENTORY");break;
119 case ISO15693_STAYQUIET
:snprintf(exp
, size
, "STAY_QUIET");break;
120 default: snprintf(exp
,size
,"?"); break;
123 }else if(cmd
[0] == 0x02)
127 case ISO15693_READBLOCK
:snprintf(exp
, size
, "READBLOCK");break;
128 case ISO15693_WRITEBLOCK
:snprintf(exp
, size
, "WRITEBLOCK");break;
129 case ISO15693_LOCKBLOCK
:snprintf(exp
, size
, "LOCKBLOCK");break;
130 case ISO15693_READ_MULTI_BLOCK
:snprintf(exp
, size
, "READ_MULTI_BLOCK");break;
131 case ISO15693_SELECT
:snprintf(exp
, size
, "SELECT");break;
132 case ISO15693_RESET_TO_READY
:snprintf(exp
, size
, "RESET_TO_READY");break;
133 case ISO15693_WRITE_AFI
:snprintf(exp
, size
, "WRITE_AFI");break;
134 case ISO15693_LOCK_AFI
:snprintf(exp
, size
, "LOCK_AFI");break;
135 case ISO15693_WRITE_DSFID
:snprintf(exp
, size
, "WRITE_DSFID");break;
136 case ISO15693_LOCK_DSFID
:snprintf(exp
, size
, "LOCK_DSFID");break;
137 case ISO15693_GET_SYSTEM_INFO
:snprintf(exp
, size
, "GET_SYSTEM_INFO");break;
138 case ISO15693_READ_MULTI_SECSTATUS
:snprintf(exp
, size
, "READ_MULTI_SECSTATUS");break;
139 default: snprintf(exp
,size
,"?"); break;
145 void annotateTopaz(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
149 case TOPAZ_REQA
:snprintf(exp
, size
, "REQA");break;
150 case TOPAZ_WUPA
:snprintf(exp
, size
, "WUPA");break;
151 case TOPAZ_RID
:snprintf(exp
, size
, "RID");break;
152 case TOPAZ_RALL
:snprintf(exp
, size
, "RALL");break;
153 case TOPAZ_READ
:snprintf(exp
, size
, "READ");break;
154 case TOPAZ_WRITE_E
:snprintf(exp
, size
, "WRITE-E");break;
155 case TOPAZ_WRITE_NE
:snprintf(exp
, size
, "WRITE-NE");break;
156 default: snprintf(exp
,size
,"?"); break;
163 0E xx = SELECT ID (xx = Chip-ID)
165 08 yy = Read Block (yy = block number)
166 09 yy dd dd dd dd = Write Block (yy = block number; dd dd dd dd = data to be written)
167 0C = Reset to Inventory
169 0A 11 22 33 44 55 66 = Authenticate (11 22 33 44 55 66 = data to authenticate)
172 void annotateIso14443b(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
175 case ISO14443B_REQB
: snprintf(exp
,size
,"REQB");break;
176 case ISO14443B_ATTRIB
: snprintf(exp
,size
,"ATTRIB");break;
177 case ISO14443B_HALT
: snprintf(exp
,size
,"HALT");break;
178 case ISO14443B_INITIATE
: snprintf(exp
,size
,"INITIATE");break;
179 case ISO14443B_SELECT
: snprintf(exp
,size
,"SELECT(%d)",cmd
[1]);break;
180 case ISO14443B_GET_UID
: snprintf(exp
,size
,"GET UID");break;
181 case ISO14443B_READ_BLK
: snprintf(exp
,size
,"READ_BLK(%d)", cmd
[1]);break;
182 case ISO14443B_WRITE_BLK
: snprintf(exp
,size
,"WRITE_BLK(%d)",cmd
[1]);break;
183 case ISO14443B_RESET
: snprintf(exp
,size
,"RESET");break;
184 case ISO14443B_COMPLETION
: snprintf(exp
,size
,"COMPLETION");break;
185 case ISO14443B_AUTHENTICATE
: snprintf(exp
,size
,"AUTHENTICATE");break;
186 default : snprintf(exp
,size
,"?");break;
192 * @brief iso14443A_CRC_check Checks CRC in command or response
196 * @return 0 : CRC-command, CRC not ok
197 * 1 : CRC-command, CRC ok
198 * 2 : Not crc-command
201 uint8_t iso14443A_CRC_check(bool isResponse
, uint8_t* data
, uint8_t len
)
205 if(len
<= 2) return 2;
207 if(isResponse
& (len
< 6)) return 2;
209 ComputeCrc14443(CRC_14443_A
, data
, len
-2, &b1
, &b2
);
210 if (b1
!= data
[len
-2] || b2
!= data
[len
-1]) {
219 * @brief iso14443B_CRC_check Checks CRC in command or response
223 * @return 0 : CRC-command, CRC not ok
224 * 1 : CRC-command, CRC ok
225 * 2 : Not crc-command
228 uint8_t iso14443B_CRC_check(bool isResponse
, uint8_t* data
, uint8_t len
)
232 if(len
<= 2) return 2;
234 ComputeCrc14443(CRC_14443_B
, data
, len
-2, &b1
, &b2
);
235 if(b1
!= data
[len
-2] || b2
!= data
[len
-1]) {
243 * @brief iclass_CRC_Ok Checks CRC in command or response
247 * @return 0 : CRC-command, CRC not ok
248 * 1 : CRC-command, CRC ok
249 * 2 : Not crc-command
251 uint8_t iclass_CRC_check(bool isResponse
, uint8_t* data
, uint8_t len
)
253 if(len
< 4) return 2;//CRC commands (and responses) are all at least 4 bytes
257 if(!isResponse
)//Commands to tag
260 These commands should have CRC. Total length leftmost
263 12 UPDATE - unsecured, ends with CRC16
264 14 UPDATE - secured, ends with signature instead
267 if(len
== 4 || len
== 12)//Covers three of them
269 //Don't include the command byte
270 ComputeCrc14443(CRC_ICLASS
, (data
+1), len
-3, &b1
, &b2
);
271 return b1
== data
[len
-2] && b2
== data
[len
-1];
276 These tag responses should have CRC. Total length leftmost
278 10 READ data[8] crc[2]
279 34 READ4 data[32]crc[2]
280 10 UPDATE data[8] crc[2]
281 10 SELECT csn[8] crc[2]
282 10 IDENTIFY asnb[8] crc[2]
283 10 PAGESEL block1[8] crc[2]
284 10 DETECT csn[8] crc[2]
288 4 CHECK chip_response[4]
293 In conclusion, without looking at the command; any response
294 of length 10 or 34 should have CRC
296 if(len
!= 10 && len
!= 34) return true;
298 ComputeCrc14443(CRC_ICLASS
, data
, len
-2, &b1
, &b2
);
299 return b1
== data
[len
-2] && b2
== data
[len
-1];
304 bool is_last_record(uint16_t tracepos
, uint8_t *trace
, uint16_t traceLen
)
306 return(tracepos
+ sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) >= traceLen
);
310 bool next_record_is_response(uint16_t tracepos
, uint8_t *trace
)
312 uint16_t next_records_datalen
= *((uint16_t *)(trace
+ tracepos
+ sizeof(uint32_t) + sizeof(uint16_t)));
314 return(next_records_datalen
& 0x8000);
318 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
)
321 #define MAX_TOPAZ_READER_CMD_LEN 9
323 uint32_t last_timestamp
= timestamp
+ *duration
;
325 if ((*data_len
!= 1) || (frame
[0] == TOPAZ_WUPA
) || (frame
[0] == TOPAZ_REQA
)) return false;
327 memcpy(topaz_reader_command
, frame
, *data_len
);
329 while (!is_last_record(*tracepos
, trace
, traceLen
) && !next_record_is_response(*tracepos
, trace
)) {
330 uint32_t next_timestamp
= *((uint32_t *)(trace
+ *tracepos
));
331 *tracepos
+= sizeof(uint32_t);
332 uint16_t next_duration
= *((uint16_t *)(trace
+ *tracepos
));
333 *tracepos
+= sizeof(uint16_t);
334 uint16_t next_data_len
= *((uint16_t *)(trace
+ *tracepos
)) & 0x7FFF;
335 *tracepos
+= sizeof(uint16_t);
336 uint8_t *next_frame
= (trace
+ *tracepos
);
337 *tracepos
+= next_data_len
;
338 if ((next_data_len
== 1) && (*data_len
+ next_data_len
<= MAX_TOPAZ_READER_CMD_LEN
)) {
339 memcpy(topaz_reader_command
+ *data_len
, next_frame
, next_data_len
);
340 *data_len
+= next_data_len
;
341 last_timestamp
= next_timestamp
+ next_duration
;
344 *tracepos
= *tracepos
- next_data_len
- sizeof(uint16_t) - sizeof(uint16_t) - sizeof(uint32_t);
347 uint16_t next_parity_len
= (next_data_len
-1)/8 + 1;
348 *tracepos
+= next_parity_len
;
351 *duration
= last_timestamp
- timestamp
;
357 uint16_t printTraceLine(uint16_t tracepos
, uint16_t traceLen
, uint8_t *trace
, uint8_t protocol
, bool showWaitCycles
)
360 uint16_t data_len
, parity_len
;
362 uint8_t topaz_reader_command
[9];
363 uint32_t timestamp
, first_timestamp
, EndOfTransmissionTimestamp
;
364 char explanation
[30] = {0};
366 if (tracepos
+ sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) > traceLen
) return traceLen
;
368 first_timestamp
= *((uint32_t *)(trace
));
369 timestamp
= *((uint32_t *)(trace
+ tracepos
));
372 duration
= *((uint16_t *)(trace
+ tracepos
));
374 data_len
= *((uint16_t *)(trace
+ tracepos
));
377 if (data_len
& 0x8000) {
383 parity_len
= (data_len
-1)/8 + 1;
385 if (tracepos
+ data_len
+ parity_len
> traceLen
) {
388 uint8_t *frame
= trace
+ tracepos
;
389 tracepos
+= data_len
;
390 uint8_t *parityBytes
= trace
+ tracepos
;
391 tracepos
+= parity_len
;
393 if (protocol
== TOPAZ
&& !isResponse
) {
394 // topaz reader commands come in 1 or 9 separate frames with 7 or 8 Bits each.
396 if (merge_topaz_reader_frames(timestamp
, &duration
, &tracepos
, traceLen
, trace
, frame
, topaz_reader_command
, &data_len
)) {
397 frame
= topaz_reader_command
;
401 //Check the CRC status
402 uint8_t crcStatus
= 2;
407 crcStatus
= iclass_CRC_check(isResponse
, frame
, data_len
);
411 crcStatus
= iso14443B_CRC_check(isResponse
, frame
, data_len
);
414 crcStatus
= iso14443A_CRC_check(isResponse
, frame
, data_len
);
420 //0 CRC-command, CRC not ok
421 //1 CRC-command, CRC ok
424 //--- Draw the data column
425 //char line[16][110];
428 for (int j
= 0; j
< data_len
&& j
/16 < 16; j
++) {
430 int oddparity
= 0x01;
433 for (k
=0 ; k
<8 ; k
++) {
434 oddparity
^= (((frame
[j
] & 0xFF) >> k
) & 0x01);
436 uint8_t parityBits
= parityBytes
[j
>>3];
437 if (isResponse
&& (oddparity
!= ((parityBits
>> (7-(j
&0x0007))) & 0x01))) {
438 snprintf(line
[j
/16]+(( j
% 16) * 4), 110, " %02x!", frame
[j
]);
440 snprintf(line
[j
/16]+(( j
% 16) * 4), 110, " %02x ", frame
[j
]);
444 if(crcStatus
== 0 || crcStatus
== 1)
446 char *pos1
= line
[(data_len
-2)/16]+(((data_len
-2) % 16) * 4);
448 char *pos2
= line
[(data_len
)/16]+(((data_len
) % 16) * 4);
449 sprintf(pos2
, "%c", ']');
454 sprintf(line
[0],"<empty trace - possible error>");
457 //--- Draw the CRC column
459 char *crc
= (crcStatus
== 0 ? "!crc" : (crcStatus
== 1 ? " ok " : " "));
461 EndOfTransmissionTimestamp
= timestamp
+ duration
;
466 case ICLASS
: annotateIclass(explanation
,sizeof(explanation
),frame
,data_len
); break;
467 case ISO_14443A
: annotateIso14443a(explanation
,sizeof(explanation
),frame
,data_len
); break;
468 case ISO_14443B
: annotateIso14443b(explanation
,sizeof(explanation
),frame
,data_len
); break;
469 case TOPAZ
: annotateTopaz(explanation
,sizeof(explanation
),frame
,data_len
); break;
474 int num_lines
= MIN((data_len
- 1)/16 + 1, 16);
475 for (int j
= 0; j
< num_lines
; j
++) {
477 PrintAndLog(" %9d | %9d | %s |%-64s | %s| %s",
478 (timestamp
- first_timestamp
),
479 (EndOfTransmissionTimestamp
- first_timestamp
),
480 (isResponse
? "Tag" : "Rdr"),
482 (j
== num_lines
-1) ? crc
: " ",
483 (j
== num_lines
-1) ? explanation
: "");
485 PrintAndLog(" | | |%-64s | %s| %s",
487 (j
== num_lines
-1) ? crc
: " ",
488 (j
== num_lines
-1) ? explanation
: "");
492 if (is_last_record(tracepos
, trace
, traceLen
)) return traceLen
;
494 if (showWaitCycles
&& !isResponse
&& next_record_is_response(tracepos
, trace
)) {
495 uint32_t next_timestamp
= *((uint32_t *)(trace
+ tracepos
));
496 PrintAndLog(" %9d | %9d | %s | fdt (Frame Delay Time): %d",
497 (EndOfTransmissionTimestamp
- first_timestamp
),
498 (next_timestamp
- first_timestamp
),
500 (next_timestamp
- EndOfTransmissionTimestamp
));
507 int CmdHFList(const char *Cmd
)
509 bool showWaitCycles
= false;
511 int tlen
= param_getstr(Cmd
,0,type
);
512 char param
= param_getchar(Cmd
, 1);
514 uint8_t protocol
= 0;
520 if(param
== 'h' || (param
!=0 && param
!= 'f'))
526 if(strcmp(type
, "iclass") == 0) {
528 } else if(strcmp(type
, "14a") == 0) {
529 protocol
= ISO_14443A
;
530 } else if(strcmp(type
, "14b") == 0) {
531 protocol
= ISO_14443B
;
532 } else if(strcmp(type
,"topaz")== 0) {
534 } else if(strcmp(type
,"raw")== 0) {
535 protocol
= -1;//No crc, no annotations
542 PrintAndLog("List protocol data in trace buffer.");
543 PrintAndLog("Usage: hf list <protocol> [f]");
544 PrintAndLog(" f - show frame delay times as well");
545 PrintAndLog("Supported <protocol> values:");
546 PrintAndLog(" raw - just show raw data without annotations");
547 PrintAndLog(" 14a - interpret data as iso14443a communications");
548 PrintAndLog(" 14b - interpret data as iso14443b communications");
549 PrintAndLog(" iclass - interpret data as iclass communications");
550 PrintAndLog(" topaz - interpret data as topaz communications");
552 PrintAndLog("example: hf list 14a f");
553 PrintAndLog("example: hf list iclass");
559 showWaitCycles
= true;
564 uint16_t tracepos
= 0;
565 trace
= malloc(USB_CMD_DATA_SIZE
);
567 // Query for the size of the trace
569 GetFromBigBuf(trace
, USB_CMD_DATA_SIZE
, 0);
570 WaitForResponse(CMD_ACK
, &response
);
571 uint16_t traceLen
= response
.arg
[2];
572 if (traceLen
> USB_CMD_DATA_SIZE
) {
573 uint8_t *p
= realloc(trace
, traceLen
);
575 PrintAndLog("Cannot allocate memory for trace");
580 GetFromBigBuf(trace
, traceLen
, 0);
581 WaitForResponse(CMD_ACK
, NULL
);
584 PrintAndLog("Recorded Activity (TraceLen = %d bytes)", traceLen
);
586 PrintAndLog("Start = Start of Start Bit, End = End of last modulation. Src = Source of Transfer");
587 PrintAndLog("iso14443a - All times are in carrier periods (1/13.56Mhz)");
588 PrintAndLog("iClass - Timings are not as accurate");
590 PrintAndLog(" Start | End | Src | Data (! denotes parity error) | CRC | Annotation |");
591 PrintAndLog("-----------|-----------|-----|-----------------------------------------------------------------|-----|--------------------|");
593 while(tracepos
< traceLen
)
595 tracepos
= printTraceLine(tracepos
, traceLen
, trace
, protocol
, showWaitCycles
);
603 static command_t CommandTable
[] =
605 {"help", CmdHelp
, 1, "This help"},
606 {"14a", CmdHF14A
, 1, "{ ISO14443A RFIDs... }"},
607 {"14b", CmdHF14B
, 1, "{ ISO14443B RFIDs... }"},
608 {"15", CmdHF15
, 1, "{ ISO15693 RFIDs... }"},
609 {"epa", CmdHFEPA
, 1, "{ German Identification Card... }"},
610 {"legic", CmdHFLegic
, 0, "{ LEGIC RFIDs... }"},
611 {"iclass", CmdHFiClass
, 1, "{ ICLASS RFIDs... }"},
612 {"mf", CmdHFMF
, 1, "{ MIFARE RFIDs... }"},
613 {"mfu", CmdHFMFUltra
, 1, "{ MIFARE Ultralight RFIDs... }"},
614 {"tune", CmdHFTune
, 0, "Continuously measure HF antenna tuning"},
615 {"list", CmdHFList
, 1, "List protocol data in trace buffer"},
616 {NULL
, NULL
, 0, NULL
}
619 int CmdHF(const char *Cmd
)
621 CmdsParse(CommandTable
, Cmd
);
625 int CmdHelp(const char *Cmd
)
627 CmdsHelp(CommandTable
);