git.zerfleddert.de Git - proxmark3-svn/blob - client/cmdhflegic.c

   1 //-----------------------------------------------------------------------------
   2 // Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
   3 //
   4 // This code is licensed to you under the terms of the GNU GPL, version 2 or,
   5 // at your option, any later version. See the LICENSE.txt file for the text of
   6 // the license.
   7 //-----------------------------------------------------------------------------
   8 // High frequency Legic commands
   9 //-----------------------------------------------------------------------------
  10
  11 #include <stdio.h>
  12 #include <string.h>
  13 #include "proxmark3.h"
  14 #include "data.h"
  15 #include "ui.h"
  16 #include "cmdparser.h"
  17 #include "cmdhflegic.h"
  18 #include "cmdmain.h"
  19 #include "util.h"
  20 #include "crc.h"
  21 static int CmdHelp(const char *Cmd);
  22
  23 int usage_legic_calccrc8(void){
  24         PrintAndLog("Calculates the legic crc8 on the input hexbytes.");
  25         PrintAndLog("There must be an even number of hexsymbols as input.");
  26         PrintAndLog("Usage:  hf legic crc8 <hexbytes>");
  27         PrintAndLog("Options :");
  28         PrintAndLog("  <hexbytes>   : hex bytes in a string");
  29         PrintAndLog("");
  30         PrintAndLog("Sample  : hf legic crc8 deadbeef1122");
  31         return 0;
  32 }
  33
  34 int usage_legic_load(void){
  35         PrintAndLog("It loads datasamples from the file `filename` to device memory");
  36         PrintAndLog("Usage:  hf legic load <file name>");
  37         PrintAndLog(" sample: hf legic load filename");
  38         return 0;
  39 }
  40
  41 int usage_legic_read(void){
  42         PrintAndLog("Read data from a legic tag.");
  43         PrintAndLog("Usage:  hf legic read <offset> <num of bytes>");
  44         PrintAndLog("Options :");
  45         PrintAndLog("  <offset>        : offset in data array to start download from");
  46         PrintAndLog("  <num of bytes>  : number of bytes to download");
  47         PrintAndLog("");
  48         PrintAndLog(" sample: hf legic read");
  49         return 0;
  50 }
  51
  52 /*
  53  *  Output BigBuf and deobfuscate LEGIC RF tag data.
  54  *  This is based on information given in the talk held
  55  *  by Henryk Ploetz and Karsten Nohl at 26c3
  56  */
  57 int CmdLegicDecode(const char *Cmd) {
  58         // Index for the bytearray.
  59         int i = 0;
  60         int k = 0, segmentNum;
  61         int segment_len = 0;
  62         int segment_flag = 0;
  63         uint8_t stamp_len = 0;
  64         int crc = 0;
  65         int wrp = 0;
  66         int wrc = 0;
  67         uint8_t data_buf[1024]; // receiver buffer,  should be 1024..
  68         char token_type[4];
  69
  70         // download EML memory, where the "legic read" command puts the data.
  71         GetEMLFromBigBuf(data_buf, sizeof(data_buf), 0);
  72         if ( !WaitForResponseTimeout(CMD_ACK, NULL, 2000)){
  73                 PrintAndLog("Command execute timeout");
  74                 return 1;
  75         }
  76
  77         // Output CDF System area (9 bytes) plus remaining header area (12 bytes)
  78         crc = data_buf[4];
  79         uint32_t calc_crc =  CRC8Legic(data_buf, 4);
  80
  81         PrintAndLog("\nCDF: System Area");
  82         PrintAndLog("------------------------------------------------------");
  83         PrintAndLog("MCD: %02x, MSN: %02x %02x %02x, MCC: %02x %s",
  84                 data_buf[0],
  85                 data_buf[1],
  86                 data_buf[2],
  87                 data_buf[3],
  88                 data_buf[4],
  89                 (calc_crc == crc) ? "OK":"Fail"
  90         );
  91
  92         switch (data_buf[5] & 0x7f) {
  93                 case 0x00 ... 0x2f:
  94                         strncpy(token_type, "IAM",sizeof(token_type));
  95                         break;
  96                 case 0x30 ... 0x6f:
  97                         strncpy(token_type, "SAM",sizeof(token_type));
  98                         break;
  99                 case 0x70 ... 0x7f:
 100                         strncpy(token_type, "GAM",sizeof(token_type));
 101                         break;
 102                 default:
 103                         strncpy(token_type, "???",sizeof(token_type));
 104                         break;
 105         }
 106
 107         stamp_len = 0xfc - data_buf[6];
 108
 109         PrintAndLog("DCF: %02x %02x, Token Type=%s (OLE=%01u), Stamp len=%02u",
 110                 data_buf[5],
 111                 data_buf[6],
 112                 token_type,
 113                 (data_buf[5]&0x80)>>7,
 114                 stamp_len
 115         );
 116
 117         PrintAndLog("WRP=%02u, WRC=%01u, RD=%01u, raw=%02x, SSC=%02x",
 118                 data_buf[7]&0x0f,
 119                 (data_buf[7]&0x70)>>4,
 120                 (data_buf[7]&0x80)>>7,
 121                 data_buf[7],
 122                 data_buf[8]
 123         );
 124
 125         PrintAndLog("Remaining Header Area");
 126         PrintAndLog("%s", sprint_hex(data_buf+9, 13));
 127
 128         uint8_t segCrcBytes[8] = {0x00};
 129         uint32_t segCalcCRC = 0;
 130         uint32_t segCRC = 0;
 131
 132         // see if user area is xored or just zeros.
 133         int numOfZeros = 0;
 134         for (int index=22; index < 256; ++index){
 135                 if ( data_buf[index] == 0x00 )
 136                         ++numOfZeros;
 137         }
 138         // if possible zeros is less then 60%, lets assume data is xored
 139         // 256  - 22 (header) = 234
 140         // 1024 - 22 (header) = 1002
 141         int isXored = (numOfZeros*100/stamp_len) < 50;
 142         PrintAndLog("is data xored?  %d  ( %d %)", isXored, (numOfZeros*100/stamp_len));
 143
 144         print_hex_break( data_buf, 33, 16);
 145
 146         return 0;
 147
 148         PrintAndLog("\nADF: User Area");
 149         PrintAndLog("------------------------------------------------------");
 150         i = 22;
 151         // 64 potential segements
 152         // how to detect there is no segments?!?
 153         for ( segmentNum=0; segmentNum<64; segmentNum++ ) {
 154                 segment_len = ((data_buf[i+1]^crc)&0x0f) * 256 + (data_buf[i]^crc);
 155                 segment_flag = ((data_buf[i+1]^crc)&0xf0)>>4;
 156
 157                 wrp = (data_buf[i+2]^crc);
 158                 wrc = ((data_buf[i+3]^crc)&0x70)>>4;
 159
 160                 bool hasWRC = (wrc > 0);
 161                 bool hasWRP = (wrp > wrc);
 162                 int wrp_len = (wrp - wrc);
 163                 int remain_seg_payload_len = (segment_len - wrp - 5);
 164
 165                 // validate segment-crc
 166                 segCrcBytes[0]=data_buf[0];                     //uid0
 167                 segCrcBytes[1]=data_buf[1];                     //uid1
 168                 segCrcBytes[2]=data_buf[2];                     //uid2
 169                 segCrcBytes[3]=data_buf[3];                     //uid3
 170                 segCrcBytes[4]=(data_buf[i]^crc);       //hdr0
 171                 segCrcBytes[5]=(data_buf[i+1]^crc); //hdr1
 172                 segCrcBytes[6]=(data_buf[i+2]^crc); //hdr2
 173                 segCrcBytes[7]=(data_buf[i+3]^crc); //hdr3
 174
 175                 segCalcCRC = CRC8Legic(segCrcBytes, 8);
 176                 segCRC = data_buf[i+4]^crc;
 177
 178                 PrintAndLog("Segment %02u \nraw header | 0x%02X 0x%02X 0x%02X 0x%02X \nSegment len: %u,  Flag: 0x%X (valid:%01u, last:%01u), WRP: %02u, WRC: %02u, RD: %01u, CRC: 0x%02X (%s)",
 179                         segmentNum,
 180                         data_buf[i]^crc,
 181                         data_buf[i+1]^crc,
 182                         data_buf[i+2]^crc,
 183                         data_buf[i+3]^crc,
 184                         segment_len,
 185                         segment_flag,
 186                         (segment_flag & 0x4) >> 2,
 187                         (segment_flag & 0x8) >> 3,
 188                         wrp,
 189                         wrc,
 190                         ((data_buf[i+3]^crc) & 0x80) >> 7,
 191                         segCRC,
 192                         ( segCRC == segCalcCRC ) ? "OK" : "fail"
 193                 );
 194
 195                 i += 5;
 196
 197                 if ( hasWRC ) {
 198                         PrintAndLog("WRC protected area:   (I %d | K %d| WRC %d)", i, k, wrc);
 199                         PrintAndLog("\nrow  | data");
 200                         PrintAndLog("-----+------------------------------------------------");
 201                         // de-xor?  if not zero, assume it needs xoring.
 202                         if ( isXored) {
 203                                 for ( k=i; k < wrc; ++k)
 204                                         data_buf[k] ^= crc;
 205                         }
 206                         print_hex_break( data_buf+i, wrc, 16);
 207
 208                         i += wrc;
 209                 }
 210
 211                 if ( hasWRP ) {
 212                         PrintAndLog("Remaining write protected area:  (I %d | K %d | WRC %d | WRP %d  WRP_LEN %d)",i, k, wrc, wrp, wrp_len);
 213                         PrintAndLog("\nrow  | data");
 214                         PrintAndLog("-----+------------------------------------------------");
 215
 216                         if (isXored) {
 217                                 for (k=i; k < wrp_len; ++k)
 218                                         data_buf[k] ^= crc;
 219                         }
 220
 221                         print_hex_break( data_buf+i, wrp_len, 16);
 222
 223                         i += wrp_len;
 224
 225                         // does this one work?
 226                         if( wrp_len == 8 )
 227                                 PrintAndLog("Card ID: %2X%02X%02X", data_buf[i-4]^crc, data_buf[i-3]^crc, data_buf[i-2]^crc);
 228                 }
 229
 230                 PrintAndLog("Remaining segment payload:  (I %d | K %d | Remain LEN %d)", i, k, remain_seg_payload_len);
 231                 PrintAndLog("\nrow  | data");
 232                 PrintAndLog("-----+------------------------------------------------");
 233                 if ( isXored ) {
 234                         for ( k=i; k < remain_seg_payload_len; ++k)
 235                                 data_buf[k] ^= crc;
 236                 }
 237
 238                 print_hex_break( data_buf+i, remain_seg_payload_len, 16);
 239
 240                 i += remain_seg_payload_len;
 241
 242                 PrintAndLog("-----+------------------------------------------------\n");
 243
 244                 // end with last segment
 245                 if (segment_flag & 0x8) return 0;
 246
 247         } // end for loop
 248         return 0;
 249 }
 250
 251 int CmdLegicRFRead(const char *Cmd) {
 252
 253         // params:
 254         // offset in data
 255         // number of bytes.
 256         char cmdp = param_getchar(Cmd, 0);
 257         if ( cmdp == 'H' || cmdp == 'h' ) return usage_legic_read();
 258
 259         int byte_count=0, offset=0;
 260         sscanf(Cmd, "%i %i", &offset, &byte_count);
 261         if(byte_count == 0) byte_count = -1;
 262         if(byte_count + offset > 1024) byte_count = 1024 - offset;
 263
 264         UsbCommand c= {CMD_READER_LEGIC_RF, {offset, byte_count, 0}};
 265         clearCommandBuffer();
 266         SendCommand(&c);
 267         return 0;
 268 }
 269
 270 int CmdLegicLoad(const char *Cmd) {
 271
 272         char cmdp = param_getchar(Cmd, 0);
 273         if ( cmdp == 'H' || cmdp == 'h' || cmdp == 0x00) return usage_legic_load();
 274
 275         char filename[FILE_PATH_SIZE] = {0x00};
 276         int len = strlen(Cmd);
 277
 278         if (len > FILE_PATH_SIZE) {
 279                 PrintAndLog("Filepath too long (was %s bytes), max allowed is %s ", len, FILE_PATH_SIZE);
 280                 return 0;
 281         }
 282         memcpy(filename, Cmd, len);
 283
 284     FILE *f = fopen(filename, "r");
 285     if(!f) {
 286         PrintAndLog("couldn't open '%s'", Cmd);
 287         return -1;
 288     }
 289
 290     char line[80];
 291         int offset = 0;
 292         uint8_t data[USB_CMD_DATA_SIZE] = {0x00};
 293         int index = 0;
 294         int totalbytes = 0;
 295     while ( fgets(line, sizeof(line), f) ) {
 296         int res = sscanf(line, "%x %x %x %x %x %x %x %x",
 297             (unsigned int *)&data[index],
 298                         (unsigned int *)&data[index + 1],
 299                         (unsigned int *)&data[index + 2],
 300                         (unsigned int *)&data[index + 3],
 301             (unsigned int *)&data[index + 4],
 302                         (unsigned int *)&data[index + 5],
 303                         (unsigned int *)&data[index + 6],
 304                         (unsigned int *)&data[index + 7]);
 305
 306         if(res != 8) {
 307           PrintAndLog("Error: could not read samples");
 308           fclose(f);
 309           return -1;
 310         }
 311                 index += res;
 312
 313                 if ( index == USB_CMD_DATA_SIZE ){
 314 //                      PrintAndLog("sent %d | %d | %d", index, offset, totalbytes);
 315                         UsbCommand c = { CMD_DOWNLOADED_SIM_SAMPLES_125K, {offset, 0, 0}};
 316                         memcpy(c.d.asBytes, data, sizeof(data));
 317                         clearCommandBuffer();
 318                         SendCommand(&c);
 319                         if ( !WaitForResponseTimeout(CMD_ACK, NULL, 1500)){
 320                                 PrintAndLog("Command execute timeout");
 321                                 fclose(f);
 322                                 return 1;
 323                         }
 324                         offset += index;
 325                         totalbytes += index;
 326                         index = 0;
 327                 }
 328     }
 329     fclose(f);
 330
 331         // left over bytes?
 332         if ( index != 0 ) {
 333                 UsbCommand c = { CMD_DOWNLOADED_SIM_SAMPLES_125K, {offset, 0, 0}};
 334                 memcpy(c.d.asBytes, data, 8);
 335                 clearCommandBuffer();
 336                 SendCommand(&c);
 337                 if ( !WaitForResponseTimeout(CMD_ACK, NULL, 1500)){
 338                                 PrintAndLog("Command execute timeout");
 339                                 return 1;
 340                 }
 341                 totalbytes += index;
 342         }
 343
 344     PrintAndLog("loaded %u samples", totalbytes);
 345     return 0;
 346 }
 347
 348 int CmdLegicSave(const char *Cmd) {
 349         int requested = 1024;
 350         int offset = 0;
 351         int delivered = 0;
 352         char filename[FILE_PATH_SIZE];
 353         uint8_t got[1024] = {0x00};
 354
 355         sscanf(Cmd, " %s %i %i", filename, &requested, &offset);
 356
 357         /* If no length given save entire legic read buffer */
 358         /* round up to nearest 8 bytes so the saved data can be used with legicload */
 359         if (requested == 0)
 360                 requested = 1024;
 361
 362         if (requested % 8 != 0) {
 363                 int remainder = requested % 8;
 364                 requested = requested + 8 - remainder;
 365         }
 366
 367         if (offset + requested > sizeof(got)) {
 368                 PrintAndLog("Tried to read past end of buffer, <bytes> + <offset> > 1024");
 369                 return 0;
 370         }
 371
 372         GetFromBigBuf(got, requested, offset);
 373         if ( !WaitForResponseTimeout(CMD_ACK, NULL, 2000)){
 374                 PrintAndLog("Command execute timeout");
 375                 return 1;
 376         }
 377
 378         FILE *f = fopen(filename, "w");
 379         if(!f) {
 380                 PrintAndLog("couldn't open '%s'", Cmd+1);
 381                 return -1;
 382         }
 383
 384         for (int j = 0; j < requested; j += 8) {
 385                 fprintf(f, "%02x %02x %02x %02x %02x %02x %02x %02x\n",
 386                         got[j+0], got[j+1], got[j+2], got[j+3],
 387                         got[j+4], got[j+5],     got[j+6], got[j+7]
 388                 );
 389                 delivered += 8;
 390                 if (delivered >= requested) break;
 391         }
 392
 393         fclose(f);
 394         PrintAndLog("saved %u samples", delivered);
 395         return 0;
 396 }
 397
 398 //TODO: write a help text (iceman)
 399 int CmdLegicRfSim(const char *Cmd) {
 400         UsbCommand c = {CMD_SIMULATE_TAG_LEGIC_RF, {6,3,0}};
 401         sscanf(Cmd, " %"lli" %"lli" %"lli, &c.arg[0], &c.arg[1], &c.arg[2]);
 402         clearCommandBuffer();
 403         SendCommand(&c);
 404         return 0;
 405 }
 406
 407 //TODO: write a help text (iceman)
 408 int CmdLegicRfWrite(const char *Cmd) {
 409     UsbCommand c = {CMD_WRITER_LEGIC_RF};
 410     int res = sscanf(Cmd, " 0x%"llx" 0x%"llx, &c.arg[0], &c.arg[1]);
 411         if(res != 2) {
 412                 PrintAndLog("Please specify the offset and length as two hex strings");
 413         return -1;
 414     }
 415         clearCommandBuffer();
 416     SendCommand(&c);
 417     return 0;
 418 }
 419
 420 int CmdLegicRfFill(const char *Cmd) {
 421     UsbCommand cmd = {CMD_WRITER_LEGIC_RF};
 422     int res = sscanf(Cmd, " 0x%"llx" 0x%"llx" 0x%"llx, &cmd.arg[0], &cmd.arg[1], &cmd.arg[2]);
 423     if(res != 3) {
 424         PrintAndLog("Please specify the offset, length and value as two hex strings");
 425         return -1;
 426     }
 427
 428     int i;
 429     UsbCommand c = {CMD_DOWNLOADED_SIM_SAMPLES_125K, {0, 0, 0}};
 430     for(i = 0; i < 48; i++) {
 431                 c.d.asBytes[i] = cmd.arg[2];
 432     }
 433
 434         for(i = 0; i < 22; i++) {
 435                 c.arg[0] = i*48;
 436                 SendCommand(&c);
 437                 WaitForResponse(CMD_ACK,NULL);
 438         }
 439         clearCommandBuffer();
 440     SendCommand(&cmd);
 441     return 0;
 442  }
 443
 444 int CmdLegicCalcCrc8(const char *Cmd){
 445
 446         int len =  strlen(Cmd);
 447         if ( len & 1 ) return usage_legic_calccrc8();
 448
 449         // add 1 for null terminator.
 450         uint8_t *data = malloc(len+1);
 451         if ( data == NULL ) return 1;
 452
 453         if (param_gethex(Cmd, 0, data, len )) {
 454                 free(data);
 455                 return usage_legic_calccrc8();
 456         }
 457
 458         uint32_t checksum =  CRC8Legic(data, len/2);
 459         PrintAndLog("Bytes: %s || CRC8: %X", sprint_hex(data, len/2), checksum );
 460         free(data);
 461         return 0;
 462 }
 463
 464 static command_t CommandTable[] =  {
 465         {"help",        CmdHelp,        1, "This help"},
 466         {"decode",      CmdLegicDecode, 0, "Display deobfuscated and decoded LEGIC RF tag data (use after hf legic reader)"},
 467         {"read",        CmdLegicRFRead, 0, "[offset][length] -- read bytes from a LEGIC card"},
 468         {"save",        CmdLegicSave,   0, "<filename> [<length>] -- Store samples"},
 469         {"load",        CmdLegicLoad,   0, "<filename> -- Restore samples"},
 470         {"sim",         CmdLegicRfSim,  0, "[phase drift [frame drift [req/resp drift]]] Start tag simulator (use after load or read)"},
 471         {"write",       CmdLegicRfWrite,0, "<offset> <length> -- Write sample buffer (user after load or read)"},
 472         {"fill",        CmdLegicRfFill, 0, "<offset> <length> <value> -- Fill/Write tag with constant value"},
 473         {"crc8",        CmdLegicCalcCrc8, 1, "Calculate Legic CRC8 over given hexbytes"},
 474         {NULL, NULL, 0, NULL}
 475 };
 476
 477 int CmdHFLegic(const char *Cmd) {
 478         clearCommandBuffer();
 479         CmdsParse(CommandTable, Cmd);
 480         return 0;
 481 }
 482
 483 int CmdHelp(const char *Cmd) {
 484         CmdsHelp(CommandTable);
 485         return 0;
 486 }