1 //-----------------------------------------------------------------------------
2 // Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
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
7 //-----------------------------------------------------------------------------
8 // High frequency Legic commands
9 //-----------------------------------------------------------------------------
13 #include "proxmark3.h"
16 #include "cmdparser.h"
17 #include "cmdhflegic.h"
21 static int CmdHelp(const char *Cmd
);
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");
30 PrintAndLog("Sample : hf legic crc8 deadbeef1122");
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");
42 * Output BigBuf and deobfuscate LEGIC RF tag data.
43 * This is based on information given in the talk held
44 * by Henryk Ploetz and Karsten Nohl at 26c3
46 int CmdLegicDecode(const char *Cmd
) {
47 // Index for the bytearray.
49 int k
= 0, segmentNum
;
52 uint8_t stamp_len
= 0;
56 uint8_t data_buf
[1200]; // receiver buffer, should be 1024..
59 // copy data from proxmark into buffer
60 GetFromBigBuf(data_buf
,sizeof(data_buf
),0);
61 WaitForResponse(CMD_ACK
,NULL
);
63 // Output CDF System area (9 bytes) plus remaining header area (12 bytes)
65 uint32_t calc_crc
= CRC8Legic(data_buf
, 4);
67 PrintAndLog("\nCDF: System Area");
69 PrintAndLog("MCD: %02x, MSN: %02x %02x %02x, MCC: %02x %s",
75 (calc_crc
== crc
) ? "OK":"Fail"
78 switch (data_buf
[5] & 0x7f) {
80 strncpy(token_type
, "IAM",sizeof(token_type
));
83 strncpy(token_type
, "SAM",sizeof(token_type
));
86 strncpy(token_type
, "GAM",sizeof(token_type
));
89 strncpy(token_type
, "???",sizeof(token_type
));
93 stamp_len
= 0xfc - data_buf
[6];
95 PrintAndLog("DCF: %02x %02x, Token Type=%s (OLE=%01u), Stamp len=%02u",
99 (data_buf
[5]&0x80)>>7,
103 PrintAndLog("WRP=%02u, WRC=%01u, RD=%01u, raw=%02x, SSC=%02x",
105 (data_buf
[7]&0x70)>>4,
106 (data_buf
[7]&0x80)>>7,
111 PrintAndLog("Remaining Header Area");
112 PrintAndLog("%s", sprint_hex(data_buf
+9, 13));
114 uint8_t segCrcBytes
[8] = {0x00};
115 uint32_t segCalcCRC
= 0;
118 PrintAndLog("\nADF: User Area");
119 printf("-------------------------------------\n");
121 // 64 potential segements
122 for ( segmentNum
=0; segmentNum
<64; segmentNum
++ ) {
123 segment_len
= ((data_buf
[i
+1]^crc
)&0x0f) * 256 + (data_buf
[i
]^crc
);
124 segment_flag
= ((data_buf
[i
+1]^crc
)&0xf0)>>4;
126 wrp
= (data_buf
[i
+2]^crc
);
127 wrc
= ((data_buf
[i
+3]^crc
)&0x70)>>4;
129 bool hasWRC
= (wrc
> 0);
130 bool hasWRP
= (wrp
> wrc
);
131 int wrp_len
= (wrp
- wrc
);
132 int remain_seg_payload_len
= (segment_len
- wrp
- 5);
134 // validate segment-crc
135 segCrcBytes
[0]=data_buf
[0]; //uid0
136 segCrcBytes
[1]=data_buf
[1]; //uid1
137 segCrcBytes
[2]=data_buf
[2]; //uid2
138 segCrcBytes
[3]=data_buf
[3]; //uid3
139 segCrcBytes
[4]=(data_buf
[i
]^crc
); //hdr0
140 segCrcBytes
[5]=(data_buf
[i
+1]^crc
); //hdr1
141 segCrcBytes
[6]=(data_buf
[i
+2]^crc
); //hdr2
142 segCrcBytes
[7]=(data_buf
[i
+3]^crc
); //hdr3
144 segCalcCRC
= CRC8Legic(segCrcBytes
, 8);
145 segCRC
= data_buf
[i
+4]^crc
;
147 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)",
155 (segment_flag
& 0x4) >> 2,
156 (segment_flag
& 0x8) >> 3,
159 ((data_buf
[i
+3]^crc
) & 0x80) >> 7,
161 ( segCRC
== segCalcCRC
) ? "OK" : "fail"
167 PrintAndLog("WRC protected area: (I %d | K %d| WRC %d)", i
, k
, wrc
);
169 for ( k
=i
; k
< wrc
; k
++)
174 // for ( k=i; k < wrc; k += 8)
175 print_hex_break( data_buf
+i
, wrc
, 16);
181 PrintAndLog("Remaining write protected area: (I %d | K %d | WRC %d | WRP %d WRP_LEN %d)",i
, k
, wrc
, wrp
, wrp_len
);
183 // de-xor? if not zero, assume it needs xoring.
184 if ( data_buf
[i
] > 0) {
185 for (k
=i
; k
< wrp_len
; k
++)
189 // for (k=i; k < wrp_len; k += 16) {
191 print_hex_break( data_buf
+i
, wrp_len
, 16);
197 PrintAndLog("Card ID: %2X%02X%02X", data_buf
[i
-4]^crc
, data_buf
[i
-3]^crc
, data_buf
[i
-2]^crc
);
200 PrintAndLog("Remaining segment payload:");
202 if ( data_buf
[i
] > 0 ) {
203 for ( k
=i
; k
< remain_seg_payload_len
; k
++)
207 // for ( k=i; k < remain_seg_payload_len; k++)
208 print_hex_break( data_buf
+i
, remain_seg_payload_len
, 16);
210 i
+= remain_seg_payload_len
;
212 printf("\n-------------------------------------\n");
213 // end with last segment
214 if (segment_flag
& 0x8) return 0;
220 int CmdLegicRFRead(const char *Cmd
) {
221 int byte_count
=0, offset
=0;
222 sscanf(Cmd
, "%i %i", &offset
, &byte_count
);
223 if(byte_count
== 0) byte_count
= -1;
224 if(byte_count
+ offset
> 1024) byte_count
= 1024 - offset
;
226 UsbCommand c
= {CMD_READER_LEGIC_RF
, {offset
, byte_count
, 0}};
227 clearCommandBuffer();
232 int CmdLegicLoad(const char *Cmd
) {
234 char cmdp
= param_getchar(Cmd
, 0);
235 if ( cmdp
== 'H' || cmdp
== 'h' || cmdp
== 0x00) return usage_legic_load();
237 char filename
[FILE_PATH_SIZE
] = {0x00};
238 int len
= strlen(Cmd
);
240 if (len
> FILE_PATH_SIZE
) {
241 PrintAndLog("Filepath too long (was %s bytes), max allowed is %s ", len
, FILE_PATH_SIZE
);
244 memcpy(filename
, Cmd
, len
);
246 FILE *f
= fopen(filename
, "r");
248 PrintAndLog("couldn't open '%s'", Cmd
);
254 uint8_t data
[USB_CMD_DATA_SIZE
] = {0x00};
257 while ( fgets(line
, sizeof(line
), f
) ) {
258 int res
= sscanf(line
, "%x %x %x %x %x %x %x %x",
259 (unsigned int *)&data
[index
],
260 (unsigned int *)&data
[index
+ 1],
261 (unsigned int *)&data
[index
+ 2],
262 (unsigned int *)&data
[index
+ 3],
263 (unsigned int *)&data
[index
+ 4],
264 (unsigned int *)&data
[index
+ 5],
265 (unsigned int *)&data
[index
+ 6],
266 (unsigned int *)&data
[index
+ 7]);
269 PrintAndLog("Error: could not read samples");
275 if ( index
== USB_CMD_DATA_SIZE
){
276 // PrintAndLog("sent %d | %d | %d", index, offset, totalbytes);
277 UsbCommand c
= { CMD_DOWNLOADED_SIM_SAMPLES_125K
, {offset
, 0, 0}};
278 memcpy(c
.d
.asBytes
, data
, sizeof(data
));
279 clearCommandBuffer();
281 if ( !WaitForResponseTimeout(CMD_ACK
, NULL
, 1500)){
282 PrintAndLog("Command execute timeout");
295 UsbCommand c
= { CMD_DOWNLOADED_SIM_SAMPLES_125K
, {offset
, 0, 0}};
296 memcpy(c
.d
.asBytes
, data
, 8);
297 clearCommandBuffer();
299 if ( !WaitForResponseTimeout(CMD_ACK
, NULL
, 1500)){
300 PrintAndLog("Command execute timeout");
306 PrintAndLog("loaded %u samples", totalbytes
);
310 int CmdLegicSave(const char *Cmd
) {
311 int requested
= 1024;
314 char filename
[FILE_PATH_SIZE
];
315 uint8_t got
[1024] = {0x00};
317 sscanf(Cmd
, " %s %i %i", filename
, &requested
, &offset
);
319 /* If no length given save entire legic read buffer */
320 /* round up to nearest 8 bytes so the saved data can be used with legicload */
324 if (requested
% 8 != 0) {
325 int remainder
= requested
% 8;
326 requested
= requested
+ 8 - remainder
;
329 if (offset
+ requested
> sizeof(got
)) {
330 PrintAndLog("Tried to read past end of buffer, <bytes> + <offset> > 1024");
334 FILE *f
= fopen(filename
, "w");
336 PrintAndLog("couldn't open '%s'", Cmd
+1);
340 GetFromBigBuf(got
, requested
, offset
);
341 WaitForResponse(CMD_ACK
, NULL
);
343 for (int j
= 0; j
< requested
; j
+= 8) {
344 fprintf(f
, "%02x %02x %02x %02x %02x %02x %02x %02x\n",
345 got
[j
+0], got
[j
+1], got
[j
+2], got
[j
+3],
346 got
[j
+4], got
[j
+5], got
[j
+6], got
[j
+7]
349 if (delivered
>= requested
) break;
353 PrintAndLog("saved %u samples", delivered
);
357 int CmdLegicRfSim(const char *Cmd
) {
358 UsbCommand c
= {CMD_SIMULATE_TAG_LEGIC_RF
, {6,3,0}};
359 sscanf(Cmd
, " %"lli
" %"lli
" %"lli
, &c
.arg
[0], &c
.arg
[1], &c
.arg
[2]);
360 clearCommandBuffer();
365 int CmdLegicRfWrite(const char *Cmd
) {
366 UsbCommand c
= {CMD_WRITER_LEGIC_RF
};
367 int res
= sscanf(Cmd
, " 0x%"llx
" 0x%"llx
, &c
.arg
[0], &c
.arg
[1]);
369 PrintAndLog("Please specify the offset and length as two hex strings");
372 clearCommandBuffer();
377 int CmdLegicRfFill(const char *Cmd
) {
378 UsbCommand cmd
= {CMD_WRITER_LEGIC_RF
};
379 int res
= sscanf(Cmd
, " 0x%"llx
" 0x%"llx
" 0x%"llx
, &cmd
.arg
[0], &cmd
.arg
[1], &cmd
.arg
[2]);
381 PrintAndLog("Please specify the offset, length and value as two hex strings");
386 UsbCommand c
= {CMD_DOWNLOADED_SIM_SAMPLES_125K
, {0, 0, 0}};
387 for(i
= 0; i
< 48; i
++) {
388 c
.d
.asBytes
[i
] = cmd
.arg
[2];
391 for(i
= 0; i
< 22; i
++) {
394 WaitForResponse(CMD_ACK
,NULL
);
396 clearCommandBuffer();
401 int CmdLegicCalcCrc8(const char *Cmd
){
403 int len
= strlen(Cmd
);
404 if (len
& 1 ) return usage_legic_calccrc8();
406 uint8_t *data
= malloc(len
);
407 if ( data
== NULL
) return 1;
409 param_gethex(Cmd
, 0, data
, len
);
411 uint32_t checksum
= CRC8Legic(data
, len
/2);
412 PrintAndLog("Bytes: %s || CRC8: %X", sprint_hex(data
, len
/2), checksum
);
417 static command_t CommandTable
[] = {
418 {"help", CmdHelp
, 1, "This help"},
419 {"decode", CmdLegicDecode
, 0, "Display deobfuscated and decoded LEGIC RF tag data (use after hf legic reader)"},
420 {"read", CmdLegicRFRead
, 0, "[offset][length] -- read bytes from a LEGIC card"},
421 {"save", CmdLegicSave
, 0, "<filename> [<length>] -- Store samples"},
422 {"load", CmdLegicLoad
, 0, "<filename> -- Restore samples"},
423 {"sim", CmdLegicRfSim
, 0, "[phase drift [frame drift [req/resp drift]]] Start tag simulator (use after load or read)"},
424 {"write", CmdLegicRfWrite
,0, "<offset> <length> -- Write sample buffer (user after load or read)"},
425 {"fill", CmdLegicRfFill
, 0, "<offset> <length> <value> -- Fill/Write tag with constant value"},
426 {"crc8", CmdLegicCalcCrc8
, 1, "Calculate Legic CRC8 over given hexbytes"},
427 {NULL
, NULL
, 0, NULL
}
430 int CmdHFLegic(const char *Cmd
) {
431 clearCommandBuffer();
432 CmdsParse(CommandTable
, Cmd
);
436 int CmdHelp(const char *Cmd
) {
437 CmdsHelp(CommandTable
);