proxmark3/client/cmdlfhitag.c

//-----------------------------------------------------------------------------
// Copyright (C) 2012 Roel Verdult
//
// 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.
//-----------------------------------------------------------------------------
// Low frequency Hitag support
//-----------------------------------------------------------------------------

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "proxmark3.h"
#include "ui.h"
#include "cmdparser.h"
#include "common.h"
#include "util.h"
#include "parity.h"
#include "hitag2.h"
#include "hitagS.h"
#include "util_posix.h"
#include "comms.h"
#include "cmddata.h"

static int CmdHelp(const char *Cmd);

size_t nbytes(size_t nbits) {
    return (nbits / 8) + ((nbits % 8) > 0);
}

int usage_hitag_reader(void) {
    PrintAndLogEx(NORMAL, "Usage: lf hitag reader [h] <reader function #>");
    PrintAndLogEx(NORMAL, "Options:");
    PrintAndLogEx(NORMAL, "       h          This help");
    PrintAndLogEx(NORMAL, "   HitagS (0*)");
    PrintAndLogEx(NORMAL, "      01 <nr> <ar>     Challenge, read all pages from a Hitag S tag");
    PrintAndLogEx(NORMAL, "      02 <key>         Set to 0 if no authentication is needed. Read all pages from a Hitag S tag");
    PrintAndLogEx(NORMAL, "   Hitag1 (1*)");
    PrintAndLogEx(NORMAL, "   Hitag2 (2*)");
    PrintAndLogEx(NORMAL, "      21 <password>    Password mode");
    PrintAndLogEx(NORMAL, "      22 <nr> <ar>     Authentication");
    PrintAndLogEx(NORMAL, "      23 <key>         Authentication, key is in format: ISK high + ISK low");
    PrintAndLogEx(NORMAL, "      25               Test recorded authentications");
    PrintAndLogEx(NORMAL, "      26               Just read UID");
    return 0;
}

int CmdLFHitagList(const char *Cmd) {
    uint8_t *got = calloc(USB_CMD_DATA_SIZE, sizeof(uint8_t));
    if (!got) {
        PrintAndLogEx(WARNING, "Cannot allocate memory for trace");
        return 2;
    }

    // Query for the actual size of the trace
    UsbCommand response;
    if (!GetFromDevice(BIG_BUF, got, USB_CMD_DATA_SIZE, 0, &response, 2500, false)) {
        PrintAndLogEx(WARNING, "command execution time out");
        free(got);
        return 2;
    }

    uint16_t traceLen = response.arg[2];
    if (traceLen > USB_CMD_DATA_SIZE) {
        uint8_t *p = realloc(got, traceLen);
        if (p == NULL) {
            PrintAndLogEx(WARNING, "Cannot allocate memory for trace");
            free(got);
            return 2;
        }
        got = p;
        if (!GetFromDevice(BIG_BUF, got, traceLen, 0, NULL, 2500, false)) {
            PrintAndLogEx(WARNING, "command execution time out");
            free(got);
            return 2;
        }
    }

    PrintAndLogEx(NORMAL, "recorded activity (TraceLen = %d bytes):");
    PrintAndLogEx(NORMAL, " ETU     :nbits: who bytes");
    PrintAndLogEx(NORMAL, "---------+-----+----+-----------");

    int i = 0;
    int prev = -1;
    int len = strlen(Cmd);

    char filename[FILE_PATH_SIZE]  = { 0x00 };
    FILE *f = NULL;

    if (len > FILE_PATH_SIZE) len = FILE_PATH_SIZE;

    memcpy(filename, Cmd, len);

    if (strlen(filename) > 0) {
        f = fopen(filename, "wb");
        if (!f) {
            PrintAndLogEx(WARNING, "Error: Could not open file [%s]", filename);
            return 1;
        }
    }

    for (;;) {

        if (i >= traceLen) { break; }

        bool isResponse;
        int timestamp = *((uint32_t *)(got + i));
        if (timestamp & 0x80000000) {
            timestamp &= 0x7fffffff;
            isResponse = 1;
        } else {
            isResponse = 0;
        }

        int parityBits = *((uint32_t *)(got + i + 4));
        // 4 bytes of additional information...
        // maximum of 32 additional parity bit information
        //
        // TODO:
        // at each quarter bit period we can send power level (16 levels)
        // or each half bit period in 256 levels.

        int bits = got[i + 8];
        int len = nbytes(got[i + 8]);

        if (len > 100) {
            break;
        }
        if (i + len > traceLen) { break;}

        uint8_t *frame = (got + i + 9);

        // Break and stick with current result if buffer was not completely full
        if (frame[0] == 0x44 && frame[1] == 0x44 && frame[3] == 0x44) { break; }

        char line[1000] = "";
        int j;
        for (j = 0; j < len; j++) {

            //if((parityBits >> (len - j - 1)) & 0x01) {
            if (isResponse && (oddparity8(frame[j]) != ((parityBits >> (len - j - 1)) & 0x01))) {
                sprintf(line + (j * 4), "%02x!  ", frame[j]);
            } else {
                sprintf(line + (j * 4), "%02x   ", frame[j]);
            }
        }

        PrintAndLogEx(NORMAL, " +%7d:  %3d: %s %s",
                      (prev < 0 ? 0 : (timestamp - prev)),
                      bits,
                      (isResponse ? "TAG" : "   "),
                      line);

        if (f) {
            fprintf(f, " +%7d:  %3d: %s %s\n",
                    (prev < 0 ? 0 : (timestamp - prev)),
                    bits,
                    (isResponse ? "TAG" : "   "),
                    line);
        }

        prev = timestamp;
        i += (len + 9);
    }

    if (f) {
        fclose(f);
        PrintAndLogEx(NORMAL, "Recorded activity succesfully written to file: %s", filename);
    }

    free(got);
    return 0;
}

