Added some more protocol support to the list annotation. Based on http://www.proxmark...

[proxmark3-svn] / armsrc / mifareutil.c

//-----------------------------------------------------------------------------\r
// Merlok, May 2011, 2012\r
// Many authors, whom made it possible\r
//\r
// This code is licensed to you under the terms of the GNU GPL, version 2 or,\r
// at your option, any later version. See the LICENSE.txt file for the text of\r
// the license.\r
//-----------------------------------------------------------------------------\r
// Work with mifare cards.\r
//-----------------------------------------------------------------------------\r
\r
#include "proxmark3.h"\r
#include "apps.h"\r
#include "util.h"\r
#include "string.h"\r
\r
#include "iso14443crc.h"\r
#include "iso14443a.h"\r
#include "crapto1.h"\r
#include "mifareutil.h"\r
\r
int MF_DBGLEVEL = MF_DBG_ALL;\r
\r
// memory management\r
uint8_t* get_bigbufptr_recvrespbuf(void) {\r
	return (((uint8_t *)BigBuf) + RECV_RESP_OFFSET);	\r
}\r
uint8_t* get_bigbufptr_recvcmdbuf(void) {\r
	return (((uint8_t *)BigBuf) + RECV_CMD_OFFSET);	\r
}\r
uint8_t* get_bigbufptr_emlcardmem(void) {\r
	return (((uint8_t *)BigBuf) + CARD_MEMORY_OFFSET);\r
}\r
\r
// crypto1 helpers\r
void mf_crypto1_decrypt(struct Crypto1State *pcs, uint8_t *data, int len){\r
	uint8_t	bt = 0;\r
	int i;\r
	\r
	if (len != 1) {\r
		for (i = 0; i < len; i++)\r
			data[i] = crypto1_byte(pcs, 0x00, 0) ^ data[i];\r
	} else {\r
		bt = 0;\r
		for (i = 0; i < 4; i++)\r
			bt |= (crypto1_bit(pcs, 0, 0) ^ BIT(data[0], i)) << i;\r
				\r
		data[0] = bt;\r
	}\r
	return;\r
}\r
\r
void mf_crypto1_encrypt(struct Crypto1State *pcs, uint8_t *data, uint16_t len, uint8_t *par) {\r
	uint8_t bt = 0;\r
	int i;\r
	par[0] = 0;\r
	\r
	for (i = 0; i < len; i++) {\r
		bt = data[i];\r
		data[i] = crypto1_byte(pcs, 0x00, 0) ^ data[i];\r
		if((i&0x0007) == 0) \r
			par[i>>3] = 0;\r
		par[i>>3] |= (((filter(pcs->odd) ^ oddparity(bt)) & 0x01)<<(7-(i&0x0007)));\r
	}	\r
	return;\r
}\r
\r
uint8_t mf_crypto1_encrypt4bit(struct Crypto1State *pcs, uint8_t data) {\r
	uint8_t bt = 0;\r
	int i;\r
\r
	for (i = 0; i < 4; i++)\r
		bt |= (crypto1_bit(pcs, 0, 0) ^ BIT(data, i)) << i;\r
		\r
	return bt;\r
}\r
\r
// send commands\r
int mifare_sendcmd_short(struct Crypto1State *pcs, uint8_t crypted, uint8_t cmd, uint8_t data, uint8_t* answer, uint8_t *answer_parity, uint32_t *timing)\r
{\r
	return mifare_sendcmd_shortex(pcs, crypted, cmd, data, answer, answer_parity, timing);
}

int mifare_sendcmd_short_special(struct Crypto1State *pcs, uint8_t crypted, uint8_t cmd, uint8_t* data, uint8_t* answer, uint8_t *answer_parity, uint32_t *timing)
{
	uint8_t dcmd[8];
    dcmd[0] = cmd;
    dcmd[1] = data[0];
	dcmd[2] = data[1];
	dcmd[3] = data[2];
	dcmd[4] = data[3];
	dcmd[5] = data[4];
	AppendCrc14443a(dcmd, 6);
	ReaderTransmit(dcmd, sizeof(dcmd), NULL);
	int len = ReaderReceive(answer, answer_parity);
	if(!len)
	{
                if (MF_DBGLEVEL >= 1)   Dbprintf("Authentication failed. Card timeout.");
                return 2;
        }
	return len;
}

