Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m3t0r/pia-wg-rs
A Rust-based command-line interface for managing Private Internet Access (PIA) WireGuard connections
https://github.com/m3t0r/pia-wg-rs
rust vpn wireguard
Last synced: 18 days ago
JSON representation
A Rust-based command-line interface for managing Private Internet Access (PIA) WireGuard connections
- Host: GitHub
- URL: https://github.com/m3t0r/pia-wg-rs
- Owner: M3t0r
- License: apache-2.0
- Created: 2024-08-11T20:02:35.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-04T20:52:00.000Z (20 days ago)
- Last Synced: 2025-01-04T21:29:09.159Z (20 days ago)
- Topics: rust, vpn, wireguard
- Language: Rust
- Homepage:
- Size: 160 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# PIA WireGuard CLI
[](https://github.com/M3t0r/pia-wg-rs/actions/workflows/ci.yml)
[](https://www.rust-lang.org)
[](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]
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 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 `.
## 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
* Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
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.