Obscura VPN API Client

Unstable

This crate and the API behind it are unstable in a number of ways:

1. The API of this crate may be broken at any time.
2. This crate may expose experimental interfaces and services which are completely unsupported. There is no indication of which interfaces these are. Both the Rust APIs and the backing APIs and implementations may change at any time with no notice.

Development

To enter a setup environment run:

nix develop

To run single commands in the environment run:

nix develop -c just lint

Static WireGuard UDP relay tunnel

Warning: This is not an officially supported service.

To create a UDP relay tunnel and write the matching WireGuard configuration to wg0.conf.

cargo run --example api_cli -- --account-no $OBS_ACCOUNT_ID create-static-tunnel --wg-conf > wg0.conf

The resulting configuration file should be compatible with any WireGuard client.

wg-quick up ./wg0.conf

Tunnel deletion

Idle static tunnels are not removed automatically by clients if no tunnel slots are left. You may use this command to delete all tunnels if you run out of tunnel slots:

cargo run --example api_cli -- --account-no $OBS_ACCOUNT_ID delete-all-tunnels

Common issues

• The API or your internet stopped working unexpectedly? You probably deleted the tunnel while your WireGuard client was connected.
• Can't connect to a newly created tunnel? You are probably connected to another tunnel already.

In any case, the solution is almost always:

wg-quick down ./wg0.conf

Utilities

Generating a Valid User ID

cargo run --example gen_id

Note that this generates a user id with the checksum (20 characters).