├── .github └── workflows │ └── test.yml ├── .gitignore ├── LICENSE ├── Makefile ├── Manifest.in ├── OPACK.md ├── README.md ├── deploy.sh ├── openwifipass ├── Connection.py ├── GrantorHandler.py ├── Keys.py ├── OPACK.py ├── Scanner.py ├── TLV8.py ├── __init__.py └── __main__.py ├── requirements-dev.txt ├── setup.cfg ├── setup.py └── tests ├── __init__.py ├── test_opack.py └── test_tlv8.py /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test package 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | build: 7 | 8 | runs-on: ubuntu-latest 9 | strategy: 10 | matrix: 11 | python-version: [3.6, 3.7, 3.8, 3.9] 12 | 13 | steps: 14 | - uses: actions/checkout@v1 15 | - name: Set up Python ${{ matrix.python-version }} 16 | uses: actions/setup-python@v1 17 | with: 18 | python-version: ${{ matrix.python-version }} 19 | - name: Install dependencies 20 | run: | 21 | python -m pip install --upgrade pip 22 | - name: Install package 23 | run: | 24 | pip install -e . 25 | - name: Check format with isort 26 | run: | 27 | pip install isort 28 | isort -c openwifipass/**.py 29 | isort -c tests/**.py 30 | - name: Check format with black 31 | run: | 32 | pip install black 33 | black . --check --diff 34 | - name: Lint with flake8 35 | run: | 36 | pip install flake8 37 | flake8 . --count --show-source --statistics 38 | - name: Lint with pylint 39 | run: | 40 | pip install pylint 41 | pylint --rcfile=setup.cfg openwifipass tests 42 | - name: Test with pytest 43 | run: | 44 | pip install pytest 45 | pytest 46 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.toptal.com/developers/gitignore/api/python 3 | # Edit at https://www.toptal.com/developers/gitignore?templates=python 4 | 5 | ### Python ### 6 | # Byte-compiled / optimized / DLL files 7 | __pycache__/ 8 | *.py[cod] 9 | *$py.class 10 | 11 | # C extensions 12 | *.so 13 | 14 | # Distribution / packaging 15 | .Python 16 | build/ 17 | develop-eggs/ 18 | dist/ 19 | downloads/ 20 | eggs/ 21 | .eggs/ 22 | lib/ 23 | lib64/ 24 | parts/ 25 | sdist/ 26 | var/ 27 | wheels/ 28 | pip-wheel-metadata/ 29 | share/python-wheels/ 30 | *.egg-info/ 31 | .installed.cfg 32 | *.egg 33 | MANIFEST 34 | 35 | # PyInstaller 36 | # Usually these files are written by a python script from a template 37 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 38 | *.manifest 39 | *.spec 40 | 41 | # Installer logs 42 | pip-log.txt 43 | pip-delete-this-directory.txt 44 | 45 | # Unit test / coverage reports 46 | htmlcov/ 47 | .tox/ 48 | .nox/ 49 | .coverage 50 | .coverage.* 51 | .cache 52 | nosetests.xml 53 | coverage.xml 54 | *.cover 55 | *.py,cover 56 | .hypothesis/ 57 | .pytest_cache/ 58 | pytestdebug.log 59 | 60 | # Translations 61 | *.mo 62 | *.pot 63 | 64 | # Django stuff: 65 | *.log 66 | local_settings.py 67 | db.sqlite3 68 | db.sqlite3-journal 69 | 70 | # Flask stuff: 71 | instance/ 72 | .webassets-cache 73 | 74 | # Scrapy stuff: 75 | .scrapy 76 | 77 | # Sphinx documentation 78 | docs/_build/ 79 | doc/_build/ 80 | 81 | # PyBuilder 82 | target/ 83 | 84 | # Jupyter Notebook 85 | .ipynb_checkpoints 86 | 87 | # IPython 88 | profile_default/ 89 | ipython_config.py 90 | 91 | # pyenv 92 | .python-version 93 | 94 | # pipenv 95 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 96 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 97 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 98 | # install all needed dependencies. 99 | #Pipfile.lock 100 | 101 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 102 | __pypackages__/ 103 | 104 | # Celery stuff 105 | celerybeat-schedule 106 | celerybeat.pid 107 | 108 | # SageMath parsed files 109 | *.sage.py 110 | 111 | # Environments 112 | .env 113 | .venv 114 | env/ 115 | venv/ 116 | ENV/ 117 | env.bak/ 118 | venv.bak/ 119 | pythonenv* 120 | 121 | # Spyder project settings 122 | .spyderproject 123 | .spyproject 124 | 125 | # Rope project settings 126 | .ropeproject 127 | 128 | # mkdocs documentation 129 | /site 130 | 131 | # mypy 132 | .mypy_cache/ 133 | .dmypy.json 134 | dmypy.json 135 | 136 | # Pyre type checker 137 | .pyre/ 138 | 139 | # pytype static type analyzer 140 | .pytype/ 141 | 142 | # profiling data 143 | .prof 144 | 145 | # End of https://www.toptal.com/developers/gitignore/api/python 146 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: ci checkformat isort lint pylint test autoformat 2 | 3 | VENV=venv 4 | PYTHON=$(VENV)/bin/python3 5 | 6 | ci: isort checkformat lint pylint test 7 | 8 | $(VENV): $(VENV)/bin/activate 9 | 10 | $(VENV)/bin/activate: setup.py requirements-dev.txt Makefile 11 | ifeq (, $(shell which virtualenv)) 12 | $(error "`virtualenv` is not installed, consider running `pip3 install virtualenv`") 13 | endif 14 | test -d $(VENV) || virtualenv -p python3 $(VENV) 15 | $(PYTHON) -m pip install --upgrade pip 16 | $(PYTHON) -m pip install -r requirements-dev.txt 17 | $(PYTHON) -m pip install -e . 18 | touch $(VENV)/bin/activate 19 | 20 | checkformat: $(VENV) 21 | $(PYTHON) -m black . --check --diff --exclude $(VENV) 22 | 23 | lint: $(VENV) 24 | $(PYTHON) -m flake8 . --count --show-source --statistics --exclude $(VENV) 25 | 26 | pylint: $(VENV) 27 | $(PYTHON) -m pylint --rcfile=setup.cfg openwifipass tests 28 | 29 | isort: $(VENV) 30 | $(PYTHON) -m isort -c openwifipass/**.py 31 | $(PYTHON) -m isort -c tests/**.py 32 | 33 | test: $(VENV) 34 | $(PYTHON) -m pytest 35 | 36 | autoformat: $(VENV) 37 | $(PYTHON) -m isort openwifipass/**.py 38 | $(PYTHON) -m isort tests/**.py 39 | $(PYTHON) -m black . --exclude $(VENV) 40 | -------------------------------------------------------------------------------- /Manifest.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include LICENSE 3 | exclude .gitignore 4 | prune .cache 5 | prune .git 6 | prune build 7 | prune dist 8 | recursive-exclude *.egg-info * 9 | -------------------------------------------------------------------------------- /OPACK.md: -------------------------------------------------------------------------------- 1 | # PyOPACK – Python OPACK parser and encoder 2 | 3 | OPACK is a propriety encoding scheme from Apple, used in a variety of services like *Handoff*, *Universal-Clipboard* and *WiFi Password Sharing*. 4 | OPACK can encode the following data types: 5 | 6 | - `bool` 7 | - `int` 8 | - `float` *(not implemented)* 9 | - `str` 10 | - `bytes` 11 | - `list` 12 | - `dict` 13 | - `date` *(not implemented)* 14 | - `UUID` *(not implemented)* 15 | 16 | ## Disclaimer 17 | 18 | This implementation is used for testing and research purposes only, and is **not designed for productive use.** 19 | 20 | ## Usage Examples 21 | 22 | ### Encoder 23 | 24 | ```python 25 | decoded = { 26 | "key1": bytes(12), 27 | "key2": [1,2,3], 28 | } 29 | encoded = OPACK.encode(decoded) 30 | ``` 31 | 32 | ### Decoder 33 | 34 | ```python 35 | decoded = OPACK.decode(encoded) 36 | ``` 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OpenWifiPass 2 | 3 | [![LGTM code quality grade](https://img.shields.io/lgtm/grade/python/github/seemoo-lab/openwifipass?label=code%20quality&logo=lgtm)](https://lgtm.com/projects/g/seemoo-lab/openwifipass/context:python) 4 | 5 | An open source implementation of the grantor role in Apple's Wi-Fi Password Sharing protocol. 6 | 7 | ## Disclaimer 8 | 9 | OpenWifiPass is experimental software and is the result of reverse engineering efforts by the [Open Wireless Link](https://owlink.org) project. 10 | The code serves solely documentary and educational purposes. It is *untested* and *incomplete*. 11 | For example, the code **does not verify the identity of the requestor**. So, do not use this implementation with sensitive Wi-Fi credentials. 12 | OpenWifiPass is not affiliated with or endorsed by Apple Inc. 13 | 14 | ## Requirements 15 | 16 | **Hardware:** Bluetooth Low Energy radio, e.g., Raspberry Pi 4 17 | 18 | **OS:** Linux (due to the `bluepy` dependency) 19 | 20 | ## Install 21 | 22 | Clone this repository and install it: 23 | 24 | ```bash 25 | git clone git@github.com/seemoo-lab/openwifipass.git 26 | pip3 install ./openwifipass 27 | ``` 28 | 29 | ## Run 30 | 31 | Run `openwifipass` to share Wi-Fi credentials (`SSID` and `PSK`) with *any* requestor (we need super user privileges to use the Bluetooth subsystem): 32 | 33 | ```bash 34 | sudo -E python3 -m openwifipass --ssid --psk 35 | ``` 36 | 37 | **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. 38 | 39 | A successful run of the protocol would look as follows: 40 | ``` 41 | pi@raspberrypi:~/openwifipass $ sudo -E python3 -m openwifipass --ssid OWL --psk '$uper$ecretPassword' 42 | Start scanning... 43 | SSID match in PWS advertisement from aa:bb:cc:dd:ee:ff 44 | Connect to device aa:bb:cc:dd:ee:ff 45 | Send PWS1 46 | Receive PWS2 47 | Send M1 48 | Receive M2 49 | Send M3 50 | Receive M4 51 | Send PWS3 52 | Receive PWS4 53 | Wi-Fi Password Sharing completed 54 | ``` 55 | 56 | ## OPACK 57 | 58 | This projects contains a reusable OPACK (de)serializer. Read [OPACK.md](OPACK.md) for more information. 59 | 60 | ## Authors 61 | 62 | * Jannik Lorenz 63 | 64 | ## Publications 65 | 66 | * 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). 67 | * 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. 68 | 69 | ## License 70 | 71 | OpenWifiPass is licensed under the [**GNU General Public License v3.0**](LICENSE). 72 | -------------------------------------------------------------------------------- /deploy.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Install package on a remote Raspberry Pi for development, e.g., 4 | # ./deploy.sh raspberrypi.local pi 5 | 6 | HOST=$1 7 | USER=$2 8 | 9 | ARCHIVE=tmp.tar 10 | INSTALL_DIR=/home/$USER/openwifipass 11 | 12 | # Archive project 13 | tmpCommit=`git stash create` 14 | if [ -z $tmpCommit ]; then tmpCommit=HEAD; fi 15 | git archive -o $ARCHIVE $tmpCommit 16 | git gc --prune=now 17 | 18 | # Install on remote machine 19 | scp -r $ARCHIVE $USER@$HOST:/home/$USER/ 20 | ssh $USER@$HOST "mkdir -p $INSTALL_DIR; tar xf $ARCHIVE -C $INSTALL_DIR/ && rm $ARCHIVE" 21 | ssh $USER@$HOST "pip3 uninstall -y openwifipass; pip3 install $INSTALL_DIR/" 22 | -------------------------------------------------------------------------------- /openwifipass/Connection.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import struct 3 | import time 4 | from uuid import UUID 5 | 6 | from bluepy.btle import ADDR_TYPE_RANDOM, DefaultDelegate, Peripheral 7 | 8 | from .GrantorHandler import GrantorHandler 9 | 10 | logger = logging.getLogger(__name__) 11 | 12 | PWSGATTServiceUUID = UUID("9FA480E0496745429390D343DC5D04AE") 13 | PWSGATTCharacteristicUUID = UUID("AF0BADB15B9943CD917AA77BC549E3CC") 14 | 15 | 16 | # Reconstructs the mechanism used by Apple in the password sharing process 17 | class WPNearbyReadDelegate(DefaultDelegate): 18 | state = 0 19 | 20 | # Current state of frame reception, ether: 21 | # - False: the last frame was fully recived, ready for a new frame. 22 | # - True: the expectedPayloadLength is still larger as the length of the 23 | # recived data, waiting for more data. 24 | openFrame = False 25 | 26 | # WPNearby payload 27 | payload = [] 28 | 29 | # The expected length of the full WPNearby frame. This length is given in 30 | # the first 2 bytes of a new frame. 31 | expectedPayloadLength = 0 32 | 33 | def __init__(self, grantorHandler): 34 | DefaultDelegate.__init__(self) 35 | self.pwsHandler = grantorHandler 36 | 37 | def handleNotification(self, _, data): 38 | # If we have an open frame, append data and check if package is complete 39 | if self.openFrame: 40 | self.payload += data 41 | 42 | # Received data without an open frame, so we open a new frame with this data 43 | else: 44 | # calculate the expected package size from the first 2 bytes 45 | expLenBytes = data[0:2] 46 | expLenBytes += b"\x00\x00" 47 | expected = struct.unpack("= self.expectedPayloadLength: 61 | self.openFrame = False 62 | 63 | # frameType is the first byte/ service type the second 64 | frameType = self.payload[0] 65 | # serviceType = self.payload[1] 66 | data = self.payload[2:] 67 | 68 | # check if frameType is 0x18 (PWS1) 69 | if frameType == 24 and self.state == 0: 70 | self.state = 1 71 | self.pwsHandler.receivePWS2(data) 72 | return 73 | 74 | # check if frameType is 0x13 (M2) 75 | if frameType == 19 and self.state == 1: 76 | self.state = 2 77 | self.pwsHandler.receiveM2(data) 78 | return 79 | 80 | if frameType == 19 and self.state == 2: 81 | self.state = 3 82 | self.pwsHandler.receiveM4(data) 83 | return 84 | 85 | if frameType == 6 and self.state == 3: 86 | self.pwsHandler.receivePWS4(data) 87 | return 88 | 89 | logger.warning("Received unknown frame") 90 | 91 | 92 | def startPWS(addr, ssid, psk): 93 | logger.info(f"Connect to device {addr}") 94 | 95 | grantorHandler = GrantorHandler(ssid, psk) 96 | 97 | # Init Peripheral, connect to it an set read delegate 98 | peripheral = Peripheral(addr, ADDR_TYPE_RANDOM) 99 | peripheral.setDelegate(WPNearbyReadDelegate(grantorHandler)) 100 | 101 | pwsService = peripheral.getServiceByUUID(PWSGATTServiceUUID) 102 | pwsCharacteristic = pwsService.getCharacteristics( 103 | forUUID=PWSGATTCharacteristicUUID 104 | )[0] 105 | logger.debug(f"PWS characteristic: {pwsCharacteristic.getHandle()}") 106 | grantorHandler.pwsCharacteristic = pwsCharacteristic 107 | 108 | time.sleep(0.5) 109 | 110 | # Subscribe to the PWS characteristics by sending 0x0200 to pwsCharacteristic Handle+1 (Todo clean uo and check if it is always +1) 111 | peripheral.writeCharacteristic( 112 | pwsCharacteristic.getHandle() + 2, b"\x01\x00", withResponse=True 113 | ) 114 | 115 | grantorHandler.sendPWS1() 116 | 117 | while peripheral.waitForNotifications(2): 118 | pass 119 | 120 | peripheral.disconnect() 121 | 122 | logger.info("Wi-Fi Password Sharing completed") 123 | -------------------------------------------------------------------------------- /openwifipass/GrantorHandler.py: -------------------------------------------------------------------------------- 1 | import hashlib 2 | import logging 3 | 4 | import hkdf 5 | from Cryptodome.Cipher import ChaCha20_Poly1305 6 | from cryptography.hazmat.primitives.asymmetric import x25519 7 | 8 | from .Keys import SessionKeys 9 | from .OPACK import OPACK 10 | from .TLV8 import TLV8, TLV8Box 11 | 12 | logger = logging.getLogger(__name__) 13 | 14 | 15 | class GrantorHandler: 16 | def __init__(self, ssid, psk): 17 | self.session_keys = SessionKeys() 18 | self.shared_secret = None 19 | self.ssid = ssid 20 | self.psk = psk 21 | 22 | # Currently the data is not split into chunks if too large, since the giving device never exceeds this limit 23 | def send(self, frameType, body): 24 | data = bytearray() 25 | data.append(frameType) 26 | data.append(0x07) 27 | data += bytearray(body) 28 | 29 | dataLength = len(data) 30 | payload = [] 31 | payload.append(dataLength) 32 | payload.append(0x00) 33 | payload += data 34 | self.pwsCharacteristic.write(bytes(payload), withResponse=True) 35 | 36 | def sendPWS1(self): 37 | logger.info("Send PWS1") 38 | opack_bytes = OPACK.encode( 39 | { 40 | "sid": b"\x01\x02\x03\x04", 41 | "shv": "1476.17", 42 | } 43 | ) 44 | self.send(0x17, opack_bytes) 45 | 46 | def receivePWS2(self, _data): 47 | logger.info("Receive PWS2") 48 | self.sendM1() 49 | 50 | def sendM1(self): 51 | logger.info("Send M1") 52 | logger.debug(f"Session key: {self.session_keys.public}") 53 | tlv8_bytes = TLV8Box( 54 | [TLV8(0x03, self.session_keys.public), TLV8(0x06, b"\x01")] 55 | ).encode() 56 | opack_bytes = OPACK.encode( 57 | { 58 | "pf": "1052676", 59 | "pd": tlv8_bytes, 60 | } 61 | ) 62 | self.send(0x12, opack_bytes) 63 | 64 | def receiveM2(self, data): 65 | logger.info("Receive M2") 66 | 67 | pvDict = OPACK.decode(data) 68 | tlv = TLV8Box.decodeFromData(pvDict["pd"]).toDict() 69 | searching_device_pub_key = x25519.X25519PublicKey.from_public_bytes( 70 | bytes(tlv[0x03]) 71 | ) 72 | self.shared_secret = self.session_keys.private.exchange( 73 | searching_device_pub_key 74 | ) 75 | 76 | hkdf_inst = hkdf.Hkdf( 77 | "Pair-Verify-Encrypt-Salt".encode(), self.shared_secret, hash=hashlib.sha512 78 | ) 79 | key = hkdf_inst.expand("Pair-Verify-Encrypt-Info".encode(), 32) 80 | 81 | encryptedData = bytes(tlv[0x05])[:-16] 82 | authKey = bytes(tlv[0x05])[-16:] 83 | nonce = "PV-Msg02".encode() 84 | 85 | cipher = ChaCha20_Poly1305.new(key=key, nonce=nonce) 86 | plainData = cipher.decrypt_and_verify(encryptedData, authKey) 87 | plainTLV = TLV8Box.decodeFromData(plainData).toDict() 88 | 89 | # plainTLV contains authentication data: 90 | # { 91 | # 9: Signature over public keys of grantor and requestor 92 | # 10: Apple ID certificate (NSDataCompressed) 93 | # 20: Apple ID validation record (NSDataCompressed) 94 | # } 95 | logger.debug(f"Identity TLV: {plainTLV}") 96 | 97 | self.sendM3() 98 | 99 | def sendM3(self): 100 | logger.info("Send M3") 101 | 102 | hkdf_inst = hkdf.Hkdf( 103 | "Pair-Verify-Encrypt-Salt".encode(), self.shared_secret, hash=hashlib.sha512 104 | ) 105 | key = hkdf_inst.expand("Pair-Verify-Encrypt-Info".encode(), 32) 106 | 107 | nonce = "PV-Msg03".encode() 108 | payload = bytes() 109 | cipher = ChaCha20_Poly1305.new(key=key, nonce=nonce) 110 | _ciphertext, authTag = cipher.encrypt_and_digest(payload) 111 | 112 | tlv8_bytes = TLV8Box([TLV8(0x05, authTag), TLV8(0x06, b"\x03")]).encode() 113 | 114 | opack_bytes = OPACK.encode( 115 | { 116 | "pd": tlv8_bytes, 117 | } 118 | ) 119 | self.send(0x13, opack_bytes) 120 | 121 | def receiveM4(self, _data): 122 | logger.info("Receive M4") 123 | self.sendPWS3() 124 | 125 | def sendPWS3(self): 126 | logger.info("Send PWS3") 127 | 128 | hkdf_inst = hkdf.Hkdf( 129 | "WriteKeySalt".encode(), self.shared_secret, hash=hashlib.sha512 130 | ) 131 | key = hkdf_inst.expand("WriteKeyInfo".encode(), 32) 132 | 133 | opack_bytes = OPACK.encode( 134 | { 135 | "op": 5, 136 | "nw": self.ssid, 137 | "psk": self.psk, 138 | } 139 | ) 140 | 141 | aad = bytes(b"\x06\x07") 142 | nonce = bytes(b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00") 143 | 144 | cipher = ChaCha20_Poly1305.new(key=key, nonce=nonce) 145 | cipher.update(aad) 146 | encryptedData, authTag = cipher.encrypt_and_digest(opack_bytes) 147 | encryptedData += authTag 148 | 149 | self.send(0x06, encryptedData) 150 | 151 | def receivePWS4(self, _data): 152 | logger.info("Receive PWS4") 153 | -------------------------------------------------------------------------------- /openwifipass/Keys.py: -------------------------------------------------------------------------------- 1 | from cryptography.hazmat.primitives import serialization 2 | from cryptography.hazmat.primitives.asymmetric import x25519 3 | 4 | 5 | class SessionKeys: 6 | def __init__(self): 7 | self.private = x25519.X25519PrivateKey.generate() 8 | self.public = self.private.public_key().public_bytes( 9 | encoding=serialization.Encoding.Raw, format=serialization.PublicFormat.Raw 10 | ) 11 | -------------------------------------------------------------------------------- /openwifipass/OPACK.py: -------------------------------------------------------------------------------- 1 | class OPACK: 2 | @staticmethod 3 | def encode(object_): 4 | return bytes(OPACKEncode().encode(object_)) 5 | 6 | @staticmethod 7 | def decode(data): 8 | return OPACKDecode(data).parse() 9 | 10 | 11 | class OPACKDecodeError(Exception): 12 | pass 13 | 14 | 15 | class OPACKEncodeError(Exception): 16 | pass 17 | 18 | 19 | class OPACKDecode: 20 | def __init__(self, data): 21 | self.data = data 22 | self.position = 0 23 | 24 | def readBytes(self, bytesCount): 25 | posFrom = self.position 26 | posTo = self.position + bytesCount 27 | self.position += bytesCount 28 | return self.data[posFrom:posTo] 29 | 30 | def parse(self): 31 | dataTypes = { 32 | 0x01: self.parseTrue, 33 | 0x02: self.parseFalse, 34 | 0x05: self.parseUUID, 35 | 0x06: self.parseDate, 36 | 0x35: self.parseFloat32, 37 | 0x36: self.parseFloat64, 38 | 0xDF: self.parseArrayEndless, 39 | 0xEF: self.parseDictEndless, 40 | } 41 | type_ = self.readBytes(1)[0] 42 | method = dataTypes.get(type_) 43 | if not method: 44 | if type_ >= 0x08 and type_ <= 0x2F: 45 | return type_ - 0x08 46 | if type_ >= 0x30 and type_ <= 0x33: 47 | return self.parseIntX(type_ - 0x30 + 1) 48 | if type_ >= 0x40 and type_ <= 0x60: 49 | return self.parseStringWithLength(type_ - 0x40) 50 | if type_ >= 0x61 and type_ <= 0x64: 51 | return self.parseStringX(type_ - 0x60) 52 | if type_ >= 0x70 and type_ <= 0x90: 53 | return self.parseDataWithLength(type_ - 0x70) 54 | if type_ >= 0x91 and type_ <= 0x94: 55 | return self.parseDataX(type_ - 0x90) 56 | if type_ >= 0xD0 and type_ <= 0xDE: 57 | return self.parseArray(type_ - 0xD0 + 1) 58 | if type_ >= 0xE0 and type_ <= 0xEE: 59 | return self.parseDict(type_ - 0xE0 + 1) 60 | raise OPACKDecodeError(f"Unknown type {type_}") 61 | else: 62 | return method() 63 | 64 | def parseTrue(self): 65 | return True 66 | 67 | def parseFalse(self): 68 | return False 69 | 70 | def parseUUID(self): 71 | return self.readBytes(4) 72 | 73 | def parseDate(self): 74 | self.position += 4 75 | return None # TODO 76 | 77 | def parseIntX(self, length): 78 | data = self.readBytes(length) 79 | return int.from_bytes(data, byteorder="big") 80 | 81 | def parseFloat32(self): 82 | self.position += 4 83 | return None # TODO 84 | 85 | def parseFloat64(self): 86 | self.position += 8 87 | return None # TODO 88 | 89 | def parseStringX(self, length): 90 | return self.parseDataX(length).decode("utf-8", "strict") 91 | 92 | def parseStringWithLength(self, length): 93 | return self.parseDataWithLength(length).decode("utf-8", "strict") 94 | 95 | def parseDataX(self, length): 96 | data = self.readBytes(length) 97 | dataLength = int.from_bytes(data, byteorder="big") 98 | return self.parseDataWithLength(dataLength) 99 | 100 | def parseDataWithLength(self, length): 101 | return self.readBytes(length) 102 | 103 | def parseArray(self, count): 104 | outArray = [] 105 | for _ in range(1, count): 106 | outArray.append(self.parse()) 107 | return outArray 108 | 109 | def parseArrayEndless(self): 110 | outArray = [] 111 | while True: 112 | outArray.append(self.parse()) 113 | if self.position <= len(self.data): 114 | break 115 | if self.data[(self.position + 1)] == 0x03: 116 | self.position += 1 117 | break 118 | return outArray 119 | 120 | def parseDict(self, count): 121 | outDict = {} 122 | for _ in range(1, count): 123 | key = self.parse() 124 | value = self.parse() 125 | outDict[key] = value 126 | return outDict 127 | 128 | def parseDictEndless(self, _): 129 | outDict = {} 130 | while True: 131 | key = self.parse() 132 | value = self.parse() 133 | outDict[key] = value 134 | if self.position <= len(self.data): 135 | break 136 | if self.data[(self.position + 1)] == 0x03: 137 | self.position += 1 138 | break 139 | return outDict 140 | 141 | 142 | class OPACKEncode: 143 | def encode(self, object_): 144 | types = { 145 | bool: self.encodeBool, 146 | int: self.encodeInt, 147 | # TODO add float 148 | str: self.encodeString, 149 | bytes: self.encodeData, 150 | list: self.encodeArray, 151 | dict: self.encodeDict, 152 | # TODO add date 153 | # TODO add UUID 154 | } 155 | type_ = type(object_) 156 | method = types.get(type_) 157 | if method: 158 | return method(object_) 159 | else: 160 | raise OPACKEncodeError(f"Unsupported type {type_}") 161 | 162 | def encodeBool(self, value): 163 | if value: 164 | return [0x01] 165 | else: 166 | return [0x02] 167 | 168 | def encodeInt(self, value): 169 | if value < 0x27: 170 | return [value + 0x08] 171 | for i in range(0, 4): 172 | if value < pow(2, 8 * (i + 1)): 173 | data = list(value.to_bytes(i + 1, byteorder="big")) 174 | data.insert(0, 0x30 + i) 175 | return data 176 | raise OPACKEncodeError(f"Failed to encode {value} (type int)") 177 | 178 | def encodeString(self, value): 179 | length = len(value) 180 | if length <= 0x20: 181 | data = list(value.encode(encoding="UTF-8", errors="strict")) 182 | data.insert(0, length + 0x40) 183 | return data 184 | for i in range(0, 4): 185 | if length < pow(2, 8 * (i + 1)): 186 | data = list(length.to_bytes(i + 1, byteorder="big")) 187 | data.insert(0, 0x61 + i) 188 | data.extend(list(value.encode(encoding="UTF-8", errors="strict"))) 189 | return data 190 | raise OPACKEncodeError(f"Failed to encode {value} (type string)") 191 | 192 | def encodeData(self, value): 193 | length = len(value) 194 | if length <= 0x20: 195 | data = list(value) 196 | data.insert(0, length + 0x70) 197 | return data 198 | for i in range(0, 4): 199 | if length < pow(2, 8 * (i + 1)): 200 | data = list(length.to_bytes(i + 1, byteorder="big")) 201 | data.insert(0, 0x91 + i) 202 | data.extend(list(value)) 203 | return data 204 | raise OPACKEncodeError(f"Failed to encode {value} (type bytes)") 205 | 206 | def encodeArray(self, value): 207 | length = len(value) 208 | if length < 0x0F: 209 | data = [length + 0xD0] 210 | for entry in value: 211 | data.extend(self.encode(entry)) 212 | return data 213 | else: 214 | data = [0xDF] 215 | for entry in value: 216 | data.extend(self.encode(entry)) 217 | data.append(0x03) 218 | return data 219 | 220 | def encodeDict(self, value): 221 | length = len(value) 222 | if length < 0x0F: 223 | data = [length + 0xE0] 224 | for key, v in value.items(): 225 | data.extend(self.encode(key)) 226 | data.extend(self.encode(v)) 227 | return data 228 | else: 229 | data = [0xEF] 230 | for key, v in value.items(): 231 | data.extend(self.encode(key)) 232 | data.extend(self.encode(v)) 233 | data.append(0x03) 234 | return data 235 | -------------------------------------------------------------------------------- /openwifipass/Scanner.py: -------------------------------------------------------------------------------- 1 | import hashlib 2 | import logging 3 | 4 | from bluepy.btle import DefaultDelegate, Scanner 5 | 6 | from .TLV8 import TLV8Box 7 | 8 | # Password Sharing advertisment frame layout 9 | # | 0 1 | 2 | 3 4 5 | 6 7 8 | 9 10 11 | 12 13 14 | 15 16 17 | 18 19 20 | 21 22 23 | 24 | 10 | # | ----- | ----- | -------- | -------- | ----------- | ----------- | ----------- | ----------- | -------- | ------ | 11 | # | 4c 00 | 0f | 11 c0 08 | 55 eb 84 | 4b 60 e5 | 89 f9 12 | f4 4d cd | e1 0d aa | 10 02 5b | 0c | 12 | # | apple | pws | const | id | mail | phone | appleID | wifi SSID | const | const | 13 | # | const | const | | | sha256[0:3] | sha256[0:3] | sha256[0:3] | sha256[0:3] | | | 14 | 15 | logger = logging.getLogger(__name__) 16 | 17 | BLE_MANUFACTURER_DATA = 255 18 | BLE_COMPANY_ID_APPLE = bytes.fromhex("4c00") 19 | BLE_APPLE_PWS_TYPE = 0x0F 20 | 21 | 22 | class PWSScanner(DefaultDelegate): 23 | def __init__(self, ssid): 24 | DefaultDelegate.__init__(self) 25 | self.result = None 26 | ssidHash = hashlib.sha256() 27 | ssidHash.update(ssid.encode()) 28 | self.ssidHash = ssidHash.digest() 29 | 30 | def getPWSTLV(self, data): 31 | company_id = data[:2] 32 | if company_id != BLE_COMPANY_ID_APPLE: 33 | return None 34 | tlv8Dict = TLV8Box.decodeFromData(data[2:]).toDict() 35 | logger.debug(f"Apple advertisement {tlv8Dict}") 36 | return tlv8Dict.get(0x0F) 37 | 38 | def isSSIDInTLV(self, tlv): 39 | return tlv[-3:] == self.ssidHash[:3] 40 | 41 | def handleDiscovery(self, scanEntry, _isNewDev, _isNewData): 42 | for (adtype, _, value) in scanEntry.getScanData(): 43 | if adtype == BLE_MANUFACTURER_DATA: 44 | data = bytes.fromhex(value) 45 | pwsTLV = self.getPWSTLV(data) 46 | if pwsTLV is not None: 47 | if self.isSSIDInTLV(pwsTLV): 48 | self.result = scanEntry 49 | 50 | def scan(self): 51 | """ 52 | Scans for PWS advertisements with the given SSID and returns the first match 53 | """ 54 | logger.info("Start scanning...") 55 | scanner = Scanner().withDelegate(self) 56 | scanner.clear() 57 | scanner.start(passive=True) 58 | while self.result is None: 59 | scanner.process(0.1) 60 | logger.info(f"SSID match in PWS advertisement from {self.result.addr}") 61 | scanner.stop() 62 | # return and clear result 63 | result = self.result 64 | self.result = None 65 | return result 66 | -------------------------------------------------------------------------------- /openwifipass/TLV8.py: -------------------------------------------------------------------------------- 1 | class TLV8: 2 | def __init__(self, type_, data): 3 | self.type_ = type_ 4 | self.payload = data 5 | self.length = len(data) 6 | 7 | def encode(self): 8 | data = [self.type_] 9 | data.append(self.length) 10 | data.extend(list(self.payload)) 11 | return bytes(data) 12 | 13 | def __str__(self): 14 | return "TLV8(type: {}, length: {}, payload: {})".format( 15 | self.type_, self.length, self.payload 16 | ) 17 | 18 | 19 | class TLV8Box: 20 | def __init__(self, tlv8s): 21 | self.tlv8s = tlv8s 22 | 23 | def encode(self): 24 | data = [] 25 | for tlv8 in self.tlv8s: 26 | data.extend(tlv8.encode()) 27 | return bytes(data) 28 | 29 | def toDict(self): 30 | dict_ = {} 31 | for tlv in self.tlv8s: 32 | if not dict_.get(tlv.type_): 33 | dict_[tlv.type_] = bytearray() 34 | dict_[tlv.type_] += bytearray(tlv.payload) 35 | return dict_ 36 | 37 | def __str__(self): 38 | out = "TLB8Box [\n" 39 | for tlv8 in self.tlv8s: 40 | out += " {} \n".format(tlv8) 41 | out += "]" 42 | return out 43 | 44 | @staticmethod 45 | def decodeFromData(data): 46 | tlv8s = [] 47 | position = 0 48 | while True: 49 | if position + 2 >= len(data): 50 | break 51 | type_ = data[position] 52 | length = data[position + 1] 53 | payload = data[position + 2 : position + 2 + length] 54 | position += 2 + length 55 | tlv8s.append(TLV8(type_, payload)) 56 | return TLV8Box(tlv8s) 57 | -------------------------------------------------------------------------------- /openwifipass/__init__.py: -------------------------------------------------------------------------------- 1 | __version__ = "0.1.0" 2 | -------------------------------------------------------------------------------- /openwifipass/__main__.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | import logging 3 | import sys 4 | 5 | from .Connection import startPWS 6 | from .Scanner import PWSScanner 7 | 8 | 9 | # Search until we found one pws advertisment frame 10 | def main(): 11 | parser = argparse.ArgumentParser() 12 | parser.add_argument("-s", "--ssid", help="The Wi-Fi name (SSID)", required=True) 13 | parser.add_argument( 14 | "-k", "--psk", help="The Wi-Fi pre-shared key (PSK)", required=True 15 | ) 16 | parser.add_argument( 17 | "-d", "--debug", help="Enable debug messages", action="store_true" 18 | ) 19 | args = parser.parse_args(sys.argv[1:]) 20 | 21 | if args.debug: 22 | logging.basicConfig(level=logging.DEBUG, format="%(message)s") 23 | else: 24 | logging.basicConfig(level=logging.INFO, format="%(message)s") 25 | 26 | scanResult = PWSScanner(args.ssid).scan() 27 | startPWS(scanResult.addr, args.ssid, args.psk) 28 | 29 | 30 | if __name__ == "__main__": 31 | main() 32 | -------------------------------------------------------------------------------- /requirements-dev.txt: -------------------------------------------------------------------------------- 1 | black 2 | flake8 3 | flake8-bugbear 4 | isort 5 | pylint 6 | pytest 7 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | extend-ignore = E203, E501 3 | max-line-length = 80 4 | max-complexity = 18 5 | select = B9 6 | 7 | [isort] 8 | multi_line_output = 3 9 | include_trailing_comma = True 10 | force_grid_wrap = 0 11 | use_parentheses = True 12 | ensure_newline_before_comments = True 13 | line_length = 88 14 | 15 | [pylint] 16 | disable = C, R, W0511, W1203 17 | max-line-length = 88 18 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from openwifipass import __version__ 2 | from codecs import open 3 | from os.path import abspath, dirname, join 4 | from setuptools import find_packages, setup 5 | 6 | this_dir = abspath(dirname(__file__)) 7 | with open(join(this_dir, "README.md"), encoding="utf-8") as file: 8 | long_description = file.read() 9 | 10 | setup( 11 | name="OpenWifiPass", 12 | version=__version__, 13 | python_requires=">=3.6", 14 | description="An open Apple Wi-Fi Password Sharing implementation", 15 | long_description=long_description, 16 | long_description_content_type="text/markdown", 17 | url="https://owlink.org", 18 | project_urls={ 19 | "Source": "https://github.com/seemoo-lab/openwifipass", 20 | }, 21 | author="The Open Wireless Link Project", 22 | classifiers=[ 23 | "Development Status :: 3 - Alpha", 24 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 25 | "Environment :: Console", 26 | "Intended Audience :: Information Technology", 27 | "Intended Audience :: Science/Research", 28 | "Operating System :: POSIX :: Linux", 29 | "Natural Language :: English", 30 | "Programming Language :: Python :: 3", 31 | "Programming Language :: Python :: 3.6", 32 | "Programming Language :: Python :: 3.7", 33 | "Programming Language :: Python :: 3.8", 34 | "Programming Language :: Python :: 3.9", 35 | "Programming Language :: Python :: 3 :: Only", 36 | ], 37 | keywords="cli", 38 | packages=find_packages(exclude=["docs"]), 39 | install_requires=[ 40 | "bluepy", 41 | "cryptography", 42 | "hkdf", 43 | "pycryptodomex", 44 | ], 45 | entry_points={ 46 | "console_scripts": [ 47 | "openwifipass=openwifipass.__main__:main", 48 | ], 49 | }, 50 | ) 51 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/seemoo-lab/openwifipass/9f8079cb8fe51ac46ce0c7444e60659b5217d2c8/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_opack.py: -------------------------------------------------------------------------------- 1 | from openwifipass.OPACK import OPACK 2 | 3 | 4 | def test_encode_decode_dict(): 5 | data = {"pf": 266256} 6 | encoded = OPACK.encode(data) 7 | decoded_data = OPACK.decode(encoded) 8 | 9 | assert data == decoded_data 10 | -------------------------------------------------------------------------------- /tests/test_tlv8.py: -------------------------------------------------------------------------------- 1 | from openwifipass.TLV8 import TLV8Box 2 | 3 | 4 | def test_tlv8box_decode_encode(): 5 | encoded = bytes.fromhex("4401ff4402ffff") 6 | decoded = TLV8Box.decodeFromData(encoded) 7 | 8 | assert encoded == decoded.encode() 9 | --------------------------------------------------------------------------------