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 // Low frequency EM4x commands
9 //-----------------------------------------------------------------------------
14 #include "proxmark3.h"
18 #include "cmdparser.h"
21 #include "cmdlfem4x.h"
26 char *global_em410xId
;
28 static int CmdHelp(const char *Cmd
);
30 int CmdEMdemodASK(const char *Cmd
)
32 char cmdp
= param_getchar(Cmd
, 0);
33 int findone
= (cmdp
== '1') ? 1 : 0;
34 UsbCommand c
={CMD_EM410X_DEMOD
};
40 /* Read the ID of an EM410x tag.
42 * 1111 1111 1 <-- standard non-repeatable header
43 * XXXX [row parity bit] <-- 10 rows of 5 bits for our 40 bit tag ID
45 * CCCC <-- each bit here is parity for the 10 bits above in corresponding column
46 * 0 <-- stop bit, end of tag
48 int CmdEM410xRead(const char *Cmd
)
53 if(!AskEm410xDemod("", &hi
, &lo
, false)) return 0;
54 PrintAndLog("EM410x pattern found: ");
57 PrintAndLog ("EM410x XL pattern found");
61 sprintf(id
, "%010llx",lo
);
67 // emulate an EM410X tag
68 int CmdEM410xSim(const char *Cmd
)
70 int i
, n
, j
, binary
[4], parity
[4];
72 char cmdp
= param_getchar(Cmd
, 0);
73 uint8_t uid
[5] = {0x00};
75 if (cmdp
== 'h' || cmdp
== 'H') {
76 PrintAndLog("Usage: lf em4x 410xsim <UID>");
78 PrintAndLog(" sample: lf em4x 410xsim 0F0368568B");
82 if (param_gethex(Cmd
, 0, uid
, 10)) {
83 PrintAndLog("UID must include 10 HEX symbols");
87 PrintAndLog("Starting simulating UID %02X%02X%02X%02X%02X", uid
[0],uid
[1],uid
[2],uid
[3],uid
[4]);
88 PrintAndLog("Press pm3-button to about simulation");
90 /* clock is 64 in EM410x tags */
96 /* write 9 start bits */
97 for (i
= 0; i
< 9; i
++)
98 AppendGraph(0, clock
, 1);
100 /* for each hex char */
101 parity
[0] = parity
[1] = parity
[2] = parity
[3] = 0;
102 for (i
= 0; i
< 10; i
++)
104 /* read each hex char */
105 sscanf(&Cmd
[i
], "%1x", &n
);
106 for (j
= 3; j
>= 0; j
--, n
/= 2)
109 /* append each bit */
110 AppendGraph(0, clock
, binary
[0]);
111 AppendGraph(0, clock
, binary
[1]);
112 AppendGraph(0, clock
, binary
[2]);
113 AppendGraph(0, clock
, binary
[3]);
115 /* append parity bit */
116 AppendGraph(0, clock
, binary
[0] ^ binary
[1] ^ binary
[2] ^ binary
[3]);
118 /* keep track of column parity */
119 parity
[0] ^= binary
[0];
120 parity
[1] ^= binary
[1];
121 parity
[2] ^= binary
[2];
122 parity
[3] ^= binary
[3];
126 AppendGraph(0, clock
, parity
[0]);
127 AppendGraph(0, clock
, parity
[1]);
128 AppendGraph(0, clock
, parity
[2]);
129 AppendGraph(0, clock
, parity
[3]);
132 AppendGraph(1, clock
, 0);
134 CmdLFSim("0"); //240 start_gap.
138 /* Function is equivalent of lf read + data samples + em410xread
139 * looped until an EM410x tag is detected
141 * Why is CmdSamples("16000")?
142 * TBD: Auto-grow sample size based on detected sample rate. IE: If the
143 * rate gets lower, then grow the number of samples
144 * Changed by martin, 4000 x 4 = 16000,
145 * see http://www.proxmark.org/forum/viewtopic.php?pid=7235#p7235
147 int CmdEM410xWatch(const char *Cmd
)
151 printf("\naborted via keyboard!\n");
156 getSamples("8201",true); //capture enough to get 2 complete preambles (4096*2+9)
157 } while (!CmdEM410xRead(""));
162 //currently only supports manchester modulations
163 int CmdEM410xWatchnSpoof(const char *Cmd
)
166 PrintAndLog("# Replaying captured ID: %s",global_em410xId
);
171 int CmdEM410xWrite(const char *Cmd
)
173 uint64_t id
= 0xFFFFFFFFFFFFFFFF; // invalid id value
174 int card
= 0xFF; // invalid card value
175 unsigned int clock
= 0; // invalid clock value
177 sscanf(Cmd
, "%" PRIx64
" %d %d", &id
, &card
, &clock
);
180 if (id
== 0xFFFFFFFFFFFFFFFF) {
181 PrintAndLog("Error! ID is required.\n");
184 if (id
>= 0x10000000000) {
185 PrintAndLog("Error! Given EM410x ID is longer than 40 bits.\n");
191 PrintAndLog("Error! Card type required.\n");
195 PrintAndLog("Error! Bad card type selected.\n");
206 // Allowed clock rates: 16, 32 and 64
207 if ((clock
!= 16) && (clock
!= 32) && (clock
!= 64)) {
208 PrintAndLog("Error! Clock rate %d not valid. Supported clock rates are 16, 32 and 64.\n", clock
);
214 PrintAndLog("Error! Clock rate is only supported on T55x7 tags.\n");
219 PrintAndLog("Writing %s tag with UID 0x%010" PRIx64
" (clock rate: %d)", "T55x7", id
, clock
);
220 // NOTE: We really should pass the clock in as a separate argument, but to
221 // provide for backwards-compatibility for older firmware, and to avoid
222 // having to add another argument to CMD_EM410X_WRITE_TAG, we just store
223 // the clock rate in bits 8-15 of the card value
224 card
= (card
& 0xFF) | (((uint64_t)clock
<< 8) & 0xFF00);
227 PrintAndLog("Writing %s tag with UID 0x%010" PRIx64
, "T5555", id
, clock
);
229 PrintAndLog("Error! Bad card type selected.\n");
233 UsbCommand c
= {CMD_EM410X_WRITE_TAG
, {card
, (uint32_t)(id
>> 32), (uint32_t)id
}};
239 bool EM_EndParityTest(uint8_t *BitStream
, size_t size
, uint8_t rows
, uint8_t cols
, uint8_t pType
)
241 if (rows
*cols
>size
) return false;
243 //assume last col is a parity and do not test
244 for (uint8_t colNum
= 0; colNum
< cols
-1; colNum
++) {
245 for (uint8_t rowNum
= 0; rowNum
< rows
; rowNum
++) {
246 colP
^= BitStream
[(rowNum
*cols
)+colNum
];
248 if (colP
!= pType
) return false;
253 bool EM_ByteParityTest(uint8_t *BitStream
, size_t size
, uint8_t rows
, uint8_t cols
, uint8_t pType
)
255 if (rows
*cols
>size
) return false;
257 //assume last row is a parity row and do not test
258 for (uint8_t rowNum
= 0; rowNum
< rows
-1; rowNum
++) {
259 for (uint8_t colNum
= 0; colNum
< cols
; colNum
++) {
260 rowP
^= BitStream
[(rowNum
*cols
)+colNum
];
262 if (rowP
!= pType
) return false;
267 uint32_t OutputEM4x50_Block(uint8_t *BitStream
, size_t size
, bool verbose
, bool pTest
)
269 if (size
<45) return 0;
270 uint32_t code
= bytebits_to_byte(BitStream
,8);
271 code
= code
<<8 | bytebits_to_byte(BitStream
+9,8);
272 code
= code
<<8 | bytebits_to_byte(BitStream
+18,8);
273 code
= code
<<8 | bytebits_to_byte(BitStream
+27,8);
274 if (verbose
|| g_debugMode
){
275 for (uint8_t i
= 0; i
<5; i
++){
276 if (i
== 4) PrintAndLog(""); //parity byte spacer
277 PrintAndLog("%d%d%d%d%d%d%d%d %d -> 0x%02x",
287 bytebits_to_byte(BitStream
+i
*9,8)
291 PrintAndLog("Parity Passed");
293 PrintAndLog("Parity Failed");
297 /* Read the transmitted data of an EM4x50 tag
300 * XXXXXXXX [row parity bit (even)] <- 8 bits plus parity
301 * XXXXXXXX [row parity bit (even)] <- 8 bits plus parity
302 * XXXXXXXX [row parity bit (even)] <- 8 bits plus parity
303 * XXXXXXXX [row parity bit (even)] <- 8 bits plus parity
304 * CCCCCCCC <- column parity bits
306 * LW <- Listen Window
308 * This pattern repeats for every block of data being transmitted.
309 * Transmission starts with two Listen Windows (LW - a modulated
310 * pattern of 320 cycles each (32/32/128/64/64)).
312 * Note that this data may or may not be the UID. It is whatever data
313 * is stored in the blocks defined in the control word First and Last
314 * Word Read values. UID is stored in block 32.
316 //completed by Marshmellow
317 int EM4x50Read(const char *Cmd
, bool verbose
)
319 uint8_t fndClk
[] = {8,16,32,40,50,64,128};
323 int i
, j
, startblock
, skip
, block
, start
, end
, low
, high
, minClk
;
324 bool complete
= false;
325 int tmpbuff
[MAX_GRAPH_TRACE_LEN
/ 64];
331 memset(tmpbuff
, 0, MAX_GRAPH_TRACE_LEN
/ 64);
333 // get user entry if any
334 sscanf(Cmd
, "%i %i", &clk
, &invert
);
336 // save GraphBuffer - to restore it later
339 // first get high and low values
340 for (i
= 0; i
< GraphTraceLen
; i
++) {
341 if (GraphBuffer
[i
] > high
)
342 high
= GraphBuffer
[i
];
343 else if (GraphBuffer
[i
] < low
)
344 low
= GraphBuffer
[i
];
350 // get to first full low to prime loop and skip incomplete first pulse
351 while ((GraphBuffer
[i
] < high
) && (i
< GraphTraceLen
))
353 while ((GraphBuffer
[i
] > low
) && (i
< GraphTraceLen
))
357 // populate tmpbuff buffer with pulse lengths
358 while (i
< GraphTraceLen
) {
359 // measure from low to low
360 while ((GraphBuffer
[i
] > low
) && (i
< GraphTraceLen
))
363 while ((GraphBuffer
[i
] < high
) && (i
< GraphTraceLen
))
365 while ((GraphBuffer
[i
] > low
) && (i
< GraphTraceLen
))
367 if (j
>=(MAX_GRAPH_TRACE_LEN
/64)) {
370 tmpbuff
[j
++]= i
- start
;
371 if (i
-start
< minClk
&& i
< GraphTraceLen
) {
377 for (uint8_t clkCnt
= 0; clkCnt
<7; clkCnt
++) {
378 tol
= fndClk
[clkCnt
]/8;
379 if (minClk
>= fndClk
[clkCnt
]-tol
&& minClk
<= fndClk
[clkCnt
]+1) {
387 // look for data start - should be 2 pairs of LW (pulses of clk*3,clk*2)
389 for (i
= 0; i
< j
- 4 ; ++i
) {
391 if (tmpbuff
[i
] >= clk
*3-tol
&& tmpbuff
[i
] <= clk
*3+tol
) //3 clocks
392 if (tmpbuff
[i
+1] >= clk
*2-tol
&& tmpbuff
[i
+1] <= clk
*2+tol
) //2 clocks
393 if (tmpbuff
[i
+2] >= clk
*3-tol
&& tmpbuff
[i
+2] <= clk
*3+tol
) //3 clocks
394 if (tmpbuff
[i
+3] >= clk
-tol
) //1.5 to 2 clocks - depends on bit following
402 // skip over the remainder of LW
403 skip
+= tmpbuff
[i
+1] + tmpbuff
[i
+2] + clk
;
404 if (tmpbuff
[i
+3]>clk
)
405 phaseoff
= tmpbuff
[i
+3]-clk
;
408 // now do it again to find the end
410 for (i
+= 3; i
< j
- 4 ; ++i
) {
412 if (tmpbuff
[i
] >= clk
*3-tol
&& tmpbuff
[i
] <= clk
*3+tol
) //3 clocks
413 if (tmpbuff
[i
+1] >= clk
*2-tol
&& tmpbuff
[i
+1] <= clk
*2+tol
) //2 clocks
414 if (tmpbuff
[i
+2] >= clk
*3-tol
&& tmpbuff
[i
+2] <= clk
*3+tol
) //3 clocks
415 if (tmpbuff
[i
+3] >= clk
-tol
) //1.5 to 2 clocks - depends on bit following
423 if (verbose
|| g_debugMode
) {
425 PrintAndLog("\nNote: one block = 50 bits (32 data, 12 parity, 6 marker)");
427 PrintAndLog("No data found!, clock tried:%d",clk
);
428 PrintAndLog("Try again with more samples.");
429 PrintAndLog(" or after a 'data askedge' command to clean up the read");
432 } else if (start
< 0) return 0;
434 snprintf(tmp2
, sizeof(tmp2
),"%d %d 1000 %d", clk
, invert
, clk
*47);
435 // get rid of leading crap
436 snprintf(tmp
, sizeof(tmp
), "%i", skip
);
439 bool AllPTest
= true;
440 // now work through remaining buffer printing out data blocks
444 if (verbose
|| g_debugMode
) PrintAndLog("\nBlock %i:", block
);
447 // look for LW before start of next block
448 for ( ; i
< j
- 4 ; ++i
) {
450 if (tmpbuff
[i
] >= clk
*3-tol
&& tmpbuff
[i
] <= clk
*3+tol
)
451 if (tmpbuff
[i
+1] >= clk
-tol
)
454 if (i
>= j
-4) break; //next LW not found
456 if (tmpbuff
[i
+1]>clk
)
457 phaseoff
= tmpbuff
[i
+1]-clk
;
461 if (ASKDemod(tmp2
, false, false, 1) < 1) {
465 //set DemodBufferLen to just one block
466 DemodBufferLen
= skip
/clk
;
468 pTest
= EM_ByteParityTest(DemodBuffer
,DemodBufferLen
,5,9,0);
469 pTest
&= EM_EndParityTest(DemodBuffer
,DemodBufferLen
,5,9,0);
472 Code
[block
] = OutputEM4x50_Block(DemodBuffer
,DemodBufferLen
,verbose
, pTest
);
473 if (g_debugMode
) PrintAndLog("\nskipping %d samples, bits:%d", skip
, skip
/clk
);
474 //skip to start of next block
475 snprintf(tmp
,sizeof(tmp
),"%i",skip
);
478 if (i
>= end
) break; //in case chip doesn't output 6 blocks
481 if (verbose
|| g_debugMode
|| AllPTest
){
483 PrintAndLog("*** Warning!");
484 PrintAndLog("Partial data - no end found!");
485 PrintAndLog("Try again with more samples.");
487 PrintAndLog("Found data at sample: %i - using clock: %i", start
, clk
);
489 for (block
=0; block
< end
; block
++){
490 PrintAndLog("Block %d: %08x",block
,Code
[block
]);
493 PrintAndLog("Parities Passed");
495 PrintAndLog("Parities Failed");
496 PrintAndLog("Try cleaning the read samples with 'data askedge'");
500 //restore GraphBuffer
502 return (int)AllPTest
;
505 int CmdEM4x50Read(const char *Cmd
)
507 return EM4x50Read(Cmd
, true);
510 int CmdReadWord(const char *Cmd
)
512 int Word
= -1; //default to invalid word
515 sscanf(Cmd
, "%d", &Word
);
517 if ( (Word
> 15) | (Word
< 0) ) {
518 PrintAndLog("Word must be between 0 and 15");
522 PrintAndLog("Reading word %d", Word
);
524 c
.cmd
= CMD_EM4X_READ_WORD
;
525 c
.d
.asBytes
[0] = 0x0; //Normal mode
533 int CmdReadWordPWD(const char *Cmd
)
535 int Word
= -1; //default to invalid word
536 int Password
= 0xFFFFFFFF; //default to blank password
539 sscanf(Cmd
, "%d %x", &Word
, &Password
);
541 if ( (Word
> 15) | (Word
< 0) ) {
542 PrintAndLog("Word must be between 0 and 15");
546 PrintAndLog("Reading word %d with password %08X", Word
, Password
);
548 c
.cmd
= CMD_EM4X_READ_WORD
;
549 c
.d
.asBytes
[0] = 0x1; //Password mode
557 int CmdWriteWord(const char *Cmd
)
559 int Word
= 16; //default to invalid block
560 int Data
= 0xFFFFFFFF; //default to blank data
563 sscanf(Cmd
, "%x %d", &Data
, &Word
);
566 PrintAndLog("Word must be between 0 and 15");
570 PrintAndLog("Writing word %d with data %08X", Word
, Data
);
572 c
.cmd
= CMD_EM4X_WRITE_WORD
;
573 c
.d
.asBytes
[0] = 0x0; //Normal mode
581 int CmdWriteWordPWD(const char *Cmd
)
583 int Word
= 16; //default to invalid word
584 int Data
= 0xFFFFFFFF; //default to blank data
585 int Password
= 0xFFFFFFFF; //default to blank password
588 sscanf(Cmd
, "%x %d %x", &Data
, &Word
, &Password
);
591 PrintAndLog("Word must be between 0 and 15");
595 PrintAndLog("Writing word %d with data %08X and password %08X", Word
, Data
, Password
);
597 c
.cmd
= CMD_EM4X_WRITE_WORD
;
598 c
.d
.asBytes
[0] = 0x1; //Password mode
606 static command_t CommandTable
[] =
608 {"help", CmdHelp
, 1, "This help"},
609 {"em410xdemod", CmdEMdemodASK
, 0, "[findone] -- Extract ID from EM410x tag (option 0 for continuous loop, 1 for only 1 tag)"},
610 {"em410xread", CmdEM410xRead
, 1, "[clock rate] -- Extract ID from EM410x tag in GraphBuffer"},
611 {"em410xsim", CmdEM410xSim
, 0, "<UID> -- Simulate EM410x tag"},
612 {"em410xwatch", CmdEM410xWatch
, 0, "['h'] -- Watches for EM410x 125/134 kHz tags (option 'h' for 134)"},
613 {"em410xspoof", CmdEM410xWatchnSpoof
, 0, "['h'] --- Watches for EM410x 125/134 kHz tags, and replays them. (option 'h' for 134)" },
614 {"em410xwrite", CmdEM410xWrite
, 0, "<UID> <'0' T5555> <'1' T55x7> [clock rate] -- Write EM410x UID to T5555(Q5) or T55x7 tag, optionally setting clock rate"},
615 {"em4x50read", CmdEM4x50Read
, 1, "Extract data from EM4x50 tag"},
616 {"readword", CmdReadWord
, 1, "<Word> -- Read EM4xxx word data"},
617 {"readwordPWD", CmdReadWordPWD
, 1, "<Word> <Password> -- Read EM4xxx word data in password mode"},
618 {"writeword", CmdWriteWord
, 1, "<Data> <Word> -- Write EM4xxx word data"},
619 {"writewordPWD", CmdWriteWordPWD
, 1, "<Data> <Word> <Password> -- Write EM4xxx word data in password mode"},
620 {NULL
, NULL
, 0, NULL
}
623 int CmdLFEM4X(const char *Cmd
)
625 CmdsParse(CommandTable
, Cmd
);
629 int CmdHelp(const char *Cmd
)
631 CmdsHelp(CommandTable
);