[proxmark3-svn] / client / cmdhf.c

//-----------------------------------------------------------------------------
// Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
//
// 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 commands
//-----------------------------------------------------------------------------

#include <stdio.h>
#include <string.h>
#include "proxmark3.h"
#include "graph.h"
#include "ui.h"
#include "cmdparser.h"
#include "cmdhf.h"
#include "cmdhf14a.h"
#include "cmdhf14b.h"
#include "cmdhf15.h"
#include "cmdhfepa.h"
#include "cmdhflegic.h"
#include "cmdhficlass.h"
#include "cmdhfmf.h"
#include "cmdhfmfu.h"
#include "protocols.h"

static int CmdHelp(const char *Cmd);

int CmdHFTune(const char *Cmd)
{
  UsbCommand c={CMD_MEASURE_ANTENNA_TUNING_HF};
  SendCommand(&c);
  return 0;
}


void annotateIso14443a(char *exp, size_t size, uint8_t* cmd, uint8_t cmdsize)
{
	switch(cmd[0])
	{
	case ISO14443A_CMD_WUPA:        snprintf(exp,size,"WUPA"); break;
	case ISO14443A_CMD_ANTICOLL_OR_SELECT:{
		// 93 20 = Anticollision (usage: 9320 - answer: 4bytes UID+1byte UID-bytes-xor)
		// 93 70 = Select (usage: 9370+5bytes 9320 answer - answer: 1byte SAK)
		if(cmd[1] == 0x70)
		{
			snprintf(exp,size,"SELECT_UID"); break;
		}else
		{
			snprintf(exp,size,"ANTICOLL"); break;
		}
	}
	case ISO14443A_CMD_ANTICOLL_OR_SELECT_2:{
		//95 20 = Anticollision of cascade level2
		//95 70 = Select of cascade level2
		if(cmd[2] == 0x70)
		{
			snprintf(exp,size,"SELECT_UID-2"); break;
		}else
		{
			snprintf(exp,size,"ANTICOLL-2"); break;
		}
	}
	case ISO14443A_CMD_REQA:       snprintf(exp,size,"REQA"); break;
	case ISO14443A_CMD_READBLOCK:  snprintf(exp,size,"READBLOCK(%d)",cmd[1]); break;
	case ISO14443A_CMD_WRITEBLOCK: snprintf(exp,size,"WRITEBLOCK(%d)",cmd[1]); break;
	case ISO14443A_CMD_HALT:       snprintf(exp,size,"HALT"); break;
	case ISO14443A_CMD_RATS:       snprintf(exp,size,"RATS"); break;
	case MIFARE_CMD_INC:          snprintf(exp,size,"INC(%d)",cmd[1]); break;
	case MIFARE_CMD_DEC:          snprintf(exp,size,"DEC(%d)",cmd[1]); break;
	case MIFARE_CMD_RESTORE:      snprintf(exp,size,"RESTORE(%d)",cmd[1]); break;
	case MIFARE_CMD_TRANSFER:     snprintf(exp,size,"TRANSFER(%d)",cmd[1]); break;
	case MIFARE_AUTH_KEYA:        snprintf(exp,size,"AUTH-A(%d)",cmd[1]); break;
	case MIFARE_AUTH_KEYB:        snprintf(exp,size,"AUTH-B(%d)",cmd[1]); break;
	case MIFARE_MAGICMODE:        snprintf(exp,size,"MAGIC"); break;
	default:                      snprintf(exp,size,"?"); break;
	}
	return;
}

void annotateIclass(char *exp, size_t size, uint8_t* cmd, uint8_t cmdsize)
{
	switch(cmd[0])
	{
	case ICLASS_CMD_ACTALL:      snprintf(exp,size,"ACTALL"); break;
	case ICLASS_CMD_READ_OR_IDENTIFY:{
		if(cmdsize > 1){
			snprintf(exp,size,"READ(%d)",cmd[1]);
		}else{
			snprintf(exp,size,"IDENTIFY");
		}
		break;
	}
	case ICLASS_CMD_SELECT:      snprintf(exp,size,"SELECT"); break;
	case ICLASS_CMD_PAGESEL:     snprintf(exp,size,"PAGESEL(%d)", cmd[1]); break;
	case ICLASS_CMD_READCHECK_KC:snprintf(exp,size,"READCHECK[Kc](%d)", cmd[1]); break;
	case ICLASS_CMD_READCHECK_KD:snprintf(exp,size,"READCHECK[Kd](%d)", cmd[1]); break;
	case ICLASS_CMD_CHECK:       snprintf(exp,size,"CHECK"); break;
	case ICLASS_CMD_DETECT:      snprintf(exp,size,"DETECT"); break;
	case ICLASS_CMD_HALT:        snprintf(exp,size,"HALT"); break;
	case ICLASS_CMD_UPDATE:      snprintf(exp,size,"UPDATE(%d)",cmd[1]); break;
	case ICLASS_CMD_ACT:         snprintf(exp,size,"ACT"); break;
	case ICLASS_CMD_READ4:       snprintf(exp,size,"READ4(%d)",cmd[1]); break;
	default:                     snprintf(exp,size,"?"); break;
	}
	return;
}

