atr.c

/*
    atr.c
    ISO 7816 ICC's answer to reset abstract data type implementation

    This file is part of the Unix driver for Towitoko smartcard readers
    Copyright (C) 2000 Carlos Prados <cprados@yahoo.com>

    This version is modified by doz21 to work in a special manner ;)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
#include "../globals.h"
#include "atr.h"
#define ERROR 1
/*
 * Not exported variables definition
 */

const uint32_t atr_fs_table[16] = {5000000L, 5000000L, 6000000L, 8000000L, 12000000L, 16000000L, 20000000L, 0, 0, 5000000L, 7500000L, 10000000L, 15000000L, 20000000L, 0, 0};

static const uint32_t atr_num_ib_table[16] = {0, 1, 1, 2, 1, 2, 2, 3, 1, 2, 2, 3, 2, 3, 3, 4};

/*
 * Exported variables definition
 */

const uint32_t atr_f_table[16] = {372, 372, 558, 744, 1116, 1488, 1860, 0, 0, 512, 768, 1024, 1536, 2048, 0, 0};

const double atr_d_table[16] = {0, 1, 2, 4, 8, 16, 32, 64, 12, 20, 0, 0, 0, 0, 0, 0};
//const double atr_d_table[16] = {0, 1, 2, 4, 8, 16, 32, 64, 12, 20, 0.5, 0.25, 0.125, 0.0625, 0.03125, 0.015625};
//old table has 0 for RFU:
//double atr_d_table[16] = {0, 1, 2, 4, 8, 16, 0, 0, 0, 0, 0.5, 0.25, 125, 0.0625, 0.03125, 0.015625};

static const uint32_t atr_i_table[4] = {25, 50, 100, 0};

/*
 * Exported funcions definition
 */
