warpgate/README.md at a903fdb8116eb7f88b1a6913d9a89911529c66fd

mirror of https://github.com/warp-tech/warpgate.git synced 2024-11-15 04:21:59 +08:00

Fixes #938

2024-10-09 00:08:33 +02:00

6.6 KiB

Raw Blame History

Warpgate is a smart SSH, HTTPS, MySQL and PostgreSQL bastion host for Linux that doesn't need special client apps.

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 your connections straight to the target instead.
Native 2FA and SSO support (TOTP & OpenID Connect)
Single binary with no dependencies.
Written in 100% safe Rust.

Getting started & downloads

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

Project Status

The project is currently in alpha stage and is gathering community feedback.

How it works

Warpgate is a service that you deploy on the bastion/DMZ host, which will accept SSH, HTTPS, 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 Yarn
Clone the repo
Just is used to run tasks - install it: cargo install just
Install the admin UI deps: just yarn
Build the frontend: just yarn 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.