/* * Parser for MBTA CharlieCard (Boston, MA, USA). * * Copyright 2024 Zachary Weiss * * Public security research on the MBTA's fare system stretches back to 2008, * starting with Russel Ryan, Zack Anderson, and Alessandro Chiesa's * "Anatomy of a Subway Hack", for which they were famously issued a gag order. * A thorough history of research & researchers deserving of credit is * detailed by @bobbyrsec in his 2022 blog post (& presentation): * "Operation Charlie: Hacking the MBTA CharlieCard from 2008 to Present" * https://medium.com/@bobbyrsec/operation-charlie-hacking-the-mbta-charliecard-from-2008-to-present-24ea9f0aaa38 * * Fare gate IDs, card types, and general assistance courtesy of the * minds behind DEFCON 31's "Boston Infinite Money Glitch" presentation: * — Matthew Harris; mattyharris.net * — Zachary Bertocchi; zackbertocchi.com * — Scott Campbell; josephscottcampbell.com * — Noah Gibson; * Talk available at: https://www.youtube.com/watch?v=1JT_lTfK69Q * * TODOs: * — Reverse engineer passes (sectors 4 & 5?), impl. * — Infer transaction flag meanings * — Infer remaining unknown bytes in the balance sectors (2 & 3) * — Improve string output formatting, esp. of transaction log * — Mapping of buses to garages, and subsequently, route subsets via * http://roster.transithistory.org/ data * — Mapping of stations to lines * — Add'l data fields for side of station fare gates are on? Some stations * separate inbound & outbound sides, so direction could be inferred * from gates used. * — Continually gather data on fare gate ID mappings, update as collected; * check locations this might be scrapable / inferrable from: * [X] MBTA GTFS spec (https://www.mbta.com/developers/gtfs) features & IDs * seem too-coarse-grained & uncorrelated * [X] MBTA ArcGIS (https://mbta-massdot.opendata.arcgis.com/) & Tableau * (https://public.tableau.com/app/profile/mbta.office.of.performance.management.and.innovation/vizzes) * files don't seem to have anything of that resolution (only down to ridership by station) * [X] (skim of) MBTA public GitHub (https://github.com/mbta) repos make no reference to fare-gate-level data * [X] (skim of) MBTA public engineering docs (https://www.mbta.com/engineering) unfruitful; * Closest mention spotted is 2014 "Ridership and Service Statistics" * (https://cdn.mbta.com/sites/default/files/fmcb-meeting-docs/reports-policies/2014-07-mbta-bluebook-ed14.pdf) * where on pg.40, "Equipment at Stations" is enumerated, and fare gates counts are given, * listed as "AFC Gates" (presumably standing for "Automated Fare Collection") * [X] Josiah Zachery criminal trial public evidence — convicted partially on * data on his CharlieCard, appeals partially on basis of legality of this search. * Prev. court case (gag order mentioned in preamble) leaked some data in the files * entered into evidence. Seemingly did not happen here; fare gate IDs unmentioned, * only ever the nature of stored/saved data and methods of retrieval. * Appelate case dockets 2019-P-0401, SJC-12952, SJ-2017-0390 * (https://www.ma-appellatecourts.org/party) * Trial court indictment 04/02/2015, Case# 1584CR10265 @Suffolk County Criminal Superior Court * (https://www.masscourts.org/eservices/home.page.16) * [ ] FOIA / public records request? * (https://massachusettsdot.mycusthelp.com/WEBAPP/_rs/(S(tbcygdlm0oojy35p1wv0y2y5))/supporthome.aspx) * [X] MBTA data blog? (https://www.massdottracker.com/datablog/) * [ ] MassDOT developers Google group? (https://groups.google.com/g/massdotdevelopers) * [X] preexisting posts * [ ] ask directly? * [ ] Other? * * This program is free software: you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include "../../metroflip_i.h" #include "../../metroflip_plugins.h" #include "../../api/metroflip/metroflip_api.h" #include #include #include #include #include #include #include #include #include #include #include #include "../../api/metroflip/metroflip_api.h" #define TAG "Metroflip:Scene:CharlieCard" // starts Wednesday 2003/1/1 @ midnight #define CHARLIE_EPOCH \ (DateTime) { \ 0, 0, 0, 1, 1, 2003, 4 \ } // timestep is one minute #define CHARLIE_TIME_DELTA_SECS 60 #define CHARLIE_END_VALID_DELTA_SECS 60 * 8 #define CHARLIE_N_TRANSACTION_HISTORY 10 #define CHARLIE_N_PASSES 4 // always from the same set of keys (cf. default keys dict for list w/o multiplicity) // we only care about the data in the first half of the sectors // second half sectors keys seemingly change position sometimes across cards? // no data stored there, but might want to impl some custom read function // accounting for this such that reading is faster (else it seems to fall back on dict // approach for remaining keys)... typedef struct { uint16_t dollars; uint8_t cents; } Money; // always from the same set of keys (cf. default keys dict for list w/o multiplicity) // we only care about the data in the first half of the sectors // second half sectors keys seemingly change position sometimes across cards? // no data stored there, but might want to impl some custom read function // accounting for this such that reading is faster (else it seems to fall back on dict // approach for remaining keys)... const MfClassicKeyPair charliecard_1k_keys[] = { {.a = 0x3060206F5B0A, .b = 0xF1B9F5669CC8}, {.a = 0x5EC39B022F2B, .b = 0xF662248E7E89}, {.a = 0x5EC39B022F2B, .b = 0xF662248E7E89}, {.a = 0x5EC39B022F2B, .b = 0xF662248E7E89}, {.a = 0x5EC39B022F2B, .b = 0xF662248E7E89}, {.a = 0x5EC39B022F2B, .b = 0xF662248E7E89}, {.a = 0x5EC39B022F2B, .b = 0xF662248E7E89}, {.a = 0x5EC39B022F2B, .b = 0xF662248E7E89}, {.a = 0x3A09594C8587, .b = 0x62387B8D250D}, {.a = 0xF238D78FF48F, .b = 0x9DC282D46217}, {.a = 0xAFD0BA94D624, .b = 0x92EE4DC87191}, {.a = 0xB35A0E4ACC09, .b = 0x756EF55E2507}, {.a = 0x447AB7FD5A6B, .b = 0x932B9CB730EF}, {.a = 0x1F1A0A111B5B, .b = 0xAD9E0A1CA2F7}, {.a = 0xD58023BA2BDC, .b = 0x62CED42A6D87}, {.a = 0x2548A443DF28, .b = 0x2ED3B15E7C0F}, }; #define FARE_BUS \ (Money) { \ 1, 70 \ } #define FARE_SUB \ (Money) { \ 2, 40 \ } typedef struct { DateTime date; uint16_t gate; uint8_t g_flag; Money fare; uint16_t f_flag; } Transaction; typedef struct { bool valid; uint16_t pre; uint16_t post; DateTime date; } Pass; typedef struct { uint16_t n_uses; uint8_t active_balance_sector; } CounterSector; typedef struct { Money balance; uint16_t type; DateTime issued; DateTime end_validity; } BalanceSector; // IdMapping approach borrowed from Jeremy Cooper's 'clipper.c' typedef struct { uint16_t id; const char* name; } IdMapping; // this should be a complete accounting of types, (1 and 7 day pass types maybe missing?) static const IdMapping charliecard_types[] = { // Regular card types {.id = 367, .name = "Adult"}, {.id = 366, .name = "SV Adult"}, {.id = 418, .name = "Student"}, {.id = 419, .name = "Senior"}, {.id = 420, .name = "TAP"}, {.id = 417, .name = "Blind"}, {.id = 426, .name = "Child"}, {.id = 410, .name = "Employee ID Without Passback"}, {.id = 414, .name = "Employee ID With Passback"}, {.id = 415, .name = "Retiree"}, {.id = 416, .name = "Police/Fire"}, // Passes {.id = 135, .name = "30 Day Local Bus Pass"}, {.id = 136, .name = "30 Day Inner Express Bus Pass"}, {.id = 137, .name = "30 Day Outer Express Bus Pass"}, {.id = 138, .name = "30 Day LinkPass"}, {.id = 139, .name = "30 Day Senior LinkPass"}, {.id = 148, .name = "30 Day TAP LinkPass"}, {.id = 150, .name = "Monthly Student LinkPass"}, {.id = 424, .name = "Monthly TAP LinkPass"}, {.id = 425, .name = "Monthly Senior LinkPass"}, {.id = 421, .name = "Senior TAP/Permit"}, {.id = 422, .name = "Senior TAP/Permit 30 Days"}, // Commuter rail passes {.id = 166, .name = "30 Day Commuter Rail Zone 1A Pass"}, {.id = 167, .name = "30 Day Commuter Rail Zone 1 Pass"}, {.id = 168, .name = "30 Day Commuter Rail Zone 2 Pass"}, {.id = 169, .name = "30 Day Commuter Rail Zone 3 Pass"}, {.id = 170, .name = "30 Day Commuter Rail Zone 4 Pass"}, {.id = 171, .name = "30 Day Commuter Rail Zone 5 Pass"}, {.id = 172, .name = "30 Day Commuter Rail Zone 6 Pass"}, {.id = 173, .name = "30 Day Commuter Rail Zone 7 Pass"}, {.id = 174, .name = "30 Day Commuter Rail Zone 8 Pass"}, {.id = 175, .name = "30 Day Interzone 1 Pass"}, {.id = 176, .name = "30 Day Interzone 2 Pass"}, {.id = 177, .name = "30 Day Interzone 3 Pass"}, {.id = 178, .name = "30 Day Interzone 4 Pass"}, {.id = 179, .name = "30 Day Interzone 5 Pass"}, {.id = 180, .name = "30 Day Interzone 6 Pass"}, {.id = 181, .name = "30 Day Interzone 7 Pass"}, {.id = 182, .name = "30 Day Interzone 8 Pass"}, {.id = 140, .name = "One Way Interzone Adult 1 Zone"}, {.id = 141, .name = "One Way Interzone Adult 2 Zones"}, {.id = 142, .name = "One Way Interzone Adult 3 Zones"}, {.id = 143, .name = "One Way Interzone Adult 4 Zones"}, {.id = 144, .name = "One Way Interzone Adult 5 Zones"}, {.id = 145, .name = "One Way Interzone Adult 6 Zones"}, {.id = 146, .name = "One Way Interzone Adult 7 Zones"}, {.id = 147, .name = "One Way Interzone Adult 8 Zones"}, {.id = 428, .name = "One Way Half Fare Zone 1"}, {.id = 429, .name = "One Way Half Fare Zone 2"}, {.id = 430, .name = "One Way Half Fare Zone 3"}, {.id = 431, .name = "One Way Half Fare Zone 4"}, {.id = 432, .name = "One Way Half Fare Zone 5"}, {.id = 433, .name = "One Way Half Fare Zone 6"}, {.id = 434, .name = "One Way Half Fare Zone 7"}, {.id = 435, .name = "One Way Half Fare Zone 8"}, {.id = 436, .name = "One Way Interzone Half Fare 1 Zone"}, {.id = 437, .name = "One Way Interzone Half Fare 2 Zones"}, {.id = 438, .name = "One Way Interzone Half Fare 3 Zones"}, {.id = 439, .name = "One Way Interzone Half Fare 4 Zones"}, {.id = 440, .name = "One Way Interzone Half Fare 5 Zones"}, {.id = 441, .name = "One Way Interzone Half Fare 6 Zones"}, {.id = 442, .name = "One Way Interzone Half Fare 7 Zones"}, {.id = 443, .name = "One Way Interzone Half Fare 8 Zones"}, {.id = 509, .name = "Group Interzone 1 Zones"}, {.id = 510, .name = "Group Interzone 2 Zones"}, {.id = 511, .name = "Group Interzone 3 Zones"}, {.id = 512, .name = "Group Interzone 4 Zones"}, {.id = 513, .name = "Group Interzone 5 Zones"}, {.id = 514, .name = "Group Interzone 6 Zones"}, {.id = 515, .name = "Group Interzone 7 Zones"}, {.id = 516, .name = "Group Interzone 8 Zones"}, {.id = 952, .name = "Zone 1 Student Monthly Pass"}, {.id = 953, .name = "Zone 2 Student Monthly Pass"}, {.id = 954, .name = "Zone 3 Student Monthly Pass"}, {.id = 955, .name = "Zone 4 Student Monthly Pass"}, {.id = 956, .name = "Zone 5 Student Monthly Pass"}, {.id = 957, .name = "Zone 6 Student Monthly Pass"}, {.id = 958, .name = "Zone 7 Student Monthly Pass"}, {.id = 959, .name = "Zone 8 Student Monthly Pass"}, {.id = 960, .name = "Zone 9 Student Monthly Pass"}, {.id = 961, .name = "Zone 10 Student Monthly Pass"}, {.id = 963, .name = "Interzone 1 Zone Student Monthly Pass"}, {.id = 964, .name = "Interzone 2 Zone Student Monthly Pass"}, {.id = 965, .name = "Interzone 3 Zone Student Monthly Pass"}, {.id = 966, .name = "Interzone 4 Zone Student Monthly Pass"}, {.id = 967, .name = "Interzone 5 Zone Student Monthly Pass"}, {.id = 968, .name = "Interzone 6 Zone Student Monthly Pass"}, {.id = 969, .name = "Interzone 7 Zone Student Monthly Pass"}, {.id = 970, .name = "Interzone 8 Zone Student Monthly Pass"}, {.id = 971, .name = "Interzone 9 Zone Student Monthly Pass"}, {.id = 972, .name = "Interzone 10 Zone Student Monthly Pass"}, }; static const size_t kNumTypes = COUNT_OF(charliecard_types); // Incomplete, and subject to change // Only covers Orange & Blue line stations // Gathered manually, and provided courtesy of, DEFCON31 researchers // as cited above. static const IdMapping charliecard_fare_gate_ids[] = { // Davis {.id = 6766, .name = "Davis"}, {.id = 6767, .name = "Davis"}, {.id = 6768, .name = "Davis"}, {.id = 6769, .name = "Davis"}, {.id = 6770, .name = "Davis"}, {.id = 6771, .name = "Davis"}, {.id = 6772, .name = "Davis"}, {.id = 2167, .name = "Davis"}, {.id = 7020, .name = "Davis"}, // Porter {.id = 6781, .name = "Porter"}, {.id = 6780, .name = "Porter"}, {.id = 6779, .name = "Porter"}, {.id = 6778, .name = "Porter"}, {.id = 6777, .name = "Porter"}, {.id = 6776, .name = "Porter"}, {.id = 6775, .name = "Porter"}, {.id = 2168, .name = "Porter"}, {.id = 7021, .name = "Porter"}, {.id = 6782, .name = "Porter"}, // Oak Grove {.id = 6640, .name = "Oak Grove"}, {.id = 6641, .name = "Oak Grove"}, {.id = 6639, .name = "Oak Grove"}, {.id = 2036, .name = "Oak Grove"}, {.id = 6642, .name = "Oak Grove"}, {.id = 6979, .name = "Oak Grove"}, // Downtown Crossing {.id = 2091, .name = "Downtown Crossing"}, {.id = 6995, .name = "Downtown Crossing"}, {.id = 6699, .name = "Downtown Crossing"}, {.id = 6700, .name = "Downtown Crossing"}, {.id = 1926, .name = "Downtown Crossing"}, {.id = 2084, .name = "Downtown Crossing"}, {.id = 6994, .name = "Downtown Crossing"}, {.id = 6695, .name = "Downtown Crossing"}, {.id = 6694, .name = "Downtown Crossing"}, {.id = 6696, .name = "Downtown Crossing"}, {.id = 2336, .name = "Downtown Crossing"}, {.id = 1056, .name = "Downtown Crossing"}, {.id = 6814, .name = "Downtown Crossing"}, {.id = 6813, .name = "Downtown Crossing"}, {.id = 2212, .name = "Downtown Crossing"}, {.id = 7038, .name = "Downtown Crossing"}, // State {.id = 7092, .name = "State"}, {.id = 1844, .name = "State"}, {.id = 6689, .name = "State"}, {.id = 6988, .name = "State"}, {.id = 6991, .name = "State"}, {.id = 2083, .name = "State"}, {.id = 6688, .name = "State"}, {.id = 6687, .name = "State"}, {.id = 6686, .name = "State"}, {.id = 2078, .name = "State"}, {.id = 6987, .name = "State"}, {.id = 7090, .name = "State"}, {.id = 1842, .name = "State"}, // Haymarket {.id = 6684, .name = "Haymarket"}, {.id = 6683, .name = "Haymarket"}, {.id = 6682, .name = "Haymarket"}, {.id = 6681, .name = "Haymarket"}, {.id = 2073, .name = "Haymarket"}, {.id = 7074, .name = "Haymarket"}, {.id = 6883, .name = "Haymarket"}, {.id = 6884, .name = "Haymarket"}, {.id = 6885, .name = "Haymarket"}, {.id = 6886, .name = "Haymarket"}, {.id = 2303, .name = "Haymarket"}, {.id = 6986, .name = "Haymarket"}, // North Station {.id = 6985, .name = "North Station"}, {.id = 2063, .name = "North Station"}, {.id = 6671, .name = "North Station"}, {.id = 6672, .name = "North Station"}, {.id = 6673, .name = "North Station"}, {.id = 6674, .name = "North Station"}, {.id = 6675, .name = "North Station"}, {.id = 6676, .name = "North Station"}, {.id = 6677, .name = "North Station"}, {.id = 6678, .name = "North Station"}, {.id = 6984, .name = "North Station"}, {.id = 2062, .name = "North Station"}, {.id = 6668, .name = "North Station"}, {.id = 6667, .name = "North Station"}, {.id = 6666, .name = "North Station"}, {.id = 6665, .name = "North Station"}, {.id = 6664, .name = "North Station"}, // Sullivan Square {.id = 6654, .name = "Sullivan Square"}, {.id = 6655, .name = "Sullivan Square"}, {.id = 6656, .name = "Sullivan Square"}, {.id = 6657, .name = "Sullivan Square"}, {.id = 6658, .name = "Sullivan Square"}, {.id = 6659, .name = "Sullivan Square"}, {.id = 2053, .name = "Sullivan Square"}, {.id = 6982, .name = "Sullivan Square"}, // Community College {.id = 6661, .name = "Community College"}, {.id = 6662, .name = "Community College"}, {.id = 2056, .name = "Community College"}, {.id = 6983, .name = "Community College"}, // Assembly {.id = 3876, .name = "Assembly"}, {.id = 3875, .name = "Assembly"}, {.id = 6957, .name = "Assembly"}, {.id = 6956, .name = "Assembly"}, {.id = 6955, .name = "Assembly"}, {.id = 6954, .name = "Assembly"}, {.id = 6953, .name = "Assembly"}, {.id = 7101, .name = "Assembly"}, {.id = 3873, .name = "Assembly"}, {.id = 3872, .name = "Assembly"}, // Wellington {.id = 6981, .name = "Wellington"}, {.id = 2042, .name = "Wellington"}, {.id = 6650, .name = "Wellington"}, {.id = 6651, .name = "Wellington"}, {.id = 6652, .name = "Wellington"}, {.id = 6653, .name = "Wellington"}, // Malden {.id = 6980, .name = "Malden Center"}, {.id = 2037, .name = "Malden Center"}, {.id = 6645, .name = "Malden Center"}, {.id = 6646, .name = "Malden Center"}, {.id = 6647, .name = "Malden Center"}, {.id = 6648, .name = "Malden Center"}, // Chinatown {.id = 6704, .name = "Chinatown"}, {.id = 6705, .name = "Chinatown"}, {.id = 2099, .name = "Chinatown"}, {.id = 7003, .name = "Chinatown"}, {.id = 7002, .name = "Chinatown"}, {.id = 2096, .name = "Chinatown"}, {.id = 6702, .name = "Chinatown"}, {.id = 6701, .name = "Chinatown"}, // Tufts Medical Center {.id = 6707, .name = "Tufts Medical Center"}, {.id = 6708, .name = "Tufts Medical Center"}, {.id = 6709, .name = "Tufts Medical Center"}, {.id = 6710, .name = "Tufts Medical Center"}, {.id = 6711, .name = "Tufts Medical Center"}, {.id = 2105, .name = "Tufts Medical Center"}, {.id = 7004, .name = "Tufts Medical Center"}, {.id = 1941, .name = "Tufts Medical Center"}, {.id = 7006, .name = "Tufts Medical Center"}, // Back Bay {.id = 7007, .name = "Back Bay"}, {.id = 1480, .name = "Back Bay"}, {.id = 6714, .name = "Back Bay"}, {.id = 6715, .name = "Back Bay"}, {.id = 6716, .name = "Back Bay"}, {.id = 6717, .name = "Back Bay"}, {.id = 6718, .name = "Back Bay"}, {.id = 6719, .name = "Back Bay"}, {.id = 6720, .name = "Back Bay"}, {.id = 1801, .name = "Back Bay"}, {.id = 7009, .name = "Back Bay"}, // Massachusetts Avenue {.id = 7010, .name = "Massachusetts Avenue"}, {.id = 2118, .name = "Massachusetts Avenue"}, {.id = 6724, .name = "Massachusetts Avenue"}, {.id = 6723, .name = "Massachusetts Avenue"}, {.id = 6722, .name = "Massachusetts Avenue"}, {.id = 6721, .name = "Massachusetts Avenue"}, // Ruggles {.id = 6726, .name = "Ruggles"}, {.id = 6727, .name = "Ruggles"}, {.id = 6728, .name = "Ruggles"}, {.id = 2122, .name = "Ruggles"}, {.id = 2123, .name = "Ruggles"}, {.id = 2124, .name = "Ruggles"}, {.id = 1804, .name = "Ruggles"}, // Roxbury Crossing {.id = 6737, .name = "Roxbury Crossing"}, {.id = 6736, .name = "Roxbury Crossing"}, {.id = 6735, .name = "Roxbury Crossing"}, {.id = 6734, .name = "Roxbury Crossing"}, {.id = 6733, .name = "Roxbury Crossing"}, {.id = 2125, .name = "Roxbury Crossing"}, {.id = 7012, .name = "Roxbury Crossing"}, // Jackson Square {.id = 6741, .name = "Jackson Square"}, {.id = 6740, .name = "Jackson Square"}, {.id = 6739, .name = "Jackson Square"}, {.id = 2131, .name = "Jackson Square"}, {.id = 7013, .name = "Jackson Square"}, {.id = 7014, .name = "Jackson Square"}, {.id = 2135, .name = "Jackson Square"}, {.id = 6743, .name = "Jackson Square"}, {.id = 6744, .name = "Jackson Square"}, {.id = 6745, .name = "Jackson Square"}, // Green Street {.id = 6746, .name = "Green Street"}, {.id = 6747, .name = "Green Street"}, {.id = 6748, .name = "Green Street"}, {.id = 2142, .name = "Green Street"}, {.id = 7015, .name = "Green Street"}, // Forest Hills {.id = 6750, .name = "Forest Hills"}, {.id = 6751, .name = "Forest Hills"}, {.id = 6752, .name = "Forest Hills"}, {.id = 6753, .name = "Forest Hills"}, {.id = 6754, .name = "Forest Hills"}, {.id = 6755, .name = "Forest Hills"}, {.id = 2150, .name = "Forest Hills"}, {.id = 7016, .name = "Forest Hills"}, {.id = 6950, .name = "Forest Hills"}, {.id = 6951, .name = "Forest Hills"}, {.id = 604, .name = "Forest Hills"}, {.id = 7096, .name = "Forest Hills"}, // South Station {.id = 7039, .name = "South Station"}, {.id = 2215, .name = "South Station"}, {.id = 6816, .name = "South Station"}, {.id = 6817, .name = "South Station"}, {.id = 6818, .name = "South Station"}, {.id = 6819, .name = "South Station"}, {.id = 6820, .name = "South Station"}, {.id = 6821, .name = "South Station"}, {.id = 6822, .name = "South Station"}, {.id = 6823, .name = "South Station"}, {.id = 7040, .name = "South Station"}, {.id = 2228, .name = "South Station"}, {.id = 6827, .name = "South Station"}, {.id = 6826, .name = "South Station"}, {.id = 6825, .name = "South Station"}, {.id = 6824, .name = "South Station"}, // Courthouse {.id = 6929, .name = "Courthouse"}, {.id = 2357, .name = "Courthouse"}, {.id = 7079, .name = "Courthouse"}, {.id = 6933, .name = "Courthouse"}, {.id = 6932, .name = "Courthouse"}, {.id = 2358, .name = "Courthouse"}, {.id = 6792, .name = "Courthouse"}, // Bowdoin {.id = 6937, .name = "Bowdoin"}, {.id = 2367, .name = "Bowdoin"}, {.id = 7085, .name = "Bowdoin"}, // Government Center {.id = 6963, .name = "Government Center"}, {.id = 6962, .name = "Government Center"}, {.id = 6961, .name = "Government Center"}, {.id = 6960, .name = "Government Center"}, {.id = 6959, .name = "Government Center"}, {.id = 6958, .name = "Government Center"}, {.id = 5298, .name = "Government Center"}, // Aquarium {.id = 6609, .name = "Aquarium"}, {.id = 6608, .name = "Aquarium"}, {.id = 1877, .name = "Aquarium"}, {.id = 6965, .name = "Aquarium"}, {.id = 6610, .name = "Aquarium"}, {.id = 1880, .name = "Aquarium"}, {.id = 1871, .name = "Aquarium"}, {.id = 6966, .name = "Aquarium"}, // Maverick {.id = 7088, .name = "Maverick"}, {.id = 6944, .name = "Maverick"}, {.id = 4384, .name = "Maverick"}, {.id = 6946, .name = "Maverick"}, {.id = 6947, .name = "Maverick"}, {.id = 6948, .name = "Maverick"}, {.id = 6949, .name = "Maverick"}, {.id = 1840, .name = "Maverick"}, {.id = 7083, .name = "Maverick"}, // Airport {.id = 6613, .name = "Airport"}, {.id = 6612, .name = "Airport"}, {.id = 6611, .name = "Airport"}, {.id = 6968, .name = "Airport"}, {.id = 2009, .name = "Airport"}, {.id = 6616, .name = "Airport"}, {.id = 6615, .name = "Airport"}, {.id = 6614, .name = "Airport"}, {.id = 6970, .name = "Airport"}, {.id = 1847, .name = "Airport"}, // Wood Island {.id = 6618, .name = "Wood Island"}, {.id = 6619, .name = "Wood Island"}, {.id = 2010, .name = "Wood Island"}, {.id = 6971, .name = "Wood Island"}, // Orient Heights {.id = 6621, .name = "Orient Heights"}, {.id = 6622, .name = "Orient Heights"}, {.id = 6623, .name = "Orient Heights"}, {.id = 2014, .name = "Orient Heights"}, {.id = 6972, .name = "Orient Heights"}, {.id = 6974, .name = "Orient Heights"}, {.id = 1868, .name = "Orient Heights"}, // Suffolk Downs {.id = 6625, .name = "Suffolk Downs"}, {.id = 6626, .name = "Suffolk Downs"}, {.id = 2017, .name = "Suffolk Downs"}, {.id = 6975, .name = "Suffolk Downs"}, // Beachmont {.id = 6628, .name = "Beachmont"}, {.id = 6629, .name = "Beachmont"}, {.id = 6630, .name = "Beachmont"}, {.id = 2021, .name = "Beachmont"}, {.id = 6976, .name = "Beachmont"}, // Revere Beach {.id = 6632, .name = "Revere Beach"}, {.id = 6633, .name = "Revere Beach"}, {.id = 2024, .name = "Revere Beach"}, {.id = 6977, .name = "Revere Beach"}, // Wonderland {.id = 6638, .name = "Wonderland"}, {.id = 6637, .name = "Wonderland"}, {.id = 6636, .name = "Wonderland"}, {.id = 2025, .name = "Wonderland"}, {.id = 6978, .name = "Wonderland"}, }; static const size_t kNumFareGateIds = COUNT_OF(charliecard_fare_gate_ids); // ********************************************************** // ********************* MISC HELPERS *********************** // ********************************************************** static const uint8_t* pos_to_ptr(const MfClassicData* data, uint8_t sector_num, uint8_t block_num, uint8_t byte_num) { // returns pointer to specified sector/block/byte of MFClassic card data uint8_t block_offset = mf_classic_get_first_block_num_of_sector(sector_num); return &data->block[block_offset + block_num].data[byte_num]; } static uint64_t pos_to_num( const MfClassicData* data, uint8_t sector_num, uint8_t block_num, uint8_t byte_num, uint8_t byte_len) { // returns numeric values at specified card location, for given byte length. // assumes big endian. return bit_lib_bytes_to_num_be(pos_to_ptr(data, sector_num, block_num, byte_num), byte_len); } static DateTime dt_delta(DateTime dt, uint64_t delta_secs) { // returns shifted DateTime, from initial DateTime and time offset in seconds DateTime dt_shifted = {0}; datetime_timestamp_to_datetime(datetime_datetime_to_timestamp(&dt) + delta_secs, &dt_shifted); return dt_shifted; } static bool dt_ge(DateTime dt1, DateTime dt2) { // compares two DateTimes return datetime_datetime_to_timestamp(&dt1) >= datetime_datetime_to_timestamp(&dt2); } static bool dt_eq(DateTime dt1, DateTime dt2) { // compares two DateTimes return datetime_datetime_to_timestamp(&dt1) == datetime_datetime_to_timestamp(&dt2); } static bool get_map_item(uint16_t id, const IdMapping* map, size_t sz, const char** out) { // code borrowed from Jeremy Cooper's 'clipper.c'. Used as follows: // const char* s; if(!get_map_item(_,_,_,&s)) {s="Default str";} // TODO: change to furistring out? for(size_t i = 0; i < sz; i++) { if(map[i].id == id) { *out = map[i].name; return true; } } return false; } uint32_t time_now() { return furi_hal_rtc_get_timestamp(); } static bool is_debug() { return furi_hal_rtc_is_flag_set(FuriHalRtcFlagDebug); } // ********************************************************** // ******************** FIELD PARSING *********************** // ********************************************************** static Money money_parse( const MfClassicData* data, uint8_t sector_num, uint8_t block_num, uint8_t byte_num) { // CharlieCards store all money values in two bytes as half-cents // bitmask removes sign/flag, bitshift converts half-cents to cents, div & mod yield dollars & cents uint16_t amt = (pos_to_num(data, sector_num, block_num, byte_num, 2) & 0x7FFF) >> 1; return (Money){amt / 100, amt % 100}; } static DateTime date_parse(const MfClassicData* data, uint8_t sector_num, uint8_t block_num, uint8_t byte_num) { // Dates are 3 bytes, in minutes since 2003/1/1 ("CHARLIE_EPOCH") uint32_t ts_charlie = pos_to_num(data, sector_num, block_num, byte_num, 3); return dt_delta(CHARLIE_EPOCH, ts_charlie * CHARLIE_TIME_DELTA_SECS); } static DateTime end_validity_parse( const MfClassicData* data, uint8_t sector_num, uint8_t block_num, uint8_t byte_num) { // End validity field is weird; shares first byte with another variable (the card type field), // occupying the last 5 bits (and subsequent two bytes), hence bitmask uint32_t ts_charlie_ev = pos_to_num(data, sector_num, block_num, byte_num, 3) & 0x1FFFFF; // additionally, instead of minute deltas, is in 8 minute increments // relative to CHARLIE_EPOCH (2003/1/1), per DEFCON31 researcher's work return dt_delta(CHARLIE_EPOCH, ts_charlie_ev * CHARLIE_END_VALID_DELTA_SECS); } static Pass pass_parse(const MfClassicData* data, uint8_t sector_num, uint8_t block_num, uint8_t byte_num) { // WIP; testing only. Speculating it may be structured as follows // Sub-byte field divisions not drawn to scale, see code for exact bit offsets // // 0 1 2 3 4 5 // +----.----.----.----+----.----+ // | uk1 | date | uk2 | // +----.----.----.----+----.----+ // // "Blank" entries are as follows: // 0 1 2 3 4 5 // +----.----.----.----.----.----+ // | 00 20 00 00 00 00 | // +----.----.----.----.----.----+ // // even when not blank, uk1 LSB seems to always be set to 1... // the sole bit set to 1 on the blank entry seems to divide // the uk1 and date fields, and is always set to 1 regardless // same is true of type & end-validity split found in balance sector // // likely fields incl // — type #, // — a secondary date field (eg start/end, end validity or normal format) // — ID of FVM from which the pass was loaded // check for empty, if so, return struct filled w/ 0s // (incl "valid" field: hence, "valid" is false-y) if(pos_to_num(data, sector_num, block_num, byte_num, 6) == 0x002000000000) { return (Pass){0}; } // const DateTime start = date_parse(data, sector_num, block_num, byte_num + 1); const uint16_t pre = pos_to_num(data, sector_num, block_num, byte_num, 2) >> 6; const uint16_t post = (pos_to_num(data, sector_num, block_num, byte_num + 4, 2) >> 2) & 0x3ff; // these values make sense for a date, but implied position of type // before end validity, as seen in balance sector, doesn't seem // to produce sensible values const DateTime date = end_validity_parse(data, sector_num, block_num, byte_num + 1); // DateTime start = date_parse(data, sector_num, block_num, byte_num); // uint16_t type = 0; // pos_to_num(data, sector_num, block_num, byte_num + 3, 2) >> 6; return (Pass){true, pre, post, date}; } static Transaction transaction_parse(const MfClassicData* data, uint8_t sector, uint8_t block, uint8_t byte) { // This function parses individual transactions. Each transaction packs 7 bytes, stored as follows: // // 0 1 2 3 4 5 6 // +----.----.----+----.--+-+----.----+ // | date | loc |f| amt | // +----.----.----+----.--+-+----.----+ // // Where date is in the typical format, loc represents the fare gate tapped, and amt is the fare amount. // Amount appears to contain some flag bits, however, it is unclear what precisely their function is. // // Gate ID ("loc") is only the first 13 bits of 0x3:0x5, the final three bits appear to be flags ("f"). // Least significant flag bit seems to indicate: // — When f & 1 == 1, fare (the amount by which balance is decremented) // — When f & 1 == 0, refill (the amount by which balance is incremented) // MSB (sign bit) of amt seems to serve the same role, just inverted, ie // — When amt & 0x8000 == 0, fare // — When amt & 0x8000 == 0x8000, refill // Only contradiction between the two observed is on cards w/ passes; // MSB of amt seems to be set for every transaction when (remaining bits of) amt is 0 on a card w/ a pass // Hence, using f's LSB as method for inferring fare v. refill // // Remaining unknown bits: // — f & 0b100; seems to be set on fares where the card has a pass, and amt is 0 // — f & 0b010 // — amt & 1; does not seem to correspond with card type, last transaction, first transaction, refill v. fare, etc const DateTime date = date_parse(data, sector, block, byte); const uint16_t gate = pos_to_num(data, sector, block, byte + 3, 2) >> 3; const uint8_t g_flag = pos_to_num(data, sector, block, byte + 3, 2) & 0b111; const Money fare = money_parse(data, sector, block, byte + 5); const uint16_t f_flag = pos_to_num(data, sector, block, byte + 5, 2) & 0x8001; return (Transaction){date, gate, g_flag, fare, f_flag}; } // ********************************************************** // ******************* SECTOR PARSING *********************** // ********************************************************** static uint32_t mfg_sector_parse(const MfClassicData* data) { // Manufacturer data (Sector 0) // // 0 1 2 3 4 5 6 7 8 9 A B C D E F // +----.----.----.----+----+----.----.----.----+----+----.----.----.----.----+----+ // 0x000 | UID | rc | 88 04 00 C8 | uk | 00 20 00 00 00 | uk | // +----.----.----.----+----+----.----.----.----+----+----.----.----.----.----+----+ // 0x010 | 4E 0F 04 10 04 10 04 10 04 10 04 10 04 10 04 10 | // +----.----.----.----.----.----.----.----.----.----.----.----.----.----.----.----+ // 0x020 | ... 00 00 ... | // +----.----.----.----.----.----.----.----.----.----.----.----.----.----.----.----+ // // rc := "redundancy check" (lrc / bcc) // uk := "unknown" size_t uid_len = 0; const uint8_t* uid = mf_classic_get_uid(data, &uid_len); const uint32_t card_number = bit_lib_bytes_to_num_be(uid, 4); return card_number; } static CounterSector counter_sector_parse(const MfClassicData* data) { // Trip/transaction counters (Sector 1) // // 0 1 2 3 4 5 6 7 8 9 A B C D E F // +----.----.----.----.----.----.----.----.----.----.----.----.----.----.----.----+ // 0x040 | 04 10 23 45 66 77 ... 00 00 ... | // +----.----+----+----.----.----.----.----.----.----.----.----.----.----.----.----+ // 0x050 | uses1 | uk | ... 00 00 ... | // +----.----+----+----.----.----.----.----.----.----.----.----.----.----.----.----+ // 0x060 | uses2 | uk | ... 00 00 ... | // +----.----+----+----.----.----.----.----.----.----.----.----.----.----.----.----+ // // uk := "unknown"; if nonzero, seems to only occupy the first 4 bits (ie, uk & 0xF0 == uk), // with the remaining 4 zero // Card has two sectors (2 & 3) containing balance data, with two // corresponding trip counters in 0x50:0x51 & 0x60:0x61 (sector 1, byte 0:1 of blocks 1 & 2). // The *lower* of the two values *minus one* is the true use count, // and corresponds to the active balance sector, // (0x50 counter lower -> sector 2 active, 0x60 counter lower -> 3 active) // per DEFCON31 researcher's findings const uint16_t n_uses1 = pos_to_num(data, 1, 1, 0, 2); const uint16_t n_uses2 = pos_to_num(data, 1, 2, 0, 2); const bool is_sec2_active = n_uses1 <= n_uses2; const uint8_t active_sector = is_sec2_active ? 2 : 3; const uint16_t n_uses = (is_sec2_active ? n_uses1 : n_uses2) - 1; return (CounterSector){n_uses, active_sector}; } static BalanceSector balance_sector_parse(const MfClassicData* data, uint8_t active_sector) { // Balance & misc card info (Sector 2 or 3) // // 0 1 2 3 4 5 6 7 8 9 A B C D E F // +----+----.----.----+----.----+----.----.----+----.----+----.----+----+----.----+ // 0x080 | 11 | date last | loc last| date issued | 65 00 | unknown | 00 | crc | 0x0C0 // +----+----.----.----+----+----+----+----+----+----.----+----.----+----+----.----+ // 0x090 | type |end validity| uk | balance | 00 | unknown | crc | 0x0D0 // +----.----.----.----+----+----.----+----+----.----.----.----.----.----+----.----+ // 0x0A0 | 20 ... 00 00 ... 04 | crc | 0x0E0 // +----.----.----.----.----.----.----.----.----.----.----.----.----.----+----.----+ // // "Active" balance sector alternates between 2 and 3 // Last trip/transaction info in balance sector ("date last" & "loc last") // is also included in transaction log, hence don't bother to read here // // Inactive balance sector represent the transaction N-1 version // (where active sector represents data from transaction N). const DateTime issued = date_parse(data, active_sector, 0, 6); const DateTime end_validity = end_validity_parse(data, active_sector, 1, 1); // Card type data stored in the first 10bits of block 1 // (0x90 or 0xD0 depending on active sector) // bitshift (2bytes = 16 bits) by 6bits for just first 10bits const uint16_t type = pos_to_num(data, active_sector, 1, 0, 2) >> 6; const Money bal = money_parse(data, active_sector, 1, 5); return (BalanceSector){bal, type, issued, end_validity}; } static Pass* passes_parse(const MfClassicData* data) { // Passes, speculative (Sectors 4 &/or 5) // // 0 1 2 3 4 5 6 7 8 9 A B C D E F // +----.----.----.----.----.----+----+----.----.----.----.----.----+----+----.----+ // 0x100 | pass0/2? | 00 | pass1/3? | 00 | crc | 0x140 // +----.----.----.----.----.----+----+----.----.----.----.----.----+----+----.----+ // 0x110 | ... 00 00 ... | crc | 0x150 // +----.----.----.----.----.----.----.----.----.----.----.----.----.----+----.----+ // 0x120 | ... 00 ... 05 | crc | 0x160 // +----.----.----.----.----.----.----.----.----.----.----.----.----.----+----.----+ // // WIP. Read in all speculative passes into array // 4 separate fields? active vs inactive sector for 2 passes? // something else entirely? Pass* passes = malloc(sizeof(Pass) * CHARLIE_N_PASSES); for(size_t i = 0; i < CHARLIE_N_PASSES; i++) { passes[i] = pass_parse(data, 4 + (i / 2), 0, (i % 2) * 7); } return passes; } static Transaction* transactions_parse(const MfClassicData* data) { // Transaction history (Sectors 6–7) // // 0 1 2 3 4 5 6 7 8 9 A B C D E F // +----.----.----.----.----.----.----+----.----.----.----.----.----.----+----.----+ // 0x180 | transaction0 | transaction1 | crc | // +----.----.----.----.----.----.----+----.----.----.----.----.----.----+----.----+ // ... ... ... ... // +----.----.----.----.----.----.----+----.----.----.----.----.----.----+----.----+ // 0x1D0 | transaction8 | transaction9 | crc | // +----.----.----.----.----.----.----+----.----.----.----.----.----.----+----.----+ // 0x1E0 | ... 00 00 ... | crc | // +----.----.----.----.----.----.----.----.----.----.----.----.----.----+----.----+ // // Transactions are not sorted, rather, appear to get overwritten // sequentially. (eg, sorted modulo array rotation) Transaction* transactions = malloc(sizeof(Transaction) * CHARLIE_N_TRANSACTION_HISTORY); // Parse each transaction field using some modular math magic to get the offsets: // move from sector 6 -> 7 after the first 6 transactions // move a block within a given sector every 2 transactions, reset every 3 blocks (as sector has changed) // alternate between a start byte of 0 and 7 with every iteration for(size_t i = 0; i < CHARLIE_N_TRANSACTION_HISTORY; i++) { transactions[i] = transaction_parse(data, 6 + (i / 6), (i / 2) % 3, (i % 2) * 7); } // Iterate through the array to find the maximum (newest) date value int max_idx = 0; for(int i = 1; i < CHARLIE_N_TRANSACTION_HISTORY; i++) { if(dt_ge(transactions[i].date, transactions[max_idx].date)) { max_idx = i; } } // Sort by rotating for(int r = 0; r < (max_idx + 1); r++) { // Store the first element Transaction temp = transactions[0]; // Shift elements to the left for(int i = 0; i < CHARLIE_N_TRANSACTION_HISTORY - 1; i++) { transactions[i] = transactions[i + 1]; } // Move the first element to the last transactions[CHARLIE_N_TRANSACTION_HISTORY - 1] = temp; } // Reverse order, such that newest is first, oldest last for(int i = 0; i < CHARLIE_N_TRANSACTION_HISTORY / 2; i++) { // Swap elements at index i and size - i - 1 Transaction temp = transactions[i]; transactions[i] = transactions[CHARLIE_N_TRANSACTION_HISTORY - i - 1]; transactions[CHARLIE_N_TRANSACTION_HISTORY - i - 1] = temp; } return transactions; } /* static DateTime expiry(DateTime iss) { // Per Metrodroid CharlieCard parser (https://github.com/metrodroid/metrodroid/blob/master/src/commonMain/kotlin/au/id/micolous/metrodroid/transit/charlie/CharlieCardTransitData.kt) // Expiry not explicitly stored in card data; rather, calculated from date of issue // Cards were first issued in 2006, expired in 5 years, w/ no printed expiry date // Cards issued after 2011 expire in 10 years // // Per DEFCON31 researcher's work (cited above): // Student cards last one school year and expire at the end of August the following year // Pre-2011 issued cards expire in 7 years, not 5 as claimed by Metrodroid // Post-2011 expire in 10 years, less one day // Redundant function given the existance of the end validity field? // Any important distinctions between the two? // perhaps additionally clipping to 2030-12-__ in anticipation of upcoming system migration? // need to get a new card to confirm. // TODO add card type logic for student card expiry DateTime exp; if(iss.year < 2011) { // add 7 years; assumes average year of 8766 hrs (to account for leap years) // may be off by a few hours as a result exp = dt_delta(iss, 7 * 8766 * 60 * 60); } else { // add 10 years, subtract a day. Same assumption as above exp = dt_delta(iss, ((10 * 8766) - 24) * 60 * 60); } return exp; } static bool expired(DateTime expiry, DateTime last_transaction) { // if a card has sat unused for >2 years, expired (verify this claim?) // else expired if current date > expiry date uint32_t ts_exp = datetime_datetime_to_timestamp(&expiry); uint32_t ts_last = datetime_datetime_to_timestamp(&last_transaction); uint32_t ts_now = time_now(); return (ts_exp <= ts_now) | ((ts_now - ts_last) >= (2 * 365 * 24 * 60 * 60)); } */ // ********************************************************** // ****************** STRING FORMATTING ********************* // ********************************************************** void locale_format_dt_cat(FuriString* out, const DateTime* dt) { // helper to print datetimes FuriString* s = furi_string_alloc(); LocaleDateFormat date_format = locale_get_date_format(); const char* separator = (date_format == LocaleDateFormatDMY) ? "." : "/"; locale_format_date(s, dt, date_format, separator); furi_string_cat(out, s); locale_format_time(s, dt, locale_get_time_format(), false); furi_string_cat_printf(out, " "); furi_string_cat(out, s); furi_string_free(s); } void type_format_cat(FuriString* out, uint16_t type) { const char* s; if(!get_map_item(type, charliecard_types, kNumTypes, &s)) { s = ""; furi_string_cat_printf(out, "Unknown-%u", type); } furi_string_cat_str(out, s); } void pass_format_cat(FuriString* out, Pass pass) { furi_string_cat_printf(out, "\n-Pre: %b", pass.pre); // type_format_cat(out, pass.type); furi_string_cat_printf(out, "\n-Post: "); type_format_cat(out, pass.post); // locale_format_dt_cat(out, &pass.start); furi_string_cat_printf(out, "\n-Date: "); locale_format_dt_cat(out, &pass.date); } void passes_format_cat(FuriString* out, Pass* passes) { // only print passes if DEBUG on if(!is_debug()) { return; } // only print if there is at least 1 valid pass to print bool any_valid = false; for(size_t i = 0; i < CHARLIE_N_PASSES; i++) { any_valid |= passes[i].valid; } if(!any_valid) { return; } furi_string_cat_printf(out, "\nPasses (DEBUG / WIP):"); for(size_t i = 0; i < CHARLIE_N_PASSES; i++) { if(passes[i].valid) { furi_string_cat_printf(out, "\nPass %u", i + 1); pass_format_cat(out, passes[i]); furi_string_cat_printf(out, "\n"); } } } void money_format_cat(FuriString* out, Money money) { furi_string_cat_printf(out, "$%u.%02u", money.dollars, money.cents); } void transaction_format_cat(FuriString* out, Transaction transaction) { const char* sep = " "; const char* sta; locale_format_dt_cat(out, &transaction.date); furi_string_cat_printf(out, "\n%s", !!(transaction.g_flag & 0x1) ? "-" : "+"); money_format_cat(out, transaction.fare); if(!!(transaction.g_flag & 0x1) && (transaction.fare.dollars == FARE_BUS.dollars) && (transaction.fare.cents == FARE_BUS.cents)) { // if not a refill, and the fare amount is equal to bus fare (any better approach? flag bits for modality?) // format for bus — supposedly some correlation between gate ID & bus #, haven't investigated furi_string_cat_printf(out, "%s#%u", sep, transaction.gate); } else if(get_map_item(transaction.gate, charliecard_fare_gate_ids, kNumFareGateIds, &sta)) { // station found in fare gate ID map, append station name furi_string_cat_str(out, sep); furi_string_cat_str(out, sta); } else { // no found station in fare gate ID map & not a bus, just print ID w/o add'l info furi_string_cat_printf(out, "%s#%u", sep, transaction.gate); } // print flags for debugging purposes if(is_debug()) { furi_string_cat_printf(out, "%s%x%s%x", sep, transaction.g_flag, sep, transaction.f_flag); } } void transactions_format_cat(FuriString* out, Transaction* transactions) { furi_string_cat_printf(out, "\nTransactions:"); for(size_t i = 0; i < CHARLIE_N_TRANSACTION_HISTORY; i++) { furi_string_cat_printf(out, "\n"); transaction_format_cat(out, transactions[i]); furi_string_cat_printf(out, "\n"); } } // ********************************************************** // **************** NFC PLUGIN BOILERPLATE ****************** // ********************************************************** static bool charliecard_parse(FuriString* parsed_data, const MfClassicData* data) { bool parsed = false; do { // Verify key // arbitrary sector in the main data portion const uint8_t verify_sector = 3; const MfClassicSectorTrailer* sec_tr = mf_classic_get_sector_trailer_by_sector(data, verify_sector); const uint64_t key_a = bit_lib_bytes_to_num_be(sec_tr->key_a.data, COUNT_OF(sec_tr->key_a.data)); if(key_a != charliecard_1k_keys[verify_sector].a) break; // parse card data const uint32_t card_number = mfg_sector_parse(data); const CounterSector counter_sector = counter_sector_parse(data); const BalanceSector balance_sector = balance_sector_parse(data, counter_sector.active_balance_sector); Pass* passes = passes_parse(data); Transaction* transactions = transactions_parse(data); // print/append card data furi_string_cat_printf(parsed_data, "\e#CharlieCard"); furi_string_cat_printf(parsed_data, "\nSerial: 5-%lu", card_number); // Type and balance 0 on some (Perq) cards // (ie no "main" type / balance / end validity, // essentially only pass & trip info) // skip/change formatting for that case? furi_string_cat_printf(parsed_data, "\nBal: "); money_format_cat(parsed_data, balance_sector.balance); furi_string_cat_printf(parsed_data, "\nType: "); type_format_cat(parsed_data, balance_sector.type); furi_string_cat_printf(parsed_data, "\nTrip Count: %u", counter_sector.n_uses); furi_string_cat_printf(parsed_data, "\nIssued: "); locale_format_dt_cat(parsed_data, &balance_sector.issued); if(!dt_eq(balance_sector.end_validity, CHARLIE_EPOCH) & dt_ge(balance_sector.end_validity, balance_sector.issued)) { // sometimes (seen on Perq cards) end validity field is all 0 // When this is the case, calc'd end validity is equal to CHARLIE_EPOCH). // Only print if not 0, & end validity after issuance date furi_string_cat_printf(parsed_data, "\nExpiry: "); locale_format_dt_cat(parsed_data, &balance_sector.end_validity); } // const DateTime last = date_parse(data, active_sector, 0, 1); // furi_string_cat_printf(parsed_data, "\nExpired: %s", expired(e_v, last) ? "Yes" : "No"); transactions_format_cat(parsed_data, transactions); free(transactions); passes_format_cat(parsed_data, passes); free(passes); parsed = true; } while(false); return parsed; } static NfcCommand metroflip_scene_charlicard_poller_callback(NfcGenericEvent event, void* context) { furi_assert(context); furi_assert(event.event_data); furi_assert(event.protocol == NfcProtocolMfClassic); NfcCommand command = NfcCommandContinue; const MfClassicPollerEvent* mfc_event = event.event_data; Metroflip* app = context; if(mfc_event->type == MfClassicPollerEventTypeCardDetected) { view_dispatcher_send_custom_event(app->view_dispatcher, MetroflipCustomEventCardDetected); command = NfcCommandContinue; } else if(mfc_event->type == MfClassicPollerEventTypeCardLost) { view_dispatcher_send_custom_event(app->view_dispatcher, MetroflipCustomEventCardLost); app->sec_num = 0; command = NfcCommandStop; } else if(mfc_event->type == MfClassicPollerEventTypeRequestMode) { mfc_event->data->poller_mode.mode = MfClassicPollerModeRead; } else if(mfc_event->type == MfClassicPollerEventTypeRequestReadSector) { MfClassicKey key = {0}; bit_lib_num_to_bytes_be(charliecard_1k_keys[app->sec_num].a, COUNT_OF(key.data), key.data); MfClassicKeyType key_type = MfClassicKeyTypeA; mfc_event->data->read_sector_request_data.sector_num = app->sec_num; mfc_event->data->read_sector_request_data.key = key; mfc_event->data->read_sector_request_data.key_type = key_type; mfc_event->data->read_sector_request_data.key_provided = true; if(app->sec_num == 16) { mfc_event->data->read_sector_request_data.key_provided = false; app->sec_num = 0; } app->sec_num++; } else if(mfc_event->type == MfClassicPollerEventTypeSuccess) { nfc_device_set_data( app->nfc_device, NfcProtocolMfClassic, nfc_poller_get_data(app->poller)); const MfClassicData* mfc_data = nfc_device_get_data(app->nfc_device, NfcProtocolMfClassic); FuriString* parsed_data = furi_string_alloc(); Widget* widget = app->widget; dolphin_deed(DolphinDeedNfcReadSuccess); furi_string_reset(app->text_box_store); if(!charliecard_parse(parsed_data, mfc_data)) { furi_string_reset(app->text_box_store); FURI_LOG_I(TAG, "Unknown card type"); furi_string_printf(parsed_data, "\e#Unknown card\n"); } widget_add_text_scroll_element(widget, 0, 0, 128, 64, furi_string_get_cstr(parsed_data)); widget_add_button_element( widget, GuiButtonTypeRight, "Exit", metroflip_exit_widget_callback, app); widget_add_button_element( widget, GuiButtonTypeCenter, "Save", metroflip_save_widget_callback, app); furi_string_free(parsed_data); view_dispatcher_switch_to_view(app->view_dispatcher, MetroflipViewWidget); command = NfcCommandStop; metroflip_app_blink_stop(app); } else if(mfc_event->type == MfClassicPollerEventTypeFail) { FURI_LOG_I(TAG, "fail"); command = NfcCommandContinue; } return command; } static void charliecard_on_enter(Metroflip* app) { dolphin_deed(DolphinDeedNfcRead); app->sec_num = 0; if(app->data_loaded) { Storage* storage = furi_record_open(RECORD_STORAGE); FlipperFormat* ff = flipper_format_file_alloc(storage); if(flipper_format_file_open_existing(ff, app->file_path)) { MfClassicData* mfc_data = mf_classic_alloc(); mf_classic_load(mfc_data, ff, 2); FuriString* parsed_data = furi_string_alloc(); Widget* widget = app->widget; furi_string_reset(app->text_box_store); if(!charliecard_parse(parsed_data, mfc_data)) { furi_string_reset(app->text_box_store); FURI_LOG_I(TAG, "Unknown card type"); furi_string_printf(parsed_data, "\e#Unknown card\n"); } widget_add_text_scroll_element( widget, 0, 0, 128, 64, furi_string_get_cstr(parsed_data)); widget_add_button_element( widget, GuiButtonTypeRight, "Exit", metroflip_exit_widget_callback, app); widget_add_button_element( widget, GuiButtonTypeCenter, "Delete", metroflip_delete_widget_callback, app); mf_classic_free(mfc_data); furi_string_free(parsed_data); view_dispatcher_switch_to_view(app->view_dispatcher, MetroflipViewWidget); } flipper_format_free(ff); } else { // Setup view Popup* popup = app->popup; popup_set_header(popup, "Apply\n card to\nthe back", 68, 30, AlignLeft, AlignTop); popup_set_icon(popup, 0, 3, &I_RFIDDolphinReceive_97x61); // Start worker view_dispatcher_switch_to_view(app->view_dispatcher, MetroflipViewPopup); app->poller = nfc_poller_alloc(app->nfc, NfcProtocolMfClassic); nfc_poller_start(app->poller, metroflip_scene_charlicard_poller_callback, app); metroflip_app_blink_start(app); } } static bool charliecard_on_event(Metroflip* app, SceneManagerEvent event) { bool consumed = false; if(event.type == SceneManagerEventTypeCustom) { if(event.event == MetroflipCustomEventCardDetected) { Popup* popup = app->popup; popup_set_header(popup, "DON'T\nMOVE", 68, 30, AlignLeft, AlignTop); consumed = true; } else if(event.event == MetroflipCustomEventCardLost) { Popup* popup = app->popup; popup_set_header(popup, "Card \n lost", 68, 30, AlignLeft, AlignTop); consumed = true; } else if(event.event == MetroflipCustomEventWrongCard) { Popup* popup = app->popup; popup_set_header(popup, "WRONG \n CARD", 68, 30, AlignLeft, AlignTop); consumed = true; } else if(event.event == MetroflipCustomEventPollerFail) { Popup* popup = app->popup; popup_set_header(popup, "Failed", 68, 30, AlignLeft, AlignTop); consumed = true; } } else if(event.type == SceneManagerEventTypeBack) { scene_manager_search_and_switch_to_previous_scene(app->scene_manager, MetroflipSceneStart); scene_manager_set_scene_state(app->scene_manager, MetroflipSceneStart, MetroflipSceneAuto); consumed = true; } return consumed; } static void charliecard_on_exit(Metroflip* app) { widget_reset(app->widget); if(app->poller && !app->data_loaded) { nfc_poller_stop(app->poller); nfc_poller_free(app->poller); } // Clear view popup_reset(app->popup); metroflip_app_blink_stop(app); } /* Actual implementation of app<>plugin interface */ static const MetroflipPlugin charliecard_plugin = { .card_name = "Charliecard", .plugin_on_enter = charliecard_on_enter, .plugin_on_event = charliecard_on_event, .plugin_on_exit = charliecard_on_exit, }; /* Plugin descriptor to comply with basic plugin specification */ static const FlipperAppPluginDescriptor charliecard_plugin_descriptor = { .appid = METROFLIP_SUPPORTED_CARD_PLUGIN_APP_ID, .ep_api_version = METROFLIP_SUPPORTED_CARD_PLUGIN_API_VERSION, .entry_point = &charliecard_plugin, }; /* Plugin entry point - must return a pointer to const descriptor */ const FlipperAppPluginDescriptor* charliecard_plugin_ep(void) { return &charliecard_plugin_descriptor; }