1 //-----------------------------------------------------------------------------
3 // Copyright (C) 2010 iZsh <izsh at fail0verflow.com>, Hagen Fritsch
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 ISO14443A commands
10 //-----------------------------------------------------------------------------
17 #include "../common/iso14443crc.h"
19 #include "proxmark3.h"
21 #include "cmdparser.h"
23 #include "../include/common.h"
25 #include "../include/mifare.h"
27 static int CmdHelp(const char *Cmd
);
28 static void waitCmd(uint8_t iLen
);
30 int CmdHF14AList(const char *Cmd
)
32 bool ShowWaitCycles
= false;
33 char param
= param_getchar(Cmd
, 0);
35 if (param
== 'h' || (param
!= 0 && param
!= 'f')) {
36 PrintAndLog("List data in trace buffer.");
37 PrintAndLog("Usage: hf 14a list [f]");
38 PrintAndLog("f - show frame delay times as well");
39 PrintAndLog("sample: hf 14a list f");
44 ShowWaitCycles
= true;
47 // for the time being. Need better Bigbuf handling.
48 #define TRACE_SIZE 3000
50 uint8_t trace
[TRACE_SIZE
];
51 GetFromBigBuf(trace
, TRACE_SIZE
, 0);
52 WaitForResponse(CMD_ACK
,NULL
);
54 PrintAndLog("Recorded Activity");
56 PrintAndLog("Start = Start of Start Bit, End = End of last modulation. Src = Source of Transfer");
57 PrintAndLog("All times are in carrier periods (1/13.56Mhz)");
59 PrintAndLog(" Start | End | Src | Data");
60 PrintAndLog("-----------|-----------|-----|--------");
62 uint16_t tracepos
= 0;
68 uint32_t first_timestamp
;
69 uint32_t EndOfTransmissionTimestamp
;
73 if(tracepos
>= TRACE_SIZE
) {
77 timestamp
= *((uint32_t *)(trace
+ tracepos
));
79 first_timestamp
= timestamp
;
82 duration
= *((uint16_t *)(trace
+ tracepos
));
84 data_len
= *((uint16_t *)(trace
+ tracepos
));
87 if (data_len
& 0x8000) {
94 parity_len
= (data_len
-1)/8 + 1;
96 if (tracepos
+ data_len
+ parity_len
>= TRACE_SIZE
) {
100 uint8_t *frame
= trace
+ tracepos
;
101 tracepos
+= data_len
;
102 uint8_t *parityBytes
= trace
+ tracepos
;
103 tracepos
+= parity_len
;
105 // Break and stick with current result if buffer was not completely full
106 if (timestamp
== 0x44444444) break;
108 char line
[1000] = "";
110 for (j
= 0; j
< data_len
; j
++) {
111 int oddparity
= 0x01;
115 oddparity
^= (((frame
[j
] & 0xFF) >> k
) & 0x01);
118 uint8_t parityBits
= parityBytes
[j
>>3];
119 if (isResponse
&& (oddparity
!= ((parityBits
>> (7-(j
&0x0007))) & 0x01))) {
120 sprintf(line
+(j
*4), "%02x! ", frame
[j
]);
122 sprintf(line
+(j
*4), "%02x ", frame
[j
]);
129 ComputeCrc14443(CRC_14443_A
, frame
, data_len
-2, &b1
, &b2
);
130 if (b1
!= frame
[data_len
-2] || b2
!= frame
[data_len
-1]) {
131 sprintf(crc
, (isResponse
& (data_len
< 6)) ? "" : " !crc");
137 EndOfTransmissionTimestamp
= timestamp
+ duration
;
139 PrintAndLog(" %9d | %9d | %s | %s %s",
140 (timestamp
- first_timestamp
),
141 (EndOfTransmissionTimestamp
- first_timestamp
),
142 (isResponse
? "Tag" : "Rdr"),
146 bool next_isResponse
= *((uint16_t *)(trace
+ tracepos
+ 6)) & 0x8000;
148 if (ShowWaitCycles
&& !isResponse
&& next_isResponse
) {
149 uint32_t next_timestamp
= *((uint32_t *)(trace
+ tracepos
));
150 if (next_timestamp
!= 0x44444444) {
151 PrintAndLog(" %9d | %9d | %s | fdt (Frame Delay Time): %d",
152 (EndOfTransmissionTimestamp
- first_timestamp
),
153 (next_timestamp
- first_timestamp
),
155 (next_timestamp
- EndOfTransmissionTimestamp
));
164 void iso14a_set_timeout(uint32_t timeout
) {
165 UsbCommand c
= {CMD_READER_ISO_14443a
, {ISO14A_SET_TIMEOUT
, 0, timeout
}};
169 int CmdHF14AReader(const char *Cmd
)
171 //UsbCommand c = {CMD_READER_ISO_14443a, {ISO14A_CONNECT | ISO14A_NO_DISCONNECT, 0, 0}};
172 UsbCommand c
= {CMD_READER_ISO_14443a
, {ISO14A_CONNECT
, 0, 0}};
176 WaitForResponse(CMD_ACK
,&resp
);
178 iso14a_card_select_t card
;
179 memcpy(&card
, (iso14a_card_select_t
*)resp
.d
.asBytes
, sizeof(iso14a_card_select_t
));
181 uint64_t select_status
= resp
.arg
[0]; // 0: couldn't read, 1: OK, with ATS, 2: OK, no ATS
183 if(select_status
== 0) {
184 PrintAndLog("iso14443a card select failed");
188 PrintAndLog("ATQA : %02x %02x", card
.atqa
[1], card
.atqa
[0]);
189 PrintAndLog(" UID : %s", sprint_hex(card
.uid
, card
.uidlen
));
190 PrintAndLog(" SAK : %02x [%d]", card
.sak
, resp
.arg
[0]);
193 case 0x00: PrintAndLog("TYPE : NXP MIFARE Ultralight | Ultralight C"); break;
194 case 0x01: PrintAndLog("TYPE : NXP TNP3xxx Activision Game Appliance"); break;
195 case 0x04: PrintAndLog("TYPE : NXP MIFARE (various !DESFire !DESFire EV1)"); break;
196 case 0x08: PrintAndLog("TYPE : NXP MIFARE CLASSIC 1k | Plus 2k SL1"); break;
197 case 0x09: PrintAndLog("TYPE : NXP MIFARE Mini 0.3k"); break;
198 case 0x10: PrintAndLog("TYPE : NXP MIFARE Plus 2k SL2"); break;
199 case 0x11: PrintAndLog("TYPE : NXP MIFARE Plus 4k SL2"); break;
200 case 0x18: PrintAndLog("TYPE : NXP MIFARE Classic 4k | Plus 4k SL1"); break;
201 case 0x20: PrintAndLog("TYPE : NXP MIFARE DESFire 4k | DESFire EV1 2k/4k/8k | Plus 2k/4k SL3 | JCOP 31/41"); break;
202 case 0x24: PrintAndLog("TYPE : NXP MIFARE DESFire | DESFire EV1"); break;
203 case 0x28: PrintAndLog("TYPE : JCOP31 or JCOP41 v2.3.1"); break;
204 case 0x38: PrintAndLog("TYPE : Nokia 6212 or 6131 MIFARE CLASSIC 4K"); break;
205 case 0x88: PrintAndLog("TYPE : Infineon MIFARE CLASSIC 1K"); break;
206 case 0x98: PrintAndLog("TYPE : Gemplus MPCOS"); break;
211 // try to request ATS even if tag claims not to support it
212 if (select_status
== 2) {
213 uint8_t rats
[] = { 0xE0, 0x80 }; // FSDI=8 (FSD=256), CID=0
214 c
.arg
[0] = ISO14A_RAW
| ISO14A_APPEND_CRC
| ISO14A_NO_DISCONNECT
;
217 memcpy(c
.d
.asBytes
, rats
, 2);
219 WaitForResponse(CMD_ACK
,&resp
);
221 memcpy(&card
.ats
, resp
.d
.asBytes
, resp
.arg
[0]);
222 card
.ats_len
= resp
.arg
[0]; // note: ats_len includes CRC Bytes
232 if(card
.ats_len
>= 3) { // a valid ATS consists of at least the length byte (TL) and 2 CRC bytes
233 bool ta1
= 0, tb1
= 0, tc1
= 0;
236 if (select_status
== 2) {
237 PrintAndLog("SAK incorrectly claims that card doesn't support RATS");
239 PrintAndLog(" ATS : %s", sprint_hex(card
.ats
, card
.ats_len
));
240 PrintAndLog(" - TL : length is %d bytes", card
.ats
[0]);
241 if (card
.ats
[0] != card
.ats_len
- 2) {
242 PrintAndLog("ATS may be corrupted. Length of ATS (%d bytes incl. 2 Bytes CRC) doesn't match TL", card
.ats_len
);
245 if (card
.ats
[0] > 1) { // there is a format byte (T0)
246 ta1
= (card
.ats
[1] & 0x10) == 0x10;
247 tb1
= (card
.ats
[1] & 0x20) == 0x20;
248 tc1
= (card
.ats
[1] & 0x40) == 0x40;
249 int16_t fsci
= card
.ats
[1] & 0x0f;
250 PrintAndLog(" - T0 : TA1 is%s present, TB1 is%s present, "
251 "TC1 is%s present, FSCI is %d (FSC = %ld)",
252 (ta1
? "" : " NOT"), (tb1
? "" : " NOT"), (tc1
? "" : " NOT"),
254 fsci
< 5 ? (fsci
- 2) * 8 :
255 fsci
< 8 ? (fsci
- 3) * 32 :
263 dr
[0] = ds
[0] = '\0';
264 if (card
.ats
[pos
] & 0x10) strcat(ds
, "2, ");
265 if (card
.ats
[pos
] & 0x20) strcat(ds
, "4, ");
266 if (card
.ats
[pos
] & 0x40) strcat(ds
, "8, ");
267 if (card
.ats
[pos
] & 0x01) strcat(dr
, "2, ");
268 if (card
.ats
[pos
] & 0x02) strcat(dr
, "4, ");
269 if (card
.ats
[pos
] & 0x04) strcat(dr
, "8, ");
270 if (strlen(ds
) != 0) ds
[strlen(ds
) - 2] = '\0';
271 if (strlen(dr
) != 0) dr
[strlen(dr
) - 2] = '\0';
272 PrintAndLog(" - TA1 : different divisors are%s supported, "
273 "DR: [%s], DS: [%s]",
274 (card
.ats
[pos
] & 0x80 ? " NOT" : ""), dr
, ds
);
278 uint32_t sfgi
= card
.ats
[pos
] & 0x0F;
279 uint32_t fwi
= card
.ats
[pos
] >> 4;
280 PrintAndLog(" - TB1 : SFGI = %d (SFGT = %s%ld/fc), FWI = %d (FWT = %ld/fc)",
282 sfgi
? "" : "(not needed) ",
283 sfgi
? (1 << 12) << sfgi
: 0,
290 PrintAndLog(" - TC1 : NAD is%s supported, CID is%s supported",
291 (card
.ats
[pos
] & 0x01) ? "" : " NOT",
292 (card
.ats
[pos
] & 0x02) ? "" : " NOT");
295 if (card
.ats
[0] > pos
) {
297 if (card
.ats
[0] - pos
>= 7) {
298 if (memcmp(card
.ats
+ pos
, "\xC1\x05\x2F\x2F\x01\xBC\xD6", 7) == 0) {
299 tip
= "-> MIFARE Plus X 2K or 4K";
300 } else if (memcmp(card
.ats
+ pos
, "\xC1\x05\x2F\x2F\x00\x35\xC7", 7) == 0) {
301 tip
= "-> MIFARE Plus S 2K or 4K";
304 PrintAndLog(" - HB : %s%s", sprint_hex(card
.ats
+ pos
, card
.ats
[0] - pos
), tip
);
305 if (card
.ats
[pos
] == 0xC1) {
306 PrintAndLog(" c1 -> Mifare or (multiple) virtual cards of various type");
307 PrintAndLog(" %02x -> Length is %d bytes",
308 card
.ats
[pos
+ 1], card
.ats
[pos
+ 1]);
309 switch (card
.ats
[pos
+ 2] & 0xf0) {
311 PrintAndLog(" 1x -> MIFARE DESFire");
314 PrintAndLog(" 2x -> MIFARE Plus");
317 switch (card
.ats
[pos
+ 2] & 0x0f) {
319 PrintAndLog(" x0 -> <1 kByte");
322 PrintAndLog(" x0 -> 1 kByte");
325 PrintAndLog(" x0 -> 2 kByte");
328 PrintAndLog(" x0 -> 4 kByte");
331 PrintAndLog(" x0 -> 8 kByte");
334 switch (card
.ats
[pos
+ 3] & 0xf0) {
336 PrintAndLog(" 0x -> Engineering sample");
339 PrintAndLog(" 2x -> Released");
342 switch (card
.ats
[pos
+ 3] & 0x0f) {
344 PrintAndLog(" x0 -> Generation 1");
347 PrintAndLog(" x1 -> Generation 2");
350 PrintAndLog(" x2 -> Generation 3");
353 switch (card
.ats
[pos
+ 4] & 0x0f) {
355 PrintAndLog(" x0 -> Only VCSL supported");
358 PrintAndLog(" x1 -> VCS, VCSL, and SVC supported");
361 PrintAndLog(" xE -> no VCS command supported");
367 PrintAndLog("proprietary non iso14443-4 card found, RATS not supported");
370 return select_status
;
373 // Collect ISO14443 Type A UIDs
374 int CmdHF14ACUIDs(const char *Cmd
)
376 // requested number of UIDs
378 // collect at least 1 (e.g. if no parameter was given)
381 PrintAndLog("Collecting %d UIDs", n
);
382 PrintAndLog("Start: %u", time(NULL
));
384 for (int i
= 0; i
< n
; i
++) {
385 // execute anticollision procedure
386 UsbCommand c
= {CMD_READER_ISO_14443a
, {ISO14A_CONNECT
, 0, 0}};
390 WaitForResponse(CMD_ACK
,&resp
);
392 iso14a_card_select_t
*card
= (iso14a_card_select_t
*) resp
.d
.asBytes
;
394 // check if command failed
395 if (resp
.arg
[0] == 0) {
396 PrintAndLog("Card select failed.");
399 for (uint16_t i
= 0; i
< card
->uidlen
; i
++) {
400 sprintf(&uid_string
[2*i
], "%02X", card
->uid
[i
]);
402 PrintAndLog("%s", uid_string
);
405 PrintAndLog("End: %u", time(NULL
));
410 // ## simulate iso14443a tag
411 // ## greg - added ability to specify tag UID
412 int CmdHF14ASim(const char *Cmd
)
414 UsbCommand c
= {CMD_SIMULATE_TAG_ISO_14443a
,{0,0,0}};
416 // Retrieve the tag type
417 uint8_t tagtype
= param_get8ex(Cmd
,0,0,10);
419 // When no argument was given, just print help message
422 PrintAndLog(" Emulating ISO/IEC 14443 type A tag with 4 or 7 byte UID");
424 PrintAndLog(" syntax: hf 14a sim <type> <uid>");
425 PrintAndLog(" types: 1 = MIFARE Classic");
426 PrintAndLog(" 2 = MIFARE Ultralight");
427 PrintAndLog(" 3 = MIFARE DESFIRE");
428 PrintAndLog(" 4 = ISO/IEC 14443-4");
429 PrintAndLog(" 5 = MIFARE TNP3XXX");
434 // Store the tag type
437 // Retrieve the full 4 or 7 byte long uid
438 uint64_t long_uid
= param_get64ex(Cmd
,1,0,16);
440 // Are we handling the (optional) second part uid?
441 if (long_uid
> 0xffffffff) {
442 PrintAndLog("Emulating ISO/IEC 14443 type A tag with 7 byte UID (%014"llx
")",long_uid
);
443 // Store the second part
444 c
.arg
[2] = (long_uid
& 0xffffffff);
446 // Store the first part, ignore the first byte, it is replaced by cascade byte (0x88)
447 c
.arg
[1] = (long_uid
& 0xffffff);
449 PrintAndLog("Emulating ISO/IEC 14443 type A tag with 4 byte UID (%08x)",long_uid
);
450 // Only store the first part
451 c
.arg
[1] = long_uid
& 0xffffffff;
454 // At lease save the mandatory first part of the UID
455 c.arg[0] = long_uid & 0xffffffff;
458 PrintAndLog("Emulating ISO/IEC 14443 type A tag with UID %01d %08x %08x",c.arg[0],c.arg[1],c.arg[2]);
463 PrintAndLog("Emulating ISO/IEC 14443-3 type A tag with 4 byte UID");
464 UsbCommand c = {CMD_SIMULATE_TAG_ISO_14443a,param_get32ex(Cmd,0,0,10),param_get32ex(Cmd,1,0,16),param_get32ex(Cmd,2,0,16)};
467 PrintAndLog("Emulating ISO/IEC 14443-4 type A tag with 7 byte UID");
470 PrintAndLog("Error: unkown tag type (%d)",c.arg[0]);
471 PrintAndLog("syntax: hf 14a sim <uid>",c.arg[0]);
472 PrintAndLog(" type1: 4 ",c.arg[0]);
479 unsigned int hi = 0, lo = 0;
481 while (sscanf(&Cmd[i++], "%1x", &n ) == 1) {
482 hi= (hi << 4) | (lo >> 28);
483 lo= (lo << 4) | (n & 0xf);
486 // UsbCommand c = {CMD_SIMULATE_TAG_ISO_14443a,param_get32ex(Cmd,0,0,10),param_get32ex(Cmd,1,0,16),param_get32ex(Cmd,2,0,16)};
487 // PrintAndLog("Emulating ISO/IEC 14443 type A tag with UID %01d %08x %08x",c.arg[0],c.arg[1],c.arg[2]);
492 int CmdHF14ASnoop(const char *Cmd
) {
495 if (param_getchar(Cmd
, 0) == 'h') {
496 PrintAndLog("It get data from the field and saves it into command buffer.");
497 PrintAndLog("Buffer accessible from command hf 14a list.");
498 PrintAndLog("Usage: hf 14a snoop [c][r]");
499 PrintAndLog("c - triggered by first data from card");
500 PrintAndLog("r - triggered by first 7-bit request from reader (REQ,WUP,...)");
501 PrintAndLog("sample: hf 14a snoop c r");
505 for (int i
= 0; i
< 2; i
++) {
506 char ctmp
= param_getchar(Cmd
, i
);
507 if (ctmp
== 'c' || ctmp
== 'C') param
|= 0x01;
508 if (ctmp
== 'r' || ctmp
== 'R') param
|= 0x02;
511 UsbCommand c
= {CMD_SNOOP_ISO_14443a
, {param
, 0, 0}};
516 int CmdHF14ACmdRaw(const char *cmd
) {
517 UsbCommand c
= {CMD_READER_ISO_14443a
, {0, 0, 0}};
522 uint8_t active_select
=0;
528 uint8_t data
[USB_CMD_DATA_SIZE
];
529 unsigned int datalen
=0, temp
;
532 PrintAndLog("Usage: hf 14a raw [-r] [-c] [-p] [-f] [-b] [-t] <number of bits> <0A 0B 0C ... hex>");
533 PrintAndLog(" -r do not read response");
534 PrintAndLog(" -c calculate and append CRC");
535 PrintAndLog(" -p leave the signal field ON after receive");
536 PrintAndLog(" -a active signal field ON without select");
537 PrintAndLog(" -s active signal field ON with select");
538 PrintAndLog(" -b number of bits to send. Useful for send partial byte");
539 PrintAndLog(" -t timeout");
544 while (*cmd
==' ' || *cmd
=='\t') cmd
++;
546 while (cmd
[i
]!='\0') {
547 if (cmd
[i
]==' ' || cmd
[i
]=='\t') { i
++; continue; }
566 sscanf(cmd
+i
+2,"%d",&temp
);
567 numbits
= temp
& 0xFFFF;
569 while(cmd
[i
]!=' ' && cmd
[i
]!='\0') { i
++; }
574 sscanf(cmd
+i
+2,"%d",&temp
);
575 timeout
= temp
& 0xFFFF;
577 while(cmd
[i
]!=' ' && cmd
[i
]!='\0') { i
++; }
581 PrintAndLog("Invalid option");
587 if ((cmd
[i
]>='0' && cmd
[i
]<='9') ||
588 (cmd
[i
]>='a' && cmd
[i
]<='f') ||
589 (cmd
[i
]>='A' && cmd
[i
]<='F') ) {
590 buf
[strlen(buf
)+1]=0;
591 buf
[strlen(buf
)]=cmd
[i
];
594 if (strlen(buf
)>=2) {
595 sscanf(buf
,"%x",&temp
);
596 data
[datalen
]=(uint8_t)(temp
& 0xff);
598 if (++datalen
>sizeof(data
)){
600 PrintAndLog("Buffer is full, we can't add CRC to your data");
606 PrintAndLog("Invalid char on input");
609 if(crc
&& datalen
>0 && datalen
<sizeof(data
)-2)
611 uint8_t first
, second
;
612 ComputeCrc14443(CRC_14443_A
, data
, datalen
, &first
, &second
);
613 data
[datalen
++] = first
;
614 data
[datalen
++] = second
;
617 if(active
|| active_select
)
619 c
.arg
[0] |= ISO14A_CONNECT
;
621 c
.arg
[0] |= ISO14A_NO_SELECT
;
624 #define MAX_TIMEOUT 624*105 // max timeout is 624 ms
625 c
.arg
[0] |= ISO14A_SET_TIMEOUT
;
626 c
.arg
[2] = timeout
* 105; // each bit is about 9.4 us
627 if(c
.arg
[2]>MAX_TIMEOUT
) {
628 c
.arg
[2] = MAX_TIMEOUT
;
629 PrintAndLog("Set timeout to 624 ms. The max we can wait for response");
633 c
.arg
[0] |= ISO14A_NO_DISCONNECT
;
635 c
.arg
[0] |= ISO14A_RAW
;
637 // Max buffer is USB_CMD_DATA_SIZE
638 c
.arg
[1] = (datalen
& 0xFFFF) | (numbits
<< 16);
639 memcpy(c
.d
.asBytes
,data
,datalen
);
652 static void waitCmd(uint8_t iSelect
)
658 if (WaitForResponseTimeout(CMD_ACK
,&resp
,10000)) {
659 recv
= resp
.d
.asBytes
;
660 uint8_t iLen
= iSelect
? resp
.arg
[1] : resp
.arg
[0];
661 PrintAndLog("received %i octets",iLen
);
664 hexout
= (char *)malloc(iLen
* 3 + 1);
665 if (hexout
!= NULL
) {
666 for (int i
= 0; i
< iLen
; i
++) { // data in hex
667 sprintf(&hexout
[i
* 3], "%02X ", recv
[i
]);
669 PrintAndLog("%s", hexout
);
672 PrintAndLog("malloc failed your client has low memory?");
675 PrintAndLog("timeout while waiting for reply.");
679 static command_t CommandTable
[] =
681 {"help", CmdHelp
, 1, "This help"},
682 {"list", CmdHF14AList
, 0, "List ISO 14443a history"},
683 {"reader", CmdHF14AReader
, 0, "Act like an ISO14443 Type A reader"},
684 {"cuids", CmdHF14ACUIDs
, 0, "<n> Collect n>0 ISO14443 Type A UIDs in one go"},
685 {"sim", CmdHF14ASim
, 0, "<UID> -- Fake ISO 14443a tag"},
686 {"snoop", CmdHF14ASnoop
, 0, "Eavesdrop ISO 14443 Type A"},
687 {"raw", CmdHF14ACmdRaw
, 0, "Send raw hex data to tag"},
688 {NULL
, NULL
, 0, NULL
}
691 int CmdHF14A(const char *Cmd
) {
693 WaitForResponseTimeout(CMD_ACK
,NULL
,100);
696 CmdsParse(CommandTable
, Cmd
);
700 int CmdHelp(const char *Cmd
)
702 CmdsHelp(CommandTable
);