Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hybridgroup/go-haystack
CLI tools for OpenHaystack written in Go
https://github.com/hybridgroup/go-haystack
Last synced: 14 days ago
JSON representation
CLI tools for OpenHaystack written in Go
- Host: GitHub
- URL: https://github.com/hybridgroup/go-haystack
- Owner: hybridgroup
- License: mit
- Created: 2025-01-09T13:40:45.000Z (19 days ago)
- Default Branch: main
- Last Pushed: 2025-01-09T14:54:52.000Z (19 days ago)
- Last Synced: 2025-01-09T14:56:26.359Z (19 days ago)
- Language: Go
- Size: 1000 Bytes
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - hybridgroup/go-haystack - Track personal Bluetooth devices via Apple's "Find My" network using OpenHaystack and Macless-Haystack with tools written in Go/TinyGo. No Apple hardware required! (Go)
README
# go-haystack
Go Haystack lets you track personal Bluetooth devices via Apple's massive ["Find My"](https://developer.apple.com/find-my/) network.
It uses [OpenHaystack](https://github.com/seemoo-lab/openhaystack) together with [Macless-Haystack](https://github.com/dchristl/macless-haystack) to help you setup a custom FindMy network with tools written in Go/TinyGo. No Apple hardware required!
## Build Your Own Beacon
This package provides firmware written using [TinyGo](https://tinygo.org/) and the [TinyGo Bluetooth package](https://github.com/tinygo-org/bluetooth).
As a result, any of the following hardware devices should work:
- [Adafruit Bluefruit boards using nRF SoftDevice](https://github.com/tinygo-org/bluetooth?tab=readme-ov-file#adafruit-bluefruit-boards)
- [BBC Microbit using nRF SoftDevice](https://github.com/tinygo-org/bluetooth?tab=readme-ov-file#bbc-microbit)
- [Seeed Studio XIAO nRF52840](https://wiki.seeedstudio.com/XIAO_BLE)
- [Other Nordic Semi SoftDevice boards](https://github.com/tinygo-org/bluetooth?tab=readme-ov-file#flashing-the-softdevice-on-other-boards)
- [Boards using the NINA-FW with an ESP32 co-processor](https://github.com/tinygo-org/bluetooth?tab=readme-ov-file#esp32-nina)
- [Boards such as the RP2040 Pico-W using the CYW43439 co-processor](https://github.com/tinygo-org/bluetooth?tab=readme-ov-file#cyw43439-rp2040-w)
The beacon code is located in this repository in the [firmware](./firmware/) directory.
## Linux Beacons
You can also run the beacon code on any Linux that has Bluetooth hardware, such as a Raspberry Pi or other embedded system.
The beacon code is the same for embedded Linux as for microcontrollers, and is located in this repo in the [firmware](./firmware/) directory.
## TinyScan
Go Haystack also includes TinyScan, a hardware scanner for local devices.
TinyScan runs on several different microcontrollers boards with Bluetooth and miniature displays, such as those made by [Adafruit](https://www.adafruit.com/) and [Pimoroni](https://shop.pimoroni.com/)
The TinyScan code is located in the [tinyscan](./tinyscan/) directory in this repository.
## How to install
### Apple ID
You must have an Apple-ID with 2FA enabled. Only sms/text message as second factor is supported!
### anisette-v3-server
Start [`anisette-v3-server`](https://github.com/Dadoum/anisette-v3-server)
```bash
docker network create mh-network
docker run -d --restart always --name anisette -p 6969:6969 --volume anisette-v3_data:/home/Alcoholic/.config/anisette-v3 --network mh-network dadoum/anisette-v3-server
```
### macless-haystack
1. Start and set up your Macless Haystack endpoint in interactive mode:
```bash
docker run -it --restart unless-stopped --name macless-haystack -p 6176:6176 --volume mh_data:/app/endpoint/data --network mh-network christld/macless-haystack
```
###### You will be asked for your Apple-ID, password and your 2FA. If you see `serving at port 6176 over HTTP` you have all set up correctly
Hit ctrl-C to exit the process once it has been configured.
2. Restart the macless-haystack server
```bash
docker restart macless-haystack
```
See https://github.com/dchristl/macless-haystack/blob/main/README.md#server-setup for the original instructions.
### go-haystack
Install the go-haystack command line tool
```shell
go install github.com/hybridgroup/go-haystack/cmd/haystack@latest
```
## How to use
### Scanning for local devices
```shell
haystack scan
```
Should return any local devices within range:
```shell
$ haystack scan
CE:8B:AD:5F:8A:02 -53 ce8bad5f8a0271538ff5afda87498cb067e9a020d6e4167801d55d83 - battery full
FE:B0:67:9B:9A:5C -55 feb0679b9a5c55b1141c5cc6c8f65224ae9bc6bc2d998ccf5c56a02d - battery full
CE:8B:AD:5F:8A:02 -53 ce8bad5f8a0271538ff5afda87498cb067e9a020d6e4167801d55d83 - battery full
CE:8B:AD:5F:8A:02 -53 ce8bad5f8a0271538ff5afda87498cb067e9a020d6e4167801d55d83 - battery full
FE:B0:67:9B:9A:5C -56 feb0679b9a5c55b1141c5cc6c8f65224ae9bc6bc2d998ccf5c56a02d - battery full
CE:8B:AD:5F:8A:02 -53 ce8bad5f8a0271538ff5afda87498cb067e9a020d6e4167801d55d83 - battery full
FE:B0:67:9B:9A:5C -56 feb0679b9a5c55b1141c5cc6c8f65224ae9bc6bc2d998ccf5c56a02d - battery full
CE:8B:AD:5F:8A:02 -53 ce8bad5f8a0271538ff5afda87498cb067e9a020d6e4167801d55d83 - battery full
```
### Adding a new device
1. Generate keys for a device
```shell
haystack keys DEVICENAME
```
The keys will be saved in a file named `DEVICENAME.keys` and the configuration file for Haystack will be saved in `DEVICENAME.json`. Replace "DEVICENAME" with whatever you want to name the actual device.
2. Flash the hardware with the TinyGo target and the name of your device.
For example:
```shell
haystack flash DEVICENAME nano-rp2040
```
This will use TinyGo to compile the firmware using your keys, and then flash it to the device. See [https://tinygo.org/getting-started/overview/](https://tinygo.org/getting-started/overview/) for more information about TinyGo.
3. Upload the JSON file for that device to your running instance of `macless-haystack` using the web UI.
Point your web browser to [`https://dchristl.github.io/macless-haystack/`](https://dchristl.github.io/macless-haystack/) which is a single-page web application that only reads/writes local data. Click on the link for "Accessories", then on the "+" button. Choose the `DEVICENAME.json` file for your device.
That's it, your device is now setup.
## Objects in your data may be closer than they appear
Eventually, if your device is in range of any iPhone, they will appear in your Macless-Haystack data in the web UI.
Note that it might take a while for the first data to show up.
Have fun, be good!