README - Warpgate — ContextQMD

Warpgate is a smart & fully transparent SSH, HTTPS, Kubernetes, MySQL, PostgreSQL bastion host that doesn't require a client app or an SSH wrapper.

Set it up in your DMZ, add user accounts and easily assign them to specific hosts and URLs within the network.
Warpgate will record every session for you to view (live) and replay later through a built-in admin web UI.
Not a jump host - forwards connection straight to the target in a way that's fully transparent to the client.
Native 2FA and SSO support (TOTP & OpenID Connect)
Single binary with no dependencies.
Written in 100% safe Rust.

Supported by: <a href="https://floss.fund"></a>

Getting started & downloads

See the Getting started docs page (or Getting started on Docker).
Release / beta binaries
Nightly builds

How is Warpgate different from a jump host / VPN / Teleport?

Warpgate	SSH jump host	VPN	Teleport
✅ Precise 1:1 assignment between users and services	(Usually) full access to the network behind the jump host	(Usually) full access to the network	✅ Precise 1:1 assignment between users and services
✅ No custom client needed	Jump host config needed	✅ No custom client needed	Custom client required
✅ 2FA out of the box	🟡 2FA possible with additional PAM plugins	🟡 Depends on the provider	✅ 2FA out of the box
✅ SSO out of the box	🟡 SSO possible with additional PAM plugins	🟡 Depends on the provider	Paid
✅ Command-level audit	🟡 Connection-level audit on the jump host, no secure audit on the target if root access is given	No secure audit on the target if root access is given	✅ Command-level audit
✅ Full session recording	No secure recording possible on the target if root access is given	No secure recording possible on the target if root access is given	✅ Full session recording
✅ Non-interactive connections	🟡 Non-interactive connections are possible if the clients supports jump hosts natively	✅ Non-interactive connections	Non-interactive connections require using an SSH client wrapper or running a tunnel
✅ Self-hosted, you own the data	✅ Self-hosted, you own the data	🟡 Depends on the provider	SaaS

Reporting security issues

Please use GitHub's vulnerability reporting system.

Project Status

The project is ready for production.

How it works

Warpgate is a service that you deploy on the bastion/DMZ host, which will accept SSH, HTTPS, Kubernetes, MySQL and PostgreSQL connections and provide an (optional) web admin UI.

Run warpgate setup to interactively generate a config file, including port bindings. See Getting started for details.

It receives connections with specifically formatted credentials, authenticates the user locally, connects to the target itself, and then connects both parties together while (optionally) recording the session.

When connecting through HTTPS, Warpgate presents a selection of available targets, and will then proxy all traffic in a session to the selected target. You can switch between targets at any time.

You manage the target and user lists and assign them to each other through the admin UI, and the session history is stored in an SQLite database (default: in /var/lib/warpgate).

You can also use the admin web interface to view the live session list, review session recordings, logs and more.

Contributing / building from source

You'll need Rust, NodeJS and NPM
Clone the repo
Just is used to run tasks - install it: cargo install just
Install the admin UI deps: just npm install
Build the frontend: just npm run build
Build Warpgate: cargo build (optionally --release)

The binary is in target/{debug|release}.

Tech stack

Rust 🦀
- HTTP: poem-web
- Database: SQLite via sea-orm + sqlx
- SSH: russh
Typescript
- Svelte
- Bootstrap

Backend API

Warpgate admin and user facing APIs use autogenerated OpenAPI schemas and SDKs. To update the SDKs after changing the query/response structures, run just openapi-all.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Eugeny"> Eugeny</a> <a href="https://github.com/warp-tech/warpgate/commits?author=Eugeny" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://the-empire.systems/"> Spencer Heywood</a> <a href="https://github.com/warp-tech/warpgate/commits?author=heywoodlh" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/apiening"> Andreas Piening</a> <a href="https://github.com/warp-tech/warpgate/commits?author=apiening" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Gurkengewuerz"> Niklas</a> <a href="https://github.com/warp-tech/warpgate/commits?author=Gurkengewuerz" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/notnooblord"> Nooblord</a> <a href="https://github.com/warp-tech/warpgate/commits?author=notnooblord" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://shea.nz/"> Shea Smith</a> <a href="https://github.com/warp-tech/warpgate/commits?author=SheaSmith" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/samtoxie"> samtoxie</a> <a href="https://github.com/warp-tech/warpgate/commits?author=samtoxie" title="Code">💻</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://p.foundation/"> P Foundation</a> <a href="#financial-pfoundation" title="Financial">💵</a></td> <td align="center" valign="top" width="14.28%"><a href="http://sixteenink.com"> Skyler Lewis</a> <a href="https://github.com/warp-tech/warpgate/commits?author=alairock" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="http://www.mohammednoureldin.com"> Mohammed Noureldin</a> <a href="https://github.com/warp-tech/warpgate/commits?author=MohammedNoureldin" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/mrmm"> Mourad Maatoug</a> <a href="https://github.com/warp-tech/warpgate/commits?author=mrmm" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="http://justinforlenza.dev"> Justin</a> <a href="https://github.com/warp-tech/warpgate/commits?author=justinforlenza" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/liebermantodd"> liebermantodd</a> <a href="https://github.com/warp-tech/warpgate/commits?author=liebermantodd" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://blog.trieoflogs.com"> Hariharan</a> <a href="https://github.com/warp-tech/warpgate/commits?author=cvhariharan" title="Code">💻</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/solidassassin"> Rokas Krivaitis</a> <a href="https://github.com/warp-tech/warpgate/commits?author=solidassassin" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/SachinMaharana"> SachinMaharana</a> <a href="https://github.com/warp-tech/warpgate/commits?author=SachinMaharana" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/pandeysambhi"> Sambhavi Pandey</a> <a href="https://github.com/warp-tech/warpgate/commits?author=pandeysambhi" title="Code">💻</a></td> </tr> </tbody> </table>

This project follows the all-contributors specification. Contributions of any kind welcome!