void annotateIso15693(char *exp, size_t size, uint8_t* cmd, uint8_t cmdsize)
{

	if(cmd[0] == 0x26)
	{
		switch(cmd[1]){
		case ISO15693_INVENTORY           :snprintf(exp, size, "INVENTORY");break;
		case ISO15693_STAYQUIET           :snprintf(exp, size, "STAY_QUIET");break;
		default:                     snprintf(exp,size,"?"); break;

		}
	}else if(cmd[0] == 0x02)
	{
		switch(cmd[1])
		{
		case ISO15693_READBLOCK            :snprintf(exp, size, "READBLOCK");break;
		case ISO15693_WRITEBLOCK           :snprintf(exp, size, "WRITEBLOCK");break;
		case ISO15693_LOCKBLOCK            :snprintf(exp, size, "LOCKBLOCK");break;
		case ISO15693_READ_MULTI_BLOCK     :snprintf(exp, size, "READ_MULTI_BLOCK");break;
		case ISO15693_SELECT               :snprintf(exp, size, "SELECT");break;
		case ISO15693_RESET_TO_READY       :snprintf(exp, size, "RESET_TO_READY");break;
		case ISO15693_WRITE_AFI            :snprintf(exp, size, "WRITE_AFI");break;
		case ISO15693_LOCK_AFI             :snprintf(exp, size, "LOCK_AFI");break;
		case ISO15693_WRITE_DSFID          :snprintf(exp, size, "WRITE_DSFID");break;
		case ISO15693_LOCK_DSFID           :snprintf(exp, size, "LOCK_DSFID");break;
		case ISO15693_GET_SYSTEM_INFO      :snprintf(exp, size, "GET_SYSTEM_INFO");break;
		case ISO15693_READ_MULTI_SECSTATUS :snprintf(exp, size, "READ_MULTI_SECSTATUS");break;
		default:                            snprintf(exp,size,"?"); break;
		}
	}
}

/**
06 00 = INITIATE
0E xx = SELECT ID (xx = Chip-ID)
0B = Get UID
08 yy = Read Block (yy = block number)
09 yy dd dd dd dd = Write Block (yy = block number; dd dd dd dd = data to be written)
0C = Reset to Inventory
0F = Completion
0A 11 22 33 44 55 66 = Authenticate (11 22 33 44 55 66 = data to authenticate)
**/

void annotateIso14443b(char *exp, size_t size, uint8_t* cmd, uint8_t cmdsize)
{
	switch(cmd[0]){
	case ISO14443B_REQB   : snprintf(exp,size,"REQB");break;
	case ISO14443B_ATTRIB : snprintf(exp,size,"ATTRIB");break;
	case ISO14443B_HALT   : snprintf(exp,size,"HALT");break;
	case ISO14443B_INITIATE     : snprintf(exp,size,"INITIATE");break;
	case ISO14443B_SELECT       : snprintf(exp,size,"SELECT(%d)",cmd[1]);break;
	case ISO14443B_GET_UID      : snprintf(exp,size,"GET UID");break;
	case ISO14443B_READ_BLK     : snprintf(exp,size,"READ_BLK(%d)", cmd[1]);break;
	case ISO14443B_WRITE_BLK    : snprintf(exp,size,"WRITE_BLK(%d)",cmd[1]);break;
	case ISO14443B_RESET        : snprintf(exp,size,"RESET");break;
	case ISO14443B_COMPLETION   : snprintf(exp,size,"COMPLETION");break;
	case ISO14443B_AUTHENTICATE : snprintf(exp,size,"AUTHENTICATE");break;
	default                     : snprintf(exp,size ,"?");break;
	}

}

/**
 * @brief iso14443B_CRC_Ok Checks CRC in command or response
 * @param isResponse
 * @param data
 * @param len
 * @return  0 : CRC-command, CRC not ok
 *          1 : CRC-command, CRC ok
 *          2 : Not crc-command
 */

uint8_t iso14443B_CRC_check(bool isResponse, uint8_t* data, uint8_t len)
{
	uint8_t b1,b2;

	if(len <= 2) return 2;

	ComputeCrc14443(CRC_14443_B, data, len-2, &b1, &b2);
	if(b1 != data[len-2] || b2 != data[len-1]) {
	  return 0;
	}
	return 1;
}

/**
 * @brief iclass_CRC_Ok Checks CRC in command or response
 * @param isResponse
 * @param data
 * @param len
 * @return  0 : CRC-command, CRC not ok
 *	        1 : CRC-command, CRC ok
 *          2 : Not crc-command
 */
uint8_t iclass_CRC_check(bool isResponse, uint8_t* data, uint8_t len)
{
	if(len < 4) return 2;//CRC commands (and responses) are all at least 4 bytes

	uint8_t b1, b2;

	if(!isResponse)//Commands to tag
	{
		/**
		  These commands should have CRC. Total length leftmost
		  4	READ
		  4 READ4
		  12 UPDATE - unsecured, ends with CRC16
		  14 UPDATE - secured, ends with signature instead
		  4 PAGESEL
		  **/
		if(len == 4 || len == 12)//Covers three of them
		{
			//Don't include the command byte
			ComputeCrc14443(CRC_ICLASS, (data+1), len-3, &b1, &b2);
			return b1 == data[len -2] && b2 == data[len-1];
		}
		return 2;
	}else{
		/**
		These tag responses should have CRC. Total length leftmost

		10  READ		data[8] crc[2]
		34  READ4		data[32]crc[2]
		10  UPDATE	data[8] crc[2]
		10 SELECT	csn[8] crc[2]
		10  IDENTIFY  asnb[8] crc[2]
		10  PAGESEL   block1[8] crc[2]
		10  DETECT    csn[8] crc[2]

		These should not

		4  CHECK		chip_response[4]
		8  READCHECK data[8]
		1  ACTALL    sof[1]
		1  ACT	     sof[1]

		In conclusion, without looking at the command; any response
		of length 10 or 34 should have CRC
		  **/
		if(len != 10 && len != 34) return true;

		ComputeCrc14443(CRC_ICLASS, data, len-2, &b1, &b2);
		return b1 == data[len -2] && b2 == data[len-1];
	}
}

