add tracing functions (#784)

* add trace buffer for PCSC smartcard readers
* new option 'p' in 'hf list' to select PCSC trace buffer
* 'sc list' now supports PCSC smartcard readers
* add 'hf list 14-4' for ISO 14443-4 protocol
This commit is contained in:
pwpiwi 2019-02-16 17:51:04 +01:00 committed by GitHub
parent 3783c45af1
commit 53fb848a0a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 377 additions and 174 deletions

View file

@ -27,6 +27,7 @@
#include "mifarehost.h"
#include "mifaredefault.h"
#include "usb_cmd.h"
#include "pcsc.h"
typedef struct {
uint32_t uid; // UID
@ -91,6 +92,21 @@ static uint8_t iso14443A_CRC_check(bool isResponse, uint8_t* data, uint8_t len)
}
static uint8_t iso14443_4_CRC_check(uint8_t* data, uint8_t len)
{
uint8_t b1,b2;
if(len <= 2) return 2;
ComputeCrc14443(CRC_14443_A, data, len-2, &b1, &b2);
if (b1 != data[len-2] || b2 != data[len-1]) {
return 0;
} else {
return 1;
}
}
static uint8_t mifare_CRC_check(bool isResponse, uint8_t* data, uint8_t len)
{
switch(MifareAuthState) {
@ -274,6 +290,69 @@ void annotateTopaz(char *exp, size_t size, uint8_t* cmd, uint8_t cmdsize)
}
void annotateIso7816(char *exp, size_t size, uint8_t* cmd, uint8_t cmdsize)
{
switch ( cmd[1] ){
case ISO7816_READ_BINARY :snprintf(exp, size, "READ BINARY");break;
case ISO7816_WRITE_BINARY :snprintf(exp, size, "WRITE BINARY");break;
case ISO7816_UPDATE_BINARY :snprintf(exp, size, "UPDATE BINARY");break;
case ISO7816_ERASE_BINARY :snprintf(exp, size, "ERASE BINARY");break;
case ISO7816_READ_RECORDS :snprintf(exp, size, "READ RECORD(S)");break;
case ISO7816_WRITE_RECORD :snprintf(exp, size, "WRITE RECORD");break;
case ISO7816_APPEND_RECORD :snprintf(exp, size, "APPEND RECORD");break;
case ISO7816_UPDATE_DATA :snprintf(exp, size, "UPDATE DATA");break;
case ISO7816_GET_DATA :snprintf(exp, size, "GET DATA");break;
case ISO7816_PUT_DATA :snprintf(exp, size, "PUT DATA");break;
case ISO7816_SELECT_FILE :snprintf(exp, size, "SELECT FILE");break;
case ISO7816_VERIFY :snprintf(exp, size, "VERIFY");break;
case ISO7816_INTERNAL_AUTHENTICATE :snprintf(exp, size, "INTERNAL AUTHENTICATE");break;
case ISO7816_EXTERNAL_AUTHENTICATE :snprintf(exp, size, "EXTERNAL AUTHENTICATE");break;
case ISO7816_GET_CHALLENGE :snprintf(exp, size, "GET CHALLENGE");break;
case ISO7816_MANAGE_CHANNEL :snprintf(exp, size, "MANAGE CHANNEL");break;
case ISO7816_GET_RESPONSE :snprintf(exp, size, "GET RESPONSE");break;
case ISO7816_ENVELOPE :snprintf(exp, size, "ENVELOPE");break;
case ISO7816_GET_PROCESSING_OPTIONS :snprintf(exp, size, "GET PROCESSING OPTIONS");break;
default :snprintf(exp,size,"?"); break;
}
}
void annotateIso14443_4(char *exp, size_t size, uint8_t* cmd, uint8_t cmdsize){
// S-block
if ((cmd[0] & 0xc3) == 0xc2) {
switch (cmd[0] & 0x30) {
case 0x00 : snprintf(exp, size, "S-block DESELECT"); break;
case 0x30 : snprintf(exp, size, "S-block WTX"); break;
default : snprintf(exp, size, "S-block (RFU)"); break;
}
}
// R-block (ack)
else if ((cmd[0] & 0xe0) == 0xa0) {
if ((cmd[0] & 0x10) == 0)
snprintf(exp, size, "R-block ACK");
else
snprintf(exp, size, "R-block NACK");
}
// I-block
else {
int pos = 1;
switch (cmd[0] & 0x0c) {
case 0x08: // CID following
case 0x04: // NAD following
pos = 2;
break;
case 0x0c: // CID and NAD following
pos = 3;
break;
default:
pos = 1; // no CID, no NAD
break;
}
annotateIso7816(exp, size, &cmd[pos], cmdsize-pos);
}
}
/**
06 00 = INITIATE
0E xx = SELECT ID (xx = Chip-ID)
@ -840,6 +919,9 @@ uint16_t printTraceLine(uint16_t tracepos, uint16_t traceLen, uint8_t *trace, ui
case ISO_14443A:
crcStatus = iso14443A_CRC_check(isResponse, frame, data_len);
break;
case ISO_14443_4:
crcStatus = iso14443_4_CRC_check(frame, data_len);
break;
case ISO_15693:
crcStatus = iso15693_CRC_check(frame, data_len);
break;
@ -852,7 +934,6 @@ uint16_t printTraceLine(uint16_t tracepos, uint16_t traceLen, uint8_t *trace, ui
//2 Not crc-command
//--- Draw the data column
//char line[16][110];
char line[16][110];
for (int j = 0; j < data_len && j/16 < 16; j++) {
@ -900,6 +981,8 @@ uint16_t printTraceLine(uint16_t tracepos, uint16_t traceLen, uint8_t *trace, ui
case ISO_14443B: annotateIso14443b(explanation,sizeof(explanation),frame,data_len); break;
case TOPAZ: annotateTopaz(explanation,sizeof(explanation),frame,data_len); break;
case ISO_15693: annotateIso15693(explanation,sizeof(explanation),frame,data_len); break;
case ISO_7816_4: annotateIso7816(explanation, sizeof(explanation), frame, data_len); break;
case ISO_14443_4: annotateIso14443_4(explanation, sizeof(explanation), frame, data_len); break;
default: break;
}
}
@ -955,10 +1038,12 @@ int CmdHFList(const char *Cmd)
bool showWaitCycles = false;
bool markCRCBytes = false;
bool loadFromFile = false;
bool PCSCtrace = false;
bool saveToFile = false;
char param1 = '\0';
char param2 = '\0';
char param3 = '\0';
char param4 = '\0';
char type[40] = {0};
char filename[FILE_PATH_SIZE] = {0};
uint8_t protocol = 0;
@ -980,8 +1065,13 @@ int CmdHFList(const char *Cmd)
} else if (strlen(filename) == 0) {
param_getstr(Cmd, 3, filename, sizeof(filename));
}
if (param_getlength(Cmd, 4) == 1) {
param4 = param_getchar(Cmd, 4);
} else if (strlen(filename) == 0) {
param_getstr(Cmd, 4, filename, sizeof(filename));
}
// Validate param1
// Validate params
bool errors = false;
if(tlen == 0) {
@ -989,9 +1079,10 @@ int CmdHFList(const char *Cmd)
}
if(param1 == 'h'
|| (param1 != 0 && param1 != 'f' && param1 != 'c' && param1 != 'l')
|| (param2 != 0 && param2 != 'f' && param2 != 'c' && param2 != 'l')
|| (param3 != 0 && param3 != 'f' && param3 != 'c' && param3 != 'l')) {
|| (param1 != 0 && param1 != 'f' && param1 != 'c' && param1 != 'l' && param1 != 'p')
|| (param2 != 0 && param2 != 'f' && param2 != 'c' && param2 != 'l' && param1 != 'p')
|| (param3 != 0 && param3 != 'f' && param3 != 'c' && param3 != 'l' && param1 != 'p')
|| (param4 != 0 && param4 != 'f' && param4 != 'c' && param4 != 'l' && param4 != 'p')) {
errors = true;
}
@ -1002,24 +1093,29 @@ int CmdHFList(const char *Cmd)
else if(strcmp(type, "14b") == 0) protocol = ISO_14443B;
else if(strcmp(type, "topaz") == 0) protocol = TOPAZ;
else if(strcmp(type, "7816") == 0) protocol = ISO_7816_4;
else if(strcmp(type, "14-4") == 0) protocol = ISO_14443_4;
else if(strcmp(type, "15") == 0) protocol = ISO_15693;
else if(strcmp(type, "raw") == 0) protocol = -1;//No crc, no annotations
else if (strcmp(type, "save") == 0) saveToFile = true;
else errors = true;
}
if (param1 == 'f' || param2 == 'f' || param3 == 'f') {
if (param1 == 'f' || param2 == 'f' || param3 == 'f' || param4 == 'f') {
showWaitCycles = true;
}
if (param1 == 'c' || param2 == 'c' || param3 == 'c') {
if (param1 == 'c' || param2 == 'c' || param3 == 'c' || param4 == 'c') {
markCRCBytes = true;
}
if (param1 == 'l' || param2 == 'l' || param3 == 'l') {
if (param1 == 'l' || param2 == 'l' || param3 == 'l' || param4 == 'l') {
loadFromFile = true;
}
if (param1 == 'p' || param2 == 'p' || param3 == 'p' || param4 == 'p') {
PCSCtrace = true;
}
if ((loadFromFile || saveToFile) && strlen(filename) == 0) {
errors = true;
}
@ -1030,10 +1126,11 @@ int CmdHFList(const char *Cmd)
if (errors) {
PrintAndLog("List or save protocol data.");
PrintAndLog("Usage: hf list <protocol> [f] [c] [l <filename>]");
PrintAndLog("Usage: hf list <protocol> [f] [c] [p] [l <filename>]");
PrintAndLog(" hf list save <filename>");
PrintAndLog(" f - show frame delay times as well");
PrintAndLog(" c - mark CRC bytes");
PrintAndLog(" p - use trace buffer from PCSC card reader instead of PM3");
PrintAndLog(" l - load data from file instead of trace buffer");
PrintAndLog(" save - save data to file");
PrintAndLog("Supported <protocol> values:");
@ -1044,6 +1141,8 @@ int CmdHFList(const char *Cmd)
PrintAndLog(" 15 - interpret data as iso15693 communications");
PrintAndLog(" iclass - interpret data as iclass communications");
PrintAndLog(" topaz - interpret data as topaz communications");
PrintAndLog(" 7816 - interpret data as 7816-4 APDU communications");
PrintAndLog(" 14-4 - interpret data as ISO14443-4 communications");
PrintAndLog("");
PrintAndLog("example: hf list 14a f");
PrintAndLog("example: hf list iclass");
@ -1086,6 +1185,9 @@ int CmdHFList(const char *Cmd)
}
}
fclose(tracefile);
} else if (PCSCtrace) {
trace = pcsc_get_trace_addr();
traceLen = pcsc_get_traceLen();
} else {
trace = malloc(USB_CMD_DATA_SIZE);
// Query for the size of the trace

View file

@ -929,7 +929,11 @@ static int CmdSmartSetClock(const char *Cmd){
static int CmdSmartList(const char *Cmd) {
if (UseAlternativeSmartcardReader) {
CmdHFList("7816 p");
} else {
CmdHFList("7816");
}
return 0;
}

View file

@ -654,7 +654,7 @@ int EMVSelectApplication(struct tlvdb *tlv, uint8_t *AID, size_t *AIDlen) {
int EMVGPO(EMVCommandChannel channel, bool LeaveFieldON, uint8_t *PDOL, size_t PDOLLen, uint8_t *Result, size_t MaxResultLen, size_t *ResultLen, uint16_t *sw, struct tlvdb *tlv)
{
uint8_t GPO_APDU[APDU_COMMAND_LEN] = {0x80, 0xa8, 0x00, 0x00, PDOLLen, 0x00};
uint8_t GPO_APDU[APDU_COMMAND_LEN] = {0x80, ISO7816_GET_PROCESSING_OPTIONS, 0x00, 0x00, PDOLLen, 0x00};
memcpy(GPO_APDU + 5, PDOL, PDOLLen);
int apdulen = 5 + PDOLLen;
@ -695,7 +695,7 @@ int EMVGenerateChallenge(EMVCommandChannel channel, bool LeaveFieldON, uint8_t *
int EMVInternalAuthenticate(EMVCommandChannel channel, bool LeaveFieldON, uint8_t *DDOL, size_t DDOLLen, uint8_t *Result, size_t MaxResultLen, size_t *ResultLen, uint16_t *sw, struct tlvdb *tlv)
{
uint8_t authenticate_APDU[APDU_COMMAND_LEN] = {0x00, ISO7816_INTERNAL_AUTHENTICATION, 0x00, 0x00, DDOLLen, 0x00};
uint8_t authenticate_APDU[APDU_COMMAND_LEN] = {0x00, ISO7816_INTERNAL_AUTHENTICATE, 0x00, 0x00, DDOLLen, 0x00};
memcpy(authenticate_APDU + 5, DDOL, DDOLLen);
int apdulen = 5 + DDOLLen;

View file

@ -39,6 +39,92 @@ static SCARDHANDLE SC_Card;
static DWORD SC_Protocol;
static char* AlternativeSmartcardReader = NULL;
#define PCSC_MAX_TRACELEN 60000
static uint8_t pcsc_trace_buf[PCSC_MAX_TRACELEN];
static bool tracing = false;
static uint32_t traceLen = 0;
uint8_t *pcsc_get_trace_addr(void)
{
return pcsc_trace_buf;
}
uint32_t pcsc_get_traceLen(void)
{
return traceLen;
}
static void pcsc_clear_trace(void)
{
traceLen = 0;
}
static void pcsc_set_tracing(bool enable) {
tracing = enable;
}
static bool pcsc_LogTrace(const uint8_t *btBytes, uint16_t iLen, uint32_t timestamp_start, uint32_t timestamp_end, bool readerToTag)
{
if (!tracing) return false;
uint8_t *trace = pcsc_trace_buf;
uint32_t num_paritybytes = (iLen-1)/8 + 1; // number of paritybytes
uint32_t duration = timestamp_end - timestamp_start;
// Return when trace is full
if (traceLen + sizeof(iLen) + sizeof(timestamp_start) + sizeof(duration) + num_paritybytes + iLen >= PCSC_MAX_TRACELEN) {
tracing = false; // don't trace any more
return false;
}
// Traceformat:
// 32 bits timestamp (little endian)
// 16 bits duration (little endian)
// 16 bits data length (little endian, Highest Bit used as readerToTag flag)
// y Bytes data
// x Bytes parity (one byte per 8 bytes data)
// timestamp (start)
trace[traceLen++] = ((timestamp_start >> 0) & 0xff);
trace[traceLen++] = ((timestamp_start >> 8) & 0xff);
trace[traceLen++] = ((timestamp_start >> 16) & 0xff);
trace[traceLen++] = ((timestamp_start >> 24) & 0xff);
// duration
trace[traceLen++] = ((duration >> 0) & 0xff);
trace[traceLen++] = ((duration >> 8) & 0xff);
// data length
trace[traceLen++] = ((iLen >> 0) & 0xff);
trace[traceLen++] = ((iLen >> 8) & 0xff);
// readerToTag flag
if (!readerToTag) {
trace[traceLen - 1] |= 0x80;
}
// data bytes
if (btBytes != NULL && iLen != 0) {
for (int i = 0; i < iLen; i++) {
trace[traceLen++] = *btBytes++;
}
}
// dummy parity bytes
if (num_paritybytes != 0) {
for (int i = 0; i < num_paritybytes; i++) {
trace[traceLen++] = 0x00;
}
}
return true;
}
char *getAlternativeSmartcardReader(void)
{
@ -194,6 +280,9 @@ bool pcscSelectAlternativeCardReader(const char *readername)
bool pcscGetATR(smart_card_atr_t *card)
{
pcsc_clear_trace();
pcsc_set_tracing(true);
if (!card) {
return false;
}
@ -214,7 +303,9 @@ bool pcscGetATR(smart_card_atr_t *card)
}
card->atr_len = atr_len;
// TODO: LogTrace without device
pcsc_LogTrace(card->atr, card->atr_len, 0, 0, false);
pcsc_set_tracing(false);
return true;
}
@ -229,11 +320,10 @@ void pcscTransmit(uint8_t *data, uint32_t data_len, uint32_t flags, uint8_t *res
protocol = SCARD_PCI_RAW;
}
// TODO: tracing
// if ((flags & SC_CONNECT))
// clear_trace();
if ((flags & SC_CONNECT))
pcsc_clear_trace();
// set_tracing(true);
pcsc_set_tracing(true);
if ((flags & SC_CONNECT || flags & SC_SELECT)) {
LONG res = SCardConnect(SC_Context, AlternativeSmartcardReader, SCARD_SHARE_SHARED,
@ -245,14 +335,15 @@ void pcscTransmit(uint8_t *data, uint32_t data_len, uint32_t flags, uint8_t *res
}
if ((flags & SC_RAW) || (flags & SC_RAW_T0)) {
// TODO: tracing
// LogTrace(data, arg1, 0, 0, NULL, true);
pcsc_LogTrace(data, data_len, 0, 0, true);
DWORD len = *response_len;
LONG res = SCardTransmit(SC_Card, protocol, data, data_len, NULL, response, &len);
if (res != SCARD_S_SUCCESS) {
*response_len = -1;
} else {
pcsc_LogTrace(response, len, 0, 0, false);
*response_len = len;
}
}
pcsc_set_tracing(false);
}

View file

@ -11,9 +11,12 @@
#ifndef PCSC_H__
#define PCSC_H__
#include <stdint.h>
#include <stdbool.h>
#include "smartcard.h"
uint8_t *pcsc_get_trace_addr(void);
uint32_t pcsc_get_traceLen(void);
char *getAlternativeSmartcardReader(void);
bool pcscCheckForCardReaders(void);
bool pcscSelectAlternativeCardReader(const char *readername);

View file

@ -235,6 +235,7 @@ NXP/Philips CUSTOM COMMANDS
#define PROTO_MIFARE 4
#define ISO_7816_4 5
#define ISO_15693 6
#define ISO_14443_4 7
//-- Picopass fuses
@ -248,23 +249,25 @@ NXP/Philips CUSTOM COMMANDS
#define FUSE_RA 0x01
// ISO 7816-4 Basic interindustry commands. For command APDU's.
#define ISO7816_READ_BINARY 0xB0
#define ISO7816_WRITE_BINARY 0xD0
#define ISO7816_UPDATE_BINARY 0xD6
#define ISO7816_ERASE_BINARY 0x0E
#define ISO7816_READ_RECORDS 0xB2
#define ISO7816_WRITE_RECORDS 0xD2
#define ISO7816_APPEND_RECORD 0xE2
#define ISO7816_UPDATE_RECORD 0xDC
#define ISO7816_GET_DATA 0xCA
#define ISO7816_PUT_DATA 0xDA
#define ISO7816_SELECT_FILE 0xA4
#define ISO7816_VERIFY 0x20
#define ISO7816_INTERNAL_AUTHENTICATION 0x88
#define ISO7816_EXTERNAL_AUTHENTICATION 0x82
#define ISO7816_GET_CHALLENGE 0x84
#define ISO7816_MANAGE_CHANNEL 0x70
#define ISO7816_EXTERNAL_AUTHENTICATE 0x82
#define ISO7816_GET_CHALLENGE 0x84
#define ISO7816_INTERNAL_AUTHENTICATE 0x88
#define ISO7816_SELECT_FILE 0xA4
#define ISO7816_GET_PROCESSING_OPTIONS 0xA8
#define ISO7816_READ_BINARY 0xB0
#define ISO7816_READ_RECORDS 0xB2
#define ISO7816_GET_RESPONSE 0xC0
#define ISO7816_ENVELOPE 0xC2
#define ISO7816_GET_DATA 0xCA
#define ISO7816_WRITE_BINARY 0xD0
#define ISO7816_WRITE_RECORD 0xD2
#define ISO7816_UPDATE_BINARY 0xD6
#define ISO7816_PUT_DATA 0xDA
#define ISO7816_UPDATE_DATA 0xDC
#define ISO7816_APPEND_RECORD 0xE2
// ISO7816-4 For response APDU's
#define ISO7816_OK 0x9000
// 6x xx = ERROR