angela-d / wifi-network-testing Goto Github PK

Scan your wifi network and obtain troubleshooting details, with extreme granularity - using a colorful command-line tool.

License: GNU General Public License v3.0

Shell 58.90% Perl 41.10%

wifi wifi-network wifi-security wifi-scanner shell-scripts bash bash-script gplv3 internet-connectivity internet-access monitoring wifi-monitor network-manager nmcli macos airport wireless wireless-network brew homebrew

wifi-network-testing's Introduction

Wifi Network Testing

Scan your wifi network and obtain troubleshooting details, with extreme granularity; using a colorful command-line tool with no technical skill necessary. (Assuming you are familiar with git, of course.)

Obtain the following details about your wifi connection:

Wifi statistics:

SSID / wifi name / access point / router name you're connected to
MAC address & manufacturer details
Channel details; connection cipher/encryption for your connection
Neighbor details:
- Nearby router / access point signal strength (in relation to you)
- Their router MAC & chip manufacturer info
- SSID (wifi name) and overall neighbor channel utilization
- What channel each router or AP is using
- How many routers/APs total are on that channel

Connectivity assessments:

Connection detection
Speed tests & packet loss
IP & DNS information
VPN detection

Optional, built-in enterprise capabilities:

Useful in scenarios where you're in a multi-access point environment; several APs carrying the same SSID but are posted in different locations throughout your campus.

Determine whether or not you're on your organization's network / intranet
Assign custom AP names to access points/routers at your organization (useful when determining which access point in your building is causing issues, such as channel overlap or evil twin attacks)

Compatible Operating Systems

OS	Pre-prerequisite	Auto-Install (if not already in-use)?
Debian-based Linux	network-manager/nmcli	☑️
MacOS	brew	☑️
Windows 10	Git, Bash	❌ [details]

Screenshots

Test Option / Install Step	Image
Initial Setup
Main Menu
#2 (Extended: Basic + packet loss, IP & DNS information)
#3 (Basic + speed test only)
#5 (5g channel usage)
#6 (Access point + channel usage) - appearance varies by OS; Linux looks the coolest
Channel lookup (Linux only)

How to Install

First Run Steps - How to install and use wiki

Useful Companion Apps (optional)

If you find this tool useful, you might also find these handy (both are currently for Linux only):

wavemon - ncurses-based monitoring application for wireless network devices on Linux
wifi-channel-watcher - Monitor channel usage of neighboring routers/access points & get an alert if your active channel is not optimal

Known Bugs

There's a few cosmetic bugs that don't affect performance.

Credits

Original iteration of this application was written by my super cool boss.

I added cross-platform capabilities + enterprise AP customization, MAC lookups and channel details.

wifi-network-testing's People

Contributors

Stargazers

Watchers

Forkers

rodolfocdsantos soloinovator v9h ptrlow1 vaginessa

wifi-network-testing's Issues

ping flags for macOS need to be updated

When using option 2 on macOS, I get this error

Testing Connection to Internet...
------------------------------------------------------------------------------
usage: ping [-AaDdfnoQqRrv] [-c count] [-G sweepmaxsize]
            [-g sweepminsize] [-h sweepincrsize] [-i wait]
            [-l preload] [-M mask | time] [-m ttl] [-p pattern]
            [-S src_addr] [-s packetsize] [-t timeout][-W waittime]
            [-z tos] host
       ping [-AaDdfLnoQqRrv] [-c count] [-I iface] [-i wait]
            [-l preload] [-M mask | time] [-m ttl] [-p pattern] [-S src_addr]
            [-s packetsize] [-T ttl] [-t timeout] [-W waittime]
            [-z tos] mcast-group
Apple specific options (to be specified before mcast-group or host like all options)
            -b boundif           # bind the socket to the interface
            -k traffic_class     # set traffic class socket option
            -K net_service_type  # set traffic class socket options
            -apple-connect       # call connect(2) in the socket
            -apple-time          # display current time
Connection is DOWN

adding at set -x to the script, it looks like $PINGPROTOCOL is empty, it's set to the empty string in my config, and creating and empty argument:

+ pingOptions 9.9.9.9
+ '[' mac '!=' windows ']'
+ ping '' -c 3 -q 9.9.9.9

Unfortunately OSX doesn't have a -4 or -6 flag, one way to fix this would be to break out the mac vs linux options in the if statements, another would be to check if $PINGPROTOCOL is empty before including it in the command.

Possible shell error when doing a basic scan

I copied the default configuration into ~/.nettest/config.conf and ran nettest.sh twice, once to install on macOS, the second to run a scan. I selected (1) - basic scan.

Part of the output included

 -47 RSSI; Strong Signal
./nettest.sh: line 668: -90: No such file or directory
 -98 RF Noise High

I wasn't able to reproduce this error.

On macOS when running extended test, syntax error with $PING-c

Testing packet loss...
./nettest.sh: line 1039: ping-c: command not found
packet loss

On macOS speedtest fails under option 3 (basic and speed test)

Another case where linux != macOS and OS != linux does not imply the script is running on Windows.

------------------------------------------------------------------------------
Testing Internet Speed...
------------------------------------------------------------------------------
usage: speedtest [-h] [--no-download] [--no-upload] [--single] [--bytes]
                 [--share] [--simple] [--csv] [--csv-delimiter CSV_DELIMITER]
                 [--csv-header] [--json] [--list] [--server SERVER]
                 [--exclude EXCLUDE] [--mini MINI] [--source SOURCE]
                 [--timeout TIMEOUT] [--secure] [--no-pre-allocate]
                 [--version]
speedtest: error: unrecognized arguments: --accept-license

The code is:

[ "$OS" != "linux" ] && speedtest --accept-license || speedtest

On macOS mixed results with option 6, access point and wifi usage includes errors

Overall option 6 is working, but there are a few errors. I haven't looked at the code. Lines 969 and 972.

Option 6 selected
------------------------------------------------------------------------------
Checking Wifi...
------------------------------------------------------------------------------
Signal
 -52 RSSI; Strong Signal
 -96 RF Noise Acceptable
Access Point Details
 SSID:                Yassas2        
 Channel:             48             
 Radio:               5GHz           
 MAC:                 44:a5:6e:5a:be:73
       :              NETGEAR
------------------------------------------------------------------------------
Determining channel usage by array...
------------------------------------------------------------------------------
Sorted ascending by signal strength
BeeCee
 RSSID: 2.4G
./nettest.sh: line 969: [: 2.4G: integer expression expected
./nettest.sh: line 972: [: 2.4G: integer expression expected
 (far away; poorest signal)
 Channel: cc:be:59:1f:ea:75
 BSSID: -
--------
Brightside
 RSSID: -42
 (closest / loudest signal)
 Channel: 6,+1
 BSSID: 4a:a5:6e:5a:be:71
--------
Waterford
 RSSID: a8:4e:3f:78:03:28
./nettest.sh: line 969: [: a8:4e:3f:78:03:28: integer expression expected
./nettest.sh: line 972: [: a8:4e:3f:78:03:28: integer expression expected
 (far away; poorest signal)
 Channel: -85
 BSSID: 2.4
--------
TELUS3431-24G
 RSSID: -71
 (fairly close)
 Channel: 11
 BSSID: fc:2b:b2:e8:8f:e2
--------

...output truncated...

README.md: instructions for macOS - installer.sh requires configuration variables to be set

Based on the README I wasn't sure exactly how to install this for macOS
I cloned the repo.
I sort of thought that the installer.sh script would install stuff, but unfortunately it requires configuration variables to be setup.

On MacOS it looks like I should:

mkdir -p ~/.nettest
cp config-template.conf ~/.nettest/config.conf
./nettest.sh

and follow the prompts.