Skip to content

Latest commit

 

History

History
215 lines (148 loc) · 6.7 KB

README.rst

File metadata and controls

215 lines (148 loc) · 6.7 KB
Raw

NordNM

Build Status GitHub tag AUR license GitHub issues

This tool automates the importing and secures the usage of NordVPN OpenVPN configurations through Network Manager.

WebRTC Privacy Warning: This tool can’t protect against IP leaks through WebRTC in browsers. For more information: The WebRTC “bug”

Features:

If you encounter a problem or have a feature request, please make an issue report and it will be looked into ASAP.

  • Small Footprint: Nordnm does not use any background processes. Once a synchronise has finished, it’s all handled by Network Manager.
  • Improved readability: Humanly readable connection names, so you can easily tell what each connection offers.
  • Only import what you need: Your preference of countries, VPN categories and protocols can be saved, to synchronise only the options you need.
  • Always up-to-date: The tool can be configured to always check if it is using the latest NordVPN OpenVPN configuration files.
  • Server Benchmarking: Servers are benchmarked according to their latency and server load, to determine the optimal options available.
  • Auto-Connect: A server of your choice can be set to automatically activate whenever you connect to the Internet.
  • DNS Tunnelling: DNS requests are forced to go through the VPN tunnel, to prevent privacy ruining DNS leaks.
  • IPv6 Disabled: IPv6 is disabled by default, to avoid IPv6 leaks.
  • Kill-Switch: Set a network kill-switch, to disable the network interface being used if the active VPN disconnects.
  • MAC Address Manipulation: Change the MAC address used by Network Manager in a variety of ways (randomization, spoofing, etc), to avoid tracking across networks.

1. Installation

1.1 Arch (AUR)

Use your preferred method of installing packages via AUR. An easy option is to use yay:

yay -S nordnm

1.2 Debian/Ubuntu

wget -qO - https://bintray.com/user/downloadSubjectPublicKey?username=bintray | sudo apt-key add -
sudo apt-add-repository "https://dl.bintray.com/chadsr/nordnm-deb main"
sudo apt update && sudo apt install nordnm

1.3 RPM Based Distributions (Fedora, CentOS, etc)

wget https://bintray.com/chadsr/nordnm-rpm/rpm -O bintray-chadsr-nordnm-rpm.repo
sudo mv bintray-chadsr-nordnm-rpm.repo /etc/yum.repos.d/
sudo yum install nordnm

1.4 Python PIP

Note: If you install via PIP, system dependencies will need to be installed manually. It is therefore recommended to install via your system package manager. If your system is not yet listed above, leave an issue and it can be added ASAP.

If your default Python version is 2.x (check using ``python -V``), you will need to use pip3 below

System Install

sudo -H pip install nordnm

User Install

pip install --user nordnm

2. Usage

usage: nordnm [-h] [-v] [-k] [-a [COUNTRY_CODE] [VPN_CATEGORY] [PROTOCOL]]
              ...

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         Display the package version.
  -k, --kill-switch     Sets a network kill-switch, to disable the active
                        network interface when an active VPN connection
                        disconnects.
  -a [COUNTRY_CODE] [VPN_CATEGORY] [PROTOCOL], --auto-connect [COUNTRY_CODE] [VPN_CATEGORY] [PROTOCOL]
                        Configure NetworkManager to auto-connect to the chosen
                        server type. Takes country code, category and
                        protocol.

commands:
                        Each command has its own help page, which can be
                        accessed via nordnm <COMMAND> --help
    remove (r)          Remove active connections, auto-connect, kill-switch,
                        data, mac settings or all.
    update (u)          Update a specified setting.
    list (l)            List the specified information.
    sync (s)            Synchronise the optimal servers (based on load and
                        latency) to NetworkManager.
    import (i)          Import an OpenVPN config file to NetworkManager.
    mac (m)             Global NetworkManager MAC address preferences. This
                        command will affect ALL NetworkManager connections
                        permanently.

Note: Each command has its own help section, which can be acccessed via nordnm <COMMAND> --help.

2.1 Example Usage

  • View available categories and countries:
sudo nordnm list --categories --countries
  • Synchronise current optimal servers, activate the kill-switch and auto-connect to a “normal” UDP server in the US:
sudo nordnm sync -ka us normal udp
  • Same as above, but don’t check for latest configuration files:
sudo nordnm sync -nka us normal udp
  • View metrics of the synchronised servers:
sudo nordnm list --active-servers
  • Set your MAC address to be randomised each time you connect to a network:
sudo nordnm mac --random
  • Change the auto-connect to another synchronised server:
sudo nordnm -a ru p2p udp
  • Import a specific OpenVPN configuration file while still using the killswitch and autoconnect features (Experimental):
sudo nordnm import /home/foo/config.ovpn -ak -u username -p password
  • Update the settings:
sudo nordnm update --settings
  • Update the user credentials:
sudo nordnm update --credentials
  • Disable the network kill-switch:
sudo nordnm remove --kill-switch
  • Remove all settings and files:
sudo nordnm remove --all