Update README.md

[proxmark3-svn] / common / protocols.h

diff --git a/common/protocols.h b/common/protocols.h
index 2de52b4d42e49ab29310bdd290f72cd6ca1811a2..96a4b178bed0d1fd3346ea1eabb246a14373132b 100644 (file)
--- a/common/protocols.h
+++ b/common/protocols.h
@@ -1,6 +1,11 @@
 #ifndef PROTOCOLS_H
 #define PROTOCOLS_H
 
 #ifndef PROTOCOLS_H
 #define PROTOCOLS_H
 

+#include <string.h>
+#include <stdint.h>
+#include <stdarg.h>
+
+

 //The following data is taken from http://www.proxmark.org/forum/viewtopic.php?pid=13501#p13501
 /*
 ISO14443A (usually NFC tags)
 //The following data is taken from http://www.proxmark.org/forum/viewtopic.php?pid=13501#p13501
 /*
 ISO14443A (usually NFC tags)


@@ -134,6 +139,7 @@ ISO 7816-4 Basic interindustry commands. For command APDU's.
 #define ISO14443A_CMD_WUPA       0x52
 #define ISO14443A_CMD_ANTICOLL_OR_SELECT     0x93
 #define ISO14443A_CMD_ANTICOLL_OR_SELECT_2   0x95
 #define ISO14443A_CMD_WUPA       0x52
 #define ISO14443A_CMD_ANTICOLL_OR_SELECT     0x93
 #define ISO14443A_CMD_ANTICOLL_OR_SELECT_2   0x95

+#define ISO14443A_CMD_ANTICOLL_OR_SELECT_3   0x97

 #define ISO14443A_CMD_WRITEBLOCK 0xA0
 #define ISO14443A_CMD_HALT       0x50
 #define ISO14443A_CMD_RATS       0xE0
 #define ISO14443A_CMD_WRITEBLOCK 0xA0
 #define ISO14443A_CMD_HALT       0x50
 #define ISO14443A_CMD_RATS       0xE0


@@ -148,6 +154,9 @@ ISO 7816-4 Basic interindustry commands. For command APDU's.
 #define MIFARE_CMD_RESTORE      0xC2
 #define MIFARE_CMD_TRANSFER     0xB0
 
 #define MIFARE_CMD_RESTORE      0xC2
 #define MIFARE_CMD_TRANSFER     0xB0
 

+#define MIFARE_EV1_PERSONAL_UID 0x40
+#define MIFARE_EV1_SETMODE             0x43
+

 #define MIFARE_ULC_WRITE        0xA2
 //#define MIFARE_ULC__COMP_WRITE  0xA0
 #define MIFARE_ULC_AUTH_1       0x1A
 #define MIFARE_ULC_WRITE        0xA2
 //#define MIFARE_ULC__COMP_WRITE  0xA0
 #define MIFARE_ULC_AUTH_1       0x1A


@@ -162,6 +171,28 @@ ISO 7816-4 Basic interindustry commands. For command APDU's.
 #define MIFARE_ULEV1_CHECKTEAR 0x3E
 #define MIFARE_ULEV1_VCSL              0x4B
 
 #define MIFARE_ULEV1_CHECKTEAR 0x3E
 #define MIFARE_ULEV1_VCSL              0x4B
 

+// mifare 4bit card answers
+#define CARD_ACK      0x0A  // 1010 - ACK
+#define CARD_NACK_NA  0x04  // 0100 - NACK, not allowed (command not allowed)
+#define CARD_NACK_TR  0x05  // 0101 - NACK, transmission error
+
+
+// Magic Generation 1, parameter "work flags"
+// bit 0 - need get UID
+// bit 1 - send wupC (wakeup chinese)
+// bit 2 - send HALT cmd after sequence
+// bit 3 - turn on FPGA
+// bit 4 - turn off FPGA
+// bit 5 - set datain instead of issuing USB reply (called via ARM for StandAloneMode14a)
+#define MAGIC_UID                      0x01
+#define MAGIC_WUPC                     0x02
+#define MAGIC_HALT                     0x04
+#define MAGIC_INIT                     0x08
+#define MAGIC_OFF                      0x10
+#define MAGIC_DATAIN           0x20
+#define MAGIC_WIPE                     0x40
+#define MAGIC_SINGLE           (MAGIC_WUPC | MAGIC_HALT | MAGIC_INIT | MAGIC_OFF) //0x1E
+

 /**
 06 00 = INITIATE
 0E xx = SELECT ID (xx = Chip-ID)
 /**
 06 00 = INITIATE
 0E xx = SELECT ID (xx = Chip-ID)


@@ -220,11 +251,14 @@ ISO 7816-4 Basic interindustry commands. For command APDU's.
 #define TOPAZ_WRITE_NE8                                        0x1B    // Write-no-erase (eight bytes)
 
 
 #define TOPAZ_WRITE_NE8                                        0x1B    // Write-no-erase (eight bytes)
 
 

+// Definetions of which protocol annotations there are available

 #define ISO_14443A     0
 #define ICLASS         1
 #define ISO_14443B     2
 #define TOPAZ          3
 #define ISO_7816_4  4
 #define ISO_14443A     0
 #define ICLASS         1
 #define ISO_14443B     2
 #define TOPAZ          3
 #define ISO_7816_4  4

+#define MFDES          5
+#define LEGIC          6

 
 //-- Picopass fuses
 #define FUSE_FPERS   0x80
 
 //-- Picopass fuses
 #define FUSE_FPERS   0x80


@@ -237,27 +271,150 @@ ISO 7816-4 Basic interindustry commands. For command APDU's.
 #define FUSE_RA      0x01
 
 // ISO 7816-4 Basic interindustry commands. For command APDU's.
 #define FUSE_RA      0x01
 
 // ISO 7816-4 Basic interindustry commands. For command APDU's.

-#define ISO7816_READ_BINARY 0xB0
-#define ISO7816_WRITE_BINARY 0xD0
-#define ISO7816_UPDATE_BINARY 0xD6
-#define ISO7816_ERASE_BINARY 0x0E
-#define ISO7816_READ_RECORDS 0xB2
-#define ISO7816_WRITE_RECORDS 0xD2
-#define ISO7816_APPEND_RECORD 0xE2
-#define ISO7816_UPDATE_RECORD 0xDC
-#define ISO7816_GET_DATA 0xCA
-#define ISO7816_PUT_DATA 0xDA
-#define ISO7816_SELECT_FILE 0xA4
-#define ISO7816_VERIFY 0x20
+#define ISO7816_READ_BINARY                            0xB0
+#define ISO7816_WRITE_BINARY                   0xD0
+#define ISO7816_UPDATE_BINARY                  0xD6
+#define ISO7816_ERASE_BINARY                   0x0E
+#define ISO7816_READ_RECORDS                   0xB2
+#define ISO7816_WRITE_RECORDS                  0xD2
+#define ISO7816_APPEND_RECORD                  0xE2
+#define ISO7816_UPDATE_RECORD                  0xDC
+#define ISO7816_GET_DATA                               0xCA
+#define ISO7816_PUT_DATA                               0xDA
+#define ISO7816_SELECT_FILE                    0xA4
+#define ISO7816_VERIFY                                         0x20

 #define ISO7816_INTERNAL_AUTHENTICATION 0x88
 #define ISO7816_EXTERNAL_AUTHENTICATION 0x82
 #define ISO7816_INTERNAL_AUTHENTICATION 0x88
 #define ISO7816_EXTERNAL_AUTHENTICATION 0x82

-#define ISO7816_GET_CHALLENGE 0xB4
-#define ISO7816_MANAGE_CHANNEL 0x70
+#define ISO7816_GET_CHALLENGE                  0xB4
+#define ISO7816_MANAGE_CHANNEL                         0x70

 
 // ISO7816-4   For response APDU's
 
 // ISO7816-4   For response APDU's

-#define ISO7816_OK     0x9000
+#define ISO7816_OK                                             0x9000

 //     6x xx = ERROR
        
 //     6x xx = ERROR
        

+// MIFARE DESFire command set:
+#define  MFDES_CREATE_APPLICATION                       0xca
+#define  MFDES_DELETE_APPLICATION                       0xda
+#define  MFDES_GET_APPLICATION_IDS                      0x6a
+#define      MFDES_SELECT_APPLICATION           0x5a
+#define      MFDES_FORMAT_PICC                                  0xfc
+#define      MFDES_GET_VERSION                                  0x60
+#define      MFDES_READ_DATA                            0xbd
+#define      MFDES_WRITE_DATA                           0x3d
+#define      MFDES_GET_VALUE                            0x6c
+#define      MFDES_CREDIT                                       0x0c
+#define      MFDES_DEBIT                                        0xdc
+#define      MFDES_LIMITED_CREDIT                       0x1c
+#define      MFDES_WRITE_RECORD                         0x3b
+#define      MFDES_READ_RECORDS                         0xbb
+#define     MFDES_CLEAR_RECORD_FILE             0xeb
+#define      MFDES_COMMIT_TRANSACTION           0xc7
+#define      MFDES_ABORT_TRANSACTION            0xa7
+#define      MFDES_GET_FREE_MEMORY           0x6e
+#define        MFDES_GET_FILE_IDS                               0x6f
+#define        MFDES_GET_ISOFILE_IDS                    0x61
+#define     MFDES_GET_FILE_SETTINGS             0xf5
+#define     MFDES_CHANGE_FILE_SETTINGS                  0x5f
+#define     MFDES_CREATE_STD_DATA_FILE                  0xcd
+#define     MFDES_CREATE_BACKUP_DATA_FILE       0xcb
+#define     MFDES_CREATE_VALUE_FILE             0xcc
+#define     MFDES_CREATE_LINEAR_RECORD_FILE     0xc1
+#define     MFDES_CREATE_CYCLIC_RECORD_FILE     0xc0
+#define     MFDES_DELETE_FILE                           0xdf
+#define     MFDES_AUTHENTICATE                          0x0a  // AUTHENTICATE_NATIVE
+#define        MFDES_AUTHENTICATE_ISO                   0x1a  // AUTHENTICATE_STANDARD
+#define        MFDES_AUTHENTICATE_AES                   0xaa
+#define     MFDES_CHANGE_KEY_SETTINGS           0x54
+#define     MFDES_GET_KEY_SETTINGS                      0x45
+#define     MFDES_CHANGE_KEY                            0xc4
+#define     MFDES_GET_KEY_VERSION                       0x64
+#define     MFDES_AUTHENTICATION_FRAME                  0xAF
+
+// LEGIC Commands
+#define                LEGIC_MIM_22    0x0D
+#define                LEGIC_MIM_256   0x1D
+#define                LEGIC_MIM_1024  0x3D
+#define        LEGIC_ACK_22    0x19
+#define        LEGIC_ACK_256   0x39
+#define                LEGIC_READ              0x01
+#define        LEGIC_WRITE             0x00
+

 void printIclassDumpInfo(uint8_t* iclass_dump);
 void printIclassDumpInfo(uint8_t* iclass_dump);

+void getMemConfig(uint8_t mem_cfg, uint8_t chip_cfg, uint8_t *max_blk, uint8_t *app_areas, uint8_t *kb);
+
+/* T55x7 configuration register definitions */
+#define T55x7_POR_DELAY                                0x00000001
+#define T55x7_ST_TERMINATOR                    0x00000008
+#define T55x7_PWD                                      0x00000010
+#define T55x7_MAXBLOCK_SHIFT           5
+#define T55x7_AOR                                      0x00000200
+#define T55x7_PSKCF_RF_2                       0
+#define T55x7_PSKCF_RF_4                       0x00000400
+#define T55x7_PSKCF_RF_8                       0x00000800
+#define T55x7_MODULATION_DIRECT                0
+#define T55x7_MODULATION_PSK1          0x00001000
+#define T55x7_MODULATION_PSK2          0x00002000
+#define T55x7_MODULATION_PSK3          0x00003000
+#define T55x7_MODULATION_FSK1          0x00004000
+#define T55x7_MODULATION_FSK2          0x00005000
+#define T55x7_MODULATION_FSK1a         0x00006000
+#define T55x7_MODULATION_FSK2a         0x00007000
+#define T55x7_MODULATION_MANCHESTER    0x00008000
+#define T55x7_MODULATION_BIPHASE       0x00010000
+#define T55x7_MODULATION_DIPHASE       0x00018000
+#define T55x7_BITRATE_RF_8                     0
+#define T55x7_BITRATE_RF_16                    0x00040000
+#define T55x7_BITRATE_RF_32                    0x00080000
+#define T55x7_BITRATE_RF_40                    0x000C0000
+#define T55x7_BITRATE_RF_50                    0x00100000
+#define T55x7_BITRATE_RF_64                    0x00140000
+#define T55x7_BITRATE_RF_100           0x00180000
+#define T55x7_BITRATE_RF_128           0x001C0000
+
+/* T5555 (Q5) configuration register definitions */
+#define T5555_ST_TERMINATOR                    0x00000001
+#define T5555_MAXBLOCK_SHIFT           0x00000001
+#define T5555_MODULATION_MANCHESTER    0
+#define T5555_MODULATION_PSK1          0x00000010
+#define T5555_MODULATION_PSK2          0x00000020
+#define T5555_MODULATION_PSK3          0x00000030
+#define T5555_MODULATION_FSK1          0x00000040
+#define T5555_MODULATION_FSK2          0x00000050
+#define T5555_MODULATION_BIPHASE       0x00000060
+#define T5555_MODULATION_DIRECT                0x00000070
+#define T5555_INVERT_OUTPUT                    0x00000080
+#define T5555_PSK_RF_2                         0
+#define T5555_PSK_RF_4                         0x00000100
+#define T5555_PSK_RF_8                         0x00000200
+#define T5555_USE_PWD                          0x00000400
+#define T5555_USE_AOR                          0x00000800
+#define T5555_BITRATE_SHIFT         12 //(RF=2n+2)   ie 64=2*0x1F+2   or n = (RF-2)/2
+#define T5555_FAST_WRITE                       0x00004000
+#define T5555_PAGE_SELECT                      0x00008000
+
+uint32_t GetT55xxClockBit(uint32_t clock);
+
+// iclass / picopass chip config structures and shared routines
+typedef struct {
+       uint8_t app_limit;      //[8]
+       uint8_t otp[2];         //[9-10]
+       uint8_t block_writelock;//[11]
+       uint8_t chip_config;    //[12]
+       uint8_t mem_config;     //[13]
+       uint8_t eas;            //[14]
+       uint8_t fuses;          //[15]
+} picopass_conf_block;
+
+
+typedef struct {
+       uint8_t csn[8];
+       picopass_conf_block conf;
+       uint8_t epurse[8];
+       uint8_t key_d[8];
+       uint8_t key_c[8];
+       uint8_t app_issuer_area[8];
+} picopass_hdr;
+

 
 

-#endif // PROTOCOLS_H
+#endif 
+// PROTOCOLS_H