first push

README.md

@@ -0,0 +1,92 @@
+# Manual PIA VPN Connections
+ __This project is "Work in Progress"__
+
+This repository contains documentation on how to create native WireGuard connections to our NextGen network, and also on how to enable Port Forwarding in case you require this feature. Documentation on OpenVPN will follow soon enough.
+
+You will find a lot of information bellow. However if you prefer a hands-on approach, here is the __TL/DR__:
+ * clone this repo: `git clone https://github.com/pia-foss/manual-connections.git`
+ * use `get_region_and_token.sh` to get the best region and a token
+ * use `wireguard_and_pf.sh` to create a WireGuard connection with/without PF
+
+### Dependencies
+
+In order for the scripts to work (probably even if you do a manual setup), you will need the following packages:
+ * `curl`
+ * `jq`
+ * `wireguard-tools` (which give you the `wg-quick` utility)
+
+## PIA Port Forwarding
+
+The PIA Port Forwarding service (a.k.a. PF) allows you run services on your own devices, and expose them to the internet by using the PIA VPN Network. The easiest way to set this up is by using a native PIA aplications. In case you require port forwarding on native clients, please follow this documentation in order to enable port forwarding for your VPN connection.
+
+This service can be used only AFTER establishing a VPN connection.
+
+## Automated setup of VPN and/or PF
+
+In order to help you use VPN services and PF on any device, we have prepare a few bash scripts that should help you through the process of setting everything up. The scripts also contain a lot of comments, just in case you require detailed information regarding how the technology works.
+
+Here is a list of scripts you could find useful:
+ * [region and token script](get_region_and_token.sh): This script helps you to get the best region and also to get a token for VPN authentication. The script will extend it's functionality if you add extra environment variables. Adding your PIA credentials will allow the script to also get a VPN token. The script can also trigger the WireGuard script to create a connection, if you specify `WG_AUTOCONNECT=true`.
+ * [wireguard and pf script](wireguard_and_pf.sh): This script allow you to connect to the VPN server via WireGuard. You can specify `PIA_PF=true` if you also wish to get Port Forwarding for your connection.
+ * openvpn script: allows you to connect and to bind a port // TODO: Add Link
+
+## Manual setup of PF
+
+To use port forwarding on the NextGen network, first of all establish a connection with your favorite protocol. After this, you will need to find the private IP of the gateway you are connected to. In case you are WireGuard, the gateway will be part of the JSON response you get from the server, as you can see in the [bash script](https://github.com/pia-foss/manual-connections/blob/master/wireguard_and_pf.sh#L119). In case you are using OpenVPN, you can find the gateway by checking the routing table with `ip route s t all`.
+
+After connecting and finding out what the gateway is, get your payload and your signature by calling `getSignature` via HTTPS on port 19999. You will have to add your token as a GET var to proove you actually have an active account.
+
+Example:
+```bash
+bash-5.0# curl -k "https://10.4.128.1:19999/getSignature?token=$TOKEN"
+{
+    "status": "OK",
+    "payload": "eyJ0b2tlbiI6Inh4eHh4eHh4eCIsInBvcnQiOjQ3MDQ3LCJjcmVhdGVkX2F0IjoiMjAyMC0wNC0zMFQyMjozMzo0NC4xMTQzNjk5MDZaIn0=",
+    "signature": "a40Tf4OrVECzEpi5kkr1x5vR0DEimjCYJU9QwREDpLM+cdaJMBUcwFoemSuJlxjksncsrvIgRdZc0te4BUL6BA=="
+}
+```
+
+The payload can be decoded with base64 to see your information:
+```bash
+$ echo eyJ0b2tlbiI6Inh4eHh4eHh4eCIsInBvcnQiOjQ3MDQ3LCJjcmVhdGVkX2F0IjoiMjAyMC0wNC0zMFQyMjozMzo0NC4xMTQzNjk5MDZaIn0= | base64 -d | jq 
+{
+  "token": "xxxxxxxxx",
+  "port": 47047,
+  "expires_at": "2020-06-30T22:33:44.114369906Z"
+}
+```
+This is where you can also see the port you received. Please consider `expires_at` as your request will fail if the token is too old. All ports currently expire after 2 months.
+
+Use the payload and the signature to bind the port on any server you desire. This is also done by curling the gateway of the VPN server you are connected to.
+```bash
+bash-5.0# curl -sGk --data-urlencode "payload=${payload}" --data-urlencode "signature=${signature}" https://10.4.128.1:19999/bindPort
+{
+    "status": "OK",
+    "message": "port scheduled for add"
+}
+bash-5.0# 
+```
+
+Call __/bindPort__ every 15 minutes, or the port will be deleted!
+
+### Testing your new PF
+
+To test that it works, you can tcpdump on the port you received:
+
+```
+bash-5.0# tcpdump -ni any port 47047
+```
+
+After that, use curl on the IP of the traffic server and the port specified in the payload which in our case is `47047`:
+```bash
+$ curl "http://178.162.208.237:47047"
+```
+
+and you should see the traffic in your tcpdump:
+```
+bash-5.0# tcpdump -ni any port 47047
+tcpdump: verbose output suppressed, use -v or -vv for full protocol decode
+listening on any, link-type LINUX_SLL (Linux cooked v1), capture size 262144 bytes
+22:44:01.510804 IP 81.180.227.170.33884 > 10.4.143.34.47047: Flags [S], seq 906854496, win 64860, options [mss 1380,sackOK,TS val 2608022390 ecr 0,nop,wscale 7], length 0
+22:44:01.510895 IP 10.4.143.34.47047 > 81.180.227.170.33884: Flags [R.], seq 0, ack 906854497, win 0, length 0
+```

ca.rsa.4096.crt

@@ -0,0 +1,43 @@
+-----BEGIN CERTIFICATE-----
+MIIHqzCCBZOgAwIBAgIJAJ0u+vODZJntMA0GCSqGSIb3DQEBDQUAMIHoMQswCQYD
+VQQGEwJVUzELMAkGA1UECBMCQ0ExEzARBgNVBAcTCkxvc0FuZ2VsZXMxIDAeBgNV
+BAoTF1ByaXZhdGUgSW50ZXJuZXQgQWNjZXNzMSAwHgYDVQQLExdQcml2YXRlIElu
+dGVybmV0IEFjY2VzczEgMB4GA1UEAxMXUHJpdmF0ZSBJbnRlcm5ldCBBY2Nlc3Mx
+IDAeBgNVBCkTF1ByaXZhdGUgSW50ZXJuZXQgQWNjZXNzMS8wLQYJKoZIhvcNAQkB
+FiBzZWN1cmVAcHJpdmF0ZWludGVybmV0YWNjZXNzLmNvbTAeFw0xNDA0MTcxNzQw
+MzNaFw0zNDA0MTIxNzQwMzNaMIHoMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0Ex
+EzARBgNVBAcTCkxvc0FuZ2VsZXMxIDAeBgNVBAoTF1ByaXZhdGUgSW50ZXJuZXQg
+QWNjZXNzMSAwHgYDVQQLExdQcml2YXRlIEludGVybmV0IEFjY2VzczEgMB4GA1UE
+AxMXUHJpdmF0ZSBJbnRlcm5ldCBBY2Nlc3MxIDAeBgNVBCkTF1ByaXZhdGUgSW50
+ZXJuZXQgQWNjZXNzMS8wLQYJKoZIhvcNAQkBFiBzZWN1cmVAcHJpdmF0ZWludGVy
+bmV0YWNjZXNzLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBALVk
+hjumaqBbL8aSgj6xbX1QPTfTd1qHsAZd2B97m8Vw31c/2yQgZNf5qZY0+jOIHULN
+De4R9TIvyBEbvnAg/OkPw8n/+ScgYOeH876VUXzjLDBnDb8DLr/+w9oVsuDeFJ9K
+V2UFM1OYX0SnkHnrYAN2QLF98ESK4NCSU01h5zkcgmQ+qKSfA9Ny0/UpsKPBFqsQ
+25NvjDWFhCpeqCHKUJ4Be27CDbSl7lAkBuHMPHJs8f8xPgAbHRXZOxVCpayZ2SND
+fCwsnGWpWFoMGvdMbygngCn6jA/W1VSFOlRlfLuuGe7QFfDwA0jaLCxuWt/BgZyl
+p7tAzYKR8lnWmtUCPm4+BtjyVDYtDCiGBD9Z4P13RFWvJHw5aapx/5W/CuvVyI7p
+Kwvc2IT+KPxCUhH1XI8ca5RN3C9NoPJJf6qpg4g0rJH3aaWkoMRrYvQ+5PXXYUzj
+tRHImghRGd/ydERYoAZXuGSbPkm9Y/p2X8unLcW+F0xpJD98+ZI+tzSsI99Zs5wi
+jSUGYr9/j18KHFTMQ8n+1jauc5bCCegN27dPeKXNSZ5riXFL2XX6BkY68y58UaNz
+meGMiUL9BOV1iV+PMb7B7PYs7oFLjAhh0EdyvfHkrh/ZV9BEhtFa7yXp8XR0J6vz
+1YV9R6DYJmLjOEbhU8N0gc3tZm4Qz39lIIG6w3FDAgMBAAGjggFUMIIBUDAdBgNV
+HQ4EFgQUrsRtyWJftjpdRM0+925Y6Cl08SUwggEfBgNVHSMEggEWMIIBEoAUrsRt
+yWJftjpdRM0+925Y6Cl08SWhge6kgeswgegxCzAJBgNVBAYTAlVTMQswCQYDVQQI
+EwJDQTETMBEGA1UEBxMKTG9zQW5nZWxlczEgMB4GA1UEChMXUHJpdmF0ZSBJbnRl
+cm5ldCBBY2Nlc3MxIDAeBgNVBAsTF1ByaXZhdGUgSW50ZXJuZXQgQWNjZXNzMSAw
+HgYDVQQDExdQcml2YXRlIEludGVybmV0IEFjY2VzczEgMB4GA1UEKRMXUHJpdmF0
+ZSBJbnRlcm5ldCBBY2Nlc3MxLzAtBgkqhkiG9w0BCQEWIHNlY3VyZUBwcml2YXRl
+aW50ZXJuZXRhY2Nlc3MuY29tggkAnS7684Nkme0wDAYDVR0TBAUwAwEB/zANBgkq
+hkiG9w0BAQ0FAAOCAgEAJsfhsPk3r8kLXLxY+v+vHzbr4ufNtqnL9/1Uuf8NrsCt
+pXAoyZ0YqfbkWx3NHTZ7OE9ZRhdMP/RqHQE1p4N4Sa1nZKhTKasV6KhHDqSCt/dv
+Em89xWm2MVA7nyzQxVlHa9AkcBaemcXEiyT19XdpiXOP4Vhs+J1R5m8zQOxZlV1G
+tF9vsXmJqWZpOVPmZ8f35BCsYPvv4yMewnrtAC8PFEK/bOPeYcKN50bol22QYaZu
+LfpkHfNiFTnfMh8sl/ablPyNY7DUNiP5DRcMdIwmfGQxR5WEQoHL3yPJ42LkB5zs
+6jIm26DGNXfwura/mi105+ENH1CaROtRYwkiHb08U6qLXXJz80mWJkT90nr8Asj3
+5xN2cUppg74nG3YVav/38P48T56hG1NHbYF5uOCske19F6wi9maUoto/3vEr0rnX
+JUp2KODmKdvBI7co245lHBABWikk8VfejQSlCtDBXn644ZMtAdoxKNfR2WTFVEwJ
+iyd1Fzx0yujuiXDROLhISLQDRjVVAvawrAtLZWYK31bY7KlezPlQnl/D9Asxe85l
+8jO5+0LdJ6VyOs/Hd4w52alDW/MFySDZSfQHMTIc30hLBJ8OnCEIvluVQQ2UQvoW
++no177N9L2Y+M9TcTA62ZyMXShHQGeh20rb4kK8f+iFX8NxtdHVSkxMEFSfDDyQ=
+-----END CERTIFICATE-----

get_region_and_token.sh

@@ -0,0 +1,137 @@
+#!/bin/bash
+
+# Set this to the maximum allowed latency in seconds.
+# All servers that repond slower than this will be ignore.
+# The value is currently set to 50 milliseconds.
+maximum_allowed_latency=0.05
+export maximum_allowed_latency
+
+serverlist_url='https://serverlist.piaservers.net/vpninfo/servers/v4'
+
+# This function checks the latency you have to a specific region.
+# It will print a human-readable message to stderr,
+# and it will print the variables to stdout
+printServerLatency() {
+  serverIP="$1"
+  regionID="$2"
+  regionName="${@:3}"
+  time=$(curl -o /dev/null -s \
+    --connect-timeout $maximum_allowed_latency \
+    --write-out "%{time_connect}" \
+    http://$serverIP:443)
+  if [ $? -eq 0 ]; then
+    >&2 echo The region \"$regionName\" responded in $time seconds
+    echo $time $regionID $serverIP
+  fi
+}
+export -f printServerLatency
+
+echo -n "Getting the server list... "
+# Get all region data since we will need this on multiple ocasions
+all_region_data=$(curl -s "$serverlist_url" | head -1)
+
+# If the server list has less than 1000 characters, it means curl failed.
+if [[ ${#all_region_data} < 1000 ]]; then
+  echo "Could not get correct region data. To debug this, run:"
+  echo "$ curl -v $serverlist_url"
+  echo "If it works, you will get a huge JSON as a response."
+  exit 1
+fi
+# Notify the user that we got the server list.
+echo "OK!"
+
+# Test one server from each region to get the closest region:
+echo Testing servers that respond \
+  faster than $maximum_allowed_latency seconds:
+region_latency_report="$( echo $all_region_data |
+  jq -r '.regions[] | .servers.meta[0].ip + " " + .id + " " + .name' )"
+
+# Get the best region
+bestRegion="$(echo "$region_latency_report" |
+  xargs -i bash -c 'printServerLatency {}' |
+  sort | head -1 | awk '{ print $2 }')"
+
+# Get all data for the best region
+regionData="$( echo $all_region_data |
+  jq --arg REGION_ID "$bestRegion" -r \
+  '.regions[] | select(.id==$REGION_ID)')"
+
+echo The closest region is "$(echo $regionData | jq -r '.name')".
+echo
+bestServer_meta_IP="$(echo $regionData | jq -r '.servers.meta[0].ip')"
+bestServer_meta_hostname="$(echo $regionData | jq -r '.servers.meta[0].cn')"
+bestServer_WG_IP="$(echo $regionData | jq -r '.servers.wg[0].ip')"
+bestServer_WG_hostname="$(echo $regionData | jq -r '.servers.wg[0].cn')"
+bestServer_OT_IP="$(echo $regionData | jq -r '.servers.ovpntcp[0].ip')"
+bestServer_OT_hostname="$(echo $regionData | jq -r '.servers.ovpntcp[0].cn')"
+bestServer_OU_IP="$(echo $regionData | jq -r '.servers.ovpnudp[0].ip')"
+bestServer_OU_hostname="$(echo $regionData | jq -r '.servers.ovpnudp[0].cn')"
+
+echo "The script found the best servers from the region closes to you.
+When connecting to an IP (no matter which protocol), please verify
+the SSL/TLS certificate actually contains the hostname so that you
+are sure you are connecting to a secure server, validated by the
+PIA authority. Please find bellow the list of best IPs and matching
+hostnames for each protocol:
+Meta Services: $bestServer_meta_IP // $bestServer_meta_hostname
+WireGuard: $bestServer_WG_IP // $bestServer_WG_hostname
+OpenVPN TCP: $bestServer_OT_IP // $bestServer_OT_hostname
+OpenVPN UDP: $bestServer_OU_IP // $bestServer_OU_hostname
+"
+
+if [[ ! $PIA_USER || ! $PIA_PASS ]]; then
+  echo If you want this script to automatically get a token from the Meta
+  echo service, please add the variables PIA_USER and PIA_PASS. Example:
+  echo $ PIA_USER=p0123456 PIA_PASS=xxx ./get_region_and_token.sh
+  exit 1
+fi
+
+echo "The ./get_region_and_token.sh script got started with PIA_USER and PIA_PASS,
+so we will also use a meta service to get a new VPN token."
+
+echo "Trying to get a new token by authenticating with the meta service..."
+generateTokenResponse=$(curl -s -u "$PIA_USER:$PIA_PASS" \
+  --connect-to "$bestServer_meta_hostname::$bestServer_meta_IP:" \
+  --cacert "ca.rsa.4096.crt" \
+  "https://$bestServer_meta_hostname/authv3/generateToken")
+echo "$generateTokenResponse"
+
+if [ "$(echo "$generateTokenResponse" | jq -r '.status')" != "OK" ]; then
+  echo "Could not get a token. Please check your account credentials."
+  echo "You can also try debugging by manually running the curl command:"
+  echo $ curl -vs -u "$PIA_USER:$PIA_PASS" --cacert ca.rsa.4096.crt \
+    --connect-to "$bestServer_meta_hostname::$bestServer_meta_IP:" \
+    https://$bestServer_meta_hostname/authv3/generateToken
+  exit 1
+fi
+
+token="$(echo "$generateTokenResponse" | jq -r '.token')"
+echo "This token will expire in 24 hours.
+"
+
+if [ "$WG_AUTOCONNECT" != true ]; then
+  echo If you wish to automatically connect to WireGuard after detecting the best
+  echo region, please run the script with the env var WG_AUTOCONNECT=true. You can
+  echo also specify the env var PIA_PF=true to get port forwarding. Example:
+  echo $ PIA_USER=p0123456 PIA_PASS=xxx \
+    WG_AUTOCONNECT=true PIA_PF=true ./sort_regions_by_latency.sh
+  echo
+  echo You can connect by running:
+  echo WG_TOKEN=\"$token\" WG_SERVER_IP=$bestServer_WG_IP \
+    WG_HOSTNAME=$bestServer_WG_hostname ./wireguard_and_pf.sh
+  exit
+fi
+
+if [ "$PIA_PF" != true ]; then
+  PIA_PF="false"
+fi
+
+echo "The ./get_region_and_token.sh script got started with WG_AUTOCONNECT=true,
+so we will automatically connect to WireGuard, by running this command:
+$ WG_TOKEN=\"$token\" \\
+  WG_SERVER_IP=$bestServer_WG_IP WG_HOSTNAME=$bestServer_WG_hostname \\
+  PIA_PF=$PIA_PF ./wireguard_port_forwarding.sh
+"
+
+PIA_PF=$PIA_PF WG_TOKEN="$token" WG_SERVER_IP=$bestServer_WG_IP \
+  WG_HOSTNAME=$bestServer_WG_hostname ./wireguard_and_pf.sh