uint16_t printTraceLine(uint16_t tracepos, uint16_t traceLen, uint8_t *trace, uint8_t protocol, bool showWaitCycles)
{
	bool isResponse;
	uint16_t duration, data_len, parity_len;

	uint32_t timestamp, first_timestamp, EndOfTransmissionTimestamp;
	char explanation[30] = {0};

	if (tracepos + sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) > traceLen) return traceLen;
	
	first_timestamp = *((uint32_t *)(trace));
	timestamp = *((uint32_t *)(trace + tracepos));

	tracepos += 4;
	duration = *((uint16_t *)(trace + tracepos));
	tracepos += 2;
	data_len = *((uint16_t *)(trace + tracepos));
	tracepos += 2;

	if (data_len & 0x8000) {
	  data_len &= 0x7fff;
	  isResponse = true;
	} else {
	  isResponse = false;
	}
	parity_len = (data_len-1)/8 + 1;

	if (tracepos + data_len + parity_len > traceLen) {
		return traceLen;
	}
	uint8_t *frame = trace + tracepos;
	tracepos += data_len;
	uint8_t *parityBytes = trace + tracepos;
	tracepos += parity_len;


	//--- Draw the data column
	//char line[16][110];
	char line[16][110];

	for (int j = 0; j < data_len && j/16 < 16; j++) {

		int oddparity = 0x01;
		int k;

		for (k=0 ; k<8 ; k++) {
			oddparity ^= (((frame[j] & 0xFF) >> k) & 0x01);
		}

		uint8_t parityBits = parityBytes[j>>3];
		if (isResponse && (oddparity != ((parityBits >> (7-(j&0x0007))) & 0x01))) {
			snprintf(line[j/16]+(( j % 16) * 4),110, "%02x! ", frame[j]);

		} else {
			snprintf(line[j/16]+(( j % 16) * 4),110, "%02x  ", frame[j]);
		}
	}
	if(data_len == 0)
	{
		if(data_len == 0){
			sprintf(line[0],"<empty trace - possible error>");
		}
	}
	//--- Draw the CRC column
	uint8_t crcStatus = 2;

	if (data_len > 2) {
		uint8_t b1, b2;
		if(protocol == ICLASS)
		{
			crcStatus = iclass_CRC_check(isResponse, frame, data_len);

		}else if (protocol == ISO_14443B)
		{
			crcStatus = iso14443B_CRC_check(isResponse, frame, data_len);
		}
		else if (protocol == ISO_14443A){//Iso 14443a

			ComputeCrc14443(CRC_14443_A, frame, data_len-2, &b1, &b2);

			if (b1 != frame[data_len-2] || b2 != frame[data_len-1]) {
				if(!(isResponse & (data_len < 6)))
				{
						crcStatus = 0;
				}
			}
		}
	}
	//0 CRC-command, CRC not ok
	//1 CRC-command, CRC ok
	//2 Not crc-command
	char *crc = (crcStatus == 0 ? "!crc" : (crcStatus == 1 ? " ok " : "    "));

	EndOfTransmissionTimestamp = timestamp + duration;

	if(!isResponse)
	{
		if(protocol == ICLASS)
			annotateIclass(explanation,sizeof(explanation),frame,data_len);
		else if (protocol == ISO_14443A)
			annotateIso14443a(explanation,sizeof(explanation),frame,data_len);
		else if(protocol == ISO_14443B)
			annotateIso14443b(explanation,sizeof(explanation),frame,data_len);
	}

	int num_lines = MIN((data_len - 1)/16 + 1, 16);
	for (int j = 0; j < num_lines ; j++) {
		if (j == 0) {
			PrintAndLog(" %9d | %9d | %s | %-64s| %s| %s",
				(timestamp - first_timestamp),
				(EndOfTransmissionTimestamp - first_timestamp),
				(isResponse ? "Tag" : "Rdr"),
				line[j],
				(j == num_lines-1) ? crc : "    ",
				(j == num_lines-1) ? explanation : "");
		} else {
			PrintAndLog("           |           |     | %-64s| %s| %s",
				line[j],
				(j == num_lines-1)?crc:"    ",
				(j == num_lines-1) ? explanation : "");
		}
	}

	if (tracepos + sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) > traceLen) return traceLen;
	
	bool next_isResponse = *((uint16_t *)(trace + tracepos + 6)) & 0x8000;

	if (showWaitCycles && !isResponse && next_isResponse) {
		uint32_t next_timestamp = *((uint32_t *)(trace + tracepos));
		if (next_timestamp != 0x44444444) {
			PrintAndLog(" %9d | %9d | %s | fdt (Frame Delay Time): %d",
				(EndOfTransmissionTimestamp - first_timestamp),
				(next_timestamp - first_timestamp),
				"   ",
				(next_timestamp - EndOfTransmissionTimestamp));
		}
	}

	return tracepos;
}