int mifare_sendcmd_shortex(struct Crypto1State *pcs, uint8_t crypted, uint8_t cmd, uint8_t data, uint8_t *answer, uint8_t *answer_parity, uint32_t *timing)
{
	uint8_t dcmd[4], ecmd[4];
	uint16_t pos, res;\r
	uint8_t par[1];			// 1 Byte parity is enough here\r
	dcmd[0] = cmd;\r
	dcmd[1] = data;\r
	AppendCrc14443a(dcmd, 2);\r
	\r
	memcpy(ecmd, dcmd, sizeof(dcmd));\r
	\r
	if (crypted) {\r
		par[0] = 0;\r
		for (pos = 0; pos < 4; pos++)\r
		{\r
			ecmd[pos] = crypto1_byte(pcs, 0x00, 0) ^ dcmd[pos];\r
			par[0] |= (((filter(pcs->odd) ^ oddparity(dcmd[pos])) & 0x01) << (7-pos));\r
		}	\r
\r
		ReaderTransmitPar(ecmd, sizeof(ecmd), par, timing);\r
\r
	} else {\r
		ReaderTransmit(dcmd, sizeof(dcmd), timing);\r
	}\r
\r
	int len = ReaderReceive(answer, par);\r
	\r
	if (answer_parity) *answer_parity = par[0];\r
	\r
	if (crypted == CRYPT_ALL) {\r
		if (len == 1) {\r
			res = 0;\r
			for (pos = 0; pos < 4; pos++)\r
				res |= (crypto1_bit(pcs, 0, 0) ^ BIT(answer[0], pos)) << pos;\r
				\r
			answer[0] = res;\r
			\r
		} else {\r
			for (pos = 0; pos < len; pos++)\r
			{\r
				answer[pos] = crypto1_byte(pcs, 0x00, 0) ^ answer[pos];\r
			}\r
		}\r
	}\r
	\r
	return len;\r
}\r
\r
// mifare commands\r
int mifare_classic_auth(struct Crypto1State *pcs, uint32_t uid, uint8_t blockNo, uint8_t keyType, uint64_t ui64Key, uint8_t isNested) \r
{\r
	return mifare_classic_authex(pcs, uid, blockNo, keyType, ui64Key, isNested, NULL, NULL);\r
}\r
\r
int mifare_classic_authex(struct Crypto1State *pcs, uint32_t uid, uint8_t blockNo, uint8_t keyType, uint64_t ui64Key, uint8_t isNested, uint32_t *ntptr, uint32_t *timing) \r
{\r
	// variables\r
	int len;	\r
	uint32_t pos;\r
	uint8_t tmp4[4];\r
	uint8_t par[1] = {0x00};\r
	byte_t nr[4];\r
	uint32_t nt, ntpp; // Supplied tag nonce\r
	\r
	uint8_t mf_nr_ar[] = { 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 };\r
	uint8_t *receivedAnswer = get_bigbufptr_recvrespbuf();\r
	uint8_t *receivedAnswerPar = receivedAnswer + MAX_FRAME_SIZE;\r
	\r
	// Transmit MIFARE_CLASSIC_AUTH\r
	len = mifare_sendcmd_short(pcs, isNested, 0x60 + (keyType & 0x01), blockNo, receivedAnswer, receivedAnswerPar, timing);\r
	if (MF_DBGLEVEL >= 4)	Dbprintf("rand tag nonce len: %x", len);  \r
	if (len != 4) return 1;\r
	\r
	// "random" reader nonce:\r
	nr[0] = 0x55;\r
	nr[1] = 0x41;\r
	nr[2] = 0x49;\r
	nr[3] = 0x92; \r
	\r
	// Save the tag nonce (nt)\r
	nt = bytes_to_num(receivedAnswer, 4);\r
\r
	//  ----------------------------- crypto1 create\r
	if (isNested)\r
		crypto1_destroy(pcs);\r
\r
	// Init cipher with key\r
	crypto1_create(pcs, ui64Key);\r
\r
	if (isNested == AUTH_NESTED) {\r
		// decrypt nt with help of new key \r
		nt = crypto1_word(pcs, nt ^ uid, 1) ^ nt;\r
	} else {\r
		// Load (plain) uid^nt into the cipher\r
		crypto1_word(pcs, nt ^ uid, 0);\r
	}\r
\r
	// some statistic\r
	if (!ntptr && (MF_DBGLEVEL >= 3))\r
		Dbprintf("auth uid: %08x nt: %08x", uid, nt);  \r
	\r
	// save Nt\r
	if (ntptr)\r
		*ntptr = nt;\r
\r
	// Generate (encrypted) nr+parity by loading it into the cipher (Nr)\r
	par[0] = 0;\r
	for (pos = 0; pos < 4; pos++)\r
	{\r
		mf_nr_ar[pos] = crypto1_byte(pcs, nr[pos], 0) ^ nr[pos];\r
		par[0] |= (((filter(pcs->odd) ^ oddparity(nr[pos])) & 0x01) << (7-pos));\r
	}	\r
		\r
	// Skip 32 bits in pseudo random generator\r
	nt = prng_successor(nt,32);\r
\r
	//  ar+parity\r
	for (pos = 4; pos < 8; pos++)\r
	{\r
		nt = prng_successor(nt,8);\r
		mf_nr_ar[pos] = crypto1_byte(pcs,0x00,0) ^ (nt & 0xff);\r
		par[0] |= (((filter(pcs->odd) ^ oddparity(nt & 0xff)) & 0x01) << (7-pos));\r
	}	\r
		\r
	// Transmit reader nonce and reader answer\r
	ReaderTransmitPar(mf_nr_ar, sizeof(mf_nr_ar), par, NULL);\r
\r
	// Receive 4 byte tag answer\r
	len = ReaderReceive(receivedAnswer, receivedAnswerPar);\r
	if (!len)\r
	{\r
		if (MF_DBGLEVEL >= 1)	Dbprintf("Authentication failed. Card timeout.");\r
		return 2;\r
	}\r
	\r
	memcpy(tmp4, receivedAnswer, 4);\r
	ntpp = prng_successor(nt, 32) ^ crypto1_word(pcs, 0,0);\r
	\r
	if (ntpp != bytes_to_num(tmp4, 4)) {\r
		if (MF_DBGLEVEL >= 1)	Dbprintf("Authentication failed. Error card response.");\r
		return 3;\r
	}\r
\r
	return 0;\r
}\r
\r
int mifare_classic_readblock(struct Crypto1State *pcs, uint32_t uid, uint8_t blockNo, uint8_t *blockData) \r
{\r
	// variables\r
	int len;	\r
	uint8_t	bt[2];\r
	\r
	uint8_t* receivedAnswer = get_bigbufptr_recvrespbuf();\r
	uint8_t* receivedAnswerPar = receivedAnswer + MAX_FRAME_SIZE;\r
	\r
	// command MIFARE_CLASSIC_READBLOCK\r
	len = mifare_sendcmd_short(pcs, 1, 0x30, blockNo, receivedAnswer, receivedAnswerPar, NULL);\r
	if (len == 1) {\r
		if (MF_DBGLEVEL >= 1)	Dbprintf("Cmd Error: %02x", receivedAnswer[0]);  \r
		return 1;\r
	}\r
	if (len != 18) {\r
		if (MF_DBGLEVEL >= 1)	Dbprintf("Cmd Error: card timeout. len: %x", len);  \r
		return 2;\r
	}\r
\r
	memcpy(bt, receivedAnswer + 16, 2);\r
	AppendCrc14443a(receivedAnswer, 16);\r
	if (bt[0] != receivedAnswer[16] || bt[1] != receivedAnswer[17]) {\r
		if (MF_DBGLEVEL >= 1)	Dbprintf("Cmd CRC response error.");  \r
		return 3;\r
	}\r
	\r
	memcpy(blockData, receivedAnswer, 16);\r
	return 0;
}