#ifdef WITH_CARDREADER
int32_t ATR_InitFromArray(ATR *atr, const unsigned char atr_buffer[ATR_MAX_SIZE], uint32_t length)
{
	unsigned char TDi;
	unsigned char buffer[ATR_MAX_SIZE];
	uint32_t pointer = 0, pn = 0;

	/* Check size of buffer */
	if(length < 2)
	{
		cs_log_dbg(D_ATR, "ERROR: this ATR length is %d and minimum length is 2", length);
		return (ERROR);
	}

	/* Check if ATR is from a inverse convention card */
	if(atr_buffer[0] == 0x03)  // Readers of type R_MOUSE need this in case of inverse convention cards!
	{
		for(pointer = 0; pointer < length; pointer++)
			{ buffer[pointer] = ~(INVERT_BYTE(atr_buffer[pointer])); }
	}
	else
	{
		memcpy(buffer, atr_buffer, length);
	}

	/* Store T0 and TS */
	atr->TS = buffer[0];

	atr->T0 = TDi = buffer[1];
	pointer = 1;

	/* Store number of historical bytes */
	atr->hbn = TDi & 0x0F;

	/* TCK is not present by default */
	(atr->TCK).present = 0;

	/* Extract interface bytes */
	while(pointer < length)
	{
		/* Check buffer is long enought */
		if(pointer + atr_num_ib_table[(0xF0 & TDi) >> 4] >= length)
		{
			cs_log_dbg(D_ATR, "ERROR: this ATR the %d interface bytes for protocol %d are missing", pointer + atr_num_ib_table[(0xF0 & TDi) >> 4], pn + 1);
			return (ERROR);
		}

		/* Check TAi is present */
		if((TDi | 0xEF) == 0xFF)
		{
			pointer++;
			atr->ib[pn][ATR_INTERFACE_BYTE_TA].value = buffer[pointer];
			atr->ib[pn][ATR_INTERFACE_BYTE_TA].present = 1;
		}
		else
		{
			atr->ib[pn][ATR_INTERFACE_BYTE_TA].present = 0;
		}

		/* Check TBi is present */
		if((TDi | 0xDF) == 0xFF)
		{
			pointer++;
			atr->ib[pn][ATR_INTERFACE_BYTE_TB].value = buffer[pointer];
			atr->ib[pn][ATR_INTERFACE_BYTE_TB].present = 1;
		}
		else
		{
			atr->ib[pn][ATR_INTERFACE_BYTE_TB].present = 0;
		}

		/* Check TCi is present */
		if((TDi | 0xBF) == 0xFF)
		{
			pointer++;
			atr->ib[pn][ATR_INTERFACE_BYTE_TC].value = buffer[pointer];
			atr->ib[pn][ATR_INTERFACE_BYTE_TC].present = 1;
		}
		else
		{
			atr->ib[pn][ATR_INTERFACE_BYTE_TC].present = 0;
		}

		/* Read TDi if present */
		if((TDi | 0x7F) == 0xFF)
		{
			pointer++;
			TDi = atr->ib[pn][ATR_INTERFACE_BYTE_TD].value = buffer[pointer];
			atr->ib[pn][ATR_INTERFACE_BYTE_TD].present = 1;
			(atr->TCK).present = ((TDi & 0x0F) != ATR_PROTOCOL_TYPE_T0);
			if(pn >= ATR_MAX_PROTOCOLS)
			{
				cs_log_dbg(D_ATR, "ERROR: this ATR reports %d protocols but the maximum value is %d", pn + 1, ATR_MAX_PROTOCOLS + 1);
				return (ERROR);
			}
			pn++;
		}
		else
		{
			atr->ib[pn][ATR_INTERFACE_BYTE_TD].present = 0;
			break;
		}
	}

	/* Store number of protocols */
	atr->pn = pn + 1;

	/* Store historical bytes */
	if(pointer + atr->hbn >= length)
	{
		cs_log_dbg(D_ATR, "ERROR: this ATR reports %i historical bytes but there are only %i", atr->hbn, length - pointer - 2);
		if(length - pointer >= 2)
			{ atr->hbn = length - pointer - 2; }
		else
		{
			atr->hbn = 0;
			atr->length = pointer + 1;
			return (ERROR);
		}

	}

	memcpy(atr->hb, buffer + pointer + 1, atr->hbn);
	pointer += (atr->hbn);

	/* Store TCK  */
	if((atr->TCK).present)
	{
		if(pointer + 1 >= length)
		{
			cs_log_dbg(D_ATR, "ATR is malformed, this ATR should have a TCK byte but it was not received!");
			return (ATR_MALFORMED);
		}
		pointer++;

		(atr->TCK).value = buffer[pointer];
	}

	atr->length = pointer + 1;

	// check that TA1, if pn==1 , has a valid value for FI
	if(atr->pn == 1 && atr->ib[pn][ATR_INTERFACE_BYTE_TA].present == 1)
	{
		uchar FI;
		cs_log_dbg(D_ATR, "TA1 = %02x", atr->ib[pn][ATR_INTERFACE_BYTE_TA].value);
		FI = (atr->ib[pn][ATR_INTERFACE_BYTE_TA].value & 0xF0) >> 4;
		cs_log_dbg(D_ATR, "FI = %02x", FI);
		if(atr_fs_table[FI] == 0)
		{
			cs_log_dbg(D_ATR, "ERROR: this ATR FI for protocol %d is not returning a valid cardfrequency value", pn + 1);
			return (ERROR);
		}
	}

	// check that TB1 < 0x80
	if(atr->pn == 1 && atr->ib[pn][ATR_INTERFACE_BYTE_TB].present == 1)
	{
		if(atr->ib[pn][ATR_INTERFACE_BYTE_TB].value > 0x80)
		{
			cs_log_dbg(D_ATR, "ERROR: this ATR TB1 for protocol %d has an invalid value", pn + 1);
			return (ERROR);
		}
	}
	return (ATR_OK);
}

int32_t ATR_GetConvention(ATR *atr, int32_t *convention)
{
	if(atr->TS == 0x3B)
		{ (*convention) = ATR_CONVENTION_DIRECT; }
	else if(atr->TS == 0x3F)
		{ (*convention) = ATR_CONVENTION_INVERSE; }
	else
	{
		cs_log_dbg(D_ATR, "ERROR: this ATR TS byte is %02X and that should be 3B for direct or 3F for inverse convention!", atr->TS);
		return (ERROR);
	}

	return (ATR_OK);
}

int32_t ATR_GetSize(ATR *atr, uint32_t *size)
{
	(*size) = atr->length;
	return (ATR_OK);
}

