Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

114 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Usque — unofficial client compatible with Cloudflare WARP

简体中文

PR Check CI Build MIT License Windows 10 22H2 or later Android 8 or later

Usque

Usque is an open-source, native GUI client for Consumer Cloudflare WARP. Flutter renders the interface, while a memory-safe Rust engine owns MASQUE, CONNECT-IP, DNS, proxying, and connection state. Usque does not use a WebView.

Important

The current release is v0.1.2. Only files attached to the protected v0.1.2 GitHub Release, with matching checksums and signer fingerprints, are official. Pull Request artifacts, local builds, and untagged binaries are development outputs.

Usque is an independent project. It is not affiliated with, sponsored by, or endorsed by Cloudflare. Cloudflare and WARP are trademarks of Cloudflare, Inc. Use of Consumer WARP remains subject to Cloudflare's applicable terms and privacy policy.

Release targets

The protected v0.1.2 workflow builds and validates these six installable artifacts from one exact main commit.

Platform Package Minimum OS Architecture / variant
Windows MSI Windows 10 22H2, build 19045 x86-64-v2
Windows MSI Windows 10 22H2, build 19045 ARM64
Android / Android TV split APK Android 8.0, API 26 ARMv8 (arm64-v8a)
Android / Android TV split APK Android 8.0, API 26 x64 (x86_64)
Android / Android TV split APK Android 8.0, API 26 ARMv7 (armeabi-v7a)
Android / Android TV universal APK Android 8.0, API 26 all three Android ABIs

macOS remains a future source target and is not a build or release gate. iOS, Zero Trust, application stores, a public CLI, and multipath bandwidth aggregation are outside this release.

Highlights

  • Consumer WARP registration, WARP License Key registration, and existing WARP Secret import/export.
  • Composable VPN, SOCKS5, HTTP Proxy, and Windows system-proxy outputs over one MASQUE channel.
  • HTTP/3 over QUIC with HTTP/2 over TLS fallback and IPv4/IPv6 Happy Eyeballs ingress selection.
  • Full-tunnel VPN, tunneled DNS, Kill Switch, LAN access, and user-defined CIDR bypass rules.
  • SOCKS5 TCP/UDP and HTTP CONNECT/Forward with loopback-only listeners by default.
  • Multiple profiles with one active profile and securely isolated identity material.
  • Android Quick Settings Tile, launcher shortcuts, boot recovery, and TV-safe navigation.
  • Windows tray integration, single-instance activation, start-on-boot, and close-to-tray behavior.
  • Local, redacted diagnostics with no analytics, automatic telemetry, or automatic upload.

Selecting an IPv4 or IPv6 MASQUE endpoint changes only the physical ingress. Either ingress can carry both IPv4 and IPv6 packets inside CONNECT-IP; Usque keeps one active transport and does not aggregate bandwidth.

Default network settings

Setting Default
Endpoint IPv4 162.159.198.2
Endpoint IPv6 2606:4700:103::2
Port 443
SNI speed.cloudflare.com
Transport Auto: HTTP/3, then HTTP/2
MTU 1280
Fallback DNS 1.1.1.1, 2606:4700:4700::1111
SOCKS5 127.0.0.1:1080, [::1]:1080
HTTP Proxy 127.0.0.1:8080, [::1]:8080

Advanced users can change these values and restore them in one action. A non-loopback proxy listener is intentionally unauthenticated and always displays a prominent security warning.

Availability and installation

Download v0.1.2 only from the official release page:

Target File
Windows x64 usque-v0.1.2-windows-x64-v2.msi
Windows ARM64 usque-v0.1.2-windows-arm64.msi
Android ARMv8 usque-v0.1.2-android-arm64-v8a.apk
Android x64 usque-v0.1.2-android-x86_64.apk
Android ARMv7 usque-v0.1.2-android-armeabi-v7a.apk
Android universal usque-v0.1.2-android-universal.apk

Prefer the APK matching the device ABI. The universal APK contains ARMv8, x64, and ARMv7 native libraries and is intended for cases where the device architecture is unknown; it is larger than a split APK. The release also includes SHA256SUMS, one .sha256 sidecar per package, SPDX/CycloneDX SBOMs, license inventories, and build attestations.

  • The pre-1.0 Windows packages use a fixed self-signed identity. Verify the published SHA-256 checksum and certificate fingerprint before accepting the operating-system warning.
  • The pre-1.0 Android packages use a fixed, project-controlled self-signed release certificate and are distributed outside Google Play. Advanced sideloading or ADB may be required.
  • The v1.0.0 signing transition will be handled as a separate compatibility-reviewed release change.
  • The protected workflow performs CI, architecture, signature, package, checksum, SBOM, and provenance checks. It does not claim hardware-laboratory, physical-device, or long-duration VPN validation.
  • Updates are never installed automatically. Optional update checks only open the release page.
  • Windows uninstall restores Usque-owned network state before removing the service and can optionally delete the current user's local data.

See Installation and removal for package verification, platform warnings, upgrades, uninstall behavior, and recovery boundaries.

Outputs

One profile can enable several outputs at once. They share one pinned MASQUE transport and a packet multiplexer.

Output Behavior
VPN/TUN Creates a system tunnel and manages routes, DNS, and Kill Switch rules.
SOCKS5 Supports TCP and UDP with remote DNS by default.
HTTP Proxy Supports CONNECT and ordinary HTTP forwarding.
Windows system proxy Depends on HTTP output and points Windows at its local listener.

Windows defaults to VPN/TUN + SOCKS5 + HTTP with the system proxy disabled. Android defaults to VPN + SOCKS5 + HTTP. Turning every output off is allowed and keeps only the transport available.

Security and privacy

  • Endpoint pinning is mandatory; the GUI has no insecure TLS mode.
  • Secrets, private keys, tokens, device identifiers, licenses, and endpoint pins are stored in Windows Credential Manager or Android Keystore.
  • Secret export is explicit, confirmed, and written only to a user-selected destination.
  • The Windows engine is unprivileged; a narrow Agent owns only TUN, routes, DNS, firewall, and system-proxy state.
  • Android uses VpnService and an isolated :vpn process.
  • Logs default to INFO and are capped at 7 days or 20 MiB.

Read SECURITY.md before reporting a vulnerability. Never put credentials or unredacted diagnostics in a public Issue.

Build and contribute

The project pins Rust 1.97.1, Flutter commit 84fc5cbb223bc12f83d65b647ff8a56caf779ffd, Android NDK 29.0.14206865, and its packaging tools. Start with CONTRIBUTING.md for setup, check commands, safety boundaries, and Pull Request requirements.

Architecture and status are tracked in Implementation roadmap. The protected signing and supply-chain checks are documented in Release process.

Upstream and license

Usque GUI is forked from Diniboy1123/usque. Upstream copyright and attribution are retained.

Source code is released under the MIT License. Third-party components retain their own licenses.

About

User-friendly cross-platform GUI for Cloudflare WARP client's MASQUE protocol.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

7 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages