|
|
@@ -1,6 +1,20 @@
|
|
|
-# Passy: A Flipper Zero Passport reader
|
|
|
+# Passy: Flipper Zero Passport Reader
|
|
|
+
|
|
|
+**Passy** is a tool for reading electronic passports (ePassports/eMRTDs) using the Flipper Zero device. It extracts and decodes data securely stored in modern passports, designed for hobbyists, researchers, and security professionals.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Features
|
|
|
+
|
|
|
+- Reads and decodes ePassport data from a wide range of countries
|
|
|
+- Utilizes MRZ (Machine Readable Zone) information for secure access
|
|
|
+- Extensible for new country support—contribute your flag!
|
|
|
+- Advanced menu for debugging and exploring additional data groups (DGs)
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Tested with the following countries
|
|
|
|
|
|
-## Tested with the following countries:
|
|
|
🇺🇸
|
|
|
🇨🇱
|
|
|
🇫🇷
|
|
|
@@ -16,22 +30,80 @@
|
|
|
🇪🇪
|
|
|
🇨🇭
|
|
|
|
|
|
-(If it works for yours, submit a PR to add your country flag)
|
|
|
|
|
|
-## To use:
|
|
|
+*If it works for yours, submit a PR to add your country flag!*
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Usage
|
|
|
+
|
|
|
+eMRTDs are secured to prevent unauthorized reading. The key for accessing the data is derived from:
|
|
|
|
|
|
-eMTRD are secured to prevent people from reading the data on a passport just by bumping into it. The data is secured using a key based on the passport number, date of birth, and date of expiry. A real passport machine reads these values from the MRZ (Machine Readable Zone, the ones with ">") using a camera. For the app, you have to enter the values manually. The app will then generate the key and read the data using a system called BAC(https://en.wikipedia.org/wiki/Basic_access_control).
|
|
|
+- Passport number
|
|
|
+- Date of birth
|
|
|
+- Date of expiry
|
|
|
+
|
|
|
+**Use the Flipper Zero to scan your passport’s NFC chip and enter the required information.**
|
|
|
+
|
|
|
+---
|
|
|
|
|
|
## Limitations
|
|
|
- - Avanced menu hidden unless Debug enabled
|
|
|
- - Does not parse some DG under "advanced" menu
|
|
|
|
|
|
-## To do
|
|
|
- - Support PACE
|
|
|
- - Support other country passports
|
|
|
+- Advanced menu is hidden unless Debug mode is enabled
|
|
|
+- Some data groups (DGs) are not fully parsed under "advanced" menu
|
|
|
+- Country coverage is limited (see above)
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Development
|
|
|
|
|
|
-## Generate asn:
|
|
|
+### Prerequisites
|
|
|
+
|
|
|
+- Flipper Zero device (updated firmware recommended)
|
|
|
+- [ufbt](https://github.com/flipperdevices/flipperzero-ufbt) for building
|
|
|
+- [asn1c](https://github.com/vlm/asn1c) ASN.1 compiler (for protocol/data parsing)
|
|
|
+
|
|
|
+### Installation
|
|
|
+
|
|
|
+Clone this repository:
|
|
|
+
|
|
|
+```bash
|
|
|
+git clone https://github.com/bettse/passy.git
|
|
|
+cd passy
|
|
|
+```
|
|
|
+
|
|
|
+Build the ASN.1 code (optional, required for development):
|
|
|
|
|
|
```bash
|
|
|
asn1c -D ./lib/asn1 -no-gen-example -pdu=all eMRTD.asn1
|
|
|
```
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Roadmap / To Do
|
|
|
+
|
|
|
+- [ ] Support PACE protocol
|
|
|
+- [ ] Add support for more countries' passports
|
|
|
+- [ ] Improve parsing of additional DGs
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Contributing
|
|
|
+
|
|
|
+Contributions are welcome! If Passy works with a new country, feel free to:
|
|
|
+
|
|
|
+1. Add your country’s flag to the list above
|
|
|
+2. Submit a pull request
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## License
|
|
|
+
|
|
|
+[MIT License](LICENSE)
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Acknowledgments
|
|
|
+
|
|
|
+- Inspired by the global ePassport community
|
|
|
+- Powered by Flipper Zero and open-source tooling
|
Eric Betts