armsrc/mifareutil.h

   1 //-----------------------------------------------------------------------------
   2 // Copyright (C) Gerhard de Koning Gans - May 2008
   3 // Copyright (C) Proxmark3 contributors. See AUTHORS.md for details.
   4 //
   5 // This program is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // See LICENSE.txt for the text of the license.
  16 //-----------------------------------------------------------------------------
  17 // code for work with mifare cards.
  18 //-----------------------------------------------------------------------------
  19
  20 #ifndef __MIFAREUTIL_H
  21 #define __MIFAREUTIL_H
  22
  23 #include "common.h"
  24 #include "crapto1/crapto1.h"
  25
  26 // mifare authentication
  27 #define CRYPT_NONE    0
  28 #define CRYPT_ALL     1
  29 #define CRYPT_REQUEST 2
  30 #define AUTH_FIRST    0
  31 #define AUTH_NESTED   2
  32
  33 #define AUTHENTICATION_TIMEOUT      848 // card times out 1ms after wrong authentication (according to NXP documentation)
  34 #define PRE_AUTHENTICATION_LEADTIME 400 // some (non standard) cards need a pause after select before they are ready for first authentication
  35
  36 // reader voltage field detector
  37 #define MF_MINFIELDV            4000
  38
  39 // Mifare 4k/2k/1k/mini Max Block / Max Sector
  40 #define MIFARE_4K_MAXBLOCK      256
  41 #define MIFARE_2K_MAXBLOCK      128
  42 #define MIFARE_1K_MAXBLOCK      64
  43 #define MIFARE_MINI_MAXBLOCK    20
  44
  45 #define MIFARE_MINI_MAXSECTOR   5
  46 #define MIFARE_1K_MAXSECTOR     16
  47 #define MIFARE_2K_MAXSECTOR     32
  48 #define MIFARE_4K_MAXSECTOR     40
  49
  50 #define MIFARE_BLOCK_SIZE       16
  51
  52 //mifare emulator states
  53 #define MFEMUL_NOFIELD      0
  54 #define MFEMUL_IDLE         1
  55 #define MFEMUL_SELECT       2
  56 #define MFEMUL_AUTH1        3
  57 #define MFEMUL_WORK         4
  58 #define MFEMUL_WRITEBL2     5
  59 #define MFEMUL_INTREG_INC   6
  60 #define MFEMUL_INTREG_DEC   7
  61 #define MFEMUL_INTREG_REST  8
  62 #define MFEMUL_HALTED       9
  63
  64 #define cardSTATE_TO_IDLE() cardSTATE = MFEMUL_IDLE; LED_B_OFF(); LED_C_OFF();
  65
  66 #ifndef MifareBlockToSector
  67 #define MifareBlockToSector(block) (block < 128 ? block / 4 : (block - 128) / 16 + 32)
  68 #endif
  69
  70 //functions
  71 uint16_t mifare_sendcmd(uint8_t cmd, uint8_t *data, uint8_t data_size, uint8_t *answer, uint16_t answer_len, uint8_t *answer_parity, uint32_t *timing);
  72 uint16_t mifare_sendcmd_short(struct Crypto1State *pcs, uint8_t crypted, uint8_t cmd, uint8_t data,
  73                               uint8_t *answer, uint16_t answer_len, uint8_t *answer_parity, uint32_t *timing);
  74
  75 // mifare classic
  76 int mifare_classic_auth(struct Crypto1State *pcs, uint32_t uid, uint8_t blockNo, uint8_t keyType, uint64_t ui64Key, uint8_t isNested);
  77 int mifare_classic_authex(struct Crypto1State *pcs, uint32_t uid, uint8_t blockNo, uint8_t keyType, uint64_t ui64Key, uint8_t isNested, uint32_t *ntptr, uint32_t *timing);
  78 int mifare_classic_authex_cmd(struct Crypto1State *pcs, uint32_t uid, uint8_t blockNo, uint8_t cmd, uint64_t ui64Key, uint8_t isNested, uint32_t *ntptr, uint32_t *ntencptr, uint8_t *ntencparptr, uint32_t *timing, bool corruptnrar, bool corruptnrarparity);
  79
  80 int mifare_classic_readblock(struct Crypto1State *pcs, uint8_t blockNo, uint8_t *blockData);
  81 int mifare_classic_readblock_ex(struct Crypto1State *pcs, uint8_t blockNo, uint8_t *blockData, uint8_t iso_byte);
  82
  83 int mifare_classic_halt(struct Crypto1State *pcs);
  84 int mifare_classic_writeblock(struct Crypto1State *pcs, uint8_t blockNo, uint8_t *blockData);
  85 int mifare_classic_writeblock_ex(struct Crypto1State *pcs, uint8_t blockNo, uint8_t *blockData, uint8_t cmd);
  86 int mifare_classic_value(struct Crypto1State *pcs, uint8_t blockNo, uint8_t *blockData, uint8_t action);
  87
  88 // Ultralight/NTAG...
  89 int mifare_ul_ev1_auth(uint8_t *keybytes, uint8_t *pack);
  90 int mifare_ultra_auth(uint8_t *keybytes);
  91 int mifare_ultra_aes_auth(uint8_t keyno, uint8_t *keybytes);
  92 int mifare_ultra_readblock(uint8_t blockNo, uint8_t *blockData);
  93 int mifare_ultra_writeblock_compat(uint8_t blockNo, uint8_t *blockData);
  94 int mifare_ultra_writeblock(uint8_t blockNo, uint8_t *blockData);
  95 int mifare_ultra_halt(void);
  96
  97 // desfire
  98 int mifare_sendcmd_special(struct Crypto1State *pcs, uint8_t crypted, uint8_t cmd, uint8_t *data, uint8_t *answer, uint16_t answer_len, uint8_t *answer_parity, uint32_t *timing);
  99 int mifare_sendcmd_special2(struct Crypto1State *pcs, uint8_t crypted, uint8_t cmd, uint8_t *data, uint8_t *answer, uint16_t answer_len, uint8_t *answer_parity, uint32_t *timing);
 100 int mifare_desfire_des_auth1(uint32_t uid, uint8_t *blockData);
 101 int mifare_desfire_des_auth2(uint32_t uid, uint8_t *key, uint8_t *blockData);
 102
 103 // crypto functions
 104 void mf_crypto1_decrypt(struct Crypto1State *pcs, uint8_t *data, int len);
 105 void mf_crypto1_decryptEx(struct Crypto1State *pcs, const uint8_t *data_in, int len, uint8_t *data_out);
 106 void mf_crypto1_encrypt(struct Crypto1State *pcs, uint8_t *data, uint16_t len, uint8_t *par);
 107 void mf_crypto1_encryptEx(struct Crypto1State *pcs, const uint8_t *data_in, uint8_t *keystream,
 108                           uint8_t *data_out, uint16_t len, uint8_t *par);
 109 uint8_t mf_crypto1_encrypt4bit(struct Crypto1State *pcs, uint8_t data);
 110
 111 // Mifare memory structure
 112 uint8_t NumBlocksPerSector(uint8_t sectorNo);
 113 uint8_t FirstBlockOfSector(uint8_t sectorNo);
 114
 115 bool IsSectorTrailer(uint8_t blockNo);
 116 uint8_t SectorTrailer(uint8_t blockNo);
 117
 118 // emulator functions
 119 void emlClearMem(void);
 120 void emlSetMem_xt(uint8_t *data, int blockNum, int blocksCount, int block_width);
 121 void emlGetMem(uint8_t *data, int blockNum, int blocksCount);
 122 uint64_t emlGetKey(int sectorNum, int keyType);
 123 int emlGetValBl(uint32_t *blReg, uint8_t *blBlock, int blockNum);
 124 void emlSetValBl(uint32_t blReg, uint8_t blBlock, int blockNum);
 125 bool emlCheckValBl(int blockNum);
 126 bool validate_prng_nonce(uint32_t nonce);
 127 bool validate_parity_nonce(uint32_t ntenc, uint8_t ntparenc, uint32_t nt);
 128 int nonce_distance(uint32_t from, uint32_t to);
 129 int nonce16_distance(uint16_t x, uint16_t y);
 130 int nonce16_index(uint16_t nt);
 131 #endif