int CmdLFHitagSnoop(const char *Cmd) {
    UsbCommand c = {CMD_SNOOP_HITAG};
    clearCommandBuffer();
    SendCommand(&c);
    return 0;
}

int CmdLFHitagSim(const char *Cmd) {

    UsbCommand c = {CMD_SIMULATE_HITAG};
    char filename[FILE_PATH_SIZE] = { 0x00 };
    FILE *f;
    bool tag_mem_supplied;

    int len = strlen(Cmd);
    if (len > FILE_PATH_SIZE) len = FILE_PATH_SIZE;
    memcpy(filename, Cmd, len);

    if (strlen(filename) > 0) {
        f = fopen(filename, "rb+");
        if (!f) {
            PrintAndLogEx(WARNING, "Error: Could not open file [%s]", filename);
            return 1;
        }
        tag_mem_supplied = true;
        size_t bytes_read = fread(c.d.asBytes, 1, 48, f);
        if (bytes_read == 48) {
            PrintAndLogEx(WARNING, "Error: File reading error");
            fclose(f);
            return 1;
        }
        fclose(f);
    } else {
        tag_mem_supplied = false;
    }

    // Does the tag comes with memory
    c.arg[0] = (uint32_t)tag_mem_supplied;
    clearCommandBuffer();
    SendCommand(&c);
    return 0;
}