int32_t ATR_GetNumberOfProtocols(ATR *atr, uint32_t *number_protocols)
{
	(*number_protocols) = atr->pn;
	return (ATR_OK);
}

int32_t ATR_GetProtocolType(ATR *atr, uint32_t number_protocol, unsigned char *protocol_type)
{
	if((number_protocol > atr->pn) || number_protocol < 1)
		{ return ATR_NOT_FOUND; }

	if(atr->ib[number_protocol - 1][ATR_INTERFACE_BYTE_TD].present)
		{ (*protocol_type) = (atr->ib[number_protocol - 1][ATR_INTERFACE_BYTE_TD].value & 0x0F); }
	else
		{ (*protocol_type) = ATR_PROTOCOL_TYPE_T0; }

	return (ATR_OK);
}

int32_t ATR_GetInterfaceByte(ATR *atr, uint32_t number, int32_t character, unsigned char *value)
{
	if(number > atr->pn || number < 1)
		{ return (ATR_NOT_FOUND); }

	if(atr->ib[number - 1][character].present && (character == ATR_INTERFACE_BYTE_TA || character == ATR_INTERFACE_BYTE_TB || character == ATR_INTERFACE_BYTE_TC || character == ATR_INTERFACE_BYTE_TD))
		{ (*value) = atr->ib[number - 1][character].value; }
	else
		{ return (ATR_NOT_FOUND); }

	return (ATR_OK);
}

int32_t ATR_GetIntegerValue(ATR *atr, int32_t name, unsigned char *value)
{
	int32_t ret;

	if(name == ATR_INTEGER_VALUE_FI)
	{
		if(atr->ib[0][ATR_INTERFACE_BYTE_TA].present)
		{
			(*value) = (atr->ib[0][ATR_INTERFACE_BYTE_TA].value & 0xF0) >> 4;
			ret = ATR_OK;
		}
		else
		{
			ret = ATR_NOT_FOUND;
		}
	}
	else if(name == ATR_INTEGER_VALUE_DI)
	{
		if(atr->ib[0][ATR_INTERFACE_BYTE_TA].present)
		{
			(*value) = (atr->ib[0][ATR_INTERFACE_BYTE_TA].value & 0x0F);
			ret = ATR_OK;
		}
		else
		{
			ret = ATR_NOT_FOUND;
		}
	}
	else if(name == ATR_INTEGER_VALUE_II)
	{
		if(atr->ib[0][ATR_INTERFACE_BYTE_TB].present)
		{
			(*value) = (atr->ib[0][ATR_INTERFACE_BYTE_TB].value & 0x60) >> 5;
			ret = ATR_OK;
		}
		else
		{
			ret = ATR_NOT_FOUND;
		}
	}
	else if(name == ATR_INTEGER_VALUE_PI1)
	{
		if(atr->ib[0][ATR_INTERFACE_BYTE_TB].present)
		{
			(*value) = (atr->ib[0][ATR_INTERFACE_BYTE_TB].value & 0x1F);
			ret = ATR_OK;
		}
		else
		{
			ret = ATR_NOT_FOUND;
		}
	}
	else if(name == ATR_INTEGER_VALUE_PI2)
	{
		if(atr->ib[1][ATR_INTERFACE_BYTE_TB].present)
		{
			(*value) = atr->ib[1][ATR_INTERFACE_BYTE_TB].value;
			ret = ATR_OK;
		}
		else
		{
			ret = ATR_NOT_FOUND;
		}
	}
	else if(name == ATR_INTEGER_VALUE_N)
	{
		if(atr->ib[0][ATR_INTERFACE_BYTE_TC].present)
		{
			(*value) = atr->ib[0][ATR_INTERFACE_BYTE_TC].value;
			ret = ATR_OK;
		}
		else
		{
			ret = ATR_NOT_FOUND;
		}
	}
	else
	{
		ret = ATR_NOT_FOUND;
	}

	return ret;
}