int CmdHFList(const char *Cmd)
{
	bool showWaitCycles = false;
	char type[40] = {0};
	int tlen = param_getstr(Cmd,0,type);
	char param = param_getchar(Cmd, 1);
	bool errors = false;
	uint8_t protocol = 0;
	//Validate params
	if(tlen == 0)
	{
		errors = true;
	}
	if(param == 'h' || (param !=0 && param != 'f'))
	{
		errors = true;
	}
	if(!errors)
	{
		if(strcmp(type, "iclass") == 0)
		{
			protocol = ICLASS;
		}else if(strcmp(type, "14a") == 0)
		{
			protocol = ISO_14443A;
		}
		else if(strcmp(type, "14b") == 0)
		{
			protocol = ISO_14443B;
		}else if(strcmp(type,"raw")== 0)
		{
			protocol = -1;//No crc, no annotations
		}else{
			errors = true;
		}
	}

	if (errors) {
		PrintAndLog("List protocol data in trace buffer.");
		PrintAndLog("Usage:  hf list <protocol> [f]");
		PrintAndLog("    f      - show frame delay times as well");
		PrintAndLog("Supported <protocol> values:");
		PrintAndLog("    raw    - just show raw data without annotations");
		PrintAndLog("    14a    - interpret data as iso14443a communications");
		PrintAndLog("    14b    - interpret data as iso14443b communications");
		PrintAndLog("    iclass - interpret data as iclass communications");
		PrintAndLog("");
		PrintAndLog("example: hf list 14a f");
		PrintAndLog("example: hf list iclass");
		return 0;
	}


	if (param == 'f') {
		showWaitCycles = true;
	}


	uint8_t *trace;
	uint16_t tracepos = 0;
	trace = malloc(USB_CMD_DATA_SIZE);

	// Query for the size of the trace
	UsbCommand response;
	GetFromBigBuf(trace, USB_CMD_DATA_SIZE, 0);
	WaitForResponse(CMD_ACK, &response);
	uint16_t traceLen = response.arg[2];
	if (traceLen > USB_CMD_DATA_SIZE) {
		uint8_t *p = realloc(trace, traceLen);
		if (p == NULL) {
			PrintAndLog("Cannot allocate memory for trace");
			free(trace);
			return 2;
		}
		trace = p;
		GetFromBigBuf(trace, traceLen, 0);
		WaitForResponse(CMD_ACK, NULL);
	}
	
	PrintAndLog("Recorded Activity (TraceLen = %d bytes)", traceLen);
	PrintAndLog("");
	PrintAndLog("Start = Start of Start Bit, End = End of last modulation. Src = Source of Transfer");
	PrintAndLog("iso14443a - All times are in carrier periods (1/13.56Mhz)");
	PrintAndLog("iClass    - Timings are not as accurate");
	PrintAndLog("");
	PrintAndLog("     Start |       End | Src | Data (! denotes parity error)                                   | CRC | Annotation         |");
	PrintAndLog("-----------|-----------|-----|-----------------------------------------------------------------|-----|--------------------|");

	while(tracepos < traceLen)
	{
		tracepos = printTraceLine(tracepos, traceLen, trace, protocol, showWaitCycles);
	}

	free(trace);
	return 0;
}


static command_t CommandTable[] = 
{
  {"help",        CmdHelp,          1, "This help"},
  {"14a",         CmdHF14A,         1, "{ ISO14443A RFIDs... }"},
  {"14b",         CmdHF14B,         1, "{ ISO14443B RFIDs... }"},
  {"15",          CmdHF15,          1, "{ ISO15693 RFIDs... }"},
  {"epa",         CmdHFEPA,         1, "{ German Identification Card... }"},
  {"legic",       CmdHFLegic,       0, "{ LEGIC RFIDs... }"},
  {"iclass",      CmdHFiClass,      1, "{ ICLASS RFIDs... }"},
  {"mf",      		CmdHFMF,		1, "{ MIFARE RFIDs... }"},
  {"mfu",			CmdHFMFUltra,		1, "{ MIFARE Ultralight RFIDs... }"},
  {"tune",        CmdHFTune,        0, "Continuously measure HF antenna tuning"},
  {"list",       CmdHFList,         1, "List protocol data in trace buffer"},
	{NULL, NULL, 0, NULL}
};

int CmdHF(const char *Cmd)
{
  CmdsParse(CommandTable, Cmd);
  return 0; 
}

int CmdHelp(const char *Cmd)
{
  CmdsHelp(CommandTable);
  return 0;
}
Commit	Line	Data
a553f267	1	//-----------------------------------------------------------------------------
	2	// Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
	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 commands
	9	//-----------------------------------------------------------------------------
	10
7fe9b0b7	11	#include <stdio.h>
4c3de57a	12	#include <string.h>
902cb3c0	13	#include "proxmark3.h"
7fe9b0b7	14	#include "graph.h"
	15	#include "ui.h"
	16	#include "cmdparser.h"
	17	#include "cmdhf.h"
	18	#include "cmdhf14a.h"
	19	#include "cmdhf14b.h"
	20	#include "cmdhf15.h"
5acd09bd	21	#include "cmdhfepa.h"
7fe9b0b7	22	#include "cmdhflegic.h"
cee5a30d	23	#include "cmdhficlass.h"
9ca155ba	24	#include "cmdhfmf.h"
5ee70129	25	#include "cmdhfmfu.h"
b67f7ec3	26	#include "protocols.h"
7fe9b0b7	27
	28	static int CmdHelp(const char *Cmd);
	29
	30	int CmdHFTune(const char *Cmd)
	31	{
	32	UsbCommand c={CMD_MEASURE_ANTENNA_TUNING_HF};
	33	SendCommand(&c);
	34	return 0;
	35	}