int CmdLFHitagReader(const char *Cmd) {

    UsbCommand c = {CMD_READER_HITAG, {0, 0, 0} };
    hitag_data *htd = (hitag_data *)c.d.asBytes;
    hitag_function htf = param_get32ex(Cmd, 0, 0, 10);

    switch (htf) {
        case RHTSF_CHALLENGE: {
            c.cmd = CMD_READ_HITAG_S;
            num_to_bytes(param_get32ex(Cmd, 1, 0, 16), 4, htd->auth.NrAr);
            num_to_bytes(param_get32ex(Cmd, 2, 0, 16), 4, htd->auth.NrAr + 4);
            break;
        }
        case RHTSF_KEY: {
            c.cmd = CMD_READ_HITAG_S;
            num_to_bytes(param_get64ex(Cmd, 1, 0, 16), 6, htd->crypto.key);
            break;
        }
        case RHT2F_PASSWORD: {
            num_to_bytes(param_get32ex(Cmd, 1, 0, 16), 4, htd->pwd.password);
            break;
        }
        case RHT2F_AUTHENTICATE: {
            num_to_bytes(param_get32ex(Cmd, 1, 0, 16), 4, htd->auth.NrAr);
            num_to_bytes(param_get32ex(Cmd, 2, 0, 16), 4, htd->auth.NrAr + 4);
            break;
        }
        case RHT2F_CRYPTO: {
            num_to_bytes(param_get64ex(Cmd, 1, 0, 16), 6, htd->crypto.key);
            break;
        }
        case RHT2F_TEST_AUTH_ATTEMPTS: {
            // No additional parameters needed
            break;
        }
        case RHT2F_UID_ONLY: {
            // No additional parameters needed
            break;
        }
        default: {
            PrintAndLogEx(NORMAL, "\nError: unkown reader function %d", htf);
            return usage_hitag_reader();
        }
    }

    c.arg[0] = htf;
    clearCommandBuffer();
    SendCommand(&c);
    UsbCommand resp;
    if (!WaitForResponseTimeout(CMD_ACK, &resp, 4000)) {
        PrintAndLogEx(WARNING, "timeout while waiting for reply.");
        return 1;
    }

    if (resp.arg[0] == false) {
        PrintAndLogEx(DEBUG, "DEBUG: Error - hitag failed");
        return 1;
    }

    uint32_t id = bytes_to_num(resp.d.asBytes, 4);

    if (htf == RHT2F_UID_ONLY) {
        PrintAndLogEx(NORMAL, "Valid Hitag2 tag found - UID: %08x", id);
    } else {
        char filename[FILE_PATH_SIZE];
        FILE *f = NULL;
        sprintf(filename, "%08x_%04x.ht2", id, (rand() & 0xffff));
        f = fopen(filename, "wb");
        if (!f) {
            PrintAndLogEx(WARNING, "Error: Could not open file [%s]", filename);
            return 1;
        }

        // Write the 48 tag memory bytes to file and finalize
        fwrite(resp.d.asBytes, 1, 48, f);
        fclose(f);
        PrintAndLogEx(NORMAL, "Succesfully saved tag memory to [%s]", filename);
    }
    return 0;
}

int CmdLFHitagSimS(const char *Cmd) {
    UsbCommand c = { CMD_SIMULATE_HITAG_S };
    char filename[FILE_PATH_SIZE] = { 0x00 };
    FILE *f;
    bool tag_mem_supplied;
    int len = strlen(Cmd);
    if (len > FILE_PATH_SIZE)
        len = FILE_PATH_SIZE;
    memcpy(filename, Cmd, len);

    if (strlen(filename) > 0) {
        f = fopen(filename, "rb+");
        if (!f) {
            PrintAndLogEx(WARNING, "Error: Could not open file [%s]", filename);
            return 1;
        }
        tag_mem_supplied = true;
        size_t bytes_read = fread(c.d.asBytes, 1, 4 * 64, f);
        if (bytes_read == 4 * 64) {
            PrintAndLogEx(WARNING, "Error: File reading error");
            fclose(f);
            return 1;
        }
        fclose(f);
    } else {
        tag_mem_supplied = false;
    }

    // Does the tag comes with memory
    c.arg[0] = (uint32_t) tag_mem_supplied;
    clearCommandBuffer();
    SendCommand(&c);
    return 0;
}