int32_t ATR_GetParameter(ATR *atr, int32_t name, uint32_t *parameter)
{
	unsigned char FI, DI, II, PI1, PI2, N;

	if(name == ATR_PARAMETER_F)
	{
		if(ATR_GetIntegerValue(atr, ATR_INTEGER_VALUE_FI, &FI) != ATR_OK)
			{ FI = ATR_DEFAULT_FI; }
		(*parameter) = (double)(atr_f_table[FI]);
		return (ATR_OK);
	}
	else if(name == ATR_PARAMETER_D)
	{
		if(ATR_GetIntegerValue(atr, ATR_INTEGER_VALUE_DI, &DI) == ATR_OK)
			{ (*parameter) = (double)(atr_d_table[DI]); }
		else
			{ (*parameter) = (double) ATR_DEFAULT_D; }
		return (ATR_OK);
	}
	else if(name == ATR_PARAMETER_I)
	{
		if(ATR_GetIntegerValue(atr, ATR_INTEGER_VALUE_II, &II) == ATR_OK)
			{ (*parameter) = (double)(atr_i_table[II]); }
		else
			{ (*parameter) = ATR_DEFAULT_I; }
		return (ATR_OK);
	}
	else if(name == ATR_PARAMETER_P)
	{
		if(ATR_GetIntegerValue(atr, ATR_INTEGER_VALUE_PI2, &PI2) == ATR_OK)
			{ (*parameter) = (double) PI2; }
		else if(ATR_GetIntegerValue(atr, ATR_INTEGER_VALUE_PI1, &PI1) == ATR_OK)
			{ (*parameter) = (double) PI1; }
		else
			{ (*parameter) = (double) ATR_DEFAULT_P; }
		return (ATR_OK);
	}
	else if(name == ATR_PARAMETER_N)
	{
		if(ATR_GetIntegerValue(atr, ATR_INTEGER_VALUE_N, &N) == ATR_OK)
			{ (*parameter) = (double) N; }
		else
			{ (*parameter) = (double) ATR_DEFAULT_N; }
		return (ATR_OK);
	}

	return (ATR_NOT_FOUND);
}

int32_t ATR_GetHistoricalBytes(ATR *atr, unsigned char hist[ATR_MAX_HISTORICAL], uint32_t *length)
{
	if(atr->hbn == 0)
		{ return (ATR_NOT_FOUND); }

	(*length) = atr->hbn;
	memcpy(hist, atr->hb, atr->hbn);
	return (ATR_OK);
}

int32_t ATR_GetRaw(ATR *atr, unsigned char buffer[ATR_MAX_SIZE], uint32_t *length)
{
	uint32_t i, j;

	buffer[0] = atr->TS;
	buffer[1] = atr->T0;

	j = 2;

	for(i = 0; i < atr->pn; i++)
	{
		if(atr->ib[i][ATR_INTERFACE_BYTE_TA].present)
			{ buffer[j++] = atr->ib[i][ATR_INTERFACE_BYTE_TA].value; }

		if(atr->ib[i][ATR_INTERFACE_BYTE_TB].present)
			{ buffer[j++] = atr->ib[i][ATR_INTERFACE_BYTE_TB].value; }

		if(atr->ib[i][ATR_INTERFACE_BYTE_TC].present)
			{ buffer[j++] = atr->ib[i][ATR_INTERFACE_BYTE_TC].value; }

		if(atr->ib[i][ATR_INTERFACE_BYTE_TD].present)
			{ buffer[j++] = atr->ib[i][ATR_INTERFACE_BYTE_TD].value; }
	}

	if(atr->hbn > 0)
	{
		memcpy(&(buffer[j]), atr->hb, atr->hbn);
		j += atr->hbn;
	}

	if((atr->TCK).present)
		{ buffer[j++] = (atr->TCK).value; }

	(*length) = j;

	return ATR_OK;
}

int32_t ATR_GetCheckByte(ATR *atr, unsigned char *check_byte)
{
	if(!((atr->TCK).present))
		{ return (ATR_NOT_FOUND); }

	(*check_byte) = (atr->TCK).value;
	return (ATR_OK);
}

int32_t ATR_GetFsMax(ATR *atr, uint32_t *fsmax)
{
	unsigned char FI;

	if(ATR_GetIntegerValue(atr, ATR_INTEGER_VALUE_FI, &FI) == ATR_OK)
		{ (*fsmax) = atr_fs_table[FI]; }
	else
		{ (*fsmax) = atr_fs_table[1]; }

	return (ATR_OK);
}
#endif