https://github.com/needs-coffee/wifipasswords
Retreive and save all WiFi networks and passwords on the device. Cross platform windows, linux, macOS
https://github.com/needs-coffee/wifipasswords
linux macos passwords python python3 tools wifi wifi-network wifi-networks windows wpa-supplicant
Last synced: about 2 months ago
JSON representation
Retreive and save all WiFi networks and passwords on the device. Cross platform windows, linux, macOS
- Host: GitHub
- URL: https://github.com/needs-coffee/wifipasswords
- Owner: needs-coffee
- License: gpl-3.0
- Created: 2021-03-23T18:13:01.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-06-24T05:11:16.000Z (almost 4 years ago)
- Last Synced: 2026-01-02T18:18:24.217Z (5 months ago)
- Topics: linux, macos, passwords, python, python3, tools, wifi, wifi-network, wifi-networks, windows, wpa-supplicant
- Language: Python
- Homepage:
- Size: 158 KB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
Awesome Lists containing this project
README
# wifipasswords
    [](https://pepy.tech/project/wifipasswords)
Retrieve and save all WiFi networks and passwords on the device.
On windows uses the netsh subprocess.
On linux reads the NetworkManager files or wpa_supplicant.conf.
Cross platform:
- Windows
- Linux
- macOS (working - however see below note)
there is also a GUI version of this tool that can be found here - [WifiPasswords-GUI](https://github.com/needs-coffee/wifipasswords-GUI)
**NOTE:** requires sudo privileges on linux only if NetworkManager is not used.
**NOTE:** Macos requires admin authentication for each password read, this can result in a lot of prompts for the get_passwords() function. I am currently looking for a solution for this.
Features
--------
- Importable as a package or able to be run directly on the command line
- Tested in Python 3.6 - 3.10
- Tested on Windows 10, Ubuntu 18 - 20.04, Debian Buster, macOS 10.13 (High Sierra) and macOS 10.14 (Mojave)
- Returns WiFi passwords as a dictionary
- Able to show visible wifi networks
- Able to show currently connected SSID
- Able to show current DNS config
- Able to show known SSIDs and find single network passwords
- Can save networks as JSON or wpa_supplicant.conf file
Installation
------------
Installed via pip using: ``pip install wifipasswords``
Usage
-----
```python
from wifipasswords import WifiPasswords
passwords = WifiPasswords().get_passwords()
connected_passwords = WifiPasswords().get_currently_connected_passwords()
print(passwords)
print(connected_passwords)
WifiPasswords().save_wpa_supplicant('.', passwords, True, 'GB')
```
Command Line Usage
------------------
Provides a command line interface callable after installation with:
- ``python3 -m wifipasswords``
- ``wifipasswords``
```shell
~ $ wifipasswords
```
To see command line options run ``wifipasswords -h``
Packaging as EXE
----------------
Can be packaged to an EXE on windows with:
``pyinstaller --clean --noconsole --onefile -i wifipasswords_exe.py``
The wifipasswords_exe.py file is the same as the __main__.py file in the package except will pause after console output is finished to prevent the terminal from auto-closing if the EXE is run directly.
Testing
-------
Test locally with `pytest -v ./tests`
Currently github test runners do not have nmcli interface to access wifi data so test locally.
About
-----
Creation date: 10-02-2019
Dependencies: colorama
Licence
-------
Copyright (C) 2019-2022 Joe Campbell
GNU GENERAL PUBLIC LICENSE (GPLv3)
This program is free software: you can redistribute it and / or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY
without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see < https: // www.gnu.org/licenses/>.