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 static int CmdHelp(const char *Cmd
);
28 int CmdHFTune(const char *Cmd
)
30 UsbCommand c
={CMD_MEASURE_ANTENNA_TUNING_HF
};
34 // for the time being. Need better Bigbuf handling.
35 #define TRACE_SIZE 3000
37 //The following data is taken from http://www.proxmark.org/forum/viewtopic.php?pid=13501#p13501
39 ISO14443A (usually NFC tags)
41 30 = Read (usage: 30+1byte block number+2bytes ISO14443A-CRC - answer: 16bytes)
42 A2 = Write (usage: A2+1byte block number+4bytes data+2bytes ISO14443A-CRC - answer: 0A [ACK] or 00 [NAK])
43 52 (7bits) = WUPA (usage: 52(7bits) - answer: 2bytes ATQA)
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)
46 95 20 = Anticollision of cascade level2
47 95 70 = Select of cascade level2
48 50 00 = Halt (usage: 5000+2bytes ISO14443A-CRC - no answer from card)
50 60 = Authenticate with KeyA
51 61 = Authenticate with KeyB
52 40 (7bits) = Used to put Chinese Changeable UID cards in special mode (must be followed by 43 (8bits) - answer: 0A)
58 A0 = Compatibility Write (to accomodate MIFARE commands)
59 1A = Step1 Authenticate
60 AF = Step2 Authenticate
67 SRIX4K (tag does not respond to 05)
69 0E xx = SELECT ID (xx = Chip-ID)
71 08 yy = Read Block (yy = block number)
72 09 yy dd dd dd dd = Write Block (yy = block number; dd dd dd dd = data to be written)
73 0C = Reset to Inventory
75 0A 11 22 33 44 55 66 = Authenticate (11 22 33 44 55 66 = data to authenticate)
79 MANDATORY COMMANDS (all ISO15693 tags must support those)
80 01 = Inventory (usage: 260100+2bytes ISO15693-CRC - answer: 12bytes)
82 OPTIONAL COMMANDS (not all tags support them)
83 20 = Read Block (usage: 0220+1byte block number+2bytes ISO15693-CRC - answer: 4bytes)
84 21 = Write Block (usage: 0221+1byte block number+4bytes data+2bytes ISO15693-CRC - answer: 4bytes)
86 23 = Read Multiple Blocks (usage: 0223+1byte 1st block to read+1byte last block to read+2bytes ISO15693-CRC)
93 2B = Get_System_Info (usage: 022B+2bytes ISO15693-CRC - answer: 14 or more bytes)
94 2C = Read Multiple Block Security Status (usage: 022C+1byte 1st block security to read+1byte last block security to read+2bytes ISO15693-CRC)
96 EM Microelectronic CUSTOM COMMANDS
97 A5 = Active EAS (followed by 1byte IC Manufacturer code+1byte EAS type)
98 A7 = Write EAS ID (followed by 1byte IC Manufacturer code+2bytes EAS value)
99 B8 = Get Protection Status for a specific block (followed by 1byte IC Manufacturer code+1byte block number+1byte of how many blocks after the previous is needed the info)
100 E4 = Login (followed by 1byte IC Manufacturer code+4bytes password)
101 NXP/Philips CUSTOM COMMANDS
103 A1 = Fast Inventory Read
108 A6 = Password Protect EAS
111 B0 = Inventory Page Read
112 B1 = Fast Inventory Page Read
113 B2 = Get Random Number
117 B6 = Bit Password Protection
118 B7 = Lock Page Protection Condition
119 B8 = Get Multiple Block Protection Status
122 BB = 64bit Password Protection
123 40 = Long Range CMD (Standard ISO/TR7003:1990)
126 #define ICLASS_CMD_ACTALL 0x0A
127 #define ICLASS_CMD_READ_OR_IDENTIFY 0x0C
128 #define ICLASS_CMD_SELECT 0x81
129 #define ICLASS_CMD_PAGESEL 0x84
130 #define ICLASS_CMD_READCHECK_KD 0x88
131 #define ICLASS_CMD_READCHECK_KC 0x18
132 #define ICLASS_CMD_CHECK 0x05
133 #define ICLASS_CMD_DETECT 0x0F
134 #define ICLASS_CMD_HALT 0x00
135 #define ICLASS_CMD_UPDATE 0x87
136 #define ICLASS_CMD_ACT 0x8E
137 #define ICLASS_CMD_READ4 0x06
140 #define ISO14443A_CMD_REQA 0x26
141 #define ISO14443A_CMD_READBLOCK 0x30
142 #define ISO14443A_CMD_WUPA 0x52
143 #define ISO14443A_CMD_ANTICOLL_OR_SELECT 0x93
144 #define ISO14443A_CMD_ANTICOLL_OR_SELECT_2 0x95
145 #define ISO14443A_CMD_WRITEBLOCK 0xA0 // or 0xA2 ?
146 #define ISO14443A_CMD_HALT 0x50
147 #define ISO14443A_CMD_RATS 0xE0
149 #define MIFARE_AUTH_KEYA 0x60
150 #define MIFARE_AUTH_KEYB 0x61
151 #define MIFARE_MAGICMODE 0x40
152 #define MIFARE_CMD_INC 0xC0
153 #define MIFARE_CMD_DEC 0xC1
154 #define MIFARE_CMD_RESTORE 0xC2
155 #define MIFARE_CMD_TRANSFER 0xB0
157 #define MIFARE_ULC_WRITE 0xA0
158 #define MIFARE_ULC_AUTH_1 0x1A
159 #define MIFARE_ULC_AUTH_2 0xAF
161 #define ISO14443B_REQB 0x05
162 #define ISO14443B_ATTRIB 0x1D
163 #define ISO14443B_HALT 0x50
166 #define ISO15693_INVENTORY 0x01
167 #define ISO15693_STAYQUIET 0x02
169 #define ISO15693_READBLOCK 0x20
170 #define ISO15693_WRITEBLOCK 0x21
171 #define ISO15693_LOCKBLOCK 0x22
172 #define ISO15693_READ_MULTI_BLOCK 0x23
173 #define ISO15693_SELECT 0x25
174 #define ISO15693_RESET_TO_READY 0x26
175 #define ISO15693_WRITE_AFI 0x27
176 #define ISO15693_LOCK_AFI 0x28
177 #define ISO15693_WRITE_DSFID 0x29
178 #define ISO15693_LOCK_DSFID 0x2A
179 #define ISO15693_GET_SYSTEM_INFO 0x2B
180 #define ISO15693_READ_MULTI_SECSTATUS 0x2C
188 void annotateIso14443a(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
192 case ISO14443A_CMD_WUPA
: snprintf(exp
,size
,"WUPA"); break;
193 case ISO14443A_CMD_ANTICOLL_OR_SELECT
:{
194 // 93 20 = Anticollision (usage: 9320 - answer: 4bytes UID+1byte UID-bytes-xor)
195 // 93 70 = Select (usage: 9370+5bytes 9320 answer - answer: 1byte SAK)
198 snprintf(exp
,size
,"SELECT_UID"); break;
201 snprintf(exp
,size
,"ANTICOLL"); break;
204 case ISO14443A_CMD_ANTICOLL_OR_SELECT_2
:{
205 //95 20 = Anticollision of cascade level2
206 //95 70 = Select of cascade level2
209 snprintf(exp
,size
,"SELECT_UID-2"); break;
212 snprintf(exp
,size
,"ANTICOLL-2"); break;
215 case ISO14443A_CMD_REQA
: snprintf(exp
,size
,"REQA"); break;
216 case ISO14443A_CMD_READBLOCK
: snprintf(exp
,size
,"READBLOCK(%d)",cmd
[1]); break;
217 case ISO14443A_CMD_WRITEBLOCK
: snprintf(exp
,size
,"WRITEBLOCK(%d)",cmd
[1]); break;
218 case ISO14443A_CMD_HALT
: snprintf(exp
,size
,"HALT"); break;
219 case ISO14443A_CMD_RATS
: snprintf(exp
,size
,"RATS"); break;
220 case MIFARE_CMD_INC
: snprintf(exp
,size
,"INC(%d)",cmd
[1]); break;
221 case MIFARE_CMD_DEC
: snprintf(exp
,size
,"DEC(%d)",cmd
[1]); break;
222 case MIFARE_CMD_RESTORE
: snprintf(exp
,size
,"RESTORE(%d)",cmd
[1]); break;
223 case MIFARE_CMD_TRANSFER
: snprintf(exp
,size
,"TRANSFER(%d)",cmd
[1]); break;
224 case MIFARE_AUTH_KEYA
: snprintf(exp
,size
,"AUTH-A"); break;
225 case MIFARE_AUTH_KEYB
: snprintf(exp
,size
,"AUTH-B"); break;
226 case MIFARE_MAGICMODE
: snprintf(exp
,size
,"MAGIC"); break;
227 default: snprintf(exp
,size
,"?"); break;
232 void annotateIclass(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
236 case ICLASS_CMD_ACTALL
: snprintf(exp
,size
,"ACTALL"); break;
237 case ICLASS_CMD_READ_OR_IDENTIFY
:{
239 snprintf(exp
,size
,"READ(%d)",cmd
[1]);
241 snprintf(exp
,size
,"IDENTIFY");
245 case ICLASS_CMD_SELECT
: snprintf(exp
,size
,"SELECT"); break;
246 case ICLASS_CMD_PAGESEL
: snprintf(exp
,size
,"PAGESEL(%d)", cmd
[1]); break;
247 case ICLASS_CMD_READCHECK_KC
:snprintf(exp
,size
,"READCHECK[Kc](%d)", cmd
[1]); break;
248 case ICLASS_CMD_READCHECK_KD
:snprintf(exp
,size
,"READCHECK[Kd](%d)", cmd
[1]); break;
249 case ICLASS_CMD_CHECK
: snprintf(exp
,size
,"CHECK"); break;
250 case ICLASS_CMD_DETECT
: snprintf(exp
,size
,"DETECT"); break;
251 case ICLASS_CMD_HALT
: snprintf(exp
,size
,"HALT"); break;
252 case ICLASS_CMD_UPDATE
: snprintf(exp
,size
,"UPDATE(%d)",cmd
[1]); break;
253 case ICLASS_CMD_ACT
: snprintf(exp
,size
,"ACT"); break;
254 case ICLASS_CMD_READ4
: snprintf(exp
,size
,"READ4(%d)",cmd
[1]); break;
255 default: snprintf(exp
,size
,"?"); break;
260 void annotateIso15693(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
266 case ISO15693_INVENTORY
:snprintf(exp
, size
, "INVENTORY");break;
267 case ISO15693_STAYQUIET
:snprintf(exp
, size
, "STAY_QUIET");break;
268 default: snprintf(exp
,size
,"?"); break;
271 }else if(cmd
[0] == 0x02)
275 case ISO15693_READBLOCK
:snprintf(exp
, size
, "READBLOCK");break;
276 case ISO15693_WRITEBLOCK
:snprintf(exp
, size
, "WRITEBLOCK");break;
277 case ISO15693_LOCKBLOCK
:snprintf(exp
, size
, "LOCKBLOCK");break;
278 case ISO15693_READ_MULTI_BLOCK
:snprintf(exp
, size
, "READ_MULTI_BLOCK");break;
279 case ISO15693_SELECT
:snprintf(exp
, size
, "SELECT");break;
280 case ISO15693_RESET_TO_READY
:snprintf(exp
, size
, "RESET_TO_READY");break;
281 case ISO15693_WRITE_AFI
:snprintf(exp
, size
, "WRITE_AFI");break;
282 case ISO15693_LOCK_AFI
:snprintf(exp
, size
, "LOCK_AFI");break;
283 case ISO15693_WRITE_DSFID
:snprintf(exp
, size
, "WRITE_DSFID");break;
284 case ISO15693_LOCK_DSFID
:snprintf(exp
, size
, "LOCK_DSFID");break;
285 case ISO15693_GET_SYSTEM_INFO
:snprintf(exp
, size
, "GET_SYSTEM_INFO");break;
286 case ISO15693_READ_MULTI_SECSTATUS
:snprintf(exp
, size
, "READ_MULTI_SECSTATUS");break;
287 default: snprintf(exp
,size
,"?"); break;
291 void annotateIso14443b(char *exp
, size_t size
, uint8_t* cmd
, uint8_t cmdsize
)
294 case ISO14443B_REQB
: snprintf(exp
,size
,"REQB");break;
295 case ISO14443B_ATTRIB
: snprintf(exp
,size
,"ATTRIB");break;
296 case ISO14443B_HALT
: snprintf(exp
,size
,"HALT");break;
297 default: snprintf(exp
,size
,"?");break;
303 * @brief iso14443B_CRC_Ok Checks CRC in command or response
307 * @return 0 : CRC-command, CRC not ok
308 * 1 : CRC-command, CRC ok
309 * 2 : Not crc-command
312 uint8_t iso14443B_CRC_check(bool isResponse
, uint8_t* data
, uint8_t len
)
316 if(len
<= 2) return 2;
318 ComputeCrc14443(CRC_14443_B
, data
, len
-2, &b1
, &b2
);
319 if(b1
!= data
[len
-2] || b2
!= data
[len
-1]) {
326 * @brief iclass_CRC_Ok Checks CRC in command or response
330 * @return 0 : CRC-command, CRC not ok
331 * 1 : CRC-command, CRC ok
332 * 2 : Not crc-command
334 uint8_t iclass_CRC_check(bool isResponse
, uint8_t* data
, uint8_t len
)
336 if(len
< 4) return 2;//CRC commands (and responses) are all at least 4 bytes
340 if(!isResponse
)//Commands to tag
343 These commands should have CRC. Total length leftmost
346 12 UPDATE - unsecured, ends with CRC16
347 14 UPDATE - secured, ends with signature instead
350 if(len
== 4 || len
== 12)//Covers three of them
352 //Don't include the command byte
353 ComputeCrc14443(CRC_ICLASS
, (data
+1), len
-3, &b1
, &b2
);
354 return b1
== data
[len
-2] && b2
== data
[len
-1];
359 These tag responses should have CRC. Total length leftmost
361 10 READ data[8] crc[2]
362 34 READ4 data[32]crc[2]
363 10 UPDATE data[8] crc[2]
364 10 SELECT csn[8] crc[2]
365 10 IDENTIFY asnb[8] crc[2]
366 10 PAGESEL block1[8] crc[2]
367 10 DETECT csn[8] crc[2]
371 4 CHECK chip_response[4]
376 In conclusion, without looking at the command; any response
377 of length 10 or 34 should have CRC
379 if(len
!= 10 && len
!= 34) return true;
381 ComputeCrc14443(CRC_ICLASS
, data
, len
-2, &b1
, &b2
);
382 return b1
== data
[len
-2] && b2
== data
[len
-1];
386 uint16_t printTraceLine(uint16_t tracepos
, uint8_t* trace
, uint8_t protocol
, bool showWaitCycles
)
389 uint16_t duration
, data_len
,parity_len
;
391 uint32_t timestamp
, first_timestamp
, EndOfTransmissionTimestamp
;
392 char explanation
[30] = {0};
394 first_timestamp
= *((uint32_t *)(trace
));
395 timestamp
= *((uint32_t *)(trace
+ tracepos
));
396 // Break and stick with current result if buffer was not completely full
397 if (timestamp
== 0x44444444) return TRACE_SIZE
;
400 duration
= *((uint16_t *)(trace
+ tracepos
));
402 data_len
= *((uint16_t *)(trace
+ tracepos
));
405 if (data_len
& 0x8000) {
411 parity_len
= (data_len
-1)/8 + 1;
413 if (tracepos
+ data_len
+ parity_len
>= TRACE_SIZE
) {
417 uint8_t *frame
= trace
+ tracepos
;
418 tracepos
+= data_len
;
419 uint8_t *parityBytes
= trace
+ tracepos
;
420 tracepos
+= parity_len
;
422 //--- Draw the data column
424 for (int j
= 0; j
< data_len
; j
++) {
425 int oddparity
= 0x01;
428 for (k
=0 ; k
<8 ; k
++) {
429 oddparity
^= (((frame
[j
] & 0xFF) >> k
) & 0x01);
432 uint8_t parityBits
= parityBytes
[j
>>3];
434 if (isResponse
&& (oddparity
!= ((parityBits
>> (7-(j
&0x0007))) & 0x01))) {
435 sprintf(line
[j
/16]+((j
%16)*4), "%02x! ", frame
[j
]);
437 sprintf(line
[j
/16]+((j
%16)*4), "%02x ", frame
[j
]);
440 //--- Draw the CRC column
441 uint8_t crcStatus
= 2;
445 if(protocol
== ICLASS
)
447 crcStatus
= iclass_CRC_check(isResponse
, frame
, data_len
);
449 }else if (protocol
== ISO_14443B
)
451 crcStatus
= iso14443B_CRC_check(isResponse
, frame
, data_len
);
453 else if (protocol
== ISO_14443A
){//Iso 14443a
455 ComputeCrc14443(CRC_14443_A
, frame
, data_len
-2, &b1
, &b2
);
457 if (b1
!= frame
[data_len
-2] || b2
!= frame
[data_len
-1]) {
458 if(!(isResponse
& (data_len
< 6)))
465 //0 CRC-command, CRC not ok
466 //1 CRC-command, CRC ok
468 char *crc
= (crcStatus
== 0 ? "!crc" : (crcStatus
== 1 ? " ok " : " "));
470 EndOfTransmissionTimestamp
= timestamp
+ duration
;
474 if(protocol
== ICLASS
)
475 annotateIclass(explanation
,sizeof(explanation
),frame
,data_len
);
476 else if (protocol
== ISO_14443A
)
477 annotateIso14443a(explanation
,sizeof(explanation
),frame
,data_len
);
478 else if(protocol
== ISO_14443B
)
479 annotateIso14443b(explanation
,sizeof(explanation
),frame
,data_len
);
482 int num_lines
= (data_len
- 1)/16 + 1;
483 for (int j
= 0; j
< num_lines
; j
++) {
485 PrintAndLog(" %9d | %9d | %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 bool next_isResponse
= *((uint16_t *)(trace
+ tracepos
+ 6)) & 0x8000;
502 if (showWaitCycles
&& !isResponse
&& next_isResponse
) {
503 uint32_t next_timestamp
= *((uint32_t *)(trace
+ tracepos
));
504 if (next_timestamp
!= 0x44444444) {
505 PrintAndLog(" %9d | %9d | %s | fdt (Frame Delay Time): %d",
506 (EndOfTransmissionTimestamp
- first_timestamp
),
507 (next_timestamp
- first_timestamp
),
509 (next_timestamp
- EndOfTransmissionTimestamp
));
515 int CmdHFList(const char *Cmd
)
517 bool showWaitCycles
= false;
519 int tlen
= param_getstr(Cmd
,0,type
);
520 char param
= param_getchar(Cmd
, 1);
522 uint8_t protocol
= false;
524 if(tlen
== 0 || (strcmp(type
, "iclass") != 0 && strcmp(type
,"14a") != 0))
528 if(param
== 'h' || (param
!=0 && param
!= 'f'))
534 PrintAndLog("List protocol data in trace buffer.");
535 PrintAndLog("Usage: hf list [14a|14b|iclass] [f]");
536 PrintAndLog(" 14a - interpret data as iso14443a communications");
537 PrintAndLog(" 14b - interpret data as iso14443b communications");
538 PrintAndLog(" iclass - interpret data as iclass communications");
539 PrintAndLog(" raw - just show raw data");
540 PrintAndLog(" f - show frame delay times as well");
542 PrintAndLog("example: hf list 14a f");
543 PrintAndLog("example: hf list iclass");
546 if(strcmp(type
, "iclass") == 0)
549 }else if(strcmp(type
, "14a") == 0)
551 protocol
= ISO_14443A
;
553 else if(strcmp(type
, "14b") == 0)
555 protocol
= ISO_14443B
;
556 }else if(strcmp(type
,"raw")== 0)
558 protocol
= -1;//No crc, no annotations
562 showWaitCycles
= true;
566 uint8_t trace
[TRACE_SIZE
];
567 uint16_t tracepos
= 0;
568 GetFromBigBuf(trace
, TRACE_SIZE
, 0);
569 WaitForResponse(CMD_ACK
, NULL
);
571 PrintAndLog("Recorded Activity");
573 PrintAndLog("Start = Start of Start Bit, End = End of last modulation. Src = Source of Transfer");
574 PrintAndLog("iso14443a - All times are in carrier periods (1/13.56Mhz)");
575 PrintAndLog("iClass - Timings are not as accurate");
577 PrintAndLog(" Start | End | Src | Data (! denotes parity error) | CRC | Annotation |");
578 PrintAndLog("-----------|-----------|-----|-----------------------------------------------------------------|-----|--------------------|");
580 while(tracepos
< TRACE_SIZE
)
582 tracepos
= printTraceLine(tracepos
, trace
, protocol
, showWaitCycles
);
588 static command_t CommandTable
[] =
590 {"help", CmdHelp
, 1, "This help"},
591 {"14a", CmdHF14A
, 1, "{ ISO14443A RFIDs... }"},
592 {"14b", CmdHF14B
, 1, "{ ISO14443B RFIDs... }"},
593 {"15", CmdHF15
, 1, "{ ISO15693 RFIDs... }"},
594 {"epa", CmdHFEPA
, 1, "{ German Identification Card... }"},
595 {"legic", CmdHFLegic
, 0, "{ LEGIC RFIDs... }"},
596 {"iclass", CmdHFiClass
, 1, "{ ICLASS RFIDs... }"},
597 {"mf", CmdHFMF
, 1, "{ MIFARE RFIDs... }"},
598 {"tune", CmdHFTune
, 0, "Continuously measure HF antenna tuning"},
599 {"list", CmdHFList
, 1, "List protocol data in trace buffer"},
600 {NULL
, NULL
, 0, NULL
}
603 int CmdHF(const char *Cmd
)
605 CmdsParse(CommandTable
, Cmd
);
609 int CmdHelp(const char *Cmd
)
611 CmdsHelp(CommandTable
);