Smart SSH, HTTPS and MySQL bastion that needs no client-side software
Go to file
kekkon 3c3b843d72
Validate a TOTP code before saving it (#1055)
In order to do this, I had to remove the very old and unmaintainted
`otplib` and replace it with the well-maintained
[otpauth](https://www.npmjs.com/package/otpauth).

I kept the parameters the same, but if there is something only slightly
off between the two libraries, this could cause a major headache. I am
unsure on how to test this though, or if we can provide some sort of
migration for this.

The reason for the upgrade is two-fold:

1. As I said, the original library was unmaintained
2. It's verification mechanism relied on a Buffer class that, as far as
I can tell, can't work without some `require` statements that are
missing from the library's source files.

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Eugene <inbox@null.page>
2024-09-11 09:30:02 +02:00
.cargo Validate a TOTP code before saving it (#1055) 2024-09-11 09:30:02 +02:00
.github Group dependabot version bump prs if they are minor or patch bumps (#1049) 2024-09-05 16:53:45 +02:00
docker bumped rust in docker image 2024-07-16 12:44:23 +02:00
docs added readme banner 2022-08-08 16:03:35 +02:00
oidc-test OIDC RP-initiated logout (SSO single logout) support (#992) 2024-09-10 23:16:42 +02:00
tests word 2024-03-23 21:54:21 +01:00
warpgate Bump version: 0.10.1 → 0.10.2 2024-08-14 22:59:52 +02:00
warpgate-admin Bump version: 0.10.1 → 0.10.2 2024-08-14 22:59:52 +02:00
warpgate-common Bump version: 0.10.1 → 0.10.2 2024-08-14 22:59:52 +02:00
warpgate-core fixed SSO authentication getting incorrectly rejected when user has both an "any provider" and a provider specific SSO credential 2024-09-10 23:12:44 +02:00
warpgate-database-protocols Bump version: 0.10.1 → 0.10.2 2024-08-14 22:59:52 +02:00
warpgate-db-entities Bump version: 0.10.1 → 0.10.2 2024-08-14 22:59:52 +02:00
warpgate-db-migrations Bump version: 0.10.1 → 0.10.2 2024-08-14 22:59:52 +02:00
warpgate-protocol-http OIDC RP-initiated logout (SSO single logout) support (#992) 2024-09-10 23:16:42 +02:00
warpgate-protocol-mysql Bump version: 0.10.1 → 0.10.2 2024-08-14 22:59:52 +02:00
warpgate-protocol-ssh Bump version: 0.10.1 → 0.10.2 2024-08-14 22:59:52 +02:00
warpgate-sso OIDC RP-initiated logout (SSO single logout) support (#992) 2024-09-10 23:16:42 +02:00
warpgate-web Validate a TOTP code before saving it (#1055) 2024-09-11 09:30:02 +02:00
.all-contributorsrc Add @SheaSmith as a contributor 2024-03-23 21:59:52 +01:00
.bumpversion.cfg Bump version: 0.10.1 → 0.10.2 2024-08-14 22:59:52 +02:00
.dockerignore Updated Dockerfile & setup 2022-07-05 21:32:05 +02:00
.env import 2022-04-10 22:58:58 +02:00
.flake8 added e2e tests 2022-08-14 12:36:49 +02:00
.gitignore Validate a TOTP code before saving it (#1055) 2024-09-11 09:30:02 +02:00
Cargo.lock Validate a TOTP code before saving it (#1055) 2024-09-11 09:30:02 +02:00
Cargo.toml bumped rust 2024-01-23 12:05:59 +01:00
clippy.toml added cranky and removed all .unwrap() usages 2022-07-23 21:31:35 +02:00
Cranky.toml deny clippy::indexing_slicing 2022-07-23 21:53:21 +02:00
Cross.toml build updates 2022-11-22 00:52:43 +01:00
deny.toml Revert "use workspace-level dependencies" 2022-07-06 09:24:06 +02:00
justfile Validate a TOTP code before saving it (#1055) 2024-09-11 09:30:02 +02:00
LICENSE Update LICENSE 2022-04-14 11:14:56 +02:00
README.md Update README.md 2024-09-04 17:03:37 +02:00
rust-toolchain bump rust some more 2024-07-16 10:40:27 +02:00
rustfmt.toml sorted imports 2022-07-15 20:27:33 +02:00
sonar-project.properties added e2e tests 2022-08-14 12:36:49 +02:00



GitHub All Releases     Discord


Warpgate is a smart SSH, HTTPS and MySQL 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

image
image image

Project Status

The project is currently in alpha stage and is gathering community feedback. See the official roadmap for the upcoming features.

In particular, we're working on:

  • Requesting admin approvals for sessions
  • Support for tunneling PostgreSQL connections,
  • and much more.

How it works

Warpgate is a service that you deploy on the bastion/DMZ host, which will accept SSH, HTTPS and MySQL 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.

Contributors

Thanks goes to these wonderful people (emoji key):

Eugeny
Eugeny

💻
Spencer Heywood
Spencer Heywood

💻
Andreas Piening
Andreas Piening

💻
Niklas
Niklas

💻
Nooblord
Nooblord

💻
Shea Smith
Shea Smith

💻

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