int mifare_ultra_readblock(uint32_t uid, uint8_t blockNo, uint8_t *blockData)
{
	// variables
	uint16_t len;
	uint8_t	bt[2];
	
	uint8_t* receivedAnswer = get_bigbufptr_recvrespbuf();\r
	uint8_t* receivedAnswerPar = receivedAnswer + MAX_FRAME_SIZE;
	
	\r
	// command MIFARE_CLASSIC_READBLOCK
	len = mifare_sendcmd_short(NULL, 1, 0x30, blockNo, receivedAnswer, receivedAnswerPar, NULL);
	if (len == 1) {
		if (MF_DBGLEVEL >= 1)	Dbprintf("Cmd Error: %02x", receivedAnswer[0]);
		return 1;
	}
	if (len != 18) {
		if (MF_DBGLEVEL >= 1)	Dbprintf("Cmd Error: card timeout. len: %x", len);
		return 2;
	}
    
	memcpy(bt, receivedAnswer + 16, 2);
	AppendCrc14443a(receivedAnswer, 16);
	if (bt[0] != receivedAnswer[16] || bt[1] != receivedAnswer[17]) {
		if (MF_DBGLEVEL >= 1)	Dbprintf("Cmd CRC response error.");
		return 3;
	}
	
	memcpy(blockData, receivedAnswer, 14);
	return 0;
}


