Porting OpenHaystack to Mobile
OpenHaystack is a project that allows location tracking of Bluetooth Low Energy (BLE) devices over Apples Find My Network.
This project is written in Dart, using the cross platform development framework Flutter. This allows the creation of apps for all major platforms using a single code base.
To develop and build the project the following tools are needed and should be installed.
- Flutter SDK
- Xcode (for iOS)
- Android SDK / Studio (for Android)
- (optional) IDE Plugin (e.g. for VS Code)
To check the installation run flutter doctor. Before continuing review all displayed errors.
First the necessary dependencies need to be installed. The IDE plugin may take care of this automatically.
$ flutter pub getThen set the location proxy server URL in reports_fetcher.dart (replace https://add-your-proxy-server-here/getLocationReports with your custom URL).
To run the debug version of the app start a supported emulator and run
$ flutter runWhen the app is running a new key pair can be created / imported in the app.
The project follows the default structure for flutter applications. The android, ios and web folders contain native projects for the specified platform. Native code can be added here for example to access special APIs.
The business logic and UI can be found in the lib folder. This folder is furthermore separated into modules containing code regarding a common aspect.
The business logic for accessing and decrypting the location reports is separated in the findMy folder for easier reuse.
This project currently supports iOS and Android targets. If you are building the project for the first time, you need to run
$ flutter pub run flutter_launcher_icons:main to create the icons and then, to create a distributable application package run
$ flutter build [ios|apk|web]The resulting build artifacts can be found in the build folder. To deploy the artifacts to a device consult the platform specific documentation.