**v0.5.0**

- Set default best score to -1, to catch cases where all available options score 0 (resulting in no connection added) + raised load percentage to 95% to yield a 0 score
- Custom DNS servers via settings is now possible
- Correct Onion over VPN -> Onion Over VPN (chadsr#85)
- Experimental 'slow-mode' (sync -s)
- Live progress during benchmarking
- RPM package fix for wrongly used library directory
- Executable now installed to /usr/bin instead of /usr/local/bin
- Settings/input case fixes (everything is converted to lower-case)

Author: chadsr

.travis.yml

@@ -55,8 +55,8 @@ jobs:
       - DEB_PYTHON=python3
       - DEB_PIP=pip3
       - FED_DOCKER=fedora:latest
-      - FED_PYTHON=python3
-      - FED_PIP=pip3
+      - FED_PYTHON=python3.6
+      - FED_PIP=pip3.6
       - JFROG_USER=chadsr
       - JFROG_CLI_OFFER_CONFIG=false
       - secure: "pPG85EvUVWahXHSVToXJ9yE/ow4U1mC/RX63J3mjSG5Ywp7BYqdNEa9/YD2cwZaDx1FiwHmbSHZWiYbmNkVKfI0CgcrGXCgKLeRusAHqCSAQ7TsDbk8/LW2e/5saSDqyE7dDvZxyktsJgn906cWu2ZcX+GnwC3sEVW2GNqVIxkRcMqjoTCgxewyodnOMurbSTRrIpVlgVsXu1nBhXvocatFNXE1/RhJnE43KBgVIZHDgGysdZl2RHYkMYy4oW3g80f/d2zrwvQhnlTezUWgx6TGjpfD6w+3JnwrlVG/17A76NBu2GT3YB545hrxPw7QikZ2KMYxJ2TEKN92KResclK8wWQx1IT1csikRYwkXIPESJxzAkQfPNBqmjOofekawc7XOzsC+btOOpJz1CEvksaXfaepGJOmJr2N7h7ZeMRI8I2sXicTsvL7/9R5Tbb5wDOtnmt0PiHMyHBGMF9sBwi64qjQGoq0bj6Q0AxIbXthd2v/p5BDHSA+7fDWUuLpmRyqiPuFZckg+Cd9Q1VsldcR8Qy3pkHMwhyKK4QBgqxsEAgCTFoAozkB9E8ICgE28lJwdk7aQ5Y24ynwcbUK8Jz981v5IlkvJs6vXD6jw1tEo3YNYvi0M5FBcwkH0FNSbEVu0U1dM75wNKjJpXPIX3FBF6+IcQE/K7qXgkT3lU4k="
@@ -76,8 +76,8 @@ jobs:
       - mkdir builds && cd builds/
       # Start building packages
       - echo "Deploying ${PACKAGE} v${VERSION} from PyPi to ${GH_USER}/${NAME} - ${DESCRIPTION}"
-      - docker run -e PACKAGE_DIR=${PACKAGE_DIR} -e DEB_PYTHON=$DEB_PYTHON -e DEB_PIP=$DEB_PIP -e PYTHON_MIN_VERSION=$PYTHON_MIN_VERSION -e DESCRIPTION="${DESCRIPTION}" -e PACKAGE=$PACKAGE -e GH_USER=$GH_USER -e NAME=$NAME -v $PWD:/mnt/travis ${DEB_DOCKER} /bin/bash -c 'su && cd /mnt/travis && apt-get update && apt-get -y install ${DEB_PYTHON} ${DEB_PYTHON}-pip ruby ruby-dev rubygems-integration build-essential && gem install --no-ri --no-rdoc fpm && ${DEB_PYTHON} --version && fpm --maintainer "${GH_USER}" --description "${DESCRIPTION}" --prefix="${PACKAGE_DIR}" --url "https://github.com/${GH_USER}/${NAME}" --provides "${PACKAGE}" -a "all" --no-python-fix-name --python-package-name-prefix "${DEB_PYTHON}" --python-bin ${DEB_PYTHON} --python-pip ${DEB_PIP} --python-install-lib="lib/${DEB_PYTHON}/dist-packages/" -d "${DEB_PYTHON} >= ${PYTHON_MIN_VERSION}" -d iputils-ping -d "network-manager >= 1.2.0" -d openvpn -d network-manager-openvpn-gnome -s python -t deb ${PACKAGE}'
-      - docker run -e PACKAGE_DIR=${PACKAGE_DIR} -e FED_PYTHON=$FED_PYTHON -e FED_PIP=$FED_PIP -e DESCRIPTION="${DESCRIPTION}" -e PACKAGE=$PACKAGE -e GH_USER=$GH_USER -e NAME=$NAME -v $PWD:/mnt/travis ${FED_DOCKER} /bin/bash -c 'su && cd /mnt/travis && dnf install ruby-devel gcc make rpm-build libffi-devel ${FED_PYTHON} ${FED_PYTHON}-pip -y && gem install --no-ri --no-rdoc fpm && ${FED_PYTHON} --version && fpm --maintainer "${GH_USER}" --description "${DESCRIPTION}" --prefix="${PACKAGE_DIR}" --url "https://github.com/${GH_USER}/${NAME}" --provides "${PACKAGE}" -a "all" --no-python-fix-name --python-package-name-prefix "${FED_PYTHON}" --python-bin ${FED_PYTHON} --python-pip ${FED_PIP} --python-install-lib="lib/${FED_PYTHON}/site-packages/" -d ${FED_PYTHON} -d iputils -d "NetworkManager >= 1.2.0" -d openvpn -d NetworkManager-openvpn-gnome -s python -t rpm ${PACKAGE}'
+      - docker run -e PACKAGE_DIR=${PACKAGE_DIR} -e DEB_PYTHON=$DEB_PYTHON -e DEB_PIP=$DEB_PIP -e PYTHON_MIN_VERSION=$PYTHON_MIN_VERSION -e DESCRIPTION="${DESCRIPTION}" -e PACKAGE=$PACKAGE -e GH_USER=$GH_USER -e NAME=$NAME -v $PWD:/mnt/travis ${DEB_DOCKER} /bin/bash -c 'su && cd /mnt/travis && apt-get update && apt-get -y install ${DEB_PYTHON} ${DEB_PYTHON}-pip ruby ruby-dev rubygems-integration build-essential && gem install --no-ri --no-rdoc fpm && ${DEB_PYTHON} --version && fpm --maintainer "${GH_USER}" --description "${DESCRIPTION}" --prefix "${PACKAGE_DIR}" --url "https://github.com/${GH_USER}/${NAME}" --provides "${PACKAGE}" -a "all" --no-python-fix-name --python-package-name-prefix "${DEB_PYTHON}" --python-bin ${DEB_PYTHON} --python-pip ${DEB_PIP} --python-install-bin "/usr/bin/" --python-install-lib "/lib/${DEB_PYTHON}/dist-packages/" -d "${DEB_PYTHON} >= ${PYTHON_MIN_VERSION}" -d iputils-ping -d "network-manager >= 1.2.0" -d openvpn -d network-manager-openvpn-gnome -s python -t deb ${PACKAGE}'
+      - docker run -e PACKAGE_DIR=${PACKAGE_DIR} -e FED_PYTHON=$FED_PYTHON -e FED_PIP=$FED_PIP -e DESCRIPTION="${DESCRIPTION}" -e PACKAGE=$PACKAGE -e GH_USER=$GH_USER -e NAME=$NAME -v $PWD:/mnt/travis ${FED_DOCKER} /bin/bash -c 'su && cd /mnt/travis && dnf install ruby-devel gcc make rpm-build libffi-devel ${FED_PYTHON} ${FED_PYTHON}-pip -y && gem install --no-ri --no-rdoc fpm && ${FED_PYTHON} --version && fpm --maintainer "${GH_USER}" --description "${DESCRIPTION}" --prefix "${PACKAGE_DIR}" --url "https://github.com/${GH_USER}/${NAME}" --provides "${PACKAGE}" -a "all" --no-python-fix-name --python-package-name-prefix "${FED_PYTHON}" --python-bin ${FED_PYTHON} --python-pip ${FED_PIP} --python-install-bin "/usr/bin/" --python-install-lib "/lib/${FED_PYTHON}/site-packages/" -d "python3 >= 3.6.0" -d iputils -d "NetworkManager >= 1.2.0" -d openvpn -d NetworkManager-openvpn-gnome -s python -t rpm ${PACKAGE}'
 
       before_deploy:
       - pwd && cd ../

nordnm/__init__.py

@@ -1,3 +1,3 @@
 __package__ = "nordnm"
-__version__ = "0.4.0"
+__version__ = "0.5.0"
 __license__ = "GNU General Public License v3 or later (GPLv3+)"

nordnm/benchmarking.py

@@ -6,6 +6,7 @@
 from functools import partial
 import numpy
 import os
+import sys
 import subprocess
 from decimal import Decimal
 import resource
@@ -20,8 +21,8 @@ def get_server_score(server, ping_attempts):
     score = 0  # Lowest starting score
     rtt = None
 
-    # If a server is at 90% load or greater, we don't need to waste time pinging. Just keep starting score.
-    if load < 90:
+    # If a server is at 95% load or greater, we don't need to waste time pinging. Just keep starting score.
+    if load < 95:
         rtt, loss = utils.get_rtt_loss(ip_addr, ping_attempts)
 
         if loss < 5:  # Similarly, if packet loss is >= 5%, the connection is not reliable. Keep the starting score.
@@ -37,7 +38,7 @@ def compare_server(server, best_servers, ping_attempts, valid_protocols, valid_c
     if server['features']['openvpn_tcp'] and 'tcp' in valid_protocols:
         supported_protocols.append('tcp')
 
-    country_code = server['flag']
+    country_code = server['flag'].lower()
     domain = server['domain']
     score, load, latency = get_server_score(server, ping_attempts)
 
@@ -51,7 +52,7 @@ def compare_server(server, best_servers, ping_attempts, valid_protocols, valid_c
             category_short_name = nordapi.VPN_CATEGORIES[category['name']]
 
             for protocol in supported_protocols:
-                best_score = 0
+                best_score = -1
 
                 if best_servers.get((country_code, category_short_name, protocol)):
                     best_score = best_servers[country_code, category_short_name, protocol]['score']
@@ -82,15 +83,26 @@ def get_num_processes(num_servers):
         return num_servers
 
 
-def get_best_servers(server_list, ping_attempts, valid_protocols, valid_categories):
+def get_best_servers(server_list, ping_attempts, valid_protocols, valid_categories, slow_mode=False):
     manager = multiprocessing.Manager()
     best_servers = manager.dict()
 
     num_servers = len(server_list)
-    num_processes = get_num_processes(num_servers)
+
+    if slow_mode:
+        num_processes = multiprocessing.cpu_count()
+    else:
+        num_processes = get_num_processes(num_servers)
 
     pool = multiprocessing.Pool(num_processes, maxtasksperchild=1)
-    results = pool.map(partial(compare_server, best_servers=best_servers, ping_attempts=ping_attempts, valid_protocols=valid_protocols, valid_categories=valid_categories), server_list)
+
+    results = []
+    for i, result in enumerate(pool.imap(partial(compare_server, best_servers=best_servers, ping_attempts=ping_attempts, valid_protocols=valid_protocols, valid_categories=valid_categories), server_list)):
+        sys.stderr.write("\r[INFO] %i/%i benchmarks finished." % (i + 1, num_servers))
+        results.append(result)
+
+    sys.stderr.write('\n')
+
     pool.close()
 
     num_success = results.count(True)

nordnm/nordapi.py

@@ -13,7 +13,7 @@
     'P2P': 'p2p',
     'Double VPN': 'double',
     'Dedicated IP servers': 'dedicated',
-    'Onion over VPN': 'onion',
+    'Onion Over VPN': 'onion',
     'Anti DDoS': 'ddos',
 }
 

nordnm/nordnm.py

@@ -65,6 +65,7 @@ def __init__(self):
         list_parser.set_defaults(list=True)
 
         sync_parser = subparsers.add_parser('sync', aliases=['s'], help="Synchronise the optimal servers (based on load and latency) to NetworkManager.")
+        sync_parser.add_argument('-s', '--slow-mode', help="Run benchmarking in 'slow mode'. May increase benchmarking success by pinging servers at a slower rate.", action='store_true')
         sync_parser.add_argument('-p', '--preserve-vpn', help="When provided, synchronising will preserve any active VPN instead of disabling it for more accurate benchmarking.", action='store_true')
         sync_parser.add_argument('-u', '--update-configs', help='Download the latest OpenVPN configurations from NordVPN.', action='store_true', default=False)
         sync_parser.add_argument("-k", "--kill-switch", help="Sets a network kill-switch, to disable the active network interface when an active VPN connection disconnects.", action="store_true")
@@ -205,7 +206,7 @@ def __init__(self):
 
         # Now check for commands that can be chained...
         if "sync" in args and args.sync:
-            self.sync(args.update_configs, args.preserve_vpn)
+            self.sync(args.update_configs, args.preserve_vpn, args.slow_mode)
 
         if args.kill_switch:
             networkmanager.set_killswitch()
@@ -369,14 +370,14 @@ def get_configs(self):
 
             return True
 
-    def sync(self, update_config=True, preserve_vpn=False):
+    def sync(self, update_config=True, preserve_vpn=False, slow_mode=False):
         if self.remove_legacy_files():
             self.logger.info("Removed legacy files")
 
         if update_config:
             self.get_configs()
 
-        if self.sync_servers(preserve_vpn):
+        if self.sync_servers(preserve_vpn, slow_mode):
             networkmanager.reload_connections()
 
     def remove_data(self):
@@ -414,7 +415,7 @@ def get_ovpn_path(self, domain, protocol):
 
     def enable_auto_connect(self, country_code: str, category: str='normal', protocol: str='tcp'):
         enabled = False
-        selected_parameters = (country_code.upper(), category, protocol)
+        selected_parameters = (country_code.lower(), category.lower(), protocol.lower())
 
         if selected_parameters in self.active_servers:
             connection_name = self.active_servers[selected_parameters]['name']
@@ -505,7 +506,7 @@ def get_valid_servers(self, servers):
         valid_server_list = []
 
         for server in servers:
-            country_code = server['flag']
+            country_code = server['flag'].lower()
 
             # If the server country has been selected, it has a selected protocol and selected categories
             if self.country_is_selected(country_code) and self.has_valid_protocol(server) and self.has_valid_categories(server):
@@ -528,12 +529,16 @@ def configs_exist(self):
         else:
             return False
 
-    def sync_servers(self, preserve_vpn):
+    def sync_servers(self, preserve_vpn, slow_mode):
         updated = False
 
         username = self.credentials.get_username()
         password = self.credentials.get_password()
-        dns_list = nordapi.get_nameservers()
+
+        # Check if there are custom DNS servers specified in the settings before loading the defaults
+        dns_list = self.settings.get_custom_dns_servers()
+        if not dns_list:
+            dns_list = nordapi.get_nameservers()
 
         if not self.configs_exist():
             self.logger.warning("No OpenVPN configuration files found.")
@@ -567,14 +572,17 @@ def sync_servers(self, preserve_vpn):
                 else:
                     self.logger.warning("Active VPN preserved. This may give unreliable results!")
 
+                if slow_mode:
+                    self.logger.info("Benchmarking slow mode enabled.")
+
                 num_servers = len(valid_server_list)
                 self.logger.info("Benchmarking %i servers...", num_servers)
 
                 start = timer()
                 ping_attempts = self.settings.get_ping_attempts()  # We are going to be multiprocessing within a class instance, so this needs getting outside of the multiprocessing
                 valid_protocols = self.settings.get_protocols()
                 valid_categories = self.settings.get_categories()
-                best_servers, num_success = benchmarking.get_best_servers(valid_server_list, ping_attempts, valid_protocols, valid_categories)
+                best_servers, num_success = benchmarking.get_best_servers(valid_server_list, ping_attempts, valid_protocols, valid_categories, slow_mode)
 
                 end = timer()
 
@@ -586,7 +594,7 @@ def sync_servers(self, preserve_vpn):
                     self.logger.info("Benchmarked %i servers successfully (%0.2f%%). Took %0.2f seconds.", num_success, percent_success, end - start)
 
                     if percent_success < 90.0:
-                        self.logger.warning("A large quantity of tests failed. You might want to check the reliability of your network.")
+                        self.logger.warning("A large quantity of tests failed. Your network may be unreliable, or blocking large-scale ICMP requests. Syncing in slow mode (-s) may fix this.")
 
                 # remove all old connections and any auto-connect, until a better sync routine is added
                 if self.remove_active_connections():

nordnm/settings.py

@@ -34,9 +34,9 @@ def save_new_settings(self):
         # Populate the Countries section with out input data
         self.settings.add_section('Countries')
         self.settings.set('Countries', '# simply write country codes separated by spaces e.g. country-blacklist = GB US')
-        self.settings.set('Countries', 'country-blacklist', blacklist)
+        self.settings.set('Countries', 'country-blacklist', blacklist.lower().strip())
         self.settings.set('Countries', '\n# same as above. If this is non-empty, the blacklist is ignored')
-        self.settings.set('Countries', 'country-whitelist', whitelist)
+        self.settings.set('Countries', 'country-whitelist', whitelist.lower().strip())
 
         # Prompt for which categories to enable
         self.settings.add_section('Categories')
@@ -50,6 +50,11 @@ def save_new_settings(self):
         answer = str(utils.input_yes_no("Enable UDP configurations?")).lower()
         self.settings.set('Protocols', 'udp', answer)
 
+        self.settings.add_section('DNS')
+        print("\nWARNING: Setting custom DNS servers can compromise your privacy if you don't know what you're doing.")
+        custom_dns = input("Input custom DNS servers you would like to use, separated by spaces. (Press enter to skip): ")
+        self.settings.set('DNS', 'custom-dns-servers', custom_dns.strip())
+
         self.settings.add_section('Benchmarking')
         ping_attempts = input("Input how many ping attempts to make when benchmarking servers (Default: %i attempts): " % self.DEFAULT_PING_ATTEMPTS)
         if not ping_attempts:
@@ -82,14 +87,14 @@ def load(self):
     def get_blacklist(self):
         blacklist = self.settings.get('Countries', 'country-blacklist')
         if blacklist:
-            return [code.upper() for code in blacklist.split(' ')]
+            return [code.lower() for code in blacklist.split(' ')]
         else:
             return None
 
     def get_whitelist(self):
         whitelist = self.settings.get('Countries', 'country-whitelist')
         if whitelist:
-            return [code.upper() for code in whitelist.split(' ')]
+            return [code.lower() for code in whitelist.split(' ')]
         else:
             return None
 
@@ -125,3 +130,11 @@ def get_ping_attempts(self):
         self.logger.warning("Invalid ping-attempts value. Using default value of %d.", self.DEFAULT_PING_ATTEMPTS)
         self.settings.set('Benchmarking', 'ping-attempts', str(self.DEFAULT_PING_ATTEMPTS))  # Lets set the default, so we only get this warning once
         return self.DEFAULT_PING_ATTEMPTS
+
+    def get_custom_dns_servers(self) -> list:
+        custom_dns = self.settings.get('DNS', 'custom-dns-servers')
+
+        if custom_dns:
+            return custom_dns.split(' ')
+        else:
+            return []