int mifare_classic_writeblock(struct Crypto1State *pcs, uint32_t uid, uint8_t blockNo, uint8_t *blockData) 
{
	// variables
	uint16_t len, i;	\r
	uint32_t pos;\r
	uint8_t par[3] = {0};		// enough for 18 Bytes to send\r
	byte_t res;\r
	\r
	uint8_t d_block[18], d_block_enc[18];\r
	uint8_t* receivedAnswer = get_bigbufptr_recvrespbuf();\r
	uint8_t* receivedAnswerPar = receivedAnswer + MAX_FRAME_SIZE;\r
	\r
	// command MIFARE_CLASSIC_WRITEBLOCK\r
	len = mifare_sendcmd_short(pcs, 1, 0xA0, blockNo, receivedAnswer, receivedAnswerPar, NULL);\r
\r
	if ((len != 1) || (receivedAnswer[0] != 0x0A)) {   //  0x0a - ACK\r
		if (MF_DBGLEVEL >= 1)	Dbprintf("Cmd Error: %02x", receivedAnswer[0]);  \r
		return 1;\r
	}\r
	\r
	memcpy(d_block, blockData, 16);\r
	AppendCrc14443a(d_block, 16);\r
	\r
	// crypto\r
	for (pos = 0; pos < 18; pos++)\r
	{\r
		d_block_enc[pos] = crypto1_byte(pcs, 0x00, 0) ^ d_block[pos];\r
		par[pos>>3] |= (((filter(pcs->odd) ^ oddparity(d_block[pos])) & 0x01) << (7 - (pos&0x0007)));\r
	}	\r
\r
	ReaderTransmitPar(d_block_enc, sizeof(d_block_enc), par, NULL);\r
\r
	// Receive the response\r
	len = ReaderReceive(receivedAnswer, receivedAnswerPar);	\r
\r
	res = 0;\r
	for (i = 0; i < 4; i++)\r
		res |= (crypto1_bit(pcs, 0, 0) ^ BIT(receivedAnswer[0], i)) << i;\r
\r
	if ((len != 1) || (res != 0x0A)) {\r
		if (MF_DBGLEVEL >= 1)	Dbprintf("Cmd send data2 Error: %02x", res);  \r
		return 2;\r
	}\r
	\r
	return 0;
}