4c3de57a	36
4c3de57a MHS	37
	38	void annotateIso14443a(char exp, size_t size, uint8_t cmd, uint8_t cmdsize)
	39	{
	40	switch(cmd[0])
	41	{
41fdd0f0 MHS	42	case ISO14443A_CMD_WUPA: snprintf(exp,size,"WUPA"); break;
41fdd0f0 MHS	43	case ISO14443A_CMD_ANTICOLL_OR_SELECT:{
4df54240 MHS	44	// 93 20 = Anticollision (usage: 9320 - answer: 4bytes UID+1byte UID-bytes-xor)
4df54240 MHS	45	// 93 70 = Select (usage: 9370+5bytes 9320 answer - answer: 1byte SAK)
383608a6	46	if(cmd[1] == 0x70)
4c3de57a MHS	47	{
	48	snprintf(exp,size,"SELECT_UID"); break;
	49	}else
	50	{
4df54240 MHS	51	snprintf(exp,size,"ANTICOLL"); break;
	52	}
	53	}
41fdd0f0	54	case ISO14443A_CMD_ANTICOLL_OR_SELECT_2:{
4df54240 MHS	55	//95 20 = Anticollision of cascade level2
	56	//95 70 = Select of cascade level2
	57	if(cmd[2] == 0x70)
	58	{
	59	snprintf(exp,size,"SELECT_UID-2"); break;
	60	}else
	61	{
	62	snprintf(exp,size,"ANTICOLL-2"); break;
4c3de57a MHS	63	}
4c3de57a MHS	64	}
41fdd0f0 MHS	65	case ISO14443A_CMD_REQA: snprintf(exp,size,"REQA"); break;
	66	case ISO14443A_CMD_READBLOCK: snprintf(exp,size,"READBLOCK(%d)",cmd[1]); break;
	67	case ISO14443A_CMD_WRITEBLOCK: snprintf(exp,size,"WRITEBLOCK(%d)",cmd[1]); break;
	68	case ISO14443A_CMD_HALT: snprintf(exp,size,"HALT"); break;
	69	case ISO14443A_CMD_RATS: snprintf(exp,size,"RATS"); break;
4df54240 MHS	70	case MIFARE_CMD_INC: snprintf(exp,size,"INC(%d)",cmd[1]); break;
	71	case MIFARE_CMD_DEC: snprintf(exp,size,"DEC(%d)",cmd[1]); break;
	72	case MIFARE_CMD_RESTORE: snprintf(exp,size,"RESTORE(%d)",cmd[1]); break;
	73	case MIFARE_CMD_TRANSFER: snprintf(exp,size,"TRANSFER(%d)",cmd[1]); break;
383608a6 MHS	74	case MIFARE_AUTH_KEYA: snprintf(exp,size,"AUTH-A(%d)",cmd[1]); break;
383608a6 MHS	75	case MIFARE_AUTH_KEYB: snprintf(exp,size,"AUTH-B(%d)",cmd[1]); break;
4df54240 MHS	76	case MIFARE_MAGICMODE: snprintf(exp,size,"MAGIC"); break;
4df54240 MHS	77	default: snprintf(exp,size,"?"); break;
4c3de57a MHS	78	}
	79	return;
	80	}
	81
	82	void annotateIclass(char exp, size_t size, uint8_t cmd, uint8_t cmdsize)
	83	{
4c3de57a MHS	84	switch(cmd[0])
4c3de57a MHS	85	{
337818f7	86	case ICLASS_CMD_ACTALL: snprintf(exp,size,"ACTALL"); break;
4df54240 MHS	87	case ICLASS_CMD_READ_OR_IDENTIFY:{
	88	if(cmdsize > 1){
	89	snprintf(exp,size,"READ(%d)",cmd[1]);
	90	}else{
	91	snprintf(exp,size,"IDENTIFY");
	92	}
	93	break;
	94	}
337818f7	95	case ICLASS_CMD_SELECT: snprintf(exp,size,"SELECT"); break;
49726b40 MHS	96	case ICLASS_CMD_PAGESEL: snprintf(exp,size,"PAGESEL(%d)", cmd[1]); break;
	97	case ICLASS_CMD_READCHECK_KC:snprintf(exp,size,"READCHECK[Kc](%d)", cmd[1]); break;
	98	case ICLASS_CMD_READCHECK_KD:snprintf(exp,size,"READCHECK[Kd](%d)", cmd[1]); break;
337818f7	99	case ICLASS_CMD_CHECK: snprintf(exp,size,"CHECK"); break;
49726b40	100	case ICLASS_CMD_DETECT: snprintf(exp,size,"DETECT"); break;
337818f7	101	case ICLASS_CMD_HALT: snprintf(exp,size,"HALT"); break;
49726b40 MHS	102	case ICLASS_CMD_UPDATE: snprintf(exp,size,"UPDATE(%d)",cmd[1]); break;
	103	case ICLASS_CMD_ACT: snprintf(exp,size,"ACT"); break;
	104	case ICLASS_CMD_READ4: snprintf(exp,size,"READ4(%d)",cmd[1]); break;
337818f7	105	default: snprintf(exp,size,"?"); break;
4c3de57a MHS	106	}
	107	return;
	108	}
	109
4df54240 MHS	110	void annotateIso15693(char exp, size_t size, uint8_t cmd, uint8_t cmdsize)
	111	{
	112
	113	if(cmd[0] == 0x26)
	114	{
	115	switch(cmd[1]){
	116	case ISO15693_INVENTORY :snprintf(exp, size, "INVENTORY");break;
	117	case ISO15693_STAYQUIET :snprintf(exp, size, "STAY_QUIET");break;
	118	default: snprintf(exp,size,"?"); break;
4c3de57a	119
4df54240 MHS	120	}
	121	}else if(cmd[0] == 0x02)
	122	{
	123	switch(cmd[1])
	124	{
	125	case ISO15693_READBLOCK :snprintf(exp, size, "READBLOCK");break;
	126	case ISO15693_WRITEBLOCK :snprintf(exp, size, "WRITEBLOCK");break;
	127	case ISO15693_LOCKBLOCK :snprintf(exp, size, "LOCKBLOCK");break;
	128	case ISO15693_READ_MULTI_BLOCK :snprintf(exp, size, "READ_MULTI_BLOCK");break;
	129	case ISO15693_SELECT :snprintf(exp, size, "SELECT");break;
	130	case ISO15693_RESET_TO_READY :snprintf(exp, size, "RESET_TO_READY");break;
	131	case ISO15693_WRITE_AFI :snprintf(exp, size, "WRITE_AFI");break;
	132	case ISO15693_LOCK_AFI :snprintf(exp, size, "LOCK_AFI");break;
	133	case ISO15693_WRITE_DSFID :snprintf(exp, size, "WRITE_DSFID");break;
	134	case ISO15693_LOCK_DSFID :snprintf(exp, size, "LOCK_DSFID");break;
	135	case ISO15693_GET_SYSTEM_INFO :snprintf(exp, size, "GET_SYSTEM_INFO");break;
	136	case ISO15693_READ_MULTI_SECSTATUS :snprintf(exp, size, "READ_MULTI_SECSTATUS");break;
41fdd0f0	137	default: snprintf(exp,size,"?"); break;
4df54240 MHS	138	}
	139	}
	140	}
