{"id":13464426,"url":"https://github.com/seemoo-lab/openwifipass","last_synced_at":"2025-04-04T22:03:58.373Z","repository":{"id":45676723,"uuid":"267558885","full_name":"seemoo-lab/openwifipass","owner":"seemoo-lab","description":"An open source implementation of Apple's Wi-Fi Password Sharing protocol in Python.","archived":false,"fork":false,"pushed_at":"2021-04-13T08:27:59.000Z","size":32,"stargazers_count":824,"open_issues_count":3,"forks_count":32,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-03-28T21:03:45.422Z","etag":null,"topics":["apple","opack","password-sharing","reverse-engineering","wifi"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/seemoo-lab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-28T10:20:59.000Z","updated_at":"2025-03-24T12:18:50.000Z","dependencies_parsed_at":"2022-08-31T07:20:38.700Z","dependency_job_id":null,"html_url":"https://github.com/seemoo-lab/openwifipass","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seemoo-lab%2Fopenwifipass","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seemoo-lab%2Fopenwifipass/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seemoo-lab%2Fopenwifipass/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seemoo-lab%2Fopenwifipass/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seemoo-lab","download_url":"https://codeload.github.com/seemoo-lab/openwifipass/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247256107,"owners_count":20909240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apple","opack","password-sharing","reverse-engineering","wifi"],"created_at":"2024-07-31T14:00:42.810Z","updated_at":"2025-04-04T22:03:58.350Z","avatar_url":"https://github.com/seemoo-lab.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# OpenWifiPass\n\n[![LGTM code quality grade](https://img.shields.io/lgtm/grade/python/github/seemoo-lab/openwifipass?label=code%20quality\u0026logo=lgtm)](https://lgtm.com/projects/g/seemoo-lab/openwifipass/context:python)\n\nAn open source implementation of the grantor role in Apple's Wi-Fi Password Sharing protocol.\n\n## Disclaimer\n\nOpenWifiPass is experimental software and is the result of reverse engineering efforts by the [Open Wireless Link](https://owlink.org) project.\nThe code serves solely documentary and educational purposes. It is *untested* and *incomplete*.\nFor example, the code **does not verify the identity of the requestor**. So, do not use this implementation with sensitive Wi-Fi credentials.\nOpenWifiPass is not affiliated with or endorsed by Apple Inc.\n\n## Requirements\n\n**Hardware:** Bluetooth Low Energy radio, e.g., Raspberry Pi 4\n\n**OS:** Linux (due to the `bluepy` dependency)\n\n## Install\n\nClone this repository and install it:\n\n```bash\ngit clone git@github.com/seemoo-lab/openwifipass.git\npip3 install ./openwifipass\n```\n\n## Run\n\nRun `openwifipass` to share Wi-Fi credentials (`SSID` and `PSK`) with *any* requestor (we need super user privileges to use the Bluetooth subsystem):\n\n```bash\nsudo -E python3 -m openwifipass --ssid \u003cSSID\u003e --psk \u003cPSK\u003e\n```\n\n**Use [quoting](https://www.gnu.org/savannah-checkouts/gnu/bash/manual/bash.html#Quoting) of your shell to remove special meaning of certain characters in `SSID`/`PSK`.** In the example below, we use single quotes (`'`) to prevent shell expansion of the `$` character in the PSK.\n\nA successful run of the protocol would look as follows:\n```\npi@raspberrypi:~/openwifipass $ sudo -E python3 -m openwifipass --ssid OWL --psk '$uper$ecretPassword'\nStart scanning...\nSSID match in PWS advertisement from aa:bb:cc:dd:ee:ff\nConnect to device aa:bb:cc:dd:ee:ff\nSend PWS1\nReceive PWS2\nSend M1\nReceive M2\nSend M3\nReceive M4\nSend PWS3\nReceive PWS4\nWi-Fi Password Sharing completed\n```\n\n## OPACK\n\nThis projects contains a reusable OPACK (de)serializer. Read [OPACK.md](OPACK.md) for more information.\n\n## Authors\n\n* Jannik Lorenz\n\n## Publications\n\n* Milan Stute, Alexander Heinrich, Jannik Lorenz, and Matthias Hollick. **Disrupting Continuity of Apple’s Wireless Ecosystem Security: New Tracking, DoS, and MitM Attacks on iOS and macOS Through Bluetooth Low Energy, AWDL, and Wi-Fi.** *30th USENIX Security Symposium (USENIX Security ’21)*, August 11–13, 2021, virtual Event. [Link](https://www.usenix.org/conference/usenixsecurity21/presentation/stute).\n* Jannik Lorenz. **Wi-Fi Sharing for All: Reverse Engineering and Breaking the Apple Wi-Fi Password Sharing Protocol.** Bachelor thesis, *Technical University of Darmstadt*, March 2020.\n\n## License\n\nOpenWifiPass is licensed under the [**GNU General Public License v3.0**](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseemoo-lab%2Fopenwifipass","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseemoo-lab%2Fopenwifipass","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseemoo-lab%2Fopenwifipass/lists"}