int mifare_ultra_writeblock(uint32_t uid, uint8_t blockNo, uint8_t *blockData) 
{
    // variables
    uint16_t len;     
    uint8_t par[3] = {0};  // enough for 18 parity bits
    uint8_t d_block[18];
    uint8_t* receivedAnswer = get_bigbufptr_recvrespbuf();\r
	uint8_t* receivedAnswerPar = receivedAnswer + MAX_FRAME_SIZE;
        
    // command MIFARE_CLASSIC_WRITEBLOCK
    len = mifare_sendcmd_short(NULL, true, 0xA0, blockNo, receivedAnswer, receivedAnswerPar, NULL);

    if ((len != 1) || (receivedAnswer[0] != 0x0A)) {   //  0x0a - ACK
        if (MF_DBGLEVEL >= 1)   Dbprintf("Cmd Addr Error: %02x", receivedAnswer[0]);  
        return 1;
    }

	memset(d_block,'\0',18);
	memcpy(d_block, blockData, 16);
    AppendCrc14443a(d_block, 16);

	ReaderTransmitPar(d_block, sizeof(d_block), par, NULL);

    // Receive the response
    len = ReaderReceive(receivedAnswer, receivedAnswerPar);    

	if ((len != 1) || (receivedAnswer[0] != 0x0A)) {   //  0x0a - ACK
        if (MF_DBGLEVEL >= 1)   Dbprintf("Cmd Data Error: %02x %d", receivedAnswer[0],len);
        return 2;
    }        

    return 0;
} 

int mifare_ultra_special_writeblock(uint32_t uid, uint8_t blockNo, uint8_t *blockData)
{
    uint16_t len;
    uint8_t d_block[8];
    uint8_t *receivedAnswer = get_bigbufptr_recvrespbuf();\r
	uint8_t *receivedAnswerPar = receivedAnswer + MAX_FRAME_SIZE;

    // command MIFARE_CLASSIC_WRITEBLOCK
	memset(d_block,'\0',8);
	d_block[0]= blockNo;
	memcpy(d_block+1,blockData,4);
	AppendCrc14443a(d_block, 6);

	//i know the data send here is correct
    len = mifare_sendcmd_short_special(NULL, 1, 0xA2, d_block, receivedAnswer, receivedAnswerPar, NULL);

    if (receivedAnswer[0] != 0x0A) {   //  0x0a - ACK
        if (MF_DBGLEVEL >= 1)   Dbprintf("Cmd Send Error: %02x %d", receivedAnswer[0],len);
        return 1;
    }
\r    return 0;
}

int mifare_classic_halt(struct Crypto1State *pcs, uint32_t uid) 
{
	uint16_t len;	\r
	uint8_t *receivedAnswer = get_bigbufptr_recvrespbuf();\r
	uint8_t *receivedAnswerPar = receivedAnswer + MAX_FRAME_SIZE;\r
\r
	len = mifare_sendcmd_short(pcs, pcs == NULL ? false:true, 0x50, 0x00, receivedAnswer, receivedAnswerPar, NULL);\r
	if (len != 0) {\r
		if (MF_DBGLEVEL >= 1)	Dbprintf("halt error. response len: %x", len);  \r
		return 1;\r
	}\r
\r
	return 0;
}

int mifare_ultra_halt(uint32_t uid)
{
	uint16_t len;
	uint8_t *receivedAnswer = get_bigbufptr_recvrespbuf();\r
	uint8_t *receivedAnswerPar = receivedAnswer + MAX_FRAME_SIZE;
    
	len = mifare_sendcmd_short(NULL, true, 0x50, 0x00, receivedAnswer, receivedAnswerPar, NULL);
	if (len != 0) {
		if (MF_DBGLEVEL >= 1)	Dbprintf("halt error. response len: %x", len);
		return 1;
	}
    
	return 0;
}