08e8317c MHS	141
	142	/**
	143	06 00 = INITIATE
	144	0E xx = SELECT ID (xx = Chip-ID)
	145	0B = Get UID
	146	08 yy = Read Block (yy = block number)
	147	09 yy dd dd dd dd = Write Block (yy = block number; dd dd dd dd = data to be written)
	148	0C = Reset to Inventory
	149	0F = Completion
	150	0A 11 22 33 44 55 66 = Authenticate (11 22 33 44 55 66 = data to authenticate)
	151	**/
	152
41fdd0f0 MHS	153	void annotateIso14443b(char exp, size_t size, uint8_t cmd, uint8_t cmdsize)
	154	{
	155	switch(cmd[0]){
	156	case ISO14443B_REQB : snprintf(exp,size,"REQB");break;
	157	case ISO14443B_ATTRIB : snprintf(exp,size,"ATTRIB");break;
	158	case ISO14443B_HALT : snprintf(exp,size,"HALT");break;
08e8317c MHS	159	case ISO14443B_INITIATE : snprintf(exp,size,"INITIATE");break;
	160	case ISO14443B_SELECT : snprintf(exp,size,"SELECT(%d)",cmd[1]);break;
	161	case ISO14443B_GET_UID : snprintf(exp,size,"GET UID");break;
	162	case ISO14443B_READ_BLK : snprintf(exp,size,"READ_BLK(%d)", cmd[1]);break;
	163	case ISO14443B_WRITE_BLK : snprintf(exp,size,"WRITE_BLK(%d)",cmd[1]);break;
	164	case ISO14443B_RESET : snprintf(exp,size,"RESET");break;
	165	case ISO14443B_COMPLETION : snprintf(exp,size,"COMPLETION");break;
	166	case ISO14443B_AUTHENTICATE : snprintf(exp,size,"AUTHENTICATE");break;
	167	default : snprintf(exp,size ,"?");break;
41fdd0f0 MHS	168	}
	169
	170	}
	171
	172	/**
	173	* @brief iso14443B_CRC_Ok Checks CRC in command or response
	174	* @param isResponse
	175	* @param data
	176	* @param len
	177	* @return 0 : CRC-command, CRC not ok
	178	* 1 : CRC-command, CRC ok
	179	* 2 : Not crc-command
	180	*/
	181
	182	uint8_t iso14443B_CRC_check(bool isResponse, uint8_t* data, uint8_t len)
	183	{
	184	uint8_t b1,b2;
	185
	186	if(len <= 2) return 2;
	187
	188	ComputeCrc14443(CRC_14443_B, data, len-2, &b1, &b2);
	189	if(b1 != data[len-2] \|\| b2 != data[len-1]) {
	190	return 0;
	191	}
	192	return 1;
	193	}
	194
49726b40 MHS	195	/**
	196	* @brief iclass_CRC_Ok Checks CRC in command or response
	197	* @param isResponse
	198	* @param data
	199	* @param len
	200	* @return 0 : CRC-command, CRC not ok
	201	* 1 : CRC-command, CRC ok
	202	* 2 : Not crc-command
	203	*/
41fdd0f0	204	uint8_t iclass_CRC_check(bool isResponse, uint8_t* data, uint8_t len)
49726b40 MHS	205	{
	206	if(len < 4) return 2;//CRC commands (and responses) are all at least 4 bytes
	207
	208	uint8_t b1, b2;
	209
	210	if(!isResponse)//Commands to tag
	211	{
	212	/**
	213	These commands should have CRC. Total length leftmost
	214	4 READ
	215	4 READ4
	216	12 UPDATE - unsecured, ends with CRC16
	217	14 UPDATE - secured, ends with signature instead
	218	4 PAGESEL
	219	**/
	220	if(len == 4 \|\| len == 12)//Covers three of them
	221	{
	222	//Don't include the command byte
	223	ComputeCrc14443(CRC_ICLASS, (data+1), len-3, &b1, &b2);
	224	return b1 == data[len -2] && b2 == data[len-1];
	225	}
	226	return 2;
	227	}else{
	228	/**
	229	These tag responses should have CRC. Total length leftmost
	230
	231	10 READ data[8] crc[2]
	232	34 READ4 data[32]crc[2]
	233	10 UPDATE data[8] crc[2]
	234	10 SELECT csn[8] crc[2]
	235	10 IDENTIFY asnb[8] crc[2]
	236	10 PAGESEL block1[8] crc[2]
	237	10 DETECT csn[8] crc[2]
	238
	239	These should not
	240
	241	4 CHECK chip_response[4]
	242	8 READCHECK data[8]
	243	1 ACTALL sof[1]
	244	1 ACT sof[1]
	245
	246	In conclusion, without looking at the command; any response
	247	of length 10 or 34 should have CRC
	248	**/
	249	if(len != 10 && len != 34) return true;
	250
	251	ComputeCrc14443(CRC_ICLASS, data, len-2, &b1, &b2);
	252	return b1 == data[len -2] && b2 == data[len-1];
	253	}
	254	}
4c3de57a	255
f71f4deb	256	uint16_t printTraceLine(uint16_t tracepos, uint16_t traceLen, uint8_t *trace, uint8_t protocol, bool showWaitCycles)
4c3de57a MHS	257	{
4c3de57a MHS	258	bool isResponse;
f71f4deb	259	uint16_t duration, data_len, parity_len;
4c3de57a MHS	260
	261	uint32_t timestamp, first_timestamp, EndOfTransmissionTimestamp;
	262	char explanation[30] = {0};
	263
f71f4deb	264	if (tracepos + sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) > traceLen) return traceLen;
f71f4deb	265
4c3de57a MHS	266	first_timestamp = ((uint32_t )(trace));
4c3de57a MHS	267	timestamp = ((uint32_t )(trace + tracepos));
4c3de57a MHS	268
	269	tracepos += 4;
	270	duration = ((uint16_t )(trace + tracepos));
	271	tracepos += 2;
	272	data_len = ((uint16_t )(trace + tracepos));
	273	tracepos += 2;
	274
	275	if (data_len & 0x8000) {
	276	data_len &= 0x7fff;
	277	isResponse = true;
	278	} else {
	279	isResponse = false;
	280	}
	281	parity_len = (data_len-1)/8 + 1;
	282
f71f4deb	283	if (tracepos + data_len + parity_len > traceLen) {
f71f4deb	284	return traceLen;
4c3de57a	285	}
4c3de57a MHS	286	uint8_t *frame = trace + tracepos;
	287	tracepos += data_len;
	288	uint8_t *parityBytes = trace + tracepos;
	289	tracepos += parity_len;
	290
9e8255d4	291
4c3de57a	292	//--- Draw the data column
9e8255d4	293	//char line[16][110];
4c3de57a	294	char line[16][110];
9e8255d4 MHS	295
	296	for (int j = 0; j < data_len && j/16 < 16; j++) {
	297
4c3de57a MHS	298	int oddparity = 0x01;
	299	int k;
	300
	301	for (k=0 ; k<8 ; k++) {
	302	oddparity ^= (((frame[j] & 0xFF) >> k) & 0x01);
	303	}
	304
	305	uint8_t parityBits = parityBytes[j>>3];
4c3de57a	306	if (isResponse && (oddparity != ((parityBits >> (7-(j&0x0007))) & 0x01))) {
9e8255d4 MHS	307	snprintf(line[j/16]+(( j % 16) * 4),110, "%02x! ", frame[j]);
9e8255d4 MHS	308
4c3de57a	309	} else {
8b9393d3	310	snprintf(line[j/16]+(( j % 16) * 4),110, "%02x ", frame[j]);
9e8255d4 MHS	311	}
	312	}
	313	if(data_len == 0)
	314	{
	315	if(data_len == 0){
	316	sprintf(line[0],"<empty trace - possible error>");
4c3de57a MHS	317	}
	318	}
	319	//--- Draw the CRC column
49726b40	320	uint8_t crcStatus = 2;
4c3de57a MHS	321
	322	if (data_len > 2) {
	323	uint8_t b1, b2;
41fdd0f0	324	if(protocol == ICLASS)
4c3de57a	325	{
41fdd0f0	326	crcStatus = iclass_CRC_check(isResponse, frame, data_len);
4c3de57a	327
41fdd0f0 MHS	328	}else if (protocol == ISO_14443B)
	329	{
	330	crcStatus = iso14443B_CRC_check(isResponse, frame, data_len);
	331	}
	332	else if (protocol == ISO_14443A){//Iso 14443a
4c3de57a MHS	333
	334	ComputeCrc14443(CRC_14443_A, frame, data_len-2, &b1, &b2);
	335
	336	if (b1 != frame[data_len-2] \|\| b2 != frame[data_len-1]) {
	337	if(!(isResponse & (data_len < 6)))
	338	{
49726b40	339	crcStatus = 0;
4c3de57a MHS	340	}
	341	}
	342	}
4c3de57a	343	}
49726b40 MHS	344	//0 CRC-command, CRC not ok
	345	//1 CRC-command, CRC ok
	346	//2 Not crc-command
	347	char *crc = (crcStatus == 0 ? "!crc" : (crcStatus == 1 ? " ok " : " "));
4c3de57a MHS	348
	349	EndOfTransmissionTimestamp = timestamp + duration;
	350
	351	if(!isResponse)
	352	{
41fdd0f0	353	if(protocol == ICLASS)
79bf1ad2	354	annotateIclass(explanation,sizeof(explanation),frame,data_len);
41fdd0f0	355	else if (protocol == ISO_14443A)
79bf1ad2	356	annotateIso14443a(explanation,sizeof(explanation),frame,data_len);
41fdd0f0 MHS	357	else if(protocol == ISO_14443B)
41fdd0f0 MHS	358	annotateIso14443b(explanation,sizeof(explanation),frame,data_len);
4c3de57a MHS	359	}
4c3de57a MHS	360
9e8255d4 MHS	361	int num_lines = MIN((data_len - 1)/16 + 1, 16);
9e8255d4 MHS	362	for (int j = 0; j < num_lines ; j++) {
4c3de57a MHS	363	if (j == 0) {
	364	PrintAndLog(" %9d \| %9d \| %s \| %-64s\| %s\| %s",
	365	(timestamp - first_timestamp),
	366	(EndOfTransmissionTimestamp - first_timestamp),
	367	(isResponse ? "Tag" : "Rdr"),
	368	line[j],
	369	(j == num_lines-1) ? crc : " ",
	370	(j == num_lines-1) ? explanation : "");
	371	} else {
	372	PrintAndLog(" \| \| \| %-64s\| %s\| %s",
	373	line[j],
	374	(j == num_lines-1)?crc:" ",
	375	(j == num_lines-1) ? explanation : "");
	376	}
	377	}
	378
f71f4deb	379	if (tracepos + sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) > traceLen) return traceLen;
f71f4deb	380
4c3de57a MHS	381	bool next_isResponse = ((uint16_t )(trace + tracepos + 6)) & 0x8000;
	382
	383	if (showWaitCycles && !isResponse && next_isResponse) {
	384	uint32_t next_timestamp = ((uint32_t )(trace + tracepos));
	385	if (next_timestamp != 0x44444444) {
	386	PrintAndLog(" %9d \| %9d \| %s \| fdt (Frame Delay Time): %d",
	387	(EndOfTransmissionTimestamp - first_timestamp),
	388	(next_timestamp - first_timestamp),
	389	" ",
	390	(next_timestamp - EndOfTransmissionTimestamp));
	391	}
	392	}
