README v0.4 / 15 January 2019
Private Internet Access
Private Internet Access is the world's leading consumer VPN service. At Private Internet Access we believe in unfettered access for all, and as a firm supporter of the open source ecosystem we have made the decision to open source our VPN clients. For more information about the PIA service, please visit our website privateinternetaccess.com.
Chrome Web Extension
This repo contains all the code needed to build and run the Private Internet Access Chrome Web Extension. This extension allows a user to access our network of proxies across the world from their web browser. Users can choose a proxy server location and connect to it directly from the extension. Additional privacy and security features include disabling microphone and camera, blocking flash and ip discovery through WebRTC, and can automatically block ads and tracking through PIA MACE™.
Please be advised that connecting to a proxy through our extension only protects traffic from that particular browser and not on applications that may be installed on the operating system itself.
About
This client allows a user to sign-in to their PIA account and choose a particular proxy server to route all their browser traffic through. The client itself is has additional features such as:
- Block Adobe flash
- Block WebRTC IP Detection
- Block Camera access
- Block Microphone Access
- Block Location access
- Disable Network Prediction
- Disable SafeBrowsing
- Disable Third Party Cookies
- Disable Website Referrer
- Disable Hyperlink Auditing
- Remove UTM Parameters
- PIA MACE™ (block ads, trackers, and malicious content)
- Allow direct connections for whitelisted sites
Usage
Please start by ensuring that all the requirements in the Installation section of this README is installed. For more information, please refer to that section.
Building the client is as simple as running the following build command in PowerShell/Terminal:
`yarn run dev`
The unpacked extension can be installed from the following url in chrome: chrome://extensions/
Installation
Requirements
- Git (latest)
- NodeJS 8.1.0 or greater
- Chrome Web Browser (support for the latest two versions)
Git Please use these instructions to install Git on your computer if it is not already installed: Installing Git
NodeJS We recommend installing NodeJS via nvm on MacOS and Linux. On Windows, you can simply use the node installer found here.
Download Codebase
Using the PowerShell/Terminal:
`git clone https://github.com/pia-foss/extension-chrome.git`
or use a graphical interface like Git Desktop to download this repository into a directory of your choosing.
Setup
The extension uses NodeJS and YARN to build itself.
To install all dependencies the extension needs to build run the following command in PowerShell/Terminal:
`yarn install`
Building
To build the extension, run one of the commands below in PowerShell/Terminal at the project root. When the build is finished ./builds/$browser-$build will have been created, and it can be loaded as an unpacked extension in Chrome (if using option 1 below).
option 1: (a build that makes debugging easier)
`yarn run dev`
option 2: (a production build, that targets the webstore)
`yarn run public`
Loading Extension
- Enter "chrome://extensions" into Chrome's address bar.
- Tick "Developer Mode" if it isn't already.
- Click "Load unpacked extension", and choose the path to the build directory.
Testing
Ensure that the following environment variables are set before running tests
WAIT_TIME
TEST_USERNAME
TEST_PASSWORD
EXTENSION_ID
MANIFEST_KEY
Testing
Requirements
- yarn
Running tests
Simply run the yarn command
`yarn test`
And the entire test suite will be run
Translations
Ensure that a config/oneskyauthfile.json exist before uploading translations. This file should contain the public and secret keys for your 1sky account
Ensure that the ONESKY_PROJECT_ID environment variable is set
The extension supports all locales found in src/_locales. The translations are
translated by the 1sky service. src/_locales/en/messages.json can be uploaded to 1sky
using the following grunt task:
`yarn run translation:import`
Translations for all locales can be downloaded with the following task:
`yarn run translation:export`
Deployment
Deploying to the Chrome Webstore
Ensure the webstore.pem file exists.
Ensure the following environment variables are set before uploading to the webstore.
WEBSTORE_CLIENT_ID
WEBSTORE_CLIENT_SECRET
WEBSTORE_REFRESH_TOKEN
WEBSTORE_PUBLIC_ID
WEBSTORE_INTERNAL_ID
To publish the extension onto the webstore from the command line for either internal users(eg QA) or the general public, you can run one of the following: Note: We no longer push a internal version to the chrome webstore. The following command will only build a distributable that needs to be manually distributed.
For internal users only
`yarn run qa`
For all users
`yarn run release`
Deploying to the Firefox Add-on Store
These instructions are still in flux.
Ensure that you've created a web-ext api key and secret beforehand
At the root of the project, run the following command
yarn run public
This should create a new .xpi file in builds/firefox-public that can be uploaded to the add-on store via the addons website. This is a manual process for now until an automated procedure can be established.
Contributing
By contributing to this project you are agreeing to the terms stated in the Contributor License Agreement (CLA) here. For more details please see CONTRIBUTING.md. Issues and Pull Requests should use these templates: ISSUES and PULL REQUESTS
Authors
- Robert Gleeson
- Edward Kim
- Brad Pfannmuller
- Amir Malik
- Manish Jethani
- Pericles
- Bogdan Pitaroiu
- Stefan Nedelcu
License
This project is licensed under the MIT (Expat) license, which can be found here.
// Firefox readme