Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.62 KB

README.md

File metadata and controls

71 lines (51 loc) · 2.62 KB
Raw

PIA WireGuard CLI

CI Rust License

A Rust-based command-line interface for managing Private Internet Access (PIA) WireGuard connections. This project replaces the pia-foss/manual-connections bash scripts with a less convoluted and more auditable solution.

Features

  • Generate WireGuard configurations for PIA servers
  • List available PIA servers with optional filtering
  • Measure latency to servers
  • Verify VPN connection status
  • Support for authentication via username/password or token

Design Highlights

  • All network-related code is isolated in a single file (src/network.rs) for improved auditability
  • Easier to install / use than pia-foss/manual-connections
  • Can verify if VPN connection is still used, useful for custom kill switches
  • No sudo required!

Usage

Usage: pia-wg [OPTIONS] <COMMAND>

Commands:
  token    Login with user+password and echo a API token
  servers  List available servers
  create   Generates a new wireguard config
  check    Verify the VPN connection is active and used
  help     Print this message or the help of the given subcommand(s)

Options:
  -t, --timeout <SECONDS>  Timeout for every request [default: 3]
      --debug              [env: DEBUG=]
  -h, --help               Print help
  -V, --version            Print version

For more detailed usage instructions, run pia-wg help <COMMAND>.

Avoiding sudo

If you encounter the error "Operation not permitted (os error 1)", it's likely because the program needs special permissions to perform ICMP pings to find the closest VPN server to you. You have two options:

  1. Run the program with sudo (not recommended for security reasons).
  2. Grant the necessary capabilities to the executable (recommended): 
    sudo setcap cap_net_raw=eip pia-wg
    This allows pia-wg to send ICMP packets without requiring root privileges.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.