f71f4deb	393
4c3de57a MHS	394	return tracepos;
	395	}
	396
f71f4deb	397
4c3de57a MHS	398	int CmdHFList(const char *Cmd)
	399	{
	400	bool showWaitCycles = false;
	401	char type[40] = {0};
	402	int tlen = param_getstr(Cmd,0,type);
	403	char param = param_getchar(Cmd, 1);
	404	bool errors = false;
b689b842	405	uint8_t protocol = 0;
4c3de57a	406	//Validate params
b689b842	407	if(tlen == 0)
4c3de57a MHS	408	{
	409	errors = true;
	410	}
	411	if(param == 'h' \|\| (param !=0 && param != 'f'))
	412	{
	413	errors = true;
	414	}
b689b842 MHS	415	if(!errors)
	416	{
	417	if(strcmp(type, "iclass") == 0)
	418	{
	419	protocol = ICLASS;
	420	}else if(strcmp(type, "14a") == 0)
	421	{
	422	protocol = ISO_14443A;
	423	}
	424	else if(strcmp(type, "14b") == 0)
	425	{
	426	protocol = ISO_14443B;
	427	}else if(strcmp(type,"raw")== 0)
	428	{
	429	protocol = -1;//No crc, no annotations
	430	}else{
	431	errors = true;
	432	}
	433	}
4c3de57a MHS	434
	435	if (errors) {
	436	PrintAndLog("List protocol data in trace buffer.");
92623113 MHS	437	PrintAndLog("Usage: hf list <protocol> [f]");
	438	PrintAndLog(" f - show frame delay times as well");
	439	PrintAndLog("Supported <protocol> values:");
	440	PrintAndLog(" raw - just show raw data without annotations");
337818f7	441	PrintAndLog(" 14a - interpret data as iso14443a communications");
41fdd0f0	442	PrintAndLog(" 14b - interpret data as iso14443b communications");
4c3de57a	443	PrintAndLog(" iclass - interpret data as iclass communications");
4c3de57a MHS	444	PrintAndLog("");
	445	PrintAndLog("example: hf list 14a f");
	446	PrintAndLog("example: hf list iclass");
	447	return 0;
	448	}
b689b842	449
4c3de57a MHS	450
	451	if (param == 'f') {
	452	showWaitCycles = true;
	453	}
	454
	455
f71f4deb	456	uint8_t *trace;
4c3de57a	457	uint16_t tracepos = 0;
f71f4deb	458	trace = malloc(USB_CMD_DATA_SIZE);
	459
	460	// Query for the size of the trace
	461	UsbCommand response;
	462	GetFromBigBuf(trace, USB_CMD_DATA_SIZE, 0);
	463	WaitForResponse(CMD_ACK, &response);
	464	uint16_t traceLen = response.arg[2];
	465	if (traceLen > USB_CMD_DATA_SIZE) {
	466	uint8_t *p = realloc(trace, traceLen);
	467	if (p == NULL) {
	468	PrintAndLog("Cannot allocate memory for trace");
	469	free(trace);
	470	return 2;
	471	}
	472	trace = p;
	473	GetFromBigBuf(trace, traceLen, 0);
	474	WaitForResponse(CMD_ACK, NULL);
	475	}
	476
	477	PrintAndLog("Recorded Activity (TraceLen = %d bytes)", traceLen);
4c3de57a MHS	478	PrintAndLog("");
	479	PrintAndLog("Start = Start of Start Bit, End = End of last modulation. Src = Source of Transfer");
	480	PrintAndLog("iso14443a - All times are in carrier periods (1/13.56Mhz)");
	481	PrintAndLog("iClass - Timings are not as accurate");
	482	PrintAndLog("");
	483	PrintAndLog(" Start \| End \| Src \| Data (! denotes parity error) \| CRC \| Annotation \|");
	484	PrintAndLog("-----------\|-----------\|-----\|-----------------------------------------------------------------\|-----\|--------------------\|");
	485
f71f4deb	486	while(tracepos < traceLen)
4c3de57a	487	{
f71f4deb	488	tracepos = printTraceLine(tracepos, traceLen, trace, protocol, showWaitCycles);
4c3de57a	489	}
f71f4deb	490
f71f4deb	491	free(trace);
4c3de57a MHS	492	return 0;
	493	}
	494
7fe9b0b7	495
	496	static command_t CommandTable[] =
	497	{
	498	{"help", CmdHelp, 1, "This help"},
37239a7c	499	{"14a", CmdHF14A, 1, "{ ISO14443A RFIDs... }"},
	500	{"14b", CmdHF14B, 1, "{ ISO14443B RFIDs... }"},
	501	{"15", CmdHF15, 1, "{ ISO15693 RFIDs... }"},
5acd09bd	502	{"epa", CmdHFEPA, 1, "{ German Identification Card... }"},
8e220a91	503	{"legic", CmdHFLegic, 0, "{ LEGIC RFIDs... }"},
cee5a30d	504	{"iclass", CmdHFiClass, 1, "{ ICLASS RFIDs... }"},
4c3de57a	505	{"mf", CmdHFMF, 1, "{ MIFARE RFIDs... }"},
5ee70129	506	{"mfu", CmdHFMFUltra, 1, "{ MIFARE Ultralight RFIDs... }"},
c59c3405	507	{"tune", CmdHFTune, 0, "Continuously measure HF antenna tuning"},
4c3de57a MHS	508	{"list", CmdHFList, 1, "List protocol data in trace buffer"},
4c3de57a MHS	509	{NULL, NULL, 0, NULL}
7fe9b0b7	510	};
	511
	512	int CmdHF(const char *Cmd)
	513	{
	514	CmdsParse(CommandTable, Cmd);
	515	return 0;
	516	}
	517
	518	int CmdHelp(const char *Cmd)
	519	{
	520	CmdsHelp(CommandTable);
	521	return 0;
	522	}