1 //-----------------------------------------------------------------------------
2 // Copyright (C) 2015 Piwi
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 Topaz (NFC Type 1) commands
9 //-----------------------------------------------------------------------------
16 #include "cmdparser.h"
17 #include "cmdhftopaz.h"
21 #include "proxmark3.h"
22 #include "iso14443crc.h"
23 #include "protocols.h"
25 #define TOPAZ_MAX_MEMORY 2048
31 uint8_t data_blocks
[TOPAZ_MAX_MEMORY
/8][8];
32 uint8_t *dynamic_lock_areas
;
33 uint8_t *dynamic_reserved_areas
;
37 static void topaz_switch_on_field(void)
39 UsbCommand c
= {CMD_READER_ISO_14443a
, {ISO14A_CONNECT
| ISO14A_NO_SELECT
| ISO14A_NO_DISCONNECT
| ISO14A_TOPAZMODE
, 0, 0}};
44 static void topaz_switch_off_field(void)
46 UsbCommand c
= {CMD_READER_ISO_14443a
, {0, 0, 0}};
51 static int topaz_send_cmd_raw(uint8_t *cmd
, uint8_t len
, uint8_t *response
)
53 UsbCommand c
= {CMD_READER_ISO_14443a
, {ISO14A_RAW
| ISO14A_NO_DISCONNECT
| ISO14A_TOPAZMODE
, len
, 0}};
54 memcpy(c
.d
.asBytes
, cmd
, len
);
58 WaitForResponse(CMD_ACK
, &resp
);
60 if (resp
.arg
[0] > 0) {
61 memcpy(response
, resp
.d
.asBytes
, resp
.arg
[0]);
68 static int topaz_send_cmd(uint8_t *cmd
, uint8_t len
, uint8_t *response
)
71 uint8_t first
, second
;
72 ComputeCrc14443(CRC_14443_B
, cmd
, len
-2, &first
, &second
);
77 return topaz_send_cmd_raw(cmd
, len
, response
);
81 static int topaz_select(uint8_t *atqa
, uint8_t *rid_response
)
83 // ToDo: implement anticollision
85 uint8_t wupa_cmd
[] = {TOPAZ_WUPA
};
86 uint8_t rid_cmd
[] = {TOPAZ_RID
, 0, 0, 0, 0, 0, 0, 0, 0};
88 topaz_switch_on_field();
90 if (!topaz_send_cmd(wupa_cmd
, sizeof(wupa_cmd
), atqa
)) {
91 topaz_switch_off_field();
92 return -1; // WUPA failed
95 if (!topaz_send_cmd(rid_cmd
, sizeof(rid_cmd
), rid_response
)) {
96 topaz_switch_off_field();
97 return -2; // RID failed
104 static int topaz_rall(uint8_t *uid
, uint8_t *response
)
106 uint8_t rall_cmd
[] = {TOPAZ_RALL
, 0, 0, 0, 0, 0, 0, 0, 0};
108 memcpy(&rall_cmd
[3], uid
, 4);
109 if (!topaz_send_cmd(rall_cmd
, sizeof(rall_cmd
), response
)) {
110 topaz_switch_off_field();
111 return -1; // RALL failed
118 static bool topaz_block_is_locked(uint8_t blockno
, uint8_t *lockbits
)
120 if(lockbits
[blockno
/8] >> (blockno
% 8) & 0x01) {
128 static int topaz_print_CC(uint8_t *data
)
130 if(data
[0] != 0xe1) {
131 return -1; // no NDEF message
134 PrintAndLog("Capability Container: %02x %02x %02x %02x", data
[0], data
[1], data
[2], data
[3]);
135 PrintAndLog(" %02x: NDEF Magic Number", data
[0]);
136 PrintAndLog(" %02x: version %d.%d supported by tag", data
[1], (data
[1] & 0xF0) >> 4, data
[1] & 0x0f);
137 PrintAndLog(" %02x: Physical Memory Size of this tag: %d bytes", data
[2], (data
[2] + 1) * 8);
138 PrintAndLog(" %02x: %s / %s", data
[3],
139 (data
[3] & 0xF0) ? "(RFU)" : "Read access granted without any security",
140 (data
[3] & 0x0F)==0 ? "Write access granted without any security" : (data
[3] & 0x0F)==0x0F ? "No write access granted at all" : "(RFU)");
145 static void get_TLV(uint8_t **TLV_ptr
, uint8_t *tag
, uint16_t *length
, uint8_t **value
)
153 case 0x00: // NULL TLV.
154 case 0xFE: // Terminator TLV.
156 case 0x01: // Lock Control TLV
157 case 0x02: // Reserved Memory TLV
158 case 0x03: // NDEF message TLV
159 case 0xFD: // proprietary TLV
162 if (*length
== 0xff) {
163 *length
= **TLV_ptr
<< 8;
165 *length
|= **TLV_ptr
;
177 static bool topaz_print_lock_control_TLVs(uint8_t *memory
)
179 uint8_t *TLV_ptr
= memory
;
183 bool lock_TLV_present
= false;
185 while(*TLV_ptr
!= 0x03 && *TLV_ptr
!= 0xFD && *TLV_ptr
!= 0xFE) {
186 // all Lock Control TLVs shall be present before the NDEF message TLV, the proprietary TLV (and the Terminator TLV)
187 get_TLV(&TLV_ptr
, &tag
, &length
, &value
);
188 if (tag
== 0x01) { // the Lock Control TLV
189 uint8_t pages_addr
= value
[0] >> 4;
190 uint8_t byte_offset
= value
[0] & 0x0f;
191 uint8_t size_in_bits
= value
[1] ? value
[1] : 256;
192 uint8_t bytes_per_page
= 1 << (value
[2] & 0x0f);
193 uint8_t bytes_locked_per_bit
= 1 << (value
[2] >> 4);
194 PrintAndLog("Lock Area of %d bits at byte offset 0x%02x. Each Lock Bit locks %d bytes.",
196 pages_addr
* bytes_per_page
+ byte_offset
,
197 bytes_locked_per_bit
);
198 lock_TLV_present
= true;
202 if (!lock_TLV_present
) {
203 PrintAndLog("(No Lock Control TLV present)");
211 static int topaz_print_reserved_memory_control_TLVs(uint8_t *memory
)
213 uint8_t *TLV_ptr
= memory
;
217 bool reserved_memory_control_TLV_present
= false;
219 while(*TLV_ptr
!= 0x03 && *TLV_ptr
!= 0xFD && *TLV_ptr
!= 0xFE) {
220 // all Reserved Memory Control TLVs shall be present before the NDEF message TLV, the proprietary TLV (and the Terminator TLV)
221 get_TLV(&TLV_ptr
, &tag
, &length
, &value
);
222 if (tag
== 0x02) { // the Reserved Memory Control TLV
223 uint8_t pages_addr
= value
[0] >> 4;
224 uint8_t byte_offset
= value
[0] & 0x0f;
225 uint8_t size_in_bytes
= value
[1] ? value
[1] : 256;
226 uint8_t bytes_per_page
= 1 << (value
[2] & 0x0f);
227 PrintAndLog("Reserved Memory of %d bytes at byte offset 0x%02x.",
229 pages_addr
* bytes_per_page
+ byte_offset
);
230 reserved_memory_control_TLV_present
= true;
234 if (!reserved_memory_control_TLV_present
) {
235 PrintAndLog("(No Reserved Memory Control TLV present)");
243 static void topaz_print_lifecycle_state(uint8_t *data
)
249 static void topaz_print_NDEF(uint8_t *data
)
255 int CmdHFTopazReader(const char *Cmd
)
259 uint8_t rid_response
[8];
260 uint8_t *uid_echo
= &rid_response
[2];
261 uint8_t rall_response
[124];
263 status
= topaz_select(atqa
, rid_response
);
266 PrintAndLog("Error: couldn't receive ATQA");
270 PrintAndLog("ATQA : %02x %02x", atqa
[1], atqa
[0]);
271 if (atqa
[1] != 0x0c && atqa
[0] != 0x00) {
272 PrintAndLog("Tag doesn't support the Topaz protocol.");
273 topaz_switch_off_field();
278 PrintAndLog("Error: tag didn't answer to RID");
279 topaz_switch_off_field();
283 topaz_tag
.HR01
[0] = rid_response
[0];
284 topaz_tag
.HR01
[1] = rid_response
[1];
287 PrintAndLog("HR0 : %02x (%sa Topaz tag (%scapable of carrying a NDEF message), %s memory map)", rid_response
[0],
288 (rid_response
[0] & 0xF0) == 0x10 ? "" : "not ",
289 (rid_response
[0] & 0xF0) == 0x10 ? "" : "not ",
290 (rid_response
[0] & 0x0F) == 0x10 ? "static" : "dynamic");
291 PrintAndLog("HR1 : %02x", rid_response
[1]);
293 status
= topaz_rall(uid_echo
, rall_response
);
296 PrintAndLog("Error: tag didn't answer to RALL");
297 topaz_switch_off_field();
301 memcpy(topaz_tag
.uid
, rall_response
+2, 7);
302 PrintAndLog("UID : %02x %02x %02x %02x %02x %02x %02x",
310 PrintAndLog(" UID[6] (Manufacturer Byte) = %02x, Manufacturer: %s",
312 getTagInfo(topaz_tag
.uid
[6]));
314 memcpy(topaz_tag
.data_blocks
, rall_response
+2, 0x10*8);
316 PrintAndLog("Static Data blocks 00 to 0c:");
317 PrintAndLog("block# | offset | Data | Locked?");
319 for (uint16_t i
= 0; i
<= 0x0c; i
++) {
320 for (uint16_t j
= 0; j
< 8; j
++) {
321 sprintf(&line
[3*j
], "%02x ", topaz_tag
.data_blocks
[i
][j
] /*rall_response[2 + 8*i + j]*/);
323 PrintAndLog(" 0x%02x | 0x%02x | %s| %-3s", i
, i
*8, line
, topaz_block_is_locked(i
, &topaz_tag
.data_blocks
[0x0e][0]) ? "yes" : "no");
327 PrintAndLog("Static Reserved block 0d:");
328 for (uint16_t j
= 0; j
< 8; j
++) {
329 sprintf(&line
[3*j
], "%02x ", topaz_tag
.data_blocks
[0x0d][j
]);
331 PrintAndLog(" 0x%02x | 0x%02x | %s| %-3s", 0x0d, 0x0d*8, line
, "n/a");
334 PrintAndLog("Static Lockbits and OTP Bytes:");
335 for (uint16_t j
= 0; j
< 8; j
++) {
336 sprintf(&line
[3*j
], "%02x ", topaz_tag
.data_blocks
[0x0e][j
]);
338 PrintAndLog(" 0x%02x | 0x%02x | %s| %-3s", 0x0e, 0x0e*8, line
, "n/a");
342 status
= topaz_print_CC(&topaz_tag
.data_blocks
[1][0]);
345 PrintAndLog("No NDEF message present");
346 topaz_switch_off_field();
351 bool lock_TLV_present
= topaz_print_lock_control_TLVs(&topaz_tag
.data_blocks
[1][4]);
354 bool reserved_mem_present
= topaz_print_reserved_memory_control_TLVs(&topaz_tag
.data_blocks
[1][4]);
356 topaz_print_lifecycle_state(&topaz_tag
.data_blocks
[1][0]);
358 topaz_print_NDEF(&topaz_tag
.data_blocks
[1][0]);
360 topaz_switch_off_field();
365 int CmdHFTopazSim(const char *Cmd
)
367 PrintAndLog("not yet implemented");
372 int CmdHFTopazCmdRaw(const char *Cmd
)
374 PrintAndLog("not yet implemented");
379 static int CmdHelp(const char *Cmd
);
382 static command_t CommandTable
[] =
384 {"help", CmdHelp
, 1, "This help"},
385 {"reader", CmdHFTopazReader
, 0, "Act like a Topaz reader"},
386 {"sim", CmdHFTopazSim
, 0, "<UID> -- Simulate Topaz tag"},
387 {"sniff", CmdHF14ASniff
, 0, "Sniff Topaz reader-tag communication"},
388 {"raw", CmdHFTopazCmdRaw
, 0, "Send raw hex data to tag"},
389 {NULL
, NULL
, 0, NULL
}
393 int CmdHFTopaz(const char *Cmd
) {
395 WaitForResponseTimeout(CMD_ACK
,NULL
,100);
398 CmdsParse(CommandTable
, Cmd
);
402 static int CmdHelp(const char *Cmd
)
404 CmdsHelp(CommandTable
);