Loading...
Searching...
No Matches
mf_desfire.h
1#pragma once
2
3#include <lib/nfc/protocols/iso14443_4a/iso14443_4a.h>
4
6
7#ifdef __cplusplus
8extern "C" {
9#endif
10
11#define MF_DESFIRE_CMD_GET_VERSION (0x60)
12#define MF_DESFIRE_CMD_GET_FREE_MEMORY (0x6E)
13#define MF_DESFIRE_CMD_GET_KEY_SETTINGS (0x45)
14#define MF_DESFIRE_CMD_GET_KEY_VERSION (0x64)
15#define MF_DESFIRE_CMD_GET_APPLICATION_IDS (0x6A)
16#define MF_DESFIRE_CMD_SELECT_APPLICATION (0x5A)
17#define MF_DESFIRE_CMD_GET_FILE_IDS (0x6F)
18#define MF_DESFIRE_CMD_GET_FILE_SETTINGS (0xF5)
19
20#define MF_DESFIRE_CMD_READ_DATA (0xBD)
21#define MF_DESFIRE_CMD_GET_VALUE (0x6C)
22#define MF_DESFIRE_CMD_READ_RECORDS (0xBB)
23
24#define MF_DESFIRE_MAX_KEYS (14)
25#define MF_DESFIRE_MAX_FILES (32)
26
27#define MF_DESFIRE_UID_SIZE (7)
28#define MF_DESFIRE_BATCH_SIZE (5)
29#define MF_DESFIRE_APP_ID_SIZE (3)
30#define MF_DESFIRE_VALUE_SIZE (4)
31
32typedef enum {
33 MfDesfireTypeMF3ICD40,
34 MfDesfireTypeEV1,
35 MfDesfireTypeEV2,
36 MfDesfireTypeEV2XL,
37 MfDesfireTypeEV3,
38
39 MfDesfireTypeUnknown,
40 MfDesfireTypeNum,
41} MfDesfireType;
42
43typedef enum {
44 MfDesfireSize2k,
45 MfDesfireSize4k,
46 MfDesfireSize8k,
47 MfDesfireSize16k,
48 MfDesfireSize32k,
49
50 MfDesfireSizeUnknown,
51 MfDesfireSizeNum,
52} MfDesfireSize;
53
54typedef struct {
55 uint8_t hw_vendor;
56 uint8_t hw_type;
57 uint8_t hw_subtype;
58 uint8_t hw_major;
59 uint8_t hw_minor;
60 uint8_t hw_storage;
61 uint8_t hw_proto;
62
63 uint8_t sw_vendor;
64 uint8_t sw_type;
65 uint8_t sw_subtype;
66 uint8_t sw_major;
67 uint8_t sw_minor;
68 uint8_t sw_storage;
69 uint8_t sw_proto;
70
71 uint8_t uid[MF_DESFIRE_UID_SIZE];
72 uint8_t batch[MF_DESFIRE_BATCH_SIZE];
73 uint8_t prod_week;
74 uint8_t prod_year;
76
77typedef struct {
78 uint32_t bytes_free;
79 bool is_present;
80} MfDesfireFreeMemory; // EV1+ only
81
82typedef struct {
83 bool is_master_key_changeable;
84 bool is_free_directory_list;
85 bool is_free_create_delete;
86 bool is_config_changeable;
87 uint8_t change_key_id;
88 uint8_t max_keys;
89 uint8_t flags;
91
92typedef uint8_t MfDesfireKeyVersion;
93
94typedef enum {
95 MfDesfireFileTypeStandard = 0,
96 MfDesfireFileTypeBackup = 1,
97 MfDesfireFileTypeValue = 2,
98 MfDesfireFileTypeLinearRecord = 3,
99 MfDesfireFileTypeCyclicRecord = 4,
100} MfDesfireFileType;
101
102typedef enum {
103 MfDesfireFileCommunicationSettingsPlaintext = 0,
104 MfDesfireFileCommunicationSettingsAuthenticated = 1,
105 MfDesfireFileCommunicationSettingsEnciphered = 3,
106} MfDesfireFileCommunicationSettings;
107
108typedef uint8_t MfDesfireFileId;
109typedef uint16_t MfDesfireFileAccessRights;
110
111typedef struct {
112 MfDesfireFileType type;
113 MfDesfireFileCommunicationSettings comm;
114 MfDesfireFileAccessRights access_rights[MF_DESFIRE_MAX_KEYS];
115 uint8_t access_rights_len;
116 union {
117 struct {
118 uint32_t size;
119 } data;
120 struct {
121 uint32_t lo_limit;
122 uint32_t hi_limit;
123 uint32_t limited_credit_value;
124 bool limited_credit_enabled;
125 } value;
126 struct {
127 uint32_t size;
128 uint32_t max;
129 uint32_t cur;
130 } record;
131 };
133
134typedef struct {
135 SimpleArray* data;
137
138typedef struct {
139 uint8_t data[MF_DESFIRE_APP_ID_SIZE];
141
142typedef struct MfDesfireApplication {
143 MfDesfireKeySettings key_settings;
144 SimpleArray* key_versions;
145 SimpleArray* file_ids;
146 SimpleArray* file_settings;
147 SimpleArray* file_data;
149
150typedef enum {
151 MfDesfireErrorNone,
152 MfDesfireErrorNotPresent,
153 MfDesfireErrorProtocol,
154 MfDesfireErrorTimeout,
155 MfDesfireErrorAuthentication,
156 MfDesfireErrorCommandNotSupported,
157} MfDesfireError;
158
159typedef struct {
160 Iso14443_4aData* iso14443_4a_data;
161 MfDesfireVersion version;
162 MfDesfireFreeMemory free_memory;
163 MfDesfireKeySettings master_key_settings;
164 SimpleArray* master_key_versions;
165 SimpleArray* application_ids;
166 SimpleArray* applications;
167 FuriString* device_name;
169
170extern const NfcDeviceBase nfc_device_mf_desfire;
171
172// Virtual methods
173
174MfDesfireData* mf_desfire_alloc(void);
175
176void mf_desfire_free(MfDesfireData* data);
177
178void mf_desfire_reset(MfDesfireData* data);
179
180void mf_desfire_copy(MfDesfireData* data, const MfDesfireData* other);
181
182bool mf_desfire_verify(MfDesfireData* data, const FuriString* device_type);
183
184bool mf_desfire_load(MfDesfireData* data, FlipperFormat* ff, uint32_t version);
185
186bool mf_desfire_save(const MfDesfireData* data, FlipperFormat* ff);
187
188bool mf_desfire_is_equal(const MfDesfireData* data, const MfDesfireData* other);
189
190const char* mf_desfire_get_device_name(const MfDesfireData* data, NfcDeviceNameType name_type);
191
192const uint8_t* mf_desfire_get_uid(const MfDesfireData* data, size_t* uid_len);
193
194bool mf_desfire_set_uid(MfDesfireData* data, const uint8_t* uid, size_t uid_len);
195
196Iso14443_4aData* mf_desfire_get_base_data(const MfDesfireData* data);
197
198// Getters and tests
199
201 mf_desfire_get_application(const MfDesfireData* data, const MfDesfireApplicationId* app_id);
202
204 mf_desfire_get_file_settings(const MfDesfireApplication* data, const MfDesfireFileId* file_id);
205
207 mf_desfire_get_file_data(const MfDesfireApplication* data, const MfDesfireFileId* file_id);
208
209#ifdef __cplusplus
210}
211#endif
NfcDeviceNameType
Verbosity level of the displayed NFC device name.
Definition nfc_device_base.h:14
This file provides a simple (non-type safe) array for elements with (optional) in-place construction ...
Definition flipper_format.c:12
Definition string.c:4
Definition iso14443_4a.h:42
Definition mf_desfire.h:142
Definition mf_desfire.h:138
Definition mf_desfire.h:159
Definition mf_desfire.h:134
Definition mf_desfire.h:111
Definition mf_desfire.h:77
Definition mf_desfire.h:82
Definition mf_desfire.h:54
Generic NFC device interface.
Definition nfc_device_base_i.h:142
Definition simple_array.c:5