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 "iso14443crc.h"
19 #include "proxmark3.h"
21 #include "cmdparser.h"
27 static int CmdHelp(const char *Cmd
);
28 static void waitCmd(uint8_t iLen
);
31 // structure and database for uid -> tagtype lookups
37 const manufactureName manufactureMapping
[] = {
38 // ID, "Vendor Country"
39 { 0x01, "Motorola UK" },
40 { 0x02, "ST Microelectronics SA France" },
41 { 0x03, "Hitachi, Ltd Japan" },
42 { 0x04, "NXP Semiconductors Germany" },
43 { 0x05, "Infineon Technologies AG Germany" },
44 { 0x06, "Cylink USA" },
45 { 0x07, "Texas Instrument France" },
46 { 0x08, "Fujitsu Limited Japan" },
47 { 0x09, "Matsushita Electronics Corporation, Semiconductor Company Japan" },
48 { 0x0A, "NEC Japan" },
49 { 0x0B, "Oki Electric Industry Co. Ltd Japan" },
50 { 0x0C, "Toshiba Corp. Japan" },
51 { 0x0D, "Mitsubishi Electric Corp. Japan" },
52 { 0x0E, "Samsung Electronics Co. Ltd Korea" },
53 { 0x0F, "Hynix / Hyundai, Korea" },
54 { 0x10, "LG-Semiconductors Co. Ltd Korea" },
55 { 0x11, "Emosyn-EM Microelectronics USA" },
56 { 0x12, "INSIDE Technology France" },
57 { 0x13, "ORGA Kartensysteme GmbH Germany" },
58 { 0x14, "SHARP Corporation Japan" },
59 { 0x15, "ATMEL France" },
60 { 0x16, "EM Microelectronic-Marin SA Switzerland" },
61 { 0x17, "KSW Microtec GmbH Germany" },
62 { 0x18, "ZMD AG Germany" },
63 { 0x19, "XICOR, Inc. USA" },
64 { 0x1A, "Sony Corporation Japan Identifier Company Country" },
65 { 0x1B, "Malaysia Microelectronic Solutions Sdn. Bhd Malaysia" },
66 { 0x1C, "Emosyn USA" },
67 { 0x1D, "Shanghai Fudan Microelectronics Co. Ltd. P.R. China" },
68 { 0x1E, "Magellan Technology Pty Limited Australia" },
69 { 0x1F, "Melexis NV BO Switzerland" },
70 { 0x20, "Renesas Technology Corp. Japan" },
71 { 0x21, "TAGSYS France" },
72 { 0x22, "Transcore USA" },
73 { 0x23, "Shanghai belling corp., ltd. China" },
74 { 0x24, "Masktech Germany Gmbh Germany" },
75 { 0x25, "Innovision Research and Technology Plc UK" },
76 { 0x26, "Hitachi ULSI Systems Co., Ltd. Japan" },
77 { 0x27, "Cypak AB Sweden" },
78 { 0x28, "Ricoh Japan" },
79 { 0x29, "ASK France" },
80 { 0x2A, "Unicore Microsystems, LLC Russian Federation" },
81 { 0x2B, "Dallas Semiconductor/Maxim USA" },
82 { 0x2C, "Impinj, Inc. USA" },
83 { 0x2D, "RightPlug Alliance USA" },
84 { 0x2E, "Broadcom Corporation USA" },
85 { 0x2F, "MStar Semiconductor, Inc Taiwan, ROC" },
86 { 0x30, "BeeDar Technology Inc. USA" },
87 { 0x31, "RFIDsec Denmark" },
88 { 0x32, "Schweizer Electronic AG Germany" },
89 { 0x33, "AMIC Technology Corp Taiwan" },
90 { 0x34, "Mikron JSC Russia" },
91 { 0x35, "Fraunhofer Institute for Photonic Microsystems Germany" },
92 { 0x36, "IDS Microchip AG Switzerland" },
93 { 0x37, "Kovio USA" },
94 { 0x38, "HMT Microelectronic Ltd Switzerland Identifier Company Country" },
95 { 0x39, "Silicon Craft Technology Thailand" },
96 { 0x3A, "Advanced Film Device Inc. Japan" },
97 { 0x3B, "Nitecrest Ltd UK" },
98 { 0x3C, "Verayo Inc. USA" },
99 { 0x3D, "HID Global USA" },
100 { 0x3E, "Productivity Engineering Gmbh Germany" },
101 { 0x3F, "Austriamicrosystems AG (reserved) Austria" },
102 { 0x40, "Gemalto SA France" },
103 { 0x41, "Renesas Electronics Corporation Japan" },
104 { 0x42, "3Alogics Inc Korea" },
105 { 0x43, "Top TroniQ Asia Limited Hong Kong" },
106 { 0x44, "Gentag Inc (USA) USA" },
107 { 0x00, "no tag-info available" } // must be the last entry
111 // get a product description based on the UID
113 // returns description of the best match
114 static char* getTagInfo(uint8_t uid
) {
117 int len
= sizeof(manufactureMapping
) / sizeof(manufactureName
);
119 for ( i
= 0; i
< len
; ++i
) {
120 if ( uid
== manufactureMapping
[i
].uid
) {
127 if (best
>=0) return manufactureMapping
[best
].desc
;
129 return manufactureMapping
[i
].desc
;
132 int CmdHF14AList(const char *Cmd
)
134 PrintAndLog("Deprecated command, use 'hf list 14a' instead");
138 void iso14a_set_timeout(uint32_t timeout
) {
139 UsbCommand c
= {CMD_READER_ISO_14443a
, {ISO14A_SET_TIMEOUT
, 0, timeout
}};
143 int CmdHF14AReader(const char *Cmd
)
145 UsbCommand c
= {CMD_READER_ISO_14443a
, {ISO14A_CONNECT
| ISO14A_NO_DISCONNECT
, 0, 0}};
149 WaitForResponse(CMD_ACK
,&resp
);
151 iso14a_card_select_t card
;
152 memcpy(&card
, (iso14a_card_select_t
*)resp
.d
.asBytes
, sizeof(iso14a_card_select_t
));
154 uint64_t select_status
= resp
.arg
[0]; // 0: couldn't read, 1: OK, with ATS, 2: OK, no ATS
156 if(select_status
== 0) {
157 PrintAndLog("iso14443a card select failed");
166 PrintAndLog("ATQA : %02x %02x", card
.atqa
[1], card
.atqa
[0]);
167 PrintAndLog(" UID : %s", sprint_hex(card
.uid
, card
.uidlen
));
168 PrintAndLog(" SAK : %02x [%d]", card
.sak
, resp
.arg
[0]);
170 // Double & triple sized UID, can be mapped to a manufacturer.
171 if ( card
.uidlen
> 4 ) {
172 PrintAndLog("MANUFACTURER : %s", getTagInfo(card
.uid
[0]));
176 case 0x00: PrintAndLog("TYPE : NXP MIFARE Ultralight | Ultralight C"); break;
177 case 0x01: PrintAndLog("TYPE : NXP TNP3xxx Activision Game Appliance"); break;
178 case 0x04: PrintAndLog("TYPE : NXP MIFARE (various !DESFire !DESFire EV1)"); break;
179 case 0x08: PrintAndLog("TYPE : NXP MIFARE CLASSIC 1k | Plus 2k SL1"); break;
180 case 0x09: PrintAndLog("TYPE : NXP MIFARE Mini 0.3k"); break;
181 case 0x10: PrintAndLog("TYPE : NXP MIFARE Plus 2k SL2"); break;
182 case 0x11: PrintAndLog("TYPE : NXP MIFARE Plus 4k SL2"); break;
183 case 0x18: PrintAndLog("TYPE : NXP MIFARE Classic 4k | Plus 4k SL1"); break;
184 case 0x20: PrintAndLog("TYPE : NXP MIFARE DESFire 4k | DESFire EV1 2k/4k/8k | Plus 2k/4k SL3 | JCOP 31/41"); break;
185 case 0x24: PrintAndLog("TYPE : NXP MIFARE DESFire | DESFire EV1"); break;
186 case 0x28: PrintAndLog("TYPE : JCOP31 or JCOP41 v2.3.1"); break;
187 case 0x38: PrintAndLog("TYPE : Nokia 6212 or 6131 MIFARE CLASSIC 4K"); break;
188 case 0x88: PrintAndLog("TYPE : Infineon MIFARE CLASSIC 1K"); break;
189 case 0x98: PrintAndLog("TYPE : Gemplus MPCOS"); break;
193 // try to request ATS even if tag claims not to support it
194 if (select_status
== 2) {
195 uint8_t rats
[] = { 0xE0, 0x80 }; // FSDI=8 (FSD=256), CID=0
196 c
.arg
[0] = ISO14A_RAW
| ISO14A_APPEND_CRC
| ISO14A_NO_DISCONNECT
;
199 memcpy(c
.d
.asBytes
, rats
, 2);
201 WaitForResponse(CMD_ACK
,&resp
);
203 memcpy(&card
.ats
, resp
.d
.asBytes
, resp
.arg
[0]);
204 card
.ats_len
= resp
.arg
[0]; // note: ats_len includes CRC Bytes
207 if(card
.ats_len
>= 3) { // a valid ATS consists of at least the length byte (TL) and 2 CRC bytes
208 bool ta1
= 0, tb1
= 0, tc1
= 0;
211 if (select_status
== 2) {
212 PrintAndLog("SAK incorrectly claims that card doesn't support RATS");
214 PrintAndLog(" ATS : %s", sprint_hex(card
.ats
, card
.ats_len
));
215 PrintAndLog(" - TL : length is %d bytes", card
.ats
[0]);
216 if (card
.ats
[0] != card
.ats_len
- 2) {
217 PrintAndLog("ATS may be corrupted. Length of ATS (%d bytes incl. 2 Bytes CRC) doesn't match TL", card
.ats_len
);
220 if (card
.ats
[0] > 1) { // there is a format byte (T0)
221 ta1
= (card
.ats
[1] & 0x10) == 0x10;
222 tb1
= (card
.ats
[1] & 0x20) == 0x20;
223 tc1
= (card
.ats
[1] & 0x40) == 0x40;
224 int16_t fsci
= card
.ats
[1] & 0x0f;
225 PrintAndLog(" - T0 : TA1 is%s present, TB1 is%s present, "
226 "TC1 is%s present, FSCI is %d (FSC = %ld)",
227 (ta1
? "" : " NOT"), (tb1
? "" : " NOT"), (tc1
? "" : " NOT"),
229 fsci
< 5 ? (fsci
- 2) * 8 :
230 fsci
< 8 ? (fsci
- 3) * 32 :
238 dr
[0] = ds
[0] = '\0';
239 if (card
.ats
[pos
] & 0x10) strcat(ds
, "2, ");
240 if (card
.ats
[pos
] & 0x20) strcat(ds
, "4, ");
241 if (card
.ats
[pos
] & 0x40) strcat(ds
, "8, ");
242 if (card
.ats
[pos
] & 0x01) strcat(dr
, "2, ");
243 if (card
.ats
[pos
] & 0x02) strcat(dr
, "4, ");
244 if (card
.ats
[pos
] & 0x04) strcat(dr
, "8, ");
245 if (strlen(ds
) != 0) ds
[strlen(ds
) - 2] = '\0';
246 if (strlen(dr
) != 0) dr
[strlen(dr
) - 2] = '\0';
247 PrintAndLog(" - TA1 : different divisors are%s supported, "
248 "DR: [%s], DS: [%s]",
249 (card
.ats
[pos
] & 0x80 ? " NOT" : ""), dr
, ds
);
253 uint32_t sfgi
= card
.ats
[pos
] & 0x0F;
254 uint32_t fwi
= card
.ats
[pos
] >> 4;
255 PrintAndLog(" - TB1 : SFGI = %d (SFGT = %s%ld/fc), FWI = %d (FWT = %ld/fc)",
257 sfgi
? "" : "(not needed) ",
258 sfgi
? (1 << 12) << sfgi
: 0,
265 PrintAndLog(" - TC1 : NAD is%s supported, CID is%s supported",
266 (card
.ats
[pos
] & 0x01) ? "" : " NOT",
267 (card
.ats
[pos
] & 0x02) ? "" : " NOT");
270 if (card
.ats
[0] > pos
) {
272 if (card
.ats
[0] - pos
>= 7) {
273 if (memcmp(card
.ats
+ pos
, "\xC1\x05\x2F\x2F\x01\xBC\xD6", 7) == 0) {
274 tip
= "-> MIFARE Plus X 2K or 4K";
275 } else if (memcmp(card
.ats
+ pos
, "\xC1\x05\x2F\x2F\x00\x35\xC7", 7) == 0) {
276 tip
= "-> MIFARE Plus S 2K or 4K";
279 PrintAndLog(" - HB : %s%s", sprint_hex(card
.ats
+ pos
, card
.ats
[0] - pos
), tip
);
280 if (card
.ats
[pos
] == 0xC1) {
281 PrintAndLog(" c1 -> Mifare or (multiple) virtual cards of various type");
282 PrintAndLog(" %02x -> Length is %d bytes",
283 card
.ats
[pos
+ 1], card
.ats
[pos
+ 1]);
284 switch (card
.ats
[pos
+ 2] & 0xf0) {
286 PrintAndLog(" 1x -> MIFARE DESFire");
289 PrintAndLog(" 2x -> MIFARE Plus");
292 switch (card
.ats
[pos
+ 2] & 0x0f) {
294 PrintAndLog(" x0 -> <1 kByte");
297 PrintAndLog(" x0 -> 1 kByte");
300 PrintAndLog(" x0 -> 2 kByte");
303 PrintAndLog(" x0 -> 4 kByte");
306 PrintAndLog(" x0 -> 8 kByte");
309 switch (card
.ats
[pos
+ 3] & 0xf0) {
311 PrintAndLog(" 0x -> Engineering sample");
314 PrintAndLog(" 2x -> Released");
317 switch (card
.ats
[pos
+ 3] & 0x0f) {
319 PrintAndLog(" x0 -> Generation 1");
322 PrintAndLog(" x1 -> Generation 2");
325 PrintAndLog(" x2 -> Generation 3");
328 switch (card
.ats
[pos
+ 4] & 0x0f) {
330 PrintAndLog(" x0 -> Only VCSL supported");
333 PrintAndLog(" x1 -> VCS, VCSL, and SVC supported");
336 PrintAndLog(" xE -> no VCS command supported");
342 PrintAndLog("proprietary non iso14443-4 card found, RATS not supported");
346 // try to see if card responses to "chinese magic backdoor" commands.
347 c
.cmd
= CMD_MIFARE_CIDENT
;
352 WaitForResponse(CMD_ACK
,&resp
);
353 uint8_t isOK
= resp
.arg
[0] & 0xff;
354 PrintAndLog(" Answers to chinese magic backdoor commands: %s", (isOK
? "YES" : "NO") );
357 c
.cmd
= CMD_READER_ISO_14443a
;
363 return select_status
;
366 // Collect ISO14443 Type A UIDs
367 int CmdHF14ACUIDs(const char *Cmd
)
369 // requested number of UIDs
371 // collect at least 1 (e.g. if no parameter was given)
374 PrintAndLog("Collecting %d UIDs", n
);
375 PrintAndLog("Start: %u", time(NULL
));
377 for (int i
= 0; i
< n
; i
++) {
378 // execute anticollision procedure
379 UsbCommand c
= {CMD_READER_ISO_14443a
, {ISO14A_CONNECT
, 0, 0}};
383 WaitForResponse(CMD_ACK
,&resp
);
385 iso14a_card_select_t
*card
= (iso14a_card_select_t
*) resp
.d
.asBytes
;
387 // check if command failed
388 if (resp
.arg
[0] == 0) {
389 PrintAndLog("Card select failed.");
392 for (uint16_t i
= 0; i
< card
->uidlen
; i
++) {
393 sprintf(&uid_string
[2*i
], "%02X", card
->uid
[i
]);
395 PrintAndLog("%s", uid_string
);
398 PrintAndLog("End: %u", time(NULL
));
403 // ## simulate iso14443a tag
404 // ## greg - added ability to specify tag UID
405 int CmdHF14ASim(const char *Cmd
)
407 UsbCommand c
= {CMD_SIMULATE_TAG_ISO_14443a
,{0,0,0}};
409 // Retrieve the tag type
410 uint8_t tagtype
= param_get8ex(Cmd
,0,0,10);
412 // When no argument was given, just print help message
415 PrintAndLog(" Emulating ISO/IEC 14443 type A tag with 4 or 7 byte UID");
417 PrintAndLog(" syntax: hf 14a sim <type> <uid>");
418 PrintAndLog(" types: 1 = MIFARE Classic");
419 PrintAndLog(" 2 = MIFARE Ultralight");
420 PrintAndLog(" 3 = MIFARE DESFIRE");
421 PrintAndLog(" 4 = ISO/IEC 14443-4");
422 PrintAndLog(" 5 = MIFARE TNP3XXX");
427 // Store the tag type
430 // Retrieve the full 4 or 7 byte long uid
431 uint64_t long_uid
= param_get64ex(Cmd
,1,0,16);
433 // Are we handling the (optional) second part uid?
434 if (long_uid
> 0xffffffff) {
435 PrintAndLog("Emulating ISO/IEC 14443 type A tag with 7 byte UID (%014"llx
")",long_uid
);
436 // Store the second part
437 c
.arg
[2] = (long_uid
& 0xffffffff);
439 // Store the first part, ignore the first byte, it is replaced by cascade byte (0x88)
440 c
.arg
[1] = (long_uid
& 0xffffff);
442 PrintAndLog("Emulating ISO/IEC 14443 type A tag with 4 byte UID (%08x)",long_uid
);
443 // Only store the first part
444 c
.arg
[1] = long_uid
& 0xffffffff;
447 // At lease save the mandatory first part of the UID
448 c.arg[0] = long_uid & 0xffffffff;
451 PrintAndLog("Emulating ISO/IEC 14443 type A tag with UID %01d %08x %08x",c.arg[0],c.arg[1],c.arg[2]);
456 PrintAndLog("Emulating ISO/IEC 14443-3 type A tag with 4 byte UID");
457 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)};
460 PrintAndLog("Emulating ISO/IEC 14443-4 type A tag with 7 byte UID");
463 PrintAndLog("Error: unkown tag type (%d)",c.arg[0]);
464 PrintAndLog("syntax: hf 14a sim <uid>",c.arg[0]);
465 PrintAndLog(" type1: 4 ",c.arg[0]);
472 unsigned int hi = 0, lo = 0;
474 while (sscanf(&Cmd[i++], "%1x", &n ) == 1) {
475 hi= (hi << 4) | (lo >> 28);
476 lo= (lo << 4) | (n & 0xf);
479 // 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)};
480 // PrintAndLog("Emulating ISO/IEC 14443 type A tag with UID %01d %08x %08x",c.arg[0],c.arg[1],c.arg[2]);
485 int CmdHF14ASnoop(const char *Cmd
) {
488 if (param_getchar(Cmd
, 0) == 'h') {
489 PrintAndLog("It get data from the field and saves it into command buffer.");
490 PrintAndLog("Buffer accessible from command hf list 14a.");
491 PrintAndLog("Usage: hf 14a snoop [c][r]");
492 PrintAndLog("c - triggered by first data from card");
493 PrintAndLog("r - triggered by first 7-bit request from reader (REQ,WUP,...)");
494 PrintAndLog("sample: hf 14a snoop c r");
498 for (int i
= 0; i
< 2; i
++) {
499 char ctmp
= param_getchar(Cmd
, i
);
500 if (ctmp
== 'c' || ctmp
== 'C') param
|= 0x01;
501 if (ctmp
== 'r' || ctmp
== 'R') param
|= 0x02;
504 UsbCommand c
= {CMD_SNOOP_ISO_14443a
, {param
, 0, 0}};
509 int CmdHF14ACmdRaw(const char *cmd
) {
510 UsbCommand c
= {CMD_READER_ISO_14443a
, {0, 0, 0}};
515 uint8_t active_select
=0;
520 unsigned int datalen
=0, temp
;
523 PrintAndLog("Usage: hf 14a raw [-r] [-c] [-p] [-f] [-b] <number of bits> <0A 0B 0C ... hex>");
524 PrintAndLog(" -r do not read response");
525 PrintAndLog(" -c calculate and append CRC");
526 PrintAndLog(" -p leave the signal field ON after receive");
527 PrintAndLog(" -a active signal field ON without select");
528 PrintAndLog(" -s active signal field ON with select");
529 PrintAndLog(" -b number of bits to send. Useful for send partial byte");
534 while (*cmd
==' ' || *cmd
=='\t') cmd
++;
536 while (cmd
[i
]!='\0') {
537 if (cmd
[i
]==' ' || cmd
[i
]=='\t') { i
++; continue; }
556 sscanf(cmd
+i
+2,"%d",&temp
);
557 numbits
= temp
& 0xFFFF;
559 while(cmd
[i
]!=' ' && cmd
[i
]!='\0') { i
++; }
563 PrintAndLog("Invalid option");
569 if ((cmd
[i
]>='0' && cmd
[i
]<='9') ||
570 (cmd
[i
]>='a' && cmd
[i
]<='f') ||
571 (cmd
[i
]>='A' && cmd
[i
]<='F') ) {
572 buf
[strlen(buf
)+1]=0;
573 buf
[strlen(buf
)]=cmd
[i
];
576 if (strlen(buf
)>=2) {
577 sscanf(buf
,"%x",&temp
);
578 data
[datalen
]=(uint8_t)(temp
& 0xff);
584 PrintAndLog("Invalid char on input");
589 uint8_t first
, second
;
590 ComputeCrc14443(CRC_14443_A
, data
, datalen
, &first
, &second
);
591 data
[datalen
++] = first
;
592 data
[datalen
++] = second
;
595 if(active
|| active_select
)
597 c
.arg
[0] |= ISO14A_CONNECT
;
599 c
.arg
[0] |= ISO14A_NO_SELECT
;
602 c
.arg
[0] |= ISO14A_NO_DISCONNECT
;
604 c
.arg
[0] |= ISO14A_RAW
;
608 memcpy(c
.d
.asBytes
,data
,datalen
);
621 static void waitCmd(uint8_t iSelect
)
627 if (WaitForResponseTimeout(CMD_ACK
,&resp
,1000)) {
628 recv
= resp
.d
.asBytes
;
629 uint8_t iLen
= iSelect
? resp
.arg
[1] : resp
.arg
[0];
630 PrintAndLog("received %i octets",iLen
);
633 hexout
= (char *)malloc(iLen
* 3 + 1);
634 if (hexout
!= NULL
) {
635 for (int i
= 0; i
< iLen
; i
++) { // data in hex
636 sprintf(&hexout
[i
* 3], "%02X ", recv
[i
]);
638 PrintAndLog("%s", hexout
);
641 PrintAndLog("malloc failed your client has low memory?");
644 PrintAndLog("timeout while waiting for reply.");
648 static command_t CommandTable
[] =
650 {"help", CmdHelp
, 1, "This help"},
651 {"list", CmdHF14AList
, 0, "[Deprecated] List ISO 14443a history"},
652 {"reader", CmdHF14AReader
, 0, "Act like an ISO14443 Type A reader"},
653 {"cuids", CmdHF14ACUIDs
, 0, "<n> Collect n>0 ISO14443 Type A UIDs in one go"},
654 {"sim", CmdHF14ASim
, 0, "<UID> -- Fake ISO 14443a tag"},
655 {"snoop", CmdHF14ASnoop
, 0, "Eavesdrop ISO 14443 Type A"},
656 {"raw", CmdHF14ACmdRaw
, 0, "Send raw hex data to tag"},
657 {NULL
, NULL
, 0, NULL
}
660 int CmdHF14A(const char *Cmd
) {
662 WaitForResponseTimeout(CMD_ACK
,NULL
,100);
665 CmdsParse(CommandTable
, Cmd
);
669 int CmdHelp(const char *Cmd
)
671 CmdsHelp(CommandTable
);