add: Hitag S error reason

CHANGELOG.md

@@ -14,6 +14,8 @@ This project uses the changelog in accordance with [keepchangelog](http://keepac
 - Added crypto1 support to `hf 14a raw` (@doegox)
 - Changed `hw version` command to print LUA and Python versions (@jmichelp)
 - Updated LUA to v5.4.7 which adds utf-8 support (@jmichelp)
+- Moved `lf hitag sim --hts` -> `lf hitag hts sim` (@douniwan5788)
+- Removed `lf hitag read/write --hts` (@douniwan5788)
 - Changed `lf search` - it now tries to read and decode paxton id (@iceman1001)
 - Changed `lf search` - to identify hitag2/s/82xx in chipset detection to preserve their EM4100 or other outputs (@iceman1001)
 - Added `lf hitag hts reader` - to act as a HitagS / 82xx reader (@iceman1001)

armsrc/hitagS.c

@@ -1117,8 +1117,8 @@ static int hts_select_tag(const lf_hitag_data_t *packet, uint8_t *tx, size_t siz
     hts_send_receive(tx, txlen, rx, sizeofrx, &rxlen, t_wait, ledcontrol, true);
 
     if (rxlen != 32) {
-        DbpString("UID Request failed!");
+        // DbpString("UID Request failed!");
-        return -1;
+        return -2;
     }
 
     memcpy(tag.data.pages[HITAGS_UID_PADR], rx, HITAGS_PAGE_SIZE);
@@ -1136,8 +1136,8 @@ static int hts_select_tag(const lf_hitag_data_t *packet, uint8_t *tx, size_t siz
     hts_send_receive(tx, txlen, rx, sizeofrx, &rxlen, HITAG_T_WAIT_SC, ledcontrol, false);
 
     if (rxlen != 40) {
-        Dbprintf("Select UID failed! %i", rxlen);
+        DBG Dbprintf("Select UID failed! %i", rxlen);
-        return -1;
+        return -3;
     }
 
     memcpy(tag.data.pages[HITAGS_CONFIG_PADR], rx, HITAGS_PAGE_SIZE - 1);
@@ -1207,8 +1207,8 @@ static int hts_select_tag(const lf_hitag_data_t *packet, uint8_t *tx, size_t siz
             hts_send_receive(tx, txlen, rx, sizeofrx, &rxlen, HITAG_T_WAIT_SC, ledcontrol, false);
 
             if ((rxlen != 2) || (rx[0] >> (8 - 2) != 0x01)) {
-                Dbprintf("no write access on page " _YELLOW_("64") ". not 82xx?");
+                // Dbprintf("no write access on page " _YELLOW_("64") ". not 82xx?");
-                return -1;
+                return -4;
             }
 
             txlen = 0;
@@ -1219,24 +1219,24 @@ static int hts_select_tag(const lf_hitag_data_t *packet, uint8_t *tx, size_t siz
             hts_send_receive(tx, txlen, rx, sizeofrx, &rxlen, HITAG_T_WAIT_SC, ledcontrol, false);
 
             if ((rxlen != 2) || (rx[0] >> (8 - 2) != 0x01)) {
-                Dbprintf("write to page " _YELLOW_("64") " failed! wrong password?");
+                // Dbprintf("write to page " _YELLOW_("64") " failed! wrong password?");
-                return -1;
+                return -5;
             }
 
             return 0;
         } else if (packet->cmd == HTSF_PLAIN) {
-            Dbprintf("Error, " _YELLOW_("AUT=1") " This tag is configured in Authentication Mode");
+            // Dbprintf("Error, " _YELLOW_("AUT=1") " This tag is configured in Authentication Mode");
-            return -1;
+            return -6;
         } else {
-            Dbprintf("Error, unknown function: " _RED_("%d"), packet->cmd);
+            DBG Dbprintf("Error, unknown function: " _RED_("%d"), packet->cmd);
-            return -1;
+            return -7;
         }
 
         hts_send_receive(tx, txlen, rx, sizeofrx, &rxlen, HITAG_T_WAIT_SC, ledcontrol, false);
 
         if (rxlen != 40) {
-            Dbprintf("Authenticate failed! " _RED_("%i"), rxlen);
+            DBG Dbprintf("Authenticate failed! " _RED_("%i"), rxlen);
-            return -1;
+            return -8;
         }
 
         //encrypted con2,password received.
@@ -1275,8 +1275,9 @@ void hts_read(const lf_hitag_data_t *payload, bool ledcontrol) {
     uint8_t rx[HITAG_FRAME_LEN] = { 0x00 };
     uint8_t tx[HITAG_FRAME_LEN] = { 0x00 };
 
-    int status = PM3_SUCCESS;
+    int status = PM3_SUCCESS, reason = -1;
-    if (hts_select_tag(payload, tx, ARRAYLEN(tx), rx, ARRAYLEN(rx), HITAG_T_WAIT_FIRST, ledcontrol) == -1) {
+    reason = hts_select_tag(payload, tx, ARRAYLEN(tx), rx, ARRAYLEN(rx), HITAG_T_WAIT_FIRST, ledcontrol);
+    if (reason != 0) {
         status = PM3_ERFTRANS;
         goto read_end;
     }
@@ -1360,7 +1361,7 @@ read_end:
     hts_stop_clock();
     set_tracing(false);
     lf_finalize(ledcontrol);
-    reply_ng(CMD_LF_HITAGS_READ, status, (uint8_t *)tag.data.pages, sizeof(tag.data.pages));
+    reply_reason(CMD_LF_HITAGS_READ, status, reason,(uint8_t *)tag.data.pages, sizeof(tag.data.pages));
 }
 
 /*
@@ -1380,10 +1381,10 @@ void hts_write_page(const lf_hitag_data_t *payload, bool ledcontrol) {
     uint8_t tx[HITAG_FRAME_LEN];
     size_t txlen = 0;
 
-    int res = PM3_ESOFT;
+    int status = PM3_ESOFT, reason = -1;
-
+    reason = hts_select_tag(payload, tx, ARRAYLEN(tx), rx, ARRAYLEN(rx), HITAG_T_WAIT_FIRST, ledcontrol);
-    if (hts_select_tag(payload, tx, ARRAYLEN(tx), rx, ARRAYLEN(rx), HITAG_T_WAIT_FIRST, ledcontrol) == -1) {
+    if (reason != 0) {
-        res = PM3_ERFTRANS;
+        status = PM3_ERFTRANS;
         goto write_end;
     }
 
@@ -1409,7 +1410,7 @@ void hts_write_page(const lf_hitag_data_t *payload, bool ledcontrol) {
 
     if ((rxlen != 2) || (rx[0] >> (8 - 2) != 0x01)) {
         DBG Dbprintf("no write access on page " _YELLOW_("%d"), payload->page);
-        res = PM3_ESOFT;
+        reason = -9;
         goto write_end;
     }
 
@@ -1438,22 +1439,22 @@ void hts_write_page(const lf_hitag_data_t *payload, bool ledcontrol) {
     enable_page_tearoff = g_tearoff_enabled;
 
     if (hts_send_receive(tx, txlen, rx, ARRAYLEN(rx), &rxlen, HITAG_T_WAIT_SC, ledcontrol, false) == PM3_ETEAROFF) {
-        res = PM3_ETEAROFF;
+        status = PM3_ETEAROFF;
         enable_page_tearoff = false;
         goto write_end;
     }
 
     if ((rxlen != 2) || (rx[0] >> (8 - 2) != 0x01)) {
-        res = PM3_ESOFT; //  write failed
+        reason = -10;  // write failed
     } else {
-        res = PM3_SUCCESS;
+        status = PM3_SUCCESS;
     }
 
 write_end:
     hts_stop_clock();
     set_tracing(false);
     lf_finalize(ledcontrol);
-    reply_ng(CMD_LF_HITAGS_WRITE, res, NULL, 0);
+    reply_reason(CMD_LF_HITAGS_WRITE, status, reason, NULL, 0);
 }
 
 int hts_read_uid(uint32_t *uid, bool ledcontrol, bool send_answer) {
@@ -1548,17 +1549,17 @@ void hts_check_challenges(const uint8_t *data, uint32_t datalen, bool ledcontrol
 
         memcpy(payload.NrAr, data + dataoffset, 8);
 
-        int res = hts_select_tag(&payload, tx, ARRAYLEN(tx), rx, ARRAYLEN(rx), HITAG_T_WAIT_FIRST, ledcontrol);
+        int reason = hts_select_tag(&payload, tx, ARRAYLEN(tx), rx, ARRAYLEN(rx), HITAG_T_WAIT_FIRST, ledcontrol);
 
         DBG  Dbprintf("Challenge %s: %02X %02X %02X %02X %02X %02X %02X %02X",
-                      res == -1 ? "failed " : "success",
+                      reason != 0 ? "failed " : "success",
                       payload.NrAr[0], payload.NrAr[1],
                       payload.NrAr[2], payload.NrAr[3],
                       payload.NrAr[4], payload.NrAr[5],
                       payload.NrAr[6], payload.NrAr[7]
                      );
 
-        if (res == -1) {
+        if (reason != 0) {
             // Need to do a dummy UID select that will fail
             FpgaWriteConfWord(FPGA_MAJOR_MODE_OFF);
             SpinDelay(2);

client/src/cmdlfhitaghts.c

@@ -179,6 +179,41 @@ static int process_hitags_common_args(CLIParserContext *ctx, lf_hitag_data_t *co
 
     return PM3_SUCCESS;
 }
+
+static void print_error(int8_t reason) {
+    switch (reason) {
+        case -2:
+            PrintAndLogEx(FAILED, "UID Request failed!");
+            break;
+        case -3:
+            PrintAndLogEx(FAILED, "Select UID failed!");
+            break;
+        case -4:
+            PrintAndLogEx(FAILED, "No write access on page " _YELLOW_("64") ". not 82xx?");
+            break;
+        case -5:
+            PrintAndLogEx(FAILED, "Write to page " _YELLOW_("64") " failed! wrong password?");
+            break;
+        case -6:
+            PrintAndLogEx(FAILED, "Error, " _YELLOW_("AUT=1") " This tag is configured in Authentication Mode");
+            break;
+        case -7:
+            PrintAndLogEx(FAILED, "Error, unknown function");
+            break;
+        case -8:
+            PrintAndLogEx(FAILED, "Authenticate failed!");
+            break;
+        case -9:
+            PrintAndLogEx(FAILED, "No write access on page");
+            break;
+        case -10:
+            PrintAndLogEx(FAILED, "Write to page failed!");
+            break;
+        default:
+            PrintAndLogEx(DEBUG, "DEBUG: Error - Hitag S failed");
+    }
+}
+
 static int CmdLFHitagSRead(const char *Cmd) {
     CLIParserContext *ctx;
     CLIParserInit(&ctx, "lf hitag hts rdbl",
@@ -225,7 +260,7 @@ static int CmdLFHitagSRead(const char *Cmd) {
     }
 
     if (resp.status != PM3_SUCCESS) {
-        PrintAndLogEx(DEBUG, "DEBUG: Error - hitag failed");
+        print_error(resp.reason);
         return PM3_ESOFT;
     }
 
@@ -312,7 +347,7 @@ static int CmdLFHitagSWrite(const char *Cmd) {
     }
 
     if (resp.status != PM3_SUCCESS) {
-        PrintAndLogEx(FAILED, "Write ( " _RED_("fail") " )");
+        print_error(resp.reason);
         return resp.status;
     }
 
@@ -425,9 +460,10 @@ static command_t CommandTable[] = {
     {"list",        CmdLFHitagSList,   AlwaysAvailable, "List Hitag S trace history"},
     {"-----------", CmdHelp,           IfPm3Hitag,      "----------------------- " _CYAN_("General") " ------------------------"},
     {"reader",      CmdLFHitagSReader, IfPm3Hitag,      "Act like a Hitag S reader"},
-    {"rdbl",        CmdLFHitagSRead,   IfPm3Hitag,      "Read Hitag S memory"},
+    {"rdbl",        CmdLFHitagSRead,   IfPm3Hitag,      "Read Hitag S page"},
     {"wrbl",        CmdLFHitagSWrite,  IfPm3Hitag,      "Write Hitag S page"},
-    {"sim",         CmdLFHitagSSim,    IfPm3Hitag,      "Simulate Hitag transponder"},
+    {"-----------", CmdHelp,           IfPm3Hitag,      "----------------------- " _CYAN_("Simulation") " -----------------------"},
+    {"sim",         CmdLFHitagSSim,    IfPm3Hitag,      "Simulate Hitag S transponder"},
     {NULL,          NULL,              0,               NULL}
 };