\r
// Mifare Memory Structure: up to 32 Sectors with 4 blocks each (1k and 2k cards),\r
// plus evtl. 8 sectors with 16 blocks each (4k cards)\r
uint8_t NumBlocksPerSector(uint8_t sectorNo) \r
{\r
	if (sectorNo < 32) \r
		return 4;\r
	else\r
		return 16;\r
}\r
\r
uint8_t FirstBlockOfSector(uint8_t sectorNo) \r
{\r
	if (sectorNo < 32)\r
		return sectorNo * 4;\r
	else\r
		return 32*4 + (sectorNo - 32) * 16;\r
		\r
}\r
\r
\r
// work with emulator memory
void emlSetMem(uint8_t *data, int blockNum, int blocksCount) {
	uint8_t* emCARD = get_bigbufptr_emlcardmem();
	memcpy(emCARD + blockNum * 16, data, blocksCount * 16);\r
}\r
\r
void emlGetMem(uint8_t *data, int blockNum, int blocksCount) {\r
	uint8_t* emCARD = get_bigbufptr_emlcardmem();\r
	memcpy(data, emCARD + blockNum * 16, blocksCount * 16);\r
}\r
\r
void emlGetMemBt(uint8_t *data, int bytePtr, int byteCount) {\r
	uint8_t* emCARD = get_bigbufptr_emlcardmem();\r
	memcpy(data, emCARD + bytePtr, byteCount);\r
}\r
\r
int emlCheckValBl(int blockNum) {\r
	uint8_t* emCARD = get_bigbufptr_emlcardmem();\r
	uint8_t* data = emCARD + blockNum * 16;\r
\r
	if ((data[0] != (data[4] ^ 0xff)) || (data[0] != data[8]) ||\r
			(data[1] != (data[5] ^ 0xff)) || (data[1] != data[9]) ||\r
			(data[2] != (data[6] ^ 0xff)) || (data[2] != data[10]) ||\r
			(data[3] != (data[7] ^ 0xff)) || (data[3] != data[11]) ||\r
			(data[12] != (data[13] ^ 0xff)) || (data[12] != data[14]) ||\r
			(data[12] != (data[15] ^ 0xff))\r
		 ) \r
		return 1;\r
	return 0;\r
}\r
\r
int emlGetValBl(uint32_t *blReg, uint8_t *blBlock, int blockNum) {\r
	uint8_t* emCARD = get_bigbufptr_emlcardmem();\r
	uint8_t* data = emCARD + blockNum * 16;\r
	\r
	if (emlCheckValBl(blockNum)) {\r
		return 1;\r
	}\r
	\r
	memcpy(blReg, data, 4);\r
	*blBlock = data[12];\r
	return 0;\r
}\r
\r
int emlSetValBl(uint32_t blReg, uint8_t blBlock, int blockNum) {\r
	uint8_t* emCARD = get_bigbufptr_emlcardmem();\r
	uint8_t* data = emCARD + blockNum * 16;\r
	\r
	memcpy(data + 0, &blReg, 4);\r
	memcpy(data + 8, &blReg, 4);\r
	blReg = blReg ^ 0xffffffff;\r
	memcpy(data + 4, &blReg, 4);\r
	\r
	data[12] = blBlock;\r
	data[13] = blBlock ^ 0xff;\r
	data[14] = blBlock;\r
	data[15] = blBlock ^ 0xff;\r
	\r
	return 0;\r
}\r
\r
uint64_t emlGetKey(int sectorNum, int keyType) {\r
	uint8_t key[6];\r
	uint8_t* emCARD = get_bigbufptr_emlcardmem();\r
	\r
	memcpy(key, emCARD + 16 * (FirstBlockOfSector(sectorNum) + NumBlocksPerSector(sectorNum) - 1) + keyType * 10, 6);\r
	return bytes_to_num(key, 6);\r
}\r
\r
void emlClearMem(void) {\r
	int b;\r
	\r
	const uint8_t trailer[] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x07, 0x80, 0x69, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff};\r
	const uint8_t uid[]   =   {0xe6, 0x84, 0x87, 0xf3, 0x16, 0x88, 0x04, 0x00, 0x46, 0x8e, 0x45, 0x55, 0x4d, 0x70, 0x41, 0x04};\r
	uint8_t* emCARD = get_bigbufptr_emlcardmem();\r
	\r
	memset(emCARD, 0, CARD_MEMORY_SIZE);\r
	\r
	// fill sectors trailer data\r
	for(b = 3; b < 256; b<127?(b+=4):(b+=16)) {\r
		emlSetMem((uint8_t *)trailer, b , 1);\r
	}	\r
\r
	// uid\r
	emlSetMem((uint8_t *)uid, 0, 1);\r
	return;\r
}\r