1 //-----------------------------------------------------------------------------
2 // This code is licensed to you under the terms of the GNU GPL, version 2 or,
3 // at your option, any later version. See the LICENSE.txt file for the text of
5 //-----------------------------------------------------------------------------
6 // Hitag2 emulation (preliminary test version)
8 // (c) 2009 Henryk Plötz <henryk@ploetzli.ch>
9 //-----------------------------------------------------------------------------
10 // Hitag2 complete rewrite of the code
11 // - Fixed modulation/encoding issues
12 // - Rewrote code for transponder emulation
13 // - Added snooping of transponder communication
14 // - Added reader functionality
16 // (c) 2012 Roel Verdult
17 //-----------------------------------------------------------------------------
19 #include "proxmark3.h"
28 static bool bAuthenticating
;
30 static bool bSuccessful
;
35 TAG_STATE_RESET
= 0x01, // Just powered up, awaiting GetSnr
36 TAG_STATE_ACTIVATING
= 0x02 , // In activation phase (password mode), sent UID, awaiting reader password
37 TAG_STATE_ACTIVATED
= 0x03, // Activation complete, awaiting read/write commands
38 TAG_STATE_WRITING
= 0x04, // In write command, awaiting sector contents to be written
40 unsigned int active_sector
;
43 byte_t sectors
[12][4];
46 static struct hitag2_tag tag
= {
47 .state
= TAG_STATE_RESET
,
48 .sectors
= { // Password mode: | Crypto mode:
49 [0] = { 0x02, 0x4e, 0x02, 0x20}, // UID | UID
50 [1] = { 0x4d, 0x49, 0x4b, 0x52}, // Password RWD | 32 bit LSB key
51 [2] = { 0x20, 0xf0, 0x4f, 0x4e}, // Reserved | 16 bit MSB key, 16 bit reserved
52 [3] = { 0x0e, 0xaa, 0x48, 0x54}, // Configuration, password TAG | Configuration, password TAG
53 [4] = { 0x46, 0x5f, 0x4f, 0x4b}, // Data: F_OK
54 [5] = { 0x55, 0x55, 0x55, 0x55}, // Data: UUUU
55 [6] = { 0xaa, 0xaa, 0xaa, 0xaa}, // Data: ....
56 [7] = { 0x55, 0x55, 0x55, 0x55}, // Data: UUUU
57 [8] = { 0x00, 0x00, 0x00, 0x00}, // RSK Low
58 [9] = { 0x00, 0x00, 0x00, 0x00}, // RSK High
59 [10] = { 0x00, 0x00, 0x00, 0x00}, // RCF
60 [11] = { 0x00, 0x00, 0x00, 0x00}, // SYNC
64 // ToDo: define a meaningful maximum size for auth_table. The bigger this is, the lower will be the available memory for traces.
65 // Historically it used to be FREE_BUFFER_SIZE, which was 2744.
66 #define AUTH_TABLE_LENGTH 2744
67 static byte_t
* auth_table
;
68 static size_t auth_table_pos
= 0;
69 static size_t auth_table_len
= AUTH_TABLE_LENGTH
;
71 static byte_t password
[4];
72 static byte_t NrAr
[8];
74 static uint64_t cipher_state
;
76 /* Following is a modified version of cryptolib.com/ciphers/hitag2/ */
77 // Software optimized 48-bit Philips/NXP Mifare Hitag2 PCF7936/46/47/52 stream cipher algorithm by I.C. Wiener 2006-2007.
78 // For educational purposes only.
79 // No warranties or guarantees of any kind.
80 // This code is released into the public domain by its author.
87 #define rev8(x) ((((x)>>7)&1)+((((x)>>6)&1)<<1)+((((x)>>5)&1)<<2)+((((x)>>4)&1)<<3)+((((x)>>3)&1)<<4)+((((x)>>2)&1)<<5)+((((x)>>1)&1)<<6)+(((x)&1)<<7))
88 #define rev16(x) (rev8 (x)+(rev8 (x>> 8)<< 8))
89 #define rev32(x) (rev16(x)+(rev16(x>>16)<<16))
90 #define rev64(x) (rev32(x)+(rev32(x>>32)<<32))
91 #define bit(x,n) (((x)>>(n))&1)
92 #define bit32(x,n) ((((x)[(n)>>5])>>((n)))&1)
93 #define inv32(x,i,n) ((x)[(i)>>5]^=((u32)(n))<<((i)&31))
94 #define rotl64(x, n) ((((u64)(x))<<((n)&63))+(((u64)(x))>>((0-(n))&63)))
96 // Single bit Hitag2 functions:
97 #define i4(x,a,b,c,d) ((u32)((((x)>>(a))&1)+(((x)>>(b))&1)*2+(((x)>>(c))&1)*4+(((x)>>(d))&1)*8))
99 static const u32 ht2_f4a
= 0x2C79; // 0010 1100 0111 1001
100 static const u32 ht2_f4b
= 0x6671; // 0110 0110 0111 0001
101 static const u32 ht2_f5c
= 0x7907287B; // 0111 1001 0000 0111 0010 1000 0111 1011
103 static u32
_f20 (const u64 x
)
107 i5
= ((ht2_f4a
>> i4 (x
, 1, 2, 4, 5)) & 1)* 1
108 + ((ht2_f4b
>> i4 (x
, 7,11,13,14)) & 1)* 2
109 + ((ht2_f4b
>> i4 (x
,16,20,22,25)) & 1)* 4
110 + ((ht2_f4b
>> i4 (x
,27,28,30,32)) & 1)* 8
111 + ((ht2_f4a
>> i4 (x
,33,42,43,45)) & 1)*16;
113 return (ht2_f5c
>> i5
) & 1;
116 static u64
_hitag2_init (const u64 key
, const u32 serial
, const u32 IV
)
119 u64 x
= ((key
& 0xFFFF) << 32) + serial
;
121 for (i
= 0; i
< 32; i
++)
124 x
+= (u64
) (_f20 (x
) ^ (((IV
>> i
) ^ (key
>> (i
+16))) & 1)) << 47;
129 static u64
_hitag2_round (u64
*state
)
134 ((((x
>> 0) ^ (x
>> 2) ^ (x
>> 3) ^ (x
>> 6)
135 ^ (x
>> 7) ^ (x
>> 8) ^ (x
>> 16) ^ (x
>> 22)
136 ^ (x
>> 23) ^ (x
>> 26) ^ (x
>> 30) ^ (x
>> 41)
137 ^ (x
>> 42) ^ (x
>> 43) ^ (x
>> 46) ^ (x
>> 47)) & 1) << 47);
143 // "MIKRON" = O N M I K R
144 // Key = 4F 4E 4D 49 4B 52 - Secret 48-bit key
145 // Serial = 49 43 57 69 - Serial number of the tag, transmitted in clear
146 // Random = 65 6E 45 72 - Random IV, transmitted in clear
147 //~28~DC~80~31 = D7 23 7F CE - Authenticator value = inverted first 4 bytes of the keystream
149 // The code below must print out "D7 23 7F CE 8C D0 37 A9 57 49 C1 E6 48 00 8A B6".
150 // The inverse of the first 4 bytes is sent to the tag to authenticate.
151 // The rest is encrypted by XORing it with the subsequent keystream.
153 static u32
_hitag2_byte (u64
* x
)
157 for (i
= 0, c
= 0; i
< 8; i
++) c
+= (u32
) _hitag2_round (x
) << (i
^7);
161 static int hitag2_reset(void) {
162 tag
.state
= TAG_STATE_RESET
;
163 tag
.crypto_active
= 0;
167 static int hitag2_init(void) {
172 static void hitag2_cipher_reset(struct hitag2_tag
*tag
, const byte_t
*iv
)
174 uint64_t key
= ((uint64_t)tag
->sectors
[2][2]) |
175 ((uint64_t)tag
->sectors
[2][3] << 8) |
176 ((uint64_t)tag
->sectors
[1][0] << 16) |
177 ((uint64_t)tag
->sectors
[1][1] << 24) |
178 ((uint64_t)tag
->sectors
[1][2] << 32) |
179 ((uint64_t)tag
->sectors
[1][3] << 40);
180 uint32_t uid
= ((uint32_t)tag
->sectors
[0][0]) |
181 ((uint32_t)tag
->sectors
[0][1] << 8) |
182 ((uint32_t)tag
->sectors
[0][2] << 16) |
183 ((uint32_t)tag
->sectors
[0][3] << 24);
184 uint32_t iv_
= (((uint32_t)(iv
[0]))) |
185 (((uint32_t)(iv
[1])) << 8) |
186 (((uint32_t)(iv
[2])) << 16) |
187 (((uint32_t)(iv
[3])) << 24);
188 tag
->cs
= _hitag2_init(rev64(key
), rev32(uid
), rev32(iv_
));
191 static int hitag2_cipher_authenticate(uint64_t* cs
, const byte_t
*authenticator_is
)
193 byte_t authenticator_should
[4];
194 authenticator_should
[0] = ~_hitag2_byte(cs
);
195 authenticator_should
[1] = ~_hitag2_byte(cs
);
196 authenticator_should
[2] = ~_hitag2_byte(cs
);
197 authenticator_should
[3] = ~_hitag2_byte(cs
);
198 return (memcmp(authenticator_should
, authenticator_is
, 4) == 0);
201 static int hitag2_cipher_transcrypt(uint64_t* cs
, byte_t
*data
, unsigned int bytes
, unsigned int bits
)
204 for(i
=0; i
<bytes
; i
++) data
[i
] ^= _hitag2_byte(cs
);
205 for(i
=0; i
<bits
; i
++) data
[bytes
] ^= _hitag2_round(cs
) << (7-i
);
209 // Sam7s has several timers, we will use the source TIMER_CLOCK1 (aka AT91C_TC_CLKS_TIMER_DIV1_CLOCK)
210 // TIMER_CLOCK1 = MCK/2, MCK is running at 48 MHz, Timer is running at 48/2 = 24 MHz
211 // Hitag units (T0) have duration of 8 microseconds (us), which is 1/125000 per second (carrier)
212 // T0 = TIMER_CLOCK1 / 125000 = 192
215 #define SHORT_COIL() LOW(GPIO_SSC_DOUT)
216 #define OPEN_COIL() HIGH(GPIO_SSC_DOUT)
218 #define HITAG_FRAME_LEN 20
219 #define HITAG_T_STOP 36 /* T_EOF should be > 36 */
220 #define HITAG_T_LOW 8 /* T_LOW should be 4..10 */
221 #define HITAG_T_0_MIN 15 /* T[0] should be 18..22 */
222 #define HITAG_T_1_MIN 25 /* T[1] should be 26..30 */
223 //#define HITAG_T_EOF 40 /* T_EOF should be > 36 */
224 #define HITAG_T_EOF 80 /* T_EOF should be > 36 */
225 #define HITAG_T_WAIT_1 200 /* T_wresp should be 199..206 */
226 #define HITAG_T_WAIT_2 90 /* T_wresp should be 199..206 */
227 #define HITAG_T_WAIT_MAX 300 /* bit more than HITAG_T_WAIT_1 + HITAG_T_WAIT_2 */
229 #define HITAG_T_TAG_ONE_HALF_PERIOD 10
230 #define HITAG_T_TAG_TWO_HALF_PERIOD 25
231 #define HITAG_T_TAG_THREE_HALF_PERIOD 41
232 #define HITAG_T_TAG_FOUR_HALF_PERIOD 57
234 #define HITAG_T_TAG_HALF_PERIOD 16
235 #define HITAG_T_TAG_FULL_PERIOD 32
237 #define HITAG_T_TAG_CAPTURE_ONE_HALF 13
238 #define HITAG_T_TAG_CAPTURE_TWO_HALF 25
239 #define HITAG_T_TAG_CAPTURE_THREE_HALF 41
240 #define HITAG_T_TAG_CAPTURE_FOUR_HALF 57
243 static void hitag_send_bit(int bit
) {
245 // Reset clock for the next bit
246 AT91C_BASE_TC0
->TC_CCR
= AT91C_TC_SWTRG
;
248 // Fixed modulation, earlier proxmark version used inverted signal
250 // Manchester: Unloaded, then loaded |__--|
252 while(AT91C_BASE_TC0
->TC_CV
< T0
*HITAG_T_TAG_HALF_PERIOD
);
254 while(AT91C_BASE_TC0
->TC_CV
< T0
*HITAG_T_TAG_FULL_PERIOD
);
256 // Manchester: Loaded, then unloaded |--__|
258 while(AT91C_BASE_TC0
->TC_CV
< T0
*HITAG_T_TAG_HALF_PERIOD
);
260 while(AT91C_BASE_TC0
->TC_CV
< T0
*HITAG_T_TAG_FULL_PERIOD
);
265 static void hitag_send_frame(const byte_t
* frame
, size_t frame_len
)
267 // Send start of frame
268 for(size_t i
=0; i
<5; i
++) {
272 // Send the content of the frame
273 for(size_t i
=0; i
<frame_len
; i
++) {
274 hitag_send_bit((frame
[i
/8] >> (7-(i
%8)))&1);
277 // Drop the modulation
282 static void hitag2_handle_reader_command(byte_t
* rx
, const size_t rxlen
, byte_t
* tx
, size_t* txlen
)
284 byte_t rx_air
[HITAG_FRAME_LEN
];
286 // Copy the (original) received frame how it is send over the air
287 memcpy(rx_air
,rx
,nbytes(rxlen
));
289 if(tag
.crypto_active
) {
290 hitag2_cipher_transcrypt(&(tag
.cs
),rx
,rxlen
/8,rxlen
%8);
293 // Reset the transmission frame length
296 // Try to find out which command was send by selecting on length (in bits)
298 // Received 11000 from the reader, request for UID, send UID
300 // Always send over the air in the clear plaintext mode
301 if(rx_air
[0] != 0xC0) {
306 memcpy(tx
,tag
.sectors
[0],4);
307 tag
.crypto_active
= 0;
311 // Read/Write command: ..xx x..y yy with yyy == ~xxx, xxx is sector number
313 unsigned int sector
= (~( ((rx
[0]<<2)&0x04) | ((rx
[1]>>6)&0x03) ) & 0x07);
314 // Verify complement of sector index
315 if(sector
!= ((rx
[0]>>3)&0x07)) {
316 //DbpString("Transmission error (read/write)");
320 switch (rx
[0] & 0xC6) {
321 // Read command: 11xx x00y
323 memcpy(tx
,tag
.sectors
[sector
],4);
327 // Inverted Read command: 01xx x10y
329 for (size_t i
=0; i
<4; i
++) {
330 tx
[i
] = tag
.sectors
[sector
][i
] ^ 0xff;
335 // Write command: 10xx x01y
337 // Prepare write, acknowledge by repeating command
338 memcpy(tx
,rx
,nbytes(rxlen
));
340 tag
.active_sector
= sector
;
341 tag
.state
=TAG_STATE_WRITING
;
346 Dbprintf("Uknown command: %02x %02x",rx
[0],rx
[1]);
353 // Writing data or Reader password
355 if(tag
.state
== TAG_STATE_WRITING
) {
356 // These are the sector contents to be written. We don't have to do anything else.
357 memcpy(tag
.sectors
[tag
.active_sector
],rx
,nbytes(rxlen
));
358 tag
.state
=TAG_STATE_RESET
;
361 // Received RWD password, respond with configuration and our password
362 if(memcmp(rx
,tag
.sectors
[1],4) != 0) {
363 DbpString("Reader password is wrong");
367 memcpy(tx
,tag
.sectors
[3],4);
372 // Received RWD authentication challenge and respnse
374 // Store the authentication attempt
375 if (auth_table_len
< (AUTH_TABLE_LENGTH
-8)) {
376 memcpy(auth_table
+auth_table_len
,rx
,8);
380 // Reset the cipher state
381 hitag2_cipher_reset(&tag
,rx
);
382 // Check if the authentication was correct
383 if(!hitag2_cipher_authenticate(&(tag
.cs
),rx
+4)) {
384 // The reader failed to authenticate, do nothing
385 Dbprintf("auth: %02x%02x%02x%02x%02x%02x%02x%02x Failed!",rx
[0],rx
[1],rx
[2],rx
[3],rx
[4],rx
[5],rx
[6],rx
[7]);
388 // Succesful, but commented out reporting back to the Host, this may delay to much.
389 // Dbprintf("auth: %02x%02x%02x%02x%02x%02x%02x%02x OK!",rx[0],rx[1],rx[2],rx[3],rx[4],rx[5],rx[6],rx[7]);
391 // Activate encryption algorithm for all further communication
392 tag
.crypto_active
= 1;
394 // Use the tag password as response
395 memcpy(tx
,tag
.sectors
[3],4);
401 // LogTraceHitag(rx,rxlen,0,0,false);
402 // LogTraceHitag(tx,*txlen,0,0,true);
404 if(tag
.crypto_active
) {
405 hitag2_cipher_transcrypt(&(tag
.cs
), tx
, *txlen
/8, *txlen
%8);
409 static void hitag_reader_send_bit(int bit
) {
411 // Reset clock for the next bit
412 AT91C_BASE_TC0
->TC_CCR
= AT91C_TC_SWTRG
;
414 // Binary puls length modulation (BPLM) is used to encode the data stream
415 // This means that a transmission of a one takes longer than that of a zero
417 // Enable modulation, which means, drop the field
420 // Wait for 4-10 times the carrier period
421 while(AT91C_BASE_TC0
->TC_CV
< T0
*6);
424 // Disable modulation, just activates the field again
429 while(AT91C_BASE_TC0
->TC_CV
< T0
*22);
433 while(AT91C_BASE_TC0
->TC_CV
< T0
*28);
439 static void hitag_reader_send_frame(const byte_t
* frame
, size_t frame_len
)
441 // Send the content of the frame
442 for(size_t i
=0; i
<frame_len
; i
++) {
443 hitag_reader_send_bit((frame
[i
/8] >> (7-(i
%8)))&1);
446 AT91C_BASE_TC0
->TC_CCR
= AT91C_TC_SWTRG
;
447 // Enable modulation, which means, drop the field
449 // Wait for 4-10 times the carrier period
450 while(AT91C_BASE_TC0
->TC_CV
< T0
*6);
451 // Disable modulation, just activates the field again
457 static bool hitag2_password(byte_t
* rx
, const size_t rxlen
, byte_t
* tx
, size_t* txlen
) {
458 // Reset the transmission frame length
461 // Try to find out which command was send by selecting on length (in bits)
463 // No answer, try to resurrect
465 // Stop if there is no answer (after sending password)
467 DbpString("Password failed!");
471 memcpy(tx
,"\xc0",nbytes(*txlen
));
474 // Received UID, tag password
478 memcpy(tx
,password
,4);
480 memcpy(tag
.sectors
[blocknr
],rx
,4);
485 //store password in block1, the TAG answers with Block3, but we need the password in memory
486 memcpy(tag
.sectors
[blocknr
],tx
,4);
488 memcpy(tag
.sectors
[blocknr
],rx
,4);
493 DbpString("Read succesful!");
498 tx
[0] = 0xc0 | (blocknr
<< 3) | ((blocknr
^7) >> 2);
499 tx
[1] = ((blocknr
^7) << 6);
503 // Unexpected response
505 Dbprintf("Uknown frame length: %d",rxlen
);
512 static bool hitag2_crypto(byte_t
* rx
, const size_t rxlen
, byte_t
* tx
, size_t* txlen
) {
513 // Reset the transmission frame length
517 hitag2_cipher_transcrypt(&cipher_state
,rx
,rxlen
/8,rxlen
%8);
520 // Try to find out which command was send by selecting on length (in bits)
522 // No answer, try to resurrect
524 // Stop if there is no answer while we are in crypto mode (after sending NrAr)
526 // Failed during authentication
527 if (bAuthenticating
) {
528 DbpString("Authentication failed!");
531 // Failed reading a block, could be (read/write) locked, skip block and re-authenticate
533 // Write the low part of the key in memory
534 memcpy(tag
.sectors
[1],key
+2,4);
535 } else if (blocknr
== 2) {
536 // Write the high part of the key in memory
537 tag
.sectors
[2][0] = 0x00;
538 tag
.sectors
[2][1] = 0x00;
539 tag
.sectors
[2][2] = key
[0];
540 tag
.sectors
[2][3] = key
[1];
542 // Just put zero's in the memory (of the unreadable block)
543 memset(tag
.sectors
[blocknr
],0x00,4);
550 memcpy(tx
,"\xc0",nbytes(*txlen
));
554 // Received UID, crypto tag answer
557 uint64_t ui64key
= key
[0] | ((uint64_t)key
[1]) << 8 | ((uint64_t)key
[2]) << 16 | ((uint64_t)key
[3]) << 24 | ((uint64_t)key
[4]) << 32 | ((uint64_t)key
[5]) << 40;
558 uint32_t ui32uid
= rx
[0] | ((uint32_t)rx
[1]) << 8 | ((uint32_t)rx
[2]) << 16 | ((uint32_t)rx
[3]) << 24;
559 cipher_state
= _hitag2_init(rev64(ui64key
), rev32(ui32uid
), 0);
562 hitag2_cipher_transcrypt(&cipher_state
,tx
+4,4,0);
565 bAuthenticating
= true;
567 // Check if we received answer tag (at)
568 if (bAuthenticating
) {
569 bAuthenticating
= false;
571 // Store the received block
572 memcpy(tag
.sectors
[blocknr
],rx
,4);
576 DbpString("Read succesful!");
581 tx
[0] = 0xc0 | (blocknr
<< 3) | ((blocknr
^7) >> 2);
582 tx
[1] = ((blocknr
^7) << 6);
586 // Unexpected response
588 Dbprintf("Uknown frame length: %d",rxlen
);
595 // We have to return now to avoid double encryption
596 if (!bAuthenticating
) {
597 hitag2_cipher_transcrypt(&cipher_state
, tx
, *txlen
/8, *txlen
%8);
605 static bool hitag2_authenticate(byte_t
* rx
, const size_t rxlen
, byte_t
* tx
, size_t* txlen
) {
606 // Reset the transmission frame length
609 // Try to find out which command was send by selecting on length (in bits)
611 // No answer, try to resurrect
613 // Stop if there is no answer while we are in crypto mode (after sending NrAr)
615 DbpString("Authentication failed!");
619 memcpy(tx
,"\xc0",nbytes(*txlen
));
622 // Received UID, crypto tag answer
629 DbpString("Authentication succesful!");
634 // Unexpected response
636 Dbprintf("Uknown frame length: %d",rxlen
);
645 static bool hitag2_test_auth_attempts(byte_t
* rx
, const size_t rxlen
, byte_t
* tx
, size_t* txlen
) {
647 // Reset the transmission frame length
650 // Try to find out which command was send by selecting on length (in bits)
652 // No answer, try to resurrect
654 // Stop if there is no answer while we are in crypto mode (after sending NrAr)
656 Dbprintf("auth: %02x%02x%02x%02x%02x%02x%02x%02x Failed, removed entry!",NrAr
[0],NrAr
[1],NrAr
[2],NrAr
[3],NrAr
[4],NrAr
[5],NrAr
[6],NrAr
[7]);
658 // Removing failed entry from authentiations table
659 memcpy(auth_table
+auth_table_pos
,auth_table
+auth_table_pos
+8,8);
662 // Return if we reached the end of the authentications table
664 if (auth_table_pos
== auth_table_len
) {
668 // Copy the next authentication attempt in row (at the same position, b/c we removed last failed entry)
669 memcpy(NrAr
,auth_table
+auth_table_pos
,8);
672 memcpy(tx
,"\xc0",nbytes(*txlen
));
675 // Received UID, crypto tag answer, or read block response
682 Dbprintf("auth: %02x%02x%02x%02x%02x%02x%02x%02x OK",NrAr
[0],NrAr
[1],NrAr
[2],NrAr
[3],NrAr
[4],NrAr
[5],NrAr
[6],NrAr
[7]);
684 if ((auth_table_pos
+8) == auth_table_len
) {
688 memcpy(NrAr
,auth_table
+auth_table_pos
,8);
693 Dbprintf("Uknown frame length: %d",rxlen
);
701 static bool hitag2_read_uid(byte_t
* rx
, const size_t rxlen
, byte_t
* tx
, size_t* txlen
) {
702 // Reset the transmission frame length
705 // Try to find out which command was send by selecting on length (in bits)
707 // No answer, try to resurrect
709 // Just starting or if there is no answer
711 memcpy(tx
,"\xc0",nbytes(*txlen
));
715 // Check if we received answer tag (at)
716 if (bAuthenticating
) {
717 bAuthenticating
= false;
719 // Store the received block
720 memcpy(tag
.sectors
[blocknr
],rx
,4);
724 //DbpString("Read successful!");
729 // Unexpected response
731 Dbprintf("Uknown frame length: %d",rxlen
);
738 void SnoopHitag(uint32_t type
) {
747 byte_t rx
[HITAG_FRAME_LEN
];
750 FpgaDownloadAndGo(FPGA_BITSTREAM_LF
);
752 // free eventually allocated BigBuf memory
753 BigBuf_free(); BigBuf_Clear_ext(false);
755 // Clean up trace and prepare it for storing frames
762 auth_table
= (byte_t
*)BigBuf_malloc(AUTH_TABLE_LENGTH
);
763 memset(auth_table
, 0x00, AUTH_TABLE_LENGTH
);
765 DbpString("Starting Hitag2 snoop");
768 // Set up eavesdropping mode, frequency divisor which will drive the FPGA
769 // and analog mux selection.
770 FpgaWriteConfWord(FPGA_MAJOR_MODE_LF_EDGE_DETECT
| FPGA_LF_EDGE_DETECT_TOGGLE_MODE
);
771 FpgaSendCommand(FPGA_CMD_SET_DIVISOR
, 95); //125Khz
772 SetAdcMuxFor(GPIO_MUXSEL_LOPKD
);
775 // Configure output pin that is connected to the FPGA (for modulating)
776 AT91C_BASE_PIOA
->PIO_OER
= GPIO_SSC_DOUT
;
777 AT91C_BASE_PIOA
->PIO_PER
= GPIO_SSC_DOUT
;
779 // Disable modulation, we are going to eavesdrop, not modulate ;)
782 // Enable Peripheral Clock for TIMER_CLOCK1, used to capture edges of the reader frames
783 AT91C_BASE_PMC
->PMC_PCER
= (1 << AT91C_ID_TC1
);
784 AT91C_BASE_PIOA
->PIO_BSR
= GPIO_SSC_FRAME
;
786 // Disable timer during configuration
787 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKDIS
;
789 // Capture mode, defaul timer source = MCK/2 (TIMER_CLOCK1), TIOA is external trigger,
790 // external trigger rising edge, load RA on rising edge of TIOA.
791 uint32_t t1_channel_mode
= AT91C_TC_CLKS_TIMER_DIV1_CLOCK
| AT91C_TC_ETRGEDG_BOTH
| AT91C_TC_ABETRG
| AT91C_TC_LDRA_BOTH
;
792 AT91C_BASE_TC1
->TC_CMR
= t1_channel_mode
;
794 // Enable and reset counter
795 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKEN
| AT91C_TC_SWTRG
;
797 // Reset the received frame, frame count and timing info
798 memset(rx
,0x00,sizeof(rx
));
802 reader_frame
= false;
807 while(!BUTTON_PRESS() && !usb_poll_validate_length()) {
811 // Receive frame, watch for at most T0*EOF periods
812 while (AT91C_BASE_TC1
->TC_CV
< T0
*HITAG_T_EOF
) {
813 // Check if rising edge in modulation is detected
814 if(AT91C_BASE_TC1
->TC_SR
& AT91C_TC_LDRAS
) {
815 // Retrieve the new timing values
816 int ra
= (AT91C_BASE_TC1
->TC_RA
/T0
);
818 // Find out if we are dealing with a rising or falling edge
819 rising_edge
= (AT91C_BASE_PIOA
->PIO_PDSR
& GPIO_SSC_FRAME
) > 0;
821 // Shorter periods will only happen with reader frames
822 if (!reader_frame
&& rising_edge
&& ra
< HITAG_T_TAG_CAPTURE_ONE_HALF
) {
823 // Switch from tag to reader capture
826 memset(rx
,0x00,sizeof(rx
));
830 // Only handle if reader frame and rising edge, or tag frame and falling edge
831 if (reader_frame
!= rising_edge
) {
836 // Add the buffered timing values of earlier captured edges which were skipped
842 // Capture reader frame
843 if(ra
>= HITAG_T_STOP
) {
845 //DbpString("wierd0?");
847 // Capture the T0 periods that have passed since last communication or field drop (reset)
848 response
= (ra
- HITAG_T_LOW
);
849 } else if(ra
>= HITAG_T_1_MIN
) {
851 rx
[rxlen
/ 8] |= 1 << (7-(rxlen
%8));
853 } else if(ra
>= HITAG_T_0_MIN
) {
855 rx
[rxlen
/ 8] |= 0 << (7-(rxlen
%8));
858 // Ignore wierd value, is to small to mean anything
862 // Capture tag frame (manchester decoding using only falling edges)
863 if(ra
>= HITAG_T_EOF
) {
865 //DbpString("wierd1?");
867 // Capture the T0 periods that have passed since last communication or field drop (reset)
868 // We always recieve a 'one' first, which has the falling edge after a half period |-_|
869 response
= ra
-HITAG_T_TAG_HALF_PERIOD
;
870 } else if(ra
>= HITAG_T_TAG_CAPTURE_FOUR_HALF
) {
871 // Manchester coding example |-_|_-|-_| (101)
872 rx
[rxlen
/ 8] |= 0 << (7-(rxlen
%8));
874 rx
[rxlen
/ 8] |= 1 << (7-(rxlen
%8));
876 } else if(ra
>= HITAG_T_TAG_CAPTURE_THREE_HALF
) {
877 // Manchester coding example |_-|...|_-|-_| (0...01)
878 rx
[rxlen
/ 8] |= 0 << (7-(rxlen
%8));
880 // We have to skip this half period at start and add the 'one' the second time
882 rx
[rxlen
/ 8] |= 1 << (7-(rxlen
%8));
887 } else if(ra
>= HITAG_T_TAG_CAPTURE_TWO_HALF
) {
888 // Manchester coding example |_-|_-| (00) or |-_|-_| (11)
890 // Ignore bits that are transmitted during SOF
893 // bit is same as last bit
894 rx
[rxlen
/ 8] |= lastbit
<< (7-(rxlen
%8));
898 // Ignore wierd value, is to small to mean anything
904 // Check if frame was captured
907 if (!LogTraceHitag(rx
,rxlen
,response
,0,reader_frame
)) {
908 DbpString("Trace full");
912 // Check if we recognize a valid authentication attempt
913 if (nbytes(rxlen
) == 8) {
914 // Store the authentication attempt
915 if (auth_table_len
< (AUTH_TABLE_LENGTH
-8)) {
916 memcpy(auth_table
+auth_table_len
,rx
,8);
921 // Reset the received frame and response timing info
922 memset(rx
,0x00,sizeof(rx
));
924 reader_frame
= false;
933 // Save the timer overflow, will be 0 when frame was received
934 overflow
+= (AT91C_BASE_TC1
->TC_CV
/T0
);
936 // Reset the frame length
938 // Reset the timer to restart while-loop that receives frames
939 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_SWTRG
;
945 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKDIS
;
946 AT91C_BASE_TC0
->TC_CCR
= AT91C_TC_CLKDIS
;
947 FpgaWriteConfWord(FPGA_MAJOR_MODE_OFF
);
950 // Dbprintf("frame received: %d",frame_count);
951 // Dbprintf("Authentication Attempts: %d",(auth_table_len/8));
952 // DbpString("All done");
955 void SimulateHitagTag(bool tag_mem_supplied
, byte_t
* data
) {
959 byte_t rx
[HITAG_FRAME_LEN
];
961 byte_t tx
[HITAG_FRAME_LEN
];
963 bool bQuitTraceFull
= false;
966 FpgaDownloadAndGo(FPGA_BITSTREAM_LF
);
968 // free eventually allocated BigBuf memory
969 BigBuf_free(); BigBuf_Clear_ext(false);
971 // Clean up trace and prepare it for storing frames
979 auth_table
= (byte_t
*)BigBuf_malloc(AUTH_TABLE_LENGTH
);
980 memset(auth_table
, 0x00, AUTH_TABLE_LENGTH
);
982 DbpString("Starting Hitag2 simulation");
986 if (tag_mem_supplied
) {
987 DbpString("Loading hitag2 memory...");
988 memcpy((byte_t
*)tag
.sectors
,data
,48);
992 for (size_t i
=0; i
<12; i
++) {
993 for (size_t j
=0; j
<4; j
++) {
995 block
|= tag
.sectors
[i
][j
];
997 Dbprintf("| %d | %08x |",i
,block
);
1000 // Set up simulator mode, frequency divisor which will drive the FPGA
1001 // and analog mux selection.
1002 FpgaWriteConfWord(FPGA_MAJOR_MODE_LF_EDGE_DETECT
| FPGA_LF_EDGE_DETECT_READER_FIELD
);
1003 FpgaSendCommand(FPGA_CMD_SET_DIVISOR
, 95); //125Khz
1004 SetAdcMuxFor(GPIO_MUXSEL_LOPKD
);
1007 // Configure output pin that is connected to the FPGA (for modulating)
1008 AT91C_BASE_PIOA
->PIO_OER
= GPIO_SSC_DOUT
;
1009 AT91C_BASE_PIOA
->PIO_PER
= GPIO_SSC_DOUT
;
1011 // Disable modulation at default, which means release resistance
1014 // Enable Peripheral Clock for TIMER_CLOCK0, used to measure exact timing before answering
1015 AT91C_BASE_PMC
->PMC_PCER
= (1 << AT91C_ID_TC0
);
1017 // Enable Peripheral Clock for TIMER_CLOCK1, used to capture edges of the reader frames
1018 AT91C_BASE_PMC
->PMC_PCER
= (1 << AT91C_ID_TC1
);
1019 AT91C_BASE_PIOA
->PIO_BSR
= GPIO_SSC_FRAME
;
1021 // Disable timer during configuration
1022 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKDIS
;
1024 // Capture mode, default timer source = MCK/2 (TIMER_CLOCK1), TIOA is external trigger,
1025 // external trigger rising edge, load RA on rising edge of TIOA.
1026 AT91C_BASE_TC1
->TC_CMR
= AT91C_TC_CLKS_TIMER_DIV1_CLOCK
| AT91C_TC_ETRGEDG_RISING
| AT91C_TC_ABETRG
| AT91C_TC_LDRA_RISING
;
1028 // Reset the received frame, frame count and timing info
1029 memset(rx
,0x00,sizeof(rx
));
1034 // Enable and reset counter
1035 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKEN
| AT91C_TC_SWTRG
;
1037 while(!BUTTON_PRESS() && !usb_poll_validate_length()) {
1041 // Receive frame, watch for at most T0*EOF periods
1042 while (AT91C_BASE_TC1
->TC_CV
< T0
*HITAG_T_EOF
) {
1043 // Check if rising edge in modulation is detected
1044 if(AT91C_BASE_TC1
->TC_SR
& AT91C_TC_LDRAS
) {
1045 // Retrieve the new timing values
1046 int ra
= (AT91C_BASE_TC1
->TC_RA
/T0
) + overflow
;
1049 // Reset timer every frame, we have to capture the last edge for timing
1050 AT91C_BASE_TC0
->TC_CCR
= AT91C_TC_CLKEN
| AT91C_TC_SWTRG
;
1054 // Capture reader frame
1055 if(ra
>= HITAG_T_STOP
) {
1057 //DbpString("wierd0?");
1059 // Capture the T0 periods that have passed since last communication or field drop (reset)
1060 response
= (ra
- HITAG_T_LOW
);
1061 } else if(ra
>= HITAG_T_1_MIN
) {
1063 rx
[rxlen
/ 8] |= 1 << (7-(rxlen
%8));
1065 } else if(ra
>= HITAG_T_0_MIN
) {
1067 rx
[rxlen
/ 8] |= 0 << (7-(rxlen
%8));
1070 // Ignore wierd value, is to small to mean anything
1075 // Check if frame was captured
1079 if (!LogTraceHitag(rx
,rxlen
,response
,0,true)) {
1080 DbpString("Trace full");
1081 if (bQuitTraceFull
) {
1089 // Disable timer 1 with external trigger to avoid triggers during our own modulation
1090 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKDIS
;
1092 // Process the incoming frame (rx) and prepare the outgoing frame (tx)
1093 hitag2_handle_reader_command(rx
,rxlen
,tx
,&txlen
);
1095 // Wait for HITAG_T_WAIT_1 carrier periods after the last reader bit,
1096 // not that since the clock counts since the rising edge, but T_Wait1 is
1097 // with respect to the falling edge, we need to wait actually (T_Wait1 - T_Low)
1098 // periods. The gap time T_Low varies (4..10). All timer values are in
1099 // terms of T0 units
1100 while(AT91C_BASE_TC0
->TC_CV
< T0
*(HITAG_T_WAIT_1
-HITAG_T_LOW
));
1102 // Send and store the tag answer (if there is any)
1104 // Transmit the tag frame
1105 hitag_send_frame(tx
,txlen
);
1106 // Store the frame in the trace
1108 if (!LogTraceHitag(tx
,txlen
,0,0,false)) {
1109 DbpString("Trace full");
1110 if (bQuitTraceFull
) {
1119 // Reset the received frame and response timing info
1120 memset(rx
,0x00,sizeof(rx
));
1123 // Enable and reset external trigger in timer for capturing future frames
1124 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKEN
| AT91C_TC_SWTRG
;
1127 // Reset the frame length
1129 // Save the timer overflow, will be 0 when frame was received
1130 overflow
+= (AT91C_BASE_TC1
->TC_CV
/T0
);
1131 // Reset the timer to restart while-loop that receives frames
1132 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_SWTRG
;
1136 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKDIS
;
1137 AT91C_BASE_TC0
->TC_CCR
= AT91C_TC_CLKDIS
;
1138 FpgaWriteConfWord(FPGA_MAJOR_MODE_OFF
);
1140 DbpString("Sim Stopped");
1144 void ReaderHitag(hitag_function htf
, hitag_data
* htd
) {
1147 byte_t rx
[HITAG_FRAME_LEN
];
1149 byte_t txbuf
[HITAG_FRAME_LEN
];
1156 int t_wait
= HITAG_T_WAIT_MAX
;
1158 bool bQuitTraceFull
= false;
1160 FpgaDownloadAndGo(FPGA_BITSTREAM_LF
);
1161 // Reset the return status
1162 bSuccessful
= false;
1164 // Clean up trace and prepare it for storing frames
1168 //DbpString("Starting Hitag reader family");
1170 // Check configuration
1172 case RHT2F_PASSWORD
: {
1173 Dbprintf("List identifier in password mode");
1174 memcpy(password
,htd
->pwd
.password
,4);
1176 bQuitTraceFull
= false;
1181 case RHT2F_AUTHENTICATE
: {
1182 DbpString("Authenticating using nr,ar pair:");
1183 memcpy(NrAr
,htd
->auth
.NrAr
,8);
1184 Dbhexdump(8,NrAr
,false);
1187 bAuthenticating
= false;
1188 bQuitTraceFull
= true;
1191 case RHT2F_CRYPTO
: {
1192 DbpString("Authenticating using key:");
1193 memcpy(key
,htd
->crypto
.key
,6); //HACK; 4 or 6?? I read both in the code.
1194 Dbhexdump(6,key
,false);
1198 bAuthenticating
= false;
1199 bQuitTraceFull
= true;
1202 case RHT2F_TEST_AUTH_ATTEMPTS
: {
1203 Dbprintf("Testing %d authentication attempts",(auth_table_len
/8));
1205 memcpy(NrAr
, auth_table
, 8);
1206 bQuitTraceFull
= false;
1210 case RHT2F_UID_ONLY
: {
1214 bAuthenticating
= false;
1215 bQuitTraceFull
= true;
1218 Dbprintf("Error, unknown function: %d",htf
);
1227 // Configure output and enable pin that is connected to the FPGA (for modulating)
1228 AT91C_BASE_PIOA
->PIO_OER
= GPIO_SSC_DOUT
;
1229 AT91C_BASE_PIOA
->PIO_PER
= GPIO_SSC_DOUT
;
1231 // Set fpga in edge detect with reader field, we can modulate as reader now
1232 FpgaWriteConfWord(FPGA_MAJOR_MODE_LF_EDGE_DETECT
| FPGA_LF_EDGE_DETECT_READER_FIELD
);
1234 // Set Frequency divisor which will drive the FPGA and analog mux selection
1235 FpgaSendCommand(FPGA_CMD_SET_DIVISOR
, 95); //125Khz
1236 SetAdcMuxFor(GPIO_MUXSEL_LOPKD
);
1239 // Disable modulation at default, which means enable the field
1242 // Give it a bit of time for the resonant antenna to settle.
1245 // Enable Peripheral Clock for TIMER_CLOCK0, used to measure exact timing before answering
1246 AT91C_BASE_PMC
->PMC_PCER
= (1 << AT91C_ID_TC0
);
1248 // Enable Peripheral Clock for TIMER_CLOCK1, used to capture edges of the tag frames
1249 AT91C_BASE_PMC
->PMC_PCER
= (1 << AT91C_ID_TC1
);
1250 AT91C_BASE_PIOA
->PIO_BSR
= GPIO_SSC_FRAME
;
1252 // Disable timer during configuration
1253 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKDIS
;
1255 // Capture mode, defaul timer source = MCK/2 (TIMER_CLOCK1), TIOA is external trigger,
1256 // external trigger rising edge, load RA on falling edge of TIOA.
1257 AT91C_BASE_TC1
->TC_CMR
= AT91C_TC_CLKS_TIMER_DIV1_CLOCK
| AT91C_TC_ETRGEDG_FALLING
| AT91C_TC_ABETRG
| AT91C_TC_LDRA_FALLING
;
1259 // Enable and reset counters
1260 AT91C_BASE_TC0
->TC_CCR
= AT91C_TC_CLKEN
| AT91C_TC_SWTRG
;
1261 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKEN
| AT91C_TC_SWTRG
;
1263 // Reset the received frame, frame count and timing info
1269 // Tag specific configuration settings (sof, timings, etc.)
1274 //DbpString("Configured for hitagS reader");
1275 } else if (htf
< 20) {
1279 //DbpString("Configured for hitag1 reader");
1280 } else if (htf
< 30) {
1283 t_wait
= HITAG_T_WAIT_2
;
1284 //DbpString("Configured for hitag2 reader");
1286 Dbprintf("Error, unknown hitag reader type: %d",htf
);
1290 uint8_t attempt_count
=0;
1291 while(!bStop
&& !BUTTON_PRESS()) {
1295 // Check if frame was captured and store it
1299 if (!LogTraceHitag(rx
,rxlen
,response
,0,false)) {
1300 DbpString("Trace full");
1301 if (bQuitTraceFull
) {
1310 // By default reset the transmission buffer
1313 case RHT2F_PASSWORD
: {
1314 bStop
= !hitag2_password(rx
,rxlen
,tx
,&txlen
);
1316 case RHT2F_AUTHENTICATE
: {
1317 bStop
= !hitag2_authenticate(rx
,rxlen
,tx
,&txlen
);
1319 case RHT2F_CRYPTO
: {
1320 bStop
= !hitag2_crypto(rx
,rxlen
,tx
,&txlen
);
1322 case RHT2F_TEST_AUTH_ATTEMPTS
: {
1323 bStop
= !hitag2_test_auth_attempts(rx
,rxlen
,tx
,&txlen
);
1325 case RHT2F_UID_ONLY
: {
1326 bStop
= !hitag2_read_uid(rx
, rxlen
, tx
, &txlen
);
1327 attempt_count
++; //attempt 3 times to get uid then quit
1328 if (!bStop
&& attempt_count
== 3) bStop
= true;
1331 Dbprintf("Error, unknown function: %d",htf
);
1337 // Send and store the reader command
1338 // Disable timer 1 with external trigger to avoid triggers during our own modulation
1339 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKDIS
;
1341 // Wait for HITAG_T_WAIT_2 carrier periods after the last tag bit before transmitting,
1342 // Since the clock counts since the last falling edge, a 'one' means that the
1343 // falling edge occured halfway the period. with respect to this falling edge,
1344 // we need to wait (T_Wait2 + half_tag_period) when the last was a 'one'.
1345 // All timer values are in terms of T0 units
1346 while(AT91C_BASE_TC0
->TC_CV
< T0
*(t_wait
+(HITAG_T_TAG_HALF_PERIOD
*lastbit
)));
1348 // Transmit the reader frame
1349 hitag_reader_send_frame(tx
,txlen
);
1351 // Enable and reset external trigger in timer for capturing future frames
1352 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKEN
| AT91C_TC_SWTRG
;
1354 // Add transmitted frame to total count
1358 // Store the frame in the trace
1359 if (!LogTraceHitag(tx
,txlen
,HITAG_T_WAIT_2
,0,true)) {
1360 if (bQuitTraceFull
) {
1369 // Reset values for receiving frames
1370 memset(rx
,0x00,sizeof(rx
));
1374 tag_sof
= reset_sof
;
1376 //Dbprintf("DEBUG: Waiting to receive frame");
1377 uint32_t errorCount
= 0;
1379 // Receive frame, watch for at most T0*EOF periods
1380 while (AT91C_BASE_TC1
->TC_CV
< T0
*HITAG_T_WAIT_MAX
) {
1381 // Check if falling edge in tag modulation is detected
1382 if(AT91C_BASE_TC1
->TC_SR
& AT91C_TC_LDRAS
) {
1383 // Retrieve the new timing values
1384 int ra
= (AT91C_BASE_TC1
->TC_RA
/T0
);
1386 // Reset timer every frame, we have to capture the last edge for timing
1387 AT91C_BASE_TC0
->TC_CCR
= AT91C_TC_SWTRG
;
1391 // Capture tag frame (manchester decoding using only falling edges)
1392 if(ra
>= HITAG_T_EOF
) {
1394 //DbpString("wierd1?");
1396 // Capture the T0 periods that have passed since last communication or field drop (reset)
1397 // We always recieve a 'one' first, which has the falling edge after a half period |-_|
1398 response
= ra
-HITAG_T_TAG_HALF_PERIOD
;
1399 } else if(ra
>= HITAG_T_TAG_CAPTURE_FOUR_HALF
) {
1400 // Manchester coding example |-_|_-|-_| (101)
1401 rx
[rxlen
/ 8] |= 0 << (7-(rxlen
%8));
1403 rx
[rxlen
/ 8] |= 1 << (7-(rxlen
%8));
1405 } else if(ra
>= HITAG_T_TAG_CAPTURE_THREE_HALF
) {
1406 // Manchester coding example |_-|...|_-|-_| (0...01)
1407 rx
[rxlen
/ 8] |= 0 << (7-(rxlen
%8));
1409 // We have to skip this half period at start and add the 'one' the second time
1411 rx
[rxlen
/ 8] |= 1 << (7-(rxlen
%8));
1416 } else if(ra
>= HITAG_T_TAG_CAPTURE_TWO_HALF
) {
1417 // Manchester coding example |_-|_-| (00) or |-_|-_| (11)
1419 // Ignore bits that are transmitted during SOF
1422 // bit is same as last bit
1423 rx
[rxlen
/ 8] |= lastbit
<< (7-(rxlen
%8));
1427 //Dbprintf("DEBUG: Wierd2");
1429 // Ignore wierd value, is to small to mean anything
1432 //if we saw over 100 wierd values break it probably isn't hitag...
1433 if (errorCount
>100) break;
1434 // We can break this loop if we received the last bit from a frame
1435 if (AT91C_BASE_TC1
->TC_CV
> T0
*HITAG_T_EOF
) {
1442 AT91C_BASE_TC1
->TC_CCR
= AT91C_TC_CLKDIS
;
1443 AT91C_BASE_TC0
->TC_CCR
= AT91C_TC_CLKDIS
;
1444 FpgaWriteConfWord(FPGA_MAJOR_MODE_OFF
);
1445 // Dbprintf("DONE: frame received: %d",frame_count);
1446 cmd_send(CMD_ACK
,bSuccessful
,0,0,(byte_t
*)tag
.sectors
,48);