AdGuard VPN endpoint

Running endpoint

Building

Execute the following commands in Terminal:

cargo build

to build the debug version, or

cargo build --release

to build the release version.

Issuing self-signed cert and keys (RSA)

Execute the following commands in Terminal:

openssl req -config <openssl.conf> -new -x509 -sha256 -newkey rsa:2048 -nodes -days 1000 -keyout key.pem -out cert.pem

where

• <openssl.conf> is an optional OpenSSL request template file

Endpoint configuration

An endpoint can be configured using a JSON file. The file struct reflects the library settings (see struct Settings in settings.rs). The very basic configuration file can be found in the example. To explore the full set of settings see docs in settings.rs.

Running

To run the binary through cargo, execute the following commands in Terminal:

cargo run --bin vpn_endpoint -- <path/to/vpn.config>

To run the binary directly, execute the following commands in Terminal:

<path/to/target>/vpn_endpoint <path/to/vpn.config>

where <path/to/target> is determined by the build command (by default it is ./target/debug or ./target/release depending on the build type).

Example endpoint

For a quic setup you can run the example endpoint (see here). It shows the essential things needed to run an instance. To start one run the following commands in Terminal:

cd ./examples/my_vpn && ./run.sh

It may ask you to enter some information for generating your certificate. Skip it clicking enter if it does not matter.

Testing with Google Chrome

1. 2 options:
   • Add the generated certificate to the trusted store and run the Google Chrome
   • Run the Google Chrome from Terminal like this:

   google-chrome --ignore-certificate-errors
   

   IMPORTANT: the second option should be used just for testing, it removes the first line of defence against malicious resources
2. Set up the endpoint as an HTTPS proxy server in the browser (either via browser settings or using an extension like Proxy SwitchyOmega)

Collecting metrics

Common ways:

• As plain text: send a GET request to <ip>:<port>/metrics, for example, using CURL or a web browser
• Set up Prometheus:
  1. Configure the instance to monitor the endpoint metrics (see here)
  2. Use the graph interface