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 "cmdhftopaz.h"
27 #include "protocols.h"
29 static int CmdHelp(const char *Cmd
);
31 int CmdHFTune(const char *Cmd
)
33 UsbCommand c
={CMD_MEASURE_ANTENNA_TUNING_HF
};
39 void annotateIso14443a(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
43 case ISO14443A_CMD_WUPA
: snprintf(exp
,size
,"WUPA"); break;
44 case ISO14443A_CMD_ANTICOLL_OR_SELECT
:{
45 // 93 20 = Anticollision (usage: 9320 - answer: 4bytes UID+1byte UID-bytes-xor)
46 // 93 70 = Select (usage: 9370+5bytes 9320 answer - answer: 1byte SAK)
49 snprintf(exp
,size
,"SELECT_UID"); break;
52 snprintf(exp
,size
,"ANTICOLL"); break;
55 case ISO14443A_CMD_ANTICOLL_OR_SELECT_2
:{
56 //95 20 = Anticollision of cascade level2
57 //95 70 = Select of cascade level2
60 snprintf(exp
,size
,"SELECT_UID-2"); break;
63 snprintf(exp
,size
,"ANTICOLL-2"); break;
66 case ISO14443A_CMD_REQA
: snprintf(exp
,size
,"REQA"); break;
67 case ISO14443A_CMD_READBLOCK
: snprintf(exp
,size
,"READBLOCK(%d)",cmd
[1]); break;
68 case ISO14443A_CMD_WRITEBLOCK
: snprintf(exp
,size
,"WRITEBLOCK(%d)",cmd
[1]); break;
69 case ISO14443A_CMD_HALT
: snprintf(exp
,size
,"HALT"); break;
70 case ISO14443A_CMD_RATS
: snprintf(exp
,size
,"RATS"); break;
71 case MIFARE_CMD_INC
: snprintf(exp
,size
,"INC(%d)",cmd
[1]); break;
72 case MIFARE_CMD_DEC
: snprintf(exp
,size
,"DEC(%d)",cmd
[1]); break;
73 case MIFARE_CMD_RESTORE
: snprintf(exp
,size
,"RESTORE(%d)",cmd
[1]); break;
74 case MIFARE_CMD_TRANSFER
: snprintf(exp
,size
,"TRANSFER(%d)",cmd
[1]); break;
75 case MIFARE_AUTH_KEYA
: snprintf(exp
,size
,"AUTH-A(%d)",cmd
[1]); break;
76 case MIFARE_AUTH_KEYB
: snprintf(exp
,size
,"AUTH-B(%d)",cmd
[1]); break;
77 case MIFARE_MAGICWUPC1
: snprintf(exp
,size
,"MAGIC WUPC1"); break;
78 case MIFARE_MAGICWUPC2
: snprintf(exp
,size
,"MAGIC WUPC2"); break;
79 case MIFARE_MAGICWIPEC
: snprintf(exp
,size
,"MAGIC WIPEC"); break;
80 default: snprintf(exp
,size
,"?"); break;
85 void annotateIclass(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
89 case ICLASS_CMD_ACTALL
: snprintf(exp
,size
,"ACTALL"); break;
90 case ICLASS_CMD_READ_OR_IDENTIFY
:{
92 snprintf(exp
,size
,"READ(%d)",cmd
[1]);
94 snprintf(exp
,size
,"IDENTIFY");
98 case ICLASS_CMD_SELECT
: snprintf(exp
,size
,"SELECT"); break;
99 case ICLASS_CMD_PAGESEL
: snprintf(exp
,size
,"PAGESEL(%d)", cmd
[1]); break;
100 case ICLASS_CMD_READCHECK_KC
:snprintf(exp
,size
,"READCHECK[Kc](%d)", cmd
[1]); break;
101 case ICLASS_CMD_READCHECK_KD
:snprintf(exp
,size
,"READCHECK[Kd](%d)", cmd
[1]); break;
102 case ICLASS_CMD_CHECK
: snprintf(exp
,size
,"CHECK"); break;
103 case ICLASS_CMD_DETECT
: snprintf(exp
,size
,"DETECT"); break;
104 case ICLASS_CMD_HALT
: snprintf(exp
,size
,"HALT"); break;
105 case ICLASS_CMD_UPDATE
: snprintf(exp
,size
,"UPDATE(%d)",cmd
[1]); break;
106 case ICLASS_CMD_ACT
: snprintf(exp
,size
,"ACT"); break;
107 case ICLASS_CMD_READ4
: snprintf(exp
,size
,"READ4(%d)",cmd
[1]); break;
108 default: snprintf(exp
,size
,"?"); break;
113 void annotateIso15693(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
119 case ISO15693_INVENTORY
:snprintf(exp
, size
, "INVENTORY");break;
120 case ISO15693_STAYQUIET
:snprintf(exp
, size
, "STAY_QUIET");break;
121 default: snprintf(exp
,size
,"?"); break;
124 }else if(cmd
[0] == 0x02)
128 case ISO15693_READBLOCK
:snprintf(exp
, size
, "READBLOCK");break;
129 case ISO15693_WRITEBLOCK
:snprintf(exp
, size
, "WRITEBLOCK");break;
130 case ISO15693_LOCKBLOCK
:snprintf(exp
, size
, "LOCKBLOCK");break;
131 case ISO15693_READ_MULTI_BLOCK
:snprintf(exp
, size
, "READ_MULTI_BLOCK");break;
132 case ISO15693_SELECT
:snprintf(exp
, size
, "SELECT");break;
133 case ISO15693_RESET_TO_READY
:snprintf(exp
, size
, "RESET_TO_READY");break;
134 case ISO15693_WRITE_AFI
:snprintf(exp
, size
, "WRITE_AFI");break;
135 case ISO15693_LOCK_AFI
:snprintf(exp
, size
, "LOCK_AFI");break;
136 case ISO15693_WRITE_DSFID
:snprintf(exp
, size
, "WRITE_DSFID");break;
137 case ISO15693_LOCK_DSFID
:snprintf(exp
, size
, "LOCK_DSFID");break;
138 case ISO15693_GET_SYSTEM_INFO
:snprintf(exp
, size
, "GET_SYSTEM_INFO");break;
139 case ISO15693_READ_MULTI_SECSTATUS
:snprintf(exp
, size
, "READ_MULTI_SECSTATUS");break;
140 default: snprintf(exp
,size
,"?"); break;
146 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 case TOPAZ_RSEG
:snprintf(exp
, size
, "RSEG");break;
157 case TOPAZ_READ8
:snprintf(exp
, size
, "READ8");break;
158 case TOPAZ_WRITE_E8
:snprintf(exp
, size
, "WRITE-E8");break;
159 case TOPAZ_WRITE_NE8
:snprintf(exp
, size
, "WRITE-NE8");break;
160 default: snprintf(exp
,size
,"?"); break;
167 0E xx = SELECT ID (xx = Chip-ID)
169 08 yy = Read Block (yy = block number)
170 09 yy dd dd dd dd = Write Block (yy = block number; dd dd dd dd = data to be written)
171 0C = Reset to Inventory
173 0A 11 22 33 44 55 66 = Authenticate (11 22 33 44 55 66 = data to authenticate)
176 void annotateIso14443b(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
179 case ISO14443B_REQB
: snprintf(exp
,size
,"REQB");break;
180 case ISO14443B_ATTRIB
: snprintf(exp
,size
,"ATTRIB");break;
181 case ISO14443B_HALT
: snprintf(exp
,size
,"HALT");break;
182 case ISO14443B_INITIATE
: snprintf(exp
,size
,"INITIATE");break;
183 case ISO14443B_SELECT
: snprintf(exp
,size
,"SELECT(%d)",cmd
[1]);break;
184 case ISO14443B_GET_UID
: snprintf(exp
,size
,"GET UID");break;
185 case ISO14443B_READ_BLK
: snprintf(exp
,size
,"READ_BLK(%d)", cmd
[1]);break;
186 case ISO14443B_WRITE_BLK
: snprintf(exp
,size
,"WRITE_BLK(%d)",cmd
[1]);break;
187 case ISO14443B_RESET
: snprintf(exp
,size
,"RESET");break;
188 case ISO14443B_COMPLETION
: snprintf(exp
,size
,"COMPLETION");break;
189 case ISO14443B_AUTHENTICATE
: snprintf(exp
,size
,"AUTHENTICATE");break;
190 default : snprintf(exp
,size
,"?");break;
196 * @brief iso14443A_CRC_check Checks CRC in command or response
200 * @return 0 : CRC-command, CRC not ok
201 * 1 : CRC-command, CRC ok
202 * 2 : Not crc-command
205 uint8_t iso14443A_CRC_check(bool isResponse
, uint8_t* data
, uint8_t len
)
209 if(len
<= 2) return 2;
211 if(isResponse
& (len
< 6)) return 2;
213 ComputeCrc14443(CRC_14443_A
, data
, len
-2, &b1
, &b2
);
214 if (b1
!= data
[len
-2] || b2
!= data
[len
-1]) {
223 * @brief iso14443B_CRC_check Checks CRC in command or response
227 * @return 0 : CRC-command, CRC not ok
228 * 1 : CRC-command, CRC ok
229 * 2 : Not crc-command
232 uint8_t iso14443B_CRC_check(bool isResponse
, uint8_t* data
, uint8_t len
)
236 if(len
<= 2) return 2;
238 ComputeCrc14443(CRC_14443_B
, data
, len
-2, &b1
, &b2
);
239 if(b1
!= data
[len
-2] || b2
!= data
[len
-1]) {
247 * @brief iclass_CRC_Ok Checks CRC in command or response
251 * @return 0 : CRC-command, CRC not ok
252 * 1 : CRC-command, CRC ok
253 * 2 : Not crc-command
255 uint8_t iclass_CRC_check(bool isResponse
, uint8_t* data
, uint8_t len
)
257 if(len
< 4) return 2;//CRC commands (and responses) are all at least 4 bytes
261 if(!isResponse
)//Commands to tag
264 These commands should have CRC. Total length leftmost
267 12 UPDATE - unsecured, ends with CRC16
268 14 UPDATE - secured, ends with signature instead
271 if(len
== 4 || len
== 12)//Covers three of them
273 //Don't include the command byte
274 ComputeCrc14443(CRC_ICLASS
, (data
+1), len
-3, &b1
, &b2
);
275 return b1
== data
[len
-2] && b2
== data
[len
-1];
280 These tag responses should have CRC. Total length leftmost
282 10 READ data[8] crc[2]
283 34 READ4 data[32]crc[2]
284 10 UPDATE data[8] crc[2]
285 10 SELECT csn[8] crc[2]
286 10 IDENTIFY asnb[8] crc[2]
287 10 PAGESEL block1[8] crc[2]
288 10 DETECT csn[8] crc[2]
292 4 CHECK chip_response[4]
297 In conclusion, without looking at the command; any response
298 of length 10 or 34 should have CRC
300 if(len
!= 10 && len
!= 34) return true;
302 ComputeCrc14443(CRC_ICLASS
, data
, len
-2, &b1
, &b2
);
303 return b1
== data
[len
-2] && b2
== data
[len
-1];
308 bool is_last_record(uint16_t tracepos
, uint8_t *trace
, uint16_t traceLen
)
310 return(tracepos
+ sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) >= traceLen
);
314 bool next_record_is_response(uint16_t tracepos
, uint8_t *trace
)
316 uint16_t next_records_datalen
= *((uint16_t *)(trace
+ tracepos
+ sizeof(uint32_t) + sizeof(uint16_t)));
318 return(next_records_datalen
& 0x8000);
322 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
)
325 #define MAX_TOPAZ_READER_CMD_LEN 16
327 uint32_t last_timestamp
= timestamp
+ *duration
;
329 if ((*data_len
!= 1) || (frame
[0] == TOPAZ_WUPA
) || (frame
[0] == TOPAZ_REQA
)) return false;
331 memcpy(topaz_reader_command
, frame
, *data_len
);
333 while (!is_last_record(*tracepos
, trace
, traceLen
) && !next_record_is_response(*tracepos
, trace
)) {
334 uint32_t next_timestamp
= *((uint32_t *)(trace
+ *tracepos
));
335 *tracepos
+= sizeof(uint32_t);
336 uint16_t next_duration
= *((uint16_t *)(trace
+ *tracepos
));
337 *tracepos
+= sizeof(uint16_t);
338 uint16_t next_data_len
= *((uint16_t *)(trace
+ *tracepos
)) & 0x7FFF;
339 *tracepos
+= sizeof(uint16_t);
340 uint8_t *next_frame
= (trace
+ *tracepos
);
341 *tracepos
+= next_data_len
;
342 if ((next_data_len
== 1) && (*data_len
+ next_data_len
<= MAX_TOPAZ_READER_CMD_LEN
)) {
343 memcpy(topaz_reader_command
+ *data_len
, next_frame
, next_data_len
);
344 *data_len
+= next_data_len
;
345 last_timestamp
= next_timestamp
+ next_duration
;
348 *tracepos
= *tracepos
- next_data_len
- sizeof(uint16_t) - sizeof(uint16_t) - sizeof(uint32_t);
351 uint16_t next_parity_len
= (next_data_len
-1)/8 + 1;
352 *tracepos
+= next_parity_len
;
355 *duration
= last_timestamp
- timestamp
;
361 uint16_t printTraceLine(uint16_t tracepos
, uint16_t traceLen
, uint8_t *trace
, uint8_t protocol
, bool showWaitCycles
, bool markCRCBytes
)
364 uint16_t data_len
, parity_len
;
366 uint8_t topaz_reader_command
[9];
367 uint32_t timestamp
, first_timestamp
, EndOfTransmissionTimestamp
;
368 char explanation
[30] = {0};
370 if (tracepos
+ sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) > traceLen
) return traceLen
;
372 first_timestamp
= *((uint32_t *)(trace
));
373 timestamp
= *((uint32_t *)(trace
+ tracepos
));
376 duration
= *((uint16_t *)(trace
+ tracepos
));
378 data_len
= *((uint16_t *)(trace
+ tracepos
));
381 if (data_len
& 0x8000) {
387 parity_len
= (data_len
-1)/8 + 1;
389 if (tracepos
+ data_len
+ parity_len
> traceLen
) {
392 uint8_t *frame
= trace
+ tracepos
;
393 tracepos
+= data_len
;
394 uint8_t *parityBytes
= trace
+ tracepos
;
395 tracepos
+= parity_len
;
397 if (protocol
== TOPAZ
&& !isResponse
) {
398 // topaz reader commands come in 1 or 9 separate frames with 7 or 8 Bits each.
400 if (merge_topaz_reader_frames(timestamp
, &duration
, &tracepos
, traceLen
, trace
, frame
, topaz_reader_command
, &data_len
)) {
401 frame
= topaz_reader_command
;
405 //Check the CRC status
406 uint8_t crcStatus
= 2;
411 crcStatus
= iclass_CRC_check(isResponse
, frame
, data_len
);
415 crcStatus
= iso14443B_CRC_check(isResponse
, frame
, data_len
);
418 crcStatus
= iso14443A_CRC_check(isResponse
, frame
, data_len
);
424 //0 CRC-command, CRC not ok
425 //1 CRC-command, CRC ok
428 //--- Draw the data column
429 //char line[16][110];
432 for (int j
= 0; j
< data_len
&& j
/16 < 16; j
++) {
434 int oddparity
= 0x01;
437 for (k
=0 ; k
<8 ; k
++) {
438 oddparity
^= (((frame
[j
] & 0xFF) >> k
) & 0x01);
440 uint8_t parityBits
= parityBytes
[j
>>3];
441 if (isResponse
&& (oddparity
!= ((parityBits
>> (7-(j
&0x0007))) & 0x01))) {
442 snprintf(line
[j
/16]+(( j
% 16) * 4), 110, " %02x!", frame
[j
]);
444 snprintf(line
[j
/16]+(( j
% 16) * 4), 110, " %02x ", frame
[j
]);
450 if(crcStatus
== 0 || crcStatus
== 1)
452 char *pos1
= line
[(data_len
-2)/16]+(((data_len
-2) % 16) * 4);
454 char *pos2
= line
[(data_len
)/16]+(((data_len
) % 16) * 4);
455 sprintf(pos2
, "%c", ']');
462 sprintf(line
[0],"<empty trace - possible error>");
465 //--- Draw the CRC column
467 char *crc
= (crcStatus
== 0 ? "!crc" : (crcStatus
== 1 ? " ok " : " "));
469 EndOfTransmissionTimestamp
= timestamp
+ duration
;
474 case ICLASS
: annotateIclass(explanation
,sizeof(explanation
),frame
,data_len
); break;
475 case ISO_14443A
: annotateIso14443a(explanation
,sizeof(explanation
),frame
,data_len
); break;
476 case ISO_14443B
: annotateIso14443b(explanation
,sizeof(explanation
),frame
,data_len
); break;
477 case TOPAZ
: annotateTopaz(explanation
,sizeof(explanation
),frame
,data_len
); break;
482 int num_lines
= MIN((data_len
- 1)/16 + 1, 16);
483 for (int j
= 0; j
< num_lines
; j
++) {
485 PrintAndLog(" %10d | %10d | %s |%-64s | %s| %s",
486 (timestamp
- first_timestamp
),
487 (EndOfTransmissionTimestamp
- first_timestamp
),
488 (isResponse
? "Tag" : "Rdr"),
490 (j
== num_lines
-1) ? crc
: " ",
491 (j
== num_lines
-1) ? explanation
: "");
493 PrintAndLog(" | | |%-64s | %s| %s",
495 (j
== num_lines
-1) ? crc
: " ",
496 (j
== num_lines
-1) ? explanation
: "");
500 if (is_last_record(tracepos
, trace
, traceLen
)) return traceLen
;
502 if (showWaitCycles
&& !isResponse
&& next_record_is_response(tracepos
, trace
)) {
503 uint32_t next_timestamp
= *((uint32_t *)(trace
+ tracepos
));
504 PrintAndLog(" %9d | %9d | %s | fdt (Frame Delay Time): %d",
505 (EndOfTransmissionTimestamp
- first_timestamp
),
506 (next_timestamp
- first_timestamp
),
508 (next_timestamp
- EndOfTransmissionTimestamp
));
515 int CmdHFList(const char *Cmd
)
517 bool showWaitCycles
= false;
518 bool markCRCBytes
= false;
520 int tlen
= param_getstr(Cmd
,0,type
);
521 char param1
= param_getchar(Cmd
, 1);
522 char param2
= param_getchar(Cmd
, 2);
524 uint8_t protocol
= 0;
532 || (param1
!= 0 && param1
!= 'f' && param1
!= 'c')
533 || (param2
!= 0 && param2
!= 'f' && param2
!= 'c')) {
538 if(strcmp(type
, "iclass") == 0) {
540 } else if(strcmp(type
, "14a") == 0) {
541 protocol
= ISO_14443A
;
542 } else if(strcmp(type
, "14b") == 0) {
543 protocol
= ISO_14443B
;
544 } else if(strcmp(type
,"topaz")== 0) {
546 } else if(strcmp(type
,"raw")== 0) {
547 protocol
= -1;//No crc, no annotations
554 PrintAndLog("List protocol data in trace buffer.");
555 PrintAndLog("Usage: hf list <protocol> [f][c]");
556 PrintAndLog(" f - show frame delay times as well");
557 PrintAndLog(" c - mark CRC bytes");
558 PrintAndLog("Supported <protocol> values:");
559 PrintAndLog(" raw - just show raw data without annotations");
560 PrintAndLog(" 14a - interpret data as iso14443a communications");
561 PrintAndLog(" 14b - interpret data as iso14443b communications");
562 PrintAndLog(" iclass - interpret data as iclass communications");
563 PrintAndLog(" topaz - interpret data as topaz communications");
565 PrintAndLog("example: hf list 14a f");
566 PrintAndLog("example: hf list iclass");
571 if (param1
== 'f' || param2
== 'f') {
572 showWaitCycles
= true;
575 if (param1
== 'c' || param2
== 'c') {
580 uint16_t tracepos
= 0;
581 trace
= malloc(USB_CMD_DATA_SIZE
);
583 // Query for the size of the trace
585 GetFromBigBuf(trace
, USB_CMD_DATA_SIZE
, 0);
586 WaitForResponse(CMD_ACK
, &response
);
587 uint16_t traceLen
= response
.arg
[2];
588 if (traceLen
> USB_CMD_DATA_SIZE
) {
589 uint8_t *p
= realloc(trace
, traceLen
);
591 PrintAndLog("Cannot allocate memory for trace");
596 GetFromBigBuf(trace
, traceLen
, 0);
597 WaitForResponse(CMD_ACK
, NULL
);
600 PrintAndLog("Recorded Activity (TraceLen = %d bytes)", traceLen
);
602 PrintAndLog("Start = Start of Start Bit, End = End of last modulation. Src = Source of Transfer");
603 PrintAndLog("iso14443a - All times are in carrier periods (1/13.56Mhz)");
604 PrintAndLog("iClass - Timings are not as accurate");
606 PrintAndLog(" Start | End | Src | Data (! denotes parity error) | CRC | Annotation |");
607 PrintAndLog("-----------|-----------|-----|-----------------------------------------------------------------|-----|--------------------|");
609 while(tracepos
< traceLen
)
611 tracepos
= printTraceLine(tracepos
, traceLen
, trace
, protocol
, showWaitCycles
, markCRCBytes
);
619 static command_t CommandTable
[] =
621 {"help", CmdHelp
, 1, "This help"},
622 {"14a", CmdHF14A
, 1, "{ ISO14443A RFIDs... }"},
623 {"14b", CmdHF14B
, 1, "{ ISO14443B RFIDs... }"},
624 {"15", CmdHF15
, 1, "{ ISO15693 RFIDs... }"},
625 {"epa", CmdHFEPA
, 1, "{ German Identification Card... }"},
626 {"legic", CmdHFLegic
, 0, "{ LEGIC RFIDs... }"},
627 {"iclass", CmdHFiClass
, 1, "{ ICLASS RFIDs... }"},
628 {"mf", CmdHFMF
, 1, "{ MIFARE RFIDs... }"},
629 {"mfu", CmdHFMFUltra
, 1, "{ MIFARE Ultralight RFIDs... }"},
630 {"topaz", CmdHFTopaz
, 1, "{ TOPAZ (NFC Type 1) RFIDs... }"},
631 {"tune", CmdHFTune
, 0, "Continuously measure HF antenna tuning"},
632 {"list", CmdHFList
, 1, "List protocol data in trace buffer"},
633 {NULL
, NULL
, 0, NULL
}
636 int CmdHF(const char *Cmd
)
638 CmdsParse(CommandTable
, Cmd
);
642 int CmdHelp(const char *Cmd
)
644 CmdsHelp(CommandTable
);