int CmdLFHitagCheckChallenges(const char *Cmd) {
    UsbCommand c = { CMD_TEST_HITAGS_TRACES };
    char filename[FILE_PATH_SIZE] = { 0x00 };
    FILE *f;
    bool file_given;
    int len = strlen(Cmd);
    if (len > FILE_PATH_SIZE)
        len = FILE_PATH_SIZE;
    memcpy(filename, Cmd, len);

    if (strlen(filename) > 0) {
        f = fopen(filename, "rb+");
        if (!f) {
            PrintAndLogEx(WARNING, "Error: Could not open file [%s]", filename);
            return 1;
        }
        file_given = true;
        size_t bytes_read = fread(c.d.asBytes, 1, 8 * 60, f);
        if (bytes_read == 8 * 60) {
            PrintAndLogEx(WARNING, "Error: File reading error");
            fclose(f);
            return 1;
        }
        fclose(f);
    } else {
        file_given = false;
    }

    //file with all the challenges to try
    c.arg[0] = (uint32_t)file_given;
    clearCommandBuffer();
    SendCommand(&c);
    return 0;
}

int CmdLFHitagWP(const char *Cmd) {
    UsbCommand c = { CMD_WR_HITAG_S };
    hitag_data *htd = (hitag_data *)c.d.asBytes;
    hitag_function htf = param_get32ex(Cmd, 0, 0, 10);
    switch (htf) {
        case 03: { //WHTSF_CHALLENGE
            num_to_bytes(param_get64ex(Cmd, 1, 0, 16), 8, htd->auth.NrAr);
            c.arg[2] = param_get32ex(Cmd, 2, 0, 10);
            num_to_bytes(param_get32ex(Cmd, 3, 0, 16), 4, htd->auth.data);
        }
        break;
        case 04:
        case 24: {
            //WHTSF_KEY
            num_to_bytes(param_get64ex(Cmd, 1, 0, 16), 6, htd->crypto.key);
            c.arg[2] = param_get32ex(Cmd, 2, 0, 10);
            num_to_bytes(param_get32ex(Cmd, 3, 0, 16), 4, htd->crypto.data);

        }
        break;
        default: {
            PrintAndLogEx(WARNING, "Error: unkown writer function %d", htf);
            PrintAndLogEx(NORMAL, "Hitag writer functions");
            PrintAndLogEx(NORMAL, " HitagS (0*)");
            PrintAndLogEx(NORMAL, "  03 <nr,ar> (Challenge) <page> <byte0...byte3> write page on a Hitag S tag");
            PrintAndLogEx(NORMAL, "  04 <key> (set to 0 if no authentication is needed) <page> <byte0...byte3> write page on a Hitag S tag");
            PrintAndLogEx(NORMAL, " Hitag1 (1*)");
            PrintAndLogEx(NORMAL, " Hitag2 (2*)");
            return 1;
        }
        break;
    }
    // Copy the hitag function into the first argument
    c.arg[0] = htf;

    clearCommandBuffer();
    SendCommand(&c);
    UsbCommand resp;
    WaitForResponse(CMD_ACK, &resp);

    // Check the return status, stored in the first argument
    if (resp.arg[0] == false) return 1;
    return 0;
}

static command_t CommandTable[] = {
    {"help",    CmdHelp,           1, "This help"},
    {"list",    CmdLFHitagList,    1, "<outfile> List Hitag trace history"},
    {"reader",  CmdLFHitagReader,  1, "Act like a Hitag Reader"},
    {"sim",     CmdLFHitagSim,     1, "<infile> Simulate Hitag transponder"},
    {"simS",    CmdLFHitagSimS,    1, "<hitagS.hts> Simulate HitagS transponder" },
    {"snoop",   CmdLFHitagSnoop,   1, "Eavesdrop Hitag communication"},
    {"writer",  CmdLFHitagWP,      1, "Act like a Hitag Writer" },
    {"check_challenges", CmdLFHitagCheckChallenges,   1, "<challenges.cc> test all challenges" },
    { NULL, NULL, 0, NULL }
};

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

int CmdHelp(const char *Cmd) {
    CmdsHelp(CommandTable);
    return 0;
}