[proxmark3-svn] / client / cmdhftopaz.c

//-----------------------------------------------------------------------------
// Copyright (C) 2015 Piwi
//
// This code is licensed to you under the terms of the GNU GPL, version 2 or,
// at your option, any later version. See the LICENSE.txt file for the text of
// the license.
//-----------------------------------------------------------------------------
// High frequency Topaz (NFC Type 1) commands
//-----------------------------------------------------------------------------

#include "cmdhftopaz.h"

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include "cmdmain.h"
#include "cmdparser.h"
#include "cmdhf14a.h"
#include "ui.h"
#include "mifare.h"
#include "comms.h"
#include "iso14443crc.h"
#include "protocols.h"
#include "taginfo.h"

#define TOPAZ_STATIC_MEMORY	(0x0f * 8)		// 15 blocks with 8 Bytes each

// a struct to describe a memory area which contains lock bits and the corresponding lockable memory area
typedef struct dynamic_lock_area {
	struct dynamic_lock_area *next;
	uint16_t	byte_offset;			// the address of the lock bits
	uint16_t	size_in_bits;
	uint16_t	first_locked_byte;		// the address of the lockable area
	uint16_t	bytes_locked_per_bit;
} dynamic_lock_area_t;


static struct {
	uint8_t HR01[2];
	uint8_t uid[7];
	uint16_t size;
	uint8_t data_blocks[TOPAZ_STATIC_MEMORY/8][8];	// this memory is always there
	uint8_t *dynamic_memory;						// this memory can be there
	dynamic_lock_area_t *dynamic_lock_areas;		// lock area descriptors
} topaz_tag;


static void topaz_switch_on_field(void)
{
	UsbCommand c = {CMD_READER_ISO_14443a, {ISO14A_CONNECT | ISO14A_NO_SELECT | ISO14A_NO_DISCONNECT | ISO14A_TOPAZMODE, 0, 0}};
	SendCommand(&c);
}


static void topaz_switch_off_field(void)
{
	UsbCommand c = {CMD_READER_ISO_14443a, {0, 0, 0}};
	SendCommand(&c);
}


// send a raw topaz command, returns the length of the response (0 in case of error)
static int topaz_send_cmd_raw(uint8_t *cmd, uint8_t len, uint8_t *response)
{
	UsbCommand c = {CMD_READER_ISO_14443a, {ISO14A_RAW | ISO14A_NO_DISCONNECT | ISO14A_TOPAZMODE, len, 0}};
	memcpy(c.d.asBytes, cmd, len);
	SendCommand(&c);

	UsbCommand resp;
	WaitForResponse(CMD_ACK, &resp);

	if (resp.arg[0] > 0) {
		memcpy(response, resp.d.asBytes, resp.arg[0]);
	}
	
	return resp.arg[0];
}


// calculate CRC bytes and send topaz command, returns the length of the response (0 in case of error) 
static int topaz_send_cmd(uint8_t *cmd, uint8_t len, uint8_t *response)
{
	if (len > 1) {
        uint8_t first, second;
		ComputeCrc14443(CRC_14443_B, cmd, len-2, &first, &second);
        cmd[len-2] = first;
        cmd[len-1] = second;
	}

	return topaz_send_cmd_raw(cmd, len, response);
}


// select a topaz tag. Send WUPA and RID.
static int topaz_select(uint8_t *atqa, uint8_t *rid_response)
{
	// ToDo: implement anticollision

	uint8_t wupa_cmd[] = {TOPAZ_WUPA};
	uint8_t rid_cmd[] = {TOPAZ_RID, 0, 0, 0, 0, 0, 0, 0, 0};

	topaz_switch_on_field();

	if (!topaz_send_cmd(wupa_cmd, sizeof(wupa_cmd), atqa)) {
		topaz_switch_off_field();
		return -1;		// WUPA failed
	}

	if (!topaz_send_cmd(rid_cmd, sizeof(rid_cmd), rid_response)) {
		topaz_switch_off_field();
		return -2;		// RID failed
	}
	
	return 0;		// OK
}


// read all of the static memory of a selected Topaz tag.
static int topaz_rall(uint8_t *uid, uint8_t *response)
{
	uint8_t rall_cmd[] = {TOPAZ_RALL, 0, 0, 0, 0, 0, 0, 0, 0};

	memcpy(&rall_cmd[3], uid, 4);
	if (!topaz_send_cmd(rall_cmd, sizeof(rall_cmd), response)) {
		topaz_switch_off_field();
		return -1;		// RALL failed
	}
	
	return 0;
}


// read a block (8 Bytes) of a selected Topaz tag.
static int topaz_read_block(uint8_t *uid, uint8_t blockno, uint8_t *block_data)
{
	uint8_t read8_cmd[] = {TOPAZ_READ8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
	uint8_t read8_response[11];
	
	read8_cmd[1] = blockno;
	memcpy(&read8_cmd[10], uid, 4);
	if (!topaz_send_cmd(read8_cmd, sizeof(read8_cmd), read8_response)) {
		topaz_switch_off_field();
		return -1;		// READ8 failed
	}
	
	memcpy(block_data, &read8_response[1], 8);
	
	return 0;
}


// read a segment (16 blocks = 128 Bytes) of a selected Topaz tag. Works only for tags with dynamic memory.
static int topaz_read_segment(uint8_t *uid, uint8_t segno, uint8_t *segment_data)
{
	uint8_t rseg_cmd[] = {TOPAZ_RSEG, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
	uint8_t rseg_response[131];
	
	rseg_cmd[1] = segno << 4;
	memcpy(&rseg_cmd[10], uid, 4);
	if (!topaz_send_cmd(rseg_cmd, sizeof(rseg_cmd), rseg_response)) {
		topaz_switch_off_field();
		return -1;		// RSEG failed
	}
	
	memcpy(segment_data, &rseg_response[1], 128);
	
	return 0;
}


// search for the lock area descriptor for the lockable area including byteno 
static dynamic_lock_area_t *get_dynamic_lock_area(uint16_t byteno)
{
	dynamic_lock_area_t *lock_area;
	
	lock_area = topaz_tag.dynamic_lock_areas;
	
	while (lock_area != NULL) {
		if (byteno < lock_area->first_locked_byte) {
			lock_area = lock_area->next;
		} else {
			return lock_area;
		}
	}

	return NULL;
}


// check if a memory byte is locked.
static bool topaz_byte_is_locked(uint16_t byteno)
{
	uint8_t *lockbits;
	uint16_t locked_bytes_per_bit;
	dynamic_lock_area_t *lock_area;
	
	if (byteno < TOPAZ_STATIC_MEMORY) {
		lockbits = &topaz_tag.data_blocks[0x0e][0];
		locked_bytes_per_bit = 8;
	} else {
		lock_area = get_dynamic_lock_area(byteno);
		if (lock_area == NULL) {
			return false;
		} else {
			lockbits = &topaz_tag.dynamic_memory[lock_area->byte_offset - TOPAZ_STATIC_MEMORY];
			locked_bytes_per_bit = lock_area->bytes_locked_per_bit;
			byteno = byteno - lock_area->first_locked_byte;
		}
	}

	uint16_t blockno = byteno / locked_bytes_per_bit;
	if(lockbits[blockno/8] & (0x01 << (blockno % 8))) {
		return true;
	} else {
		return false;
	}
}


// read and print the Capability Container
static int topaz_print_CC(uint8_t *data)
{
	if(data[0] != 0xe1) {
		topaz_tag.size = TOPAZ_STATIC_MEMORY;
		return -1;		// no NDEF message
	}

	PrintAndLog("Capability Container: %02x %02x %02x %02x", data[0], data[1], data[2], data[3]);
	PrintAndLog("  %02x: NDEF Magic Number", data[0]); 
	PrintAndLog("  %02x: version %d.%d supported by tag", data[1], (data[1] & 0xF0) >> 4, data[1] & 0x0f);
	uint16_t memsize = (data[2] + 1) * 8;
	topaz_tag.size = memsize;
	topaz_tag.dynamic_memory = malloc(memsize - TOPAZ_STATIC_MEMORY);
	PrintAndLog("  %02x: Physical Memory Size of this tag: %d bytes", data[2], memsize);
	PrintAndLog("  %02x: %s / %s", data[3], 
				(data[3] & 0xF0) ? "(RFU)" : "Read access granted without any security", 
				(data[3] & 0x0F)==0 ? "Write access granted without any security" : (data[3] & 0x0F)==0x0F ? "No write access granted at all" : "(RFU)");
	return 0;				
}


// return type, length and value of a TLV, starting at memory position *TLV_ptr 
static void get_TLV(uint8_t **TLV_ptr, uint8_t *TLV_type, uint16_t *TLV_length, uint8_t **TLV_value)
{
	*TLV_length = 0;
	*TLV_value = NULL;

	*TLV_type = **TLV_ptr;
	*TLV_ptr += 1;
	switch (*TLV_type) {
		case 0x00:			// NULL TLV.
		case 0xFE:			// Terminator TLV.
			break;
		case 0x01:			// Lock Control TLV
		case 0x02:			// Reserved Memory TLV
		case 0x03:			// NDEF message TLV
		case 0xFD:			// proprietary TLV
			*TLV_length = **TLV_ptr;
			*TLV_ptr += 1;
			if (*TLV_length == 0xff) {
				*TLV_length = **TLV_ptr << 8;
				*TLV_ptr += 1;
				*TLV_length |= **TLV_ptr;
				*TLV_ptr += 1;
			}
			*TLV_value = *TLV_ptr;
			*TLV_ptr += *TLV_length;
			break;
		default:			// RFU
			break;
	}
}


// lock area TLVs contain no information on the start of the respective lockable area. Lockable areas
// do not include the lock bits and reserved memory. We therefore need to adjust the start of the 
// respective lockable areas accordingly
static void adjust_lock_areas(uint16_t block_start, uint16_t block_size)
{
	dynamic_lock_area_t *lock_area = topaz_tag.dynamic_lock_areas;
	while (lock_area != NULL) {
		if (lock_area->first_locked_byte <= block_start) {
			lock_area->first_locked_byte += block_size;
		}
		lock_area = lock_area->next;
	}
}


// read and print the lock area and reserved memory TLVs
static void topaz_print_control_TLVs(uint8_t *memory)
{
	uint8_t *TLV_ptr = memory;
	uint8_t TLV_type = 0;
	uint16_t TLV_length;
	uint8_t *TLV_value;
	bool lock_TLV_present = false;
	bool reserved_memory_control_TLV_present = false;
	uint16_t next_lockable_byte = 0x0f * 8;				// first byte after static memory area
	
	while(*TLV_ptr != 0x03 && *TLV_ptr != 0xFD && *TLV_ptr != 0xFE) {	
		// all Lock Control TLVs shall be present before the NDEF message TLV, the proprietary TLV (and the Terminator TLV)
		get_TLV(&TLV_ptr, &TLV_type, &TLV_length, &TLV_value);
		if (TLV_type == 0x01) {			// a Lock Control TLV
			uint8_t pages_addr = TLV_value[0] >> 4;
			uint8_t byte_offset = TLV_value[0] & 0x0f;
			uint16_t size_in_bits = TLV_value[1] ? TLV_value[1] : 256;
			uint16_t size_in_bytes = (size_in_bits + 7)/8;
			uint16_t bytes_per_page = 1 << (TLV_value[2] & 0x0f);
			uint16_t bytes_locked_per_bit = 1 << (TLV_value[2] >> 4);
			uint16_t area_start = pages_addr * bytes_per_page + byte_offset;
			PrintAndLog("Lock Area of %d bits at byte offset 0x%04x. Each Lock Bit locks %d bytes.", 
						size_in_bits,
						area_start,
						bytes_locked_per_bit);
			lock_TLV_present = true;
			dynamic_lock_area_t *old = topaz_tag.dynamic_lock_areas;
			dynamic_lock_area_t *new = topaz_tag.dynamic_lock_areas;
			if (old == NULL) {
				new = topaz_tag.dynamic_lock_areas = (dynamic_lock_area_t *)malloc(sizeof(dynamic_lock_area_t));
			} else {
				while(old->next != NULL) {
					old = old->next;
				}
				new = old->next = (dynamic_lock_area_t *)malloc(sizeof(dynamic_lock_area_t));
			}
			new->next = NULL;
			if (area_start <= next_lockable_byte) {
				// lock areas are not lockable
				next_lockable_byte += size_in_bytes;
			}
			new->first_locked_byte = next_lockable_byte;
			new->byte_offset = area_start;
			new->size_in_bits = size_in_bits;
			new->bytes_locked_per_bit = bytes_locked_per_bit;
			next_lockable_byte += size_in_bits * bytes_locked_per_bit;		
		}
		if (TLV_type == 0x02) {			// a Reserved Memory Control TLV
			uint8_t pages_addr = TLV_value[0] >> 4;
			uint8_t byte_offset = TLV_value[0] & 0x0f;
			uint16_t size_in_bytes = TLV_value[1] ? TLV_value[1] : 256;
			uint8_t bytes_per_page = 1 << (TLV_value[2] & 0x0f);
			uint16_t area_start = pages_addr * bytes_per_page + byte_offset;
			PrintAndLog("Reserved Memory of %d bytes at byte offset 0x%02x.", 
						size_in_bytes,
						area_start);
			reserved_memory_control_TLV_present = true;
			adjust_lock_areas(area_start, size_in_bytes);  // reserved memory areas are not lockable
			if (area_start <= next_lockable_byte) {
				next_lockable_byte += size_in_bytes;
			}
		}
	}
	
	if (!lock_TLV_present) {
		PrintAndLog("(No Lock Control TLV present)");
	}
	
	if (!reserved_memory_control_TLV_present) {
		PrintAndLog("(No Reserved Memory Control TLV present)");
	}	
}


// read all of the dynamic memory
static int topaz_read_dynamic_data(void)
{
	// first read the remaining block of segment 0
	if(topaz_read_block(topaz_tag.uid, 0x0f, &topaz_tag.dynamic_memory[0]) == -1) {
		PrintAndLog("Error while reading dynamic memory block %02x. Aborting...", 0x0f);
		return -1;
	}
	
	// read the remaining segments
	uint8_t max_segment = topaz_tag.size / 128 - 1;
	for(uint8_t segment = 1; segment <= max_segment; segment++) {
		if(topaz_read_segment(topaz_tag.uid, segment, &topaz_tag.dynamic_memory[(segment-1)*128+8]) == -1) {
			PrintAndLog("Error while reading dynamic memory block %02x. Aborting...", 0x0f);
			return -1;
		}
	}
	
	return 0;
}
	

// read and print the dynamic memory
static void topaz_print_dynamic_data(void)
{
	if (topaz_tag.size > TOPAZ_STATIC_MEMORY) {
		PrintAndLog("Dynamic Data blocks:");
		if (topaz_read_dynamic_data() == 0) {
			PrintAndLog("block# | offset | Data                    | Locked(y/n)");
			char line[80];
			for (uint16_t blockno = 0x0f; blockno < topaz_tag.size/8; blockno++) {
				uint8_t *block_data = &topaz_tag.dynamic_memory[(blockno-0x0f)*8];
				char lockbits[9];
				for (uint16_t j = 0; j < 8; j++) {
					sprintf(&line[3*j], "%02x ", block_data[j]);
					lockbits[j] = topaz_byte_is_locked(blockno*8+j) ? 'y' : 'n';
				}
				lockbits[8] = '\0';
				PrintAndLog("  0x%02x | 0x%04x | %s|   %-3s", blockno, blockno*8, line, lockbits);
			}
		}
	}
}


static void topaz_print_lifecycle_state(uint8_t *data)
{
	// to be done
}


static void topaz_print_NDEF(uint8_t *data)
{
	// to be done. 
}


// read a Topaz tag and print some usefull information	
int CmdHFTopazReader(const char *Cmd)
{
	int status;
	uint8_t atqa[2];
	uint8_t rid_response[8];
	uint8_t *uid_echo = &rid_response[2];
	uint8_t rall_response[124];
	
	status = topaz_select(atqa, rid_response);
	
	if (status == -1) {
		PrintAndLog("Error: couldn't receive ATQA");
		return -1;
	}

	PrintAndLog("ATQA : %02x %02x", atqa[1], atqa[0]);
	if (atqa[1] != 0x0c && atqa[0] != 0x00) {
		PrintAndLog("Tag doesn't support the Topaz protocol.");
		topaz_switch_off_field();
		return -1;
	}
	
	if (status == -2) {
		PrintAndLog("Error: tag didn't answer to RID");
		topaz_switch_off_field();
		return -1;
	}

	topaz_tag.HR01[0] = rid_response[0];
	topaz_tag.HR01[1] = rid_response[1];
	
	// ToDo: CRC check
	PrintAndLog("HR0  : %02x (%sa Topaz tag (%scapable of carrying a NDEF message), %s memory map)", rid_response[0], 
						(rid_response[0] & 0xF0) == 0x10 ? "" : "not ",
						(rid_response[0] & 0xF0) == 0x10 ? "" : "not ",
						(rid_response[0] & 0x0F) == 0x01 ? "static" : "dynamic");
	PrintAndLog("HR1  : %02x", rid_response[1]);
	
	status = topaz_rall(uid_echo, rall_response);

	if(status == -1) {
		PrintAndLog("Error: tag didn't answer to RALL");
		topaz_switch_off_field();
		return -1;
	}

	memcpy(topaz_tag.uid, rall_response+2, 7);
	PrintAndLog("UID  : %02x %02x %02x %02x %02x %02x %02x", 
			topaz_tag.uid[6], 
			topaz_tag.uid[5], 
			topaz_tag.uid[4], 
			topaz_tag.uid[3], 
			topaz_tag.uid[2], 
			topaz_tag.uid[1], 
			topaz_tag.uid[0]);
	PrintAndLog("       UID[6] (Manufacturer Byte) = %02x, Manufacturer: %s", 
			topaz_tag.uid[6], 
			getManufacturerName(topaz_tag.uid[6]));

	memcpy(topaz_tag.data_blocks, rall_response+2, 0x0f*8);
	PrintAndLog("");
	PrintAndLog("Static Data blocks 00 to 0c:");
	PrintAndLog("block# | offset | Data                    | Locked(y/n)");
	char line[80];
	for (uint16_t i = 0; i <= 0x0c; i++) {
		char lockbits[9];
		for (uint16_t j = 0; j < 8; j++) {
			sprintf(&line[3*j], "%02x ", topaz_tag.data_blocks[i][j] /*rall_response[2 + 8*i + j]*/);
			lockbits[j] = topaz_byte_is_locked(i*8+j) ? 'y' : 'n';
		}
		lockbits[8] = '\0';
		PrintAndLog("  0x%02x | 0x%04x | %s|   %-3s", i, i*8, line, lockbits);
	}
	
	PrintAndLog("");
	PrintAndLog("Static Reserved block 0d:");
	for (uint16_t j = 0; j < 8; j++) {
		sprintf(&line[3*j], "%02x ", topaz_tag.data_blocks[0x0d][j]);
	}
	PrintAndLog("  0x%02x | 0x%04x | %s|   %-3s", 0x0d, 0x0d*8, line, "n/a");
	
	PrintAndLog("");
	PrintAndLog("Static Lockbits and OTP Bytes:");
	for (uint16_t j = 0; j < 8; j++) {
		sprintf(&line[3*j], "%02x ", topaz_tag.data_blocks[0x0e][j]);
	}
	PrintAndLog("  0x%02x | 0x%04x | %s|   %-3s", 0x0e, 0x0e*8, line, "n/a");

	PrintAndLog("");

	status = topaz_print_CC(&topaz_tag.data_blocks[1][0]);
	
	if (status == -1) {
		PrintAndLog("No NDEF message data present");
		topaz_switch_off_field();
		return 0;
	}

	PrintAndLog("");
	topaz_print_control_TLVs(&topaz_tag.data_blocks[1][4]);

	PrintAndLog("");
	topaz_print_dynamic_data();
	
	topaz_print_lifecycle_state(&topaz_tag.data_blocks[1][0]);

	topaz_print_NDEF(&topaz_tag.data_blocks[1][0]);
	
	topaz_switch_off_field();
	return 0;
}


int CmdHFTopazCmdRaw(const char *Cmd)
{
	PrintAndLog("not yet implemented. Use hf 14 raw with option -T.");
	return 0;
}


static int CmdHelp(const char *Cmd);


static command_t CommandTable[] = 
{
	{"help",	CmdHelp,			1, "This help"},
	{"reader",	CmdHFTopazReader,	0, "Act like a Topaz reader"},
	{"snoop",	CmdHF14ASnoop,		0, "Eavesdrop a Topaz reader-tag communication"},
	{"raw",		CmdHFTopazCmdRaw,	0, "Send raw hex data to tag"},
	{NULL,		NULL,				0, NULL}
};


int CmdHFTopaz(const char *Cmd) {
	(void)WaitForResponseTimeout(CMD_ACK,NULL,100);
	CmdsParse(CommandTable, Cmd);
	return 0;
}


static int CmdHelp(const char *Cmd)
{
	CmdsHelp(CommandTable);
	return 0;
}
Commit	Line	Data
05ddb52c	1	//-----------------------------------------------------------------------------
	2	// Copyright (C) 2015 Piwi
	3	//
	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
	6	// the license.
	7	//-----------------------------------------------------------------------------
	8	// High frequency Topaz (NFC Type 1) commands
	9	//-----------------------------------------------------------------------------
	10
ad939de5	11	#include "cmdhftopaz.h"
ad939de5	12
05ddb52c	13	#include <stdio.h>
	14	#include <stdlib.h>
	15	#include <string.h>
	16	#include <unistd.h>
	17	#include "cmdmain.h"
	18	#include "cmdparser.h"
05ddb52c	19	#include "cmdhf14a.h"
05ddb52c	20	#include "ui.h"
48ece4a7	21	#include "mifare.h"
ad939de5	22	#include "comms.h"
48ece4a7	23	#include "iso14443crc.h"
48ece4a7	24	#include "protocols.h"
1338d245	25	#include "taginfo.h"
48ece4a7	26
7624e8b2	27	#define TOPAZ_STATIC_MEMORY (0x0f * 8) // 15 blocks with 8 Bytes each
6e6f1099	28
7624e8b2	29	// a struct to describe a memory area which contains lock bits and the corresponding lockable memory area
6e6f1099	30	typedef struct dynamic_lock_area {
6e6f1099	31	struct dynamic_lock_area *next;
7624e8b2	32	uint16_t byte_offset; // the address of the lock bits
6e6f1099	33	uint16_t size_in_bits;
7624e8b2	34	uint16_t first_locked_byte; // the address of the lockable area
6e6f1099	35	uint16_t bytes_locked_per_bit;
	36	} dynamic_lock_area_t;
	37
48ece4a7	38
c5847ae8	39	static struct {
	40	uint8_t HR01[2];
	41	uint8_t uid[7];
7624e8b2	42	uint16_t size;
	43	uint8_t data_blocks[TOPAZ_STATIC_MEMORY/8][8]; // this memory is always there
	44	uint8_t *dynamic_memory; // this memory can be there
	45	dynamic_lock_area_t *dynamic_lock_areas; // lock area descriptors
c5847ae8	46	} topaz_tag;
48ece4a7	47
de15fc5f	48
48ece4a7	49	static void topaz_switch_on_field(void)
	50	{
	51	UsbCommand c = {CMD_READER_ISO_14443a, {ISO14A_CONNECT \| ISO14A_NO_SELECT \| ISO14A_NO_DISCONNECT \| ISO14A_TOPAZMODE, 0, 0}};
	52	SendCommand(&c);
48ece4a7	53	}
	54
	55
	56	static void topaz_switch_off_field(void)
	57	{
	58	UsbCommand c = {CMD_READER_ISO_14443a, {0, 0, 0}};
	59	SendCommand(&c);
48ece4a7	60	}
	61
	62
7624e8b2	63	// send a raw topaz command, returns the length of the response (0 in case of error)
de15fc5f	64	static int topaz_send_cmd_raw(uint8_t cmd, uint8_t len, uint8_t response)
48ece4a7	65	{
	66	UsbCommand c = {CMD_READER_ISO_14443a, {ISO14A_RAW \| ISO14A_NO_DISCONNECT \| ISO14A_TOPAZMODE, len, 0}};
	67	memcpy(c.d.asBytes, cmd, len);
	68	SendCommand(&c);
	69
	70	UsbCommand resp;
	71	WaitForResponse(CMD_ACK, &resp);
	72
de15fc5f	73	if (resp.arg[0] > 0) {
	74	memcpy(response, resp.d.asBytes, resp.arg[0]);
	75	}
	76
	77	return resp.arg[0];
48ece4a7	78	}
	79
	80
7624e8b2	81	// calculate CRC bytes and send topaz command, returns the length of the response (0 in case of error)
de15fc5f	82	static int topaz_send_cmd(uint8_t cmd, uint8_t len, uint8_t response)
48ece4a7	83	{
	84	if (len > 1) {
	85	uint8_t first, second;
de15fc5f	86	ComputeCrc14443(CRC_14443_B, cmd, len-2, &first, &second);
	87	cmd[len-2] = first;
	88	cmd[len-1] = second;
48ece4a7	89	}
48ece4a7	90
de15fc5f	91	return topaz_send_cmd_raw(cmd, len, response);
48ece4a7	92	}
	93
	94
7624e8b2	95	// select a topaz tag. Send WUPA and RID.
de15fc5f	96	static int topaz_select(uint8_t atqa, uint8_t rid_response)
48ece4a7	97	{
48ece4a7	98	// ToDo: implement anticollision
de15fc5f	99
48ece4a7	100	uint8_t wupa_cmd[] = {TOPAZ_WUPA};
de15fc5f	101	uint8_t rid_cmd[] = {TOPAZ_RID, 0, 0, 0, 0, 0, 0, 0, 0};
de15fc5f	102
48ece4a7	103	topaz_switch_on_field();
de15fc5f	104
	105	if (!topaz_send_cmd(wupa_cmd, sizeof(wupa_cmd), atqa)) {
	106	topaz_switch_off_field();
	107	return -1; // WUPA failed
	108	}
	109
	110	if (!topaz_send_cmd(rid_cmd, sizeof(rid_cmd), rid_response)) {
	111	topaz_switch_off_field();
	112	return -2; // RID failed
	113	}
	114
	115	return 0; // OK
	116	}
	117
	118
7624e8b2	119	// read all of the static memory of a selected Topaz tag.
c5847ae8	120	static int topaz_rall(uint8_t uid, uint8_t response)
de15fc5f	121	{
	122	uint8_t rall_cmd[] = {TOPAZ_RALL, 0, 0, 0, 0, 0, 0, 0, 0};
	123
	124	memcpy(&rall_cmd[3], uid, 4);
c5847ae8	125	if (!topaz_send_cmd(rall_cmd, sizeof(rall_cmd), response)) {
de15fc5f	126	topaz_switch_off_field();
	127	return -1; // RALL failed
	128	}
	129
	130	return 0;
48ece4a7	131	}
48ece4a7	132
05ddb52c	133
7624e8b2	134	// read a block (8 Bytes) of a selected Topaz tag.
	135	static int topaz_read_block(uint8_t uid, uint8_t blockno, uint8_t block_data)
	136	{
	137	uint8_t read8_cmd[] = {TOPAZ_READ8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
	138	uint8_t read8_response[11];
	139
	140	read8_cmd[1] = blockno;
	141	memcpy(&read8_cmd[10], uid, 4);
	142	if (!topaz_send_cmd(read8_cmd, sizeof(read8_cmd), read8_response)) {
	143	topaz_switch_off_field();
	144	return -1; // READ8 failed
	145	}
	146
	147	memcpy(block_data, &read8_response[1], 8);
	148
	149	return 0;
	150	}
	151
	152
	153	// read a segment (16 blocks = 128 Bytes) of a selected Topaz tag. Works only for tags with dynamic memory.
	154	static int topaz_read_segment(uint8_t uid, uint8_t segno, uint8_t segment_data)
	155	{
	156	uint8_t rseg_cmd[] = {TOPAZ_RSEG, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
	157	uint8_t rseg_response[131];
	158
	159	rseg_cmd[1] = segno << 4;
	160	memcpy(&rseg_cmd[10], uid, 4);
	161	if (!topaz_send_cmd(rseg_cmd, sizeof(rseg_cmd), rseg_response)) {
	162	topaz_switch_off_field();
	163	return -1; // RSEG failed
	164	}
	165
	166	memcpy(segment_data, &rseg_response[1], 128);
	167
	168	return 0;
	169	}
	170
	171
	172	// search for the lock area descriptor for the lockable area including byteno
6e6f1099	173	static dynamic_lock_area_t *get_dynamic_lock_area(uint16_t byteno)
	174	{
	175	dynamic_lock_area_t *lock_area;
	176
	177	lock_area = topaz_tag.dynamic_lock_areas;
	178
	179	while (lock_area != NULL) {
	180	if (byteno < lock_area->first_locked_byte) {
	181	lock_area = lock_area->next;
	182	} else {
	183	return lock_area;
	184	}
	185	}
	186
	187	return NULL;
	188	}
	189
	190
7624e8b2	191	// check if a memory byte is locked.
6e6f1099	192	static bool topaz_byte_is_locked(uint16_t byteno)
de15fc5f	193	{
6e6f1099	194	uint8_t *lockbits;
	195	uint16_t locked_bytes_per_bit;
	196	dynamic_lock_area_t *lock_area;
	197
	198	if (byteno < TOPAZ_STATIC_MEMORY) {
	199	lockbits = &topaz_tag.data_blocks[0x0e][0];
	200	locked_bytes_per_bit = 8;
	201	} else {
	202	lock_area = get_dynamic_lock_area(byteno);
	203	if (lock_area == NULL) {
	204	return false;
7624e8b2	205	} else {
	206	lockbits = &topaz_tag.dynamic_memory[lock_area->byte_offset - TOPAZ_STATIC_MEMORY];
	207	locked_bytes_per_bit = lock_area->bytes_locked_per_bit;
	208	byteno = byteno - lock_area->first_locked_byte;
6e6f1099	209	}
6e6f1099	210	}
	211
	212	uint16_t blockno = byteno / locked_bytes_per_bit;
7624e8b2	213	if(lockbits[blockno/8] & (0x01 << (blockno % 8))) {
de15fc5f	214	return true;
	215	} else {
	216	return false;
	217	}
	218	}
	219
	220
7624e8b2	221	// read and print the Capability Container
de15fc5f	222	static int topaz_print_CC(uint8_t *data)
	223	{
	224	if(data[0] != 0xe1) {
7624e8b2	225	topaz_tag.size = TOPAZ_STATIC_MEMORY;
de15fc5f	226	return -1; // no NDEF message
	227	}
	228
	229	PrintAndLog("Capability Container: %02x %02x %02x %02x", data[0], data[1], data[2], data[3]);
	230	PrintAndLog(" %02x: NDEF Magic Number", data[0]);
	231	PrintAndLog(" %02x: version %d.%d supported by tag", data[1], (data[1] & 0xF0) >> 4, data[1] & 0x0f);
6e6f1099	232	uint16_t memsize = (data[2] + 1) * 8;
7624e8b2	233	topaz_tag.size = memsize;
6e6f1099	234	topaz_tag.dynamic_memory = malloc(memsize - TOPAZ_STATIC_MEMORY);
6e6f1099	235	PrintAndLog(" %02x: Physical Memory Size of this tag: %d bytes", data[2], memsize);
de15fc5f	236	PrintAndLog(" %02x: %s / %s", data[3],
	237	(data[3] & 0xF0) ? "(RFU)" : "Read access granted without any security",
	238	(data[3] & 0x0F)==0 ? "Write access granted without any security" : (data[3] & 0x0F)==0x0F ? "No write access granted at all" : "(RFU)");
	239	return 0;
	240	}
	241
	242
7624e8b2	243	// return type, length and value of a TLV, starting at memory position *TLV_ptr
7624e8b2	244	static void get_TLV(uint8_t *TLV_ptr, uint8_t TLV_type, uint16_t TLV_length, uint8_t *TLV_value)
de15fc5f	245	{
7624e8b2	246	*TLV_length = 0;
7624e8b2	247	*TLV_value = NULL;
de15fc5f	248
7624e8b2	249	TLV_type = *TLV_ptr;
de15fc5f	250	*TLV_ptr += 1;
7624e8b2	251	switch (*TLV_type) {
de15fc5f	252	case 0x00: // NULL TLV.
	253	case 0xFE: // Terminator TLV.
	254	break;
	255	case 0x01: // Lock Control TLV
	256	case 0x02: // Reserved Memory TLV
	257	case 0x03: // NDEF message TLV
	258	case 0xFD: // proprietary TLV
7624e8b2	259	TLV_length = *TLV_ptr;
de15fc5f	260	*TLV_ptr += 1;
7624e8b2	261	if (*TLV_length == 0xff) {
7624e8b2	262	TLV_length = *TLV_ptr << 8;
de15fc5f	263	*TLV_ptr += 1;
7624e8b2	264	TLV_length \|= *TLV_ptr;
de15fc5f	265	*TLV_ptr += 1;
de15fc5f	266	}
7624e8b2	267	TLV_value = TLV_ptr;
7624e8b2	268	TLV_ptr += TLV_length;
de15fc5f	269	break;
	270	default: // RFU
	271	break;
	272	}
	273	}
	274
	275
7624e8b2	276	// lock area TLVs contain no information on the start of the respective lockable area. Lockable areas
	277	// do not include the lock bits and reserved memory. We therefore need to adjust the start of the
	278	// respective lockable areas accordingly
	279	static void adjust_lock_areas(uint16_t block_start, uint16_t block_size)
	280	{
	281	dynamic_lock_area_t *lock_area = topaz_tag.dynamic_lock_areas;
	282	while (lock_area != NULL) {
	283	if (lock_area->first_locked_byte <= block_start) {
	284	lock_area->first_locked_byte += block_size;
	285	}
	286	lock_area = lock_area->next;
	287	}
	288	}
	289
	290
	291	// read and print the lock area and reserved memory TLVs
	292	static void topaz_print_control_TLVs(uint8_t *memory)
de15fc5f	293	{
de15fc5f	294	uint8_t *TLV_ptr = memory;
7624e8b2	295	uint8_t TLV_type = 0;
	296	uint16_t TLV_length;
	297	uint8_t *TLV_value;
de15fc5f	298	bool lock_TLV_present = false;
7624e8b2	299	bool reserved_memory_control_TLV_present = false;
7624e8b2	300	uint16_t next_lockable_byte = 0x0f * 8; // first byte after static memory area
de15fc5f	301
	302	while(TLV_ptr != 0x03 && TLV_ptr != 0xFD && *TLV_ptr != 0xFE) {
	303	// all Lock Control TLVs shall be present before the NDEF message TLV, the proprietary TLV (and the Terminator TLV)
7624e8b2	304	get_TLV(&TLV_ptr, &TLV_type, &TLV_length, &TLV_value);
	305	if (TLV_type == 0x01) { // a Lock Control TLV
	306	uint8_t pages_addr = TLV_value[0] >> 4;
	307	uint8_t byte_offset = TLV_value[0] & 0x0f;
	308	uint16_t size_in_bits = TLV_value[1] ? TLV_value[1] : 256;
	309	uint16_t size_in_bytes = (size_in_bits + 7)/8;
	310	uint16_t bytes_per_page = 1 << (TLV_value[2] & 0x0f);
	311	uint16_t bytes_locked_per_bit = 1 << (TLV_value[2] >> 4);
	312	uint16_t area_start = pages_addr * bytes_per_page + byte_offset;
6e6f1099	313	PrintAndLog("Lock Area of %d bits at byte offset 0x%04x. Each Lock Bit locks %d bytes.",
de15fc5f	314	size_in_bits,
7624e8b2	315	area_start,
de15fc5f	316	bytes_locked_per_bit);
de15fc5f	317	lock_TLV_present = true;
6e6f1099	318	dynamic_lock_area_t *old = topaz_tag.dynamic_lock_areas;
	319	dynamic_lock_area_t *new = topaz_tag.dynamic_lock_areas;
	320	if (old == NULL) {
	321	new = topaz_tag.dynamic_lock_areas = (dynamic_lock_area_t *)malloc(sizeof(dynamic_lock_area_t));
	322	} else {
	323	while(old->next != NULL) {
	324	old = old->next;
	325	}
	326	new = old->next = (dynamic_lock_area_t *)malloc(sizeof(dynamic_lock_area_t));
	327	}
	328	new->next = NULL;
7624e8b2	329	if (area_start <= next_lockable_byte) {
	330	// lock areas are not lockable
	331	next_lockable_byte += size_in_bytes;
	332	}
	333	new->first_locked_byte = next_lockable_byte;
	334	new->byte_offset = area_start;
6e6f1099	335	new->size_in_bits = size_in_bits;
6e6f1099	336	new->bytes_locked_per_bit = bytes_locked_per_bit;
7624e8b2	337	next_lockable_byte += size_in_bits * bytes_locked_per_bit;
	338	}
	339	if (TLV_type == 0x02) { // a Reserved Memory Control TLV
	340	uint8_t pages_addr = TLV_value[0] >> 4;
	341	uint8_t byte_offset = TLV_value[0] & 0x0f;
31a29271	342	uint16_t size_in_bytes = TLV_value[1] ? TLV_value[1] : 256;
7624e8b2	343	uint8_t bytes_per_page = 1 << (TLV_value[2] & 0x0f);
	344	uint16_t area_start = pages_addr * bytes_per_page + byte_offset;
	345	PrintAndLog("Reserved Memory of %d bytes at byte offset 0x%02x.",
	346	size_in_bytes,
	347	area_start);
	348	reserved_memory_control_TLV_present = true;
	349	adjust_lock_areas(area_start, size_in_bytes); // reserved memory areas are not lockable
	350	if (area_start <= next_lockable_byte) {
	351	next_lockable_byte += size_in_bytes;
	352	}
de15fc5f	353	}
	354	}
	355
	356	if (!lock_TLV_present) {
	357	PrintAndLog("(No Lock Control TLV present)");
de15fc5f	358	}
7624e8b2	359
	360	if (!reserved_memory_control_TLV_present) {
	361	PrintAndLog("(No Reserved Memory Control TLV present)");
	362	}
de15fc5f	363	}
	364
	365
7624e8b2	366	// read all of the dynamic memory
7624e8b2	367	static int topaz_read_dynamic_data(void)
de15fc5f	368	{
7624e8b2	369	// first read the remaining block of segment 0
	370	if(topaz_read_block(topaz_tag.uid, 0x0f, &topaz_tag.dynamic_memory[0]) == -1) {
	371	PrintAndLog("Error while reading dynamic memory block %02x. Aborting...", 0x0f);
	372	return -1;
	373	}
de15fc5f	374
7624e8b2	375	// read the remaining segments
	376	uint8_t max_segment = topaz_tag.size / 128 - 1;
	377	for(uint8_t segment = 1; segment <= max_segment; segment++) {
	378	if(topaz_read_segment(topaz_tag.uid, segment, &topaz_tag.dynamic_memory[(segment-1)*128+8]) == -1) {
	379	PrintAndLog("Error while reading dynamic memory block %02x. Aborting...", 0x0f);
	380	return -1;
de15fc5f	381	}
	382	}
	383
7624e8b2	384	return 0;
	385	}
	386
	387
	388	// read and print the dynamic memory
	389	static void topaz_print_dynamic_data(void)
	390	{
	391	if (topaz_tag.size > TOPAZ_STATIC_MEMORY) {
	392	PrintAndLog("Dynamic Data blocks:");
	393	if (topaz_read_dynamic_data() == 0) {
	394	PrintAndLog("block# \| offset \| Data \| Locked(y/n)");
	395	char line[80];
	396	for (uint16_t blockno = 0x0f; blockno < topaz_tag.size/8; blockno++) {
	397	uint8_t block_data = &topaz_tag.dynamic_memory[(blockno-0x0f)8];
	398	char lockbits[9];
	399	for (uint16_t j = 0; j < 8; j++) {
	400	sprintf(&line[3*j], "%02x ", block_data[j]);
	401	lockbits[j] = topaz_byte_is_locked(blockno*8+j) ? 'y' : 'n';
	402	}
	403	lockbits[8] = '\0';
	404	PrintAndLog(" 0x%02x \| 0x%04x \| %s\| %-3s", blockno, blockno*8, line, lockbits);
	405	}
	406	}
de15fc5f	407	}
	408	}
	409
	410
	411	static void topaz_print_lifecycle_state(uint8_t *data)
	412	{
7624e8b2	413	// to be done
de15fc5f	414	}
	415
	416
	417	static void topaz_print_NDEF(uint8_t *data)
	418	{
7624e8b2	419	// to be done.
de15fc5f	420	}
de15fc5f	421
7624e8b2	422
7624e8b2	423	// read a Topaz tag and print some usefull information
05ddb52c	424	int CmdHFTopazReader(const char *Cmd)
05ddb52c	425	{
de15fc5f	426	int status;
	427	uint8_t atqa[2];
	428	uint8_t rid_response[8];
	429	uint8_t *uid_echo = &rid_response[2];
c5847ae8	430	uint8_t rall_response[124];
de15fc5f	431
	432	status = topaz_select(atqa, rid_response);
	433
	434	if (status == -1) {
	435	PrintAndLog("Error: couldn't receive ATQA");
	436	return -1;
	437	}
	438
	439	PrintAndLog("ATQA : %02x %02x", atqa[1], atqa[0]);
	440	if (atqa[1] != 0x0c && atqa[0] != 0x00) {
	441	PrintAndLog("Tag doesn't support the Topaz protocol.");
	442	topaz_switch_off_field();
	443	return -1;
	444	}
	445
	446	if (status == -2) {
	447	PrintAndLog("Error: tag didn't answer to RID");
	448	topaz_switch_off_field();
	449	return -1;
	450	}
	451
c5847ae8	452	topaz_tag.HR01[0] = rid_response[0];
	453	topaz_tag.HR01[1] = rid_response[1];
	454
de15fc5f	455	// ToDo: CRC check
	456	PrintAndLog("HR0 : %02x (%sa Topaz tag (%scapable of carrying a NDEF message), %s memory map)", rid_response[0],
	457	(rid_response[0] & 0xF0) == 0x10 ? "" : "not ",
	458	(rid_response[0] & 0xF0) == 0x10 ? "" : "not ",
44964fd1	459	(rid_response[0] & 0x0F) == 0x01 ? "static" : "dynamic");
de15fc5f	460	PrintAndLog("HR1 : %02x", rid_response[1]);
de15fc5f	461
c5847ae8	462	status = topaz_rall(uid_echo, rall_response);
de15fc5f	463
	464	if(status == -1) {
	465	PrintAndLog("Error: tag didn't answer to RALL");
	466	topaz_switch_off_field();
	467	return -1;
	468	}
	469
c5847ae8	470	memcpy(topaz_tag.uid, rall_response+2, 7);
de15fc5f	471	PrintAndLog("UID : %02x %02x %02x %02x %02x %02x %02x",
c5847ae8	472	topaz_tag.uid[6],
	473	topaz_tag.uid[5],
	474	topaz_tag.uid[4],
	475	topaz_tag.uid[3],
	476	topaz_tag.uid[2],
	477	topaz_tag.uid[1],
	478	topaz_tag.uid[0]);
de15fc5f	479	PrintAndLog(" UID[6] (Manufacturer Byte) = %02x, Manufacturer: %s",
c5847ae8	480	topaz_tag.uid[6],
1338d245	481	getManufacturerName(topaz_tag.uid[6]));
c5847ae8	482
7624e8b2	483	memcpy(topaz_tag.data_blocks, rall_response+2, 0x0f*8);
de15fc5f	484	PrintAndLog("");
de15fc5f	485	PrintAndLog("Static Data blocks 00 to 0c:");
6e6f1099	486	PrintAndLog("block# \| offset \| Data \| Locked(y/n)");
de15fc5f	487	char line[80];
de15fc5f	488	for (uint16_t i = 0; i <= 0x0c; i++) {
7624e8b2	489	char lockbits[9];
de15fc5f	490	for (uint16_t j = 0; j < 8; j++) {
c5847ae8	491	sprintf(&line[3j], "%02x ", topaz_tag.data_blocks[i][j] /rall_response[2 + 8i + j]/);
7624e8b2	492	lockbits[j] = topaz_byte_is_locked(i*8+j) ? 'y' : 'n';
de15fc5f	493	}
7624e8b2	494	lockbits[8] = '\0';
7624e8b2	495	PrintAndLog(" 0x%02x \| 0x%04x \| %s\| %-3s", i, i*8, line, lockbits);
de15fc5f	496	}
	497
	498	PrintAndLog("");
	499	PrintAndLog("Static Reserved block 0d:");
	500	for (uint16_t j = 0; j < 8; j++) {
c5847ae8	501	sprintf(&line[3*j], "%02x ", topaz_tag.data_blocks[0x0d][j]);
de15fc5f	502	}
6e6f1099	503	PrintAndLog(" 0x%02x \| 0x%04x \| %s\| %-3s", 0x0d, 0x0d*8, line, "n/a");
de15fc5f	504
de15fc5f	505	PrintAndLog("");
c5847ae8	506	PrintAndLog("Static Lockbits and OTP Bytes:");
de15fc5f	507	for (uint16_t j = 0; j < 8; j++) {
c5847ae8	508	sprintf(&line[3*j], "%02x ", topaz_tag.data_blocks[0x0e][j]);
de15fc5f	509	}
6e6f1099	510	PrintAndLog(" 0x%02x \| 0x%04x \| %s\| %-3s", 0x0e, 0x0e*8, line, "n/a");
de15fc5f	511
	512	PrintAndLog("");
	513
c5847ae8	514	status = topaz_print_CC(&topaz_tag.data_blocks[1][0]);
de15fc5f	515
de15fc5f	516	if (status == -1) {
7624e8b2	517	PrintAndLog("No NDEF message data present");
de15fc5f	518	topaz_switch_off_field();
	519	return 0;
	520	}
	521
	522	PrintAndLog("");
7624e8b2	523	topaz_print_control_TLVs(&topaz_tag.data_blocks[1][4]);
de15fc5f	524
de15fc5f	525	PrintAndLog("");
7624e8b2	526	topaz_print_dynamic_data();
7624e8b2	527
c5847ae8	528	topaz_print_lifecycle_state(&topaz_tag.data_blocks[1][0]);
de15fc5f	529
c5847ae8	530	topaz_print_NDEF(&topaz_tag.data_blocks[1][0]);
de15fc5f	531
de15fc5f	532	topaz_switch_off_field();
05ddb52c	533	return 0;
	534	}
	535
	536
05ddb52c	537	int CmdHFTopazCmdRaw(const char *Cmd)
05ddb52c	538	{
7624e8b2	539	PrintAndLog("not yet implemented. Use hf 14 raw with option -T.");
05ddb52c	540	return 0;
	541	}
	542
	543
	544	static int CmdHelp(const char *Cmd);
	545
	546
	547	static command_t CommandTable[] =
	548	{
	549	{"help", CmdHelp, 1, "This help"},
	550	{"reader", CmdHFTopazReader, 0, "Act like a Topaz reader"},
05ddb52c	551	{"snoop", CmdHF14ASnoop, 0, "Eavesdrop a Topaz reader-tag communication"},
	552	{"raw", CmdHFTopazCmdRaw, 0, "Send raw hex data to tag"},
	553	{NULL, NULL, 0, NULL}
	554	};
	555
	556
	557	int CmdHFTopaz(const char *Cmd) {
44964fd1	558	(void)WaitForResponseTimeout(CMD_ACK,NULL,100);
05ddb52c	559	CmdsParse(CommandTable, Cmd);
	560	return 0;
	561	}
	562
7624e8b2	563
05ddb52c	564	static int CmdHelp(const char *Cmd)
	565	{
	566	CmdsHelp(CommandTable);
	567	return 0;
	568	}
	569
	570