https://github.com/nmrshll/auth-rs-warp
Authentication / Authorization server example with Rust, Warp, Postgres
https://github.com/nmrshll/auth-rs-warp
api async async-await auth await email futures hyper login logout password postgres rust tokio warp
Last synced: 24 days ago
JSON representation
Authentication / Authorization server example with Rust, Warp, Postgres
- Host: GitHub
- URL: https://github.com/nmrshll/auth-rs-warp
- Owner: nmrshll
- Created: 2020-04-24T10:50:22.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-09T10:42:01.000Z (over 4 years ago)
- Last Synced: 2025-04-24T03:44:23.733Z (24 days ago)
- Topics: api, async, async-await, auth, await, email, futures, hyper, login, logout, password, postgres, rust, tokio, warp
- Language: Rust
- Size: 74.2 KB
- Stars: 11
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/nmrshll/auth-rs-warp/actions?query=workflow%3ADocker-build-push)
# auth-rs-warp
Authentication / Authorization server example with Rust, Warp, Postgres
## Features
- **Register users with email/password**
- **Get an exsisting user / Check if an email is already taken**
- **Login / Logout with email/password**
- **Access / modify protected resources**: one example included: creating posts that belong to a user
and also:
- **Great performance and minimal footprint** thanks to async Rust
- **Users database** using Postgres
### Limitations
- As of now, this example is usable for writing API routes in Rust (i.e. starting from this code and extending). Usage with an other stack might be possible but wasn't yet taken into consideration for this project.
## Usage
### Prerequisites
- **Docker** daemon running
- **Rust nightly 1.41+** (auto-installs if missing)
### Running the auth server
Three options: On your local machine with Docker, from the Docker image, or using kubernetes
#### On your local machine
Run `make`
This will start docker containers for: the API, the postgres database,
#### From the docker image
Run
```shell
docker run -p 0.0.0.0:8080:8080 -e DATABASE_URL=postgres://user:pass@postgres/db docker.pkg.github.com/nmrshll/auth-rs-warp/api:latest
```
In this configuration you need to provide your own postgres server, and run the migrations onto it manually.
#### With Kubernetes
A Kubernetes deployment file is [included](./deploy/k8s.dply.cue). It needs to be applied with [CUE](https://cuelang.org/). Examples commands to do that are included in the [makefile](./makefile)
For instance for a complete deployment on the current kubernetes context:
```shell
make k.all
```
### Configuration options
Configuration is applied, from highest to lowest priority, through:
- Environment variables
- Config file located at `./.config/api_config(.ext)?` (relative to the binary). The config format (and extension `(.ext)?`) can be `json`,`yaml`,`toml`,`hcl`, `ini` or none (autodetected).
- Hardcoded defaults
These options are:
| Option | ENV_VAR name | Config name | Default |
| ----------------- | :------------------ | :------------------ | -------------------- |
| Postgres DSN | `DATABASE_URL` | `database_url` | |
| Postgres user | `POSTGRES_USER` | `postgres_user` | |
| Postgres password | `POSTGRES_PASSWORD` | `postgres_password` | |
| Postgres database | `POSTGRES_DB` | `postgres_db` | |
| Postgres host | `POSTGRES_HOST` | `postgres_db` | |
| HTTP port | `HTTP_PORT` | `http_port` | `8080` |
| Log level | `RUST_LOG` | `postgres_db` | `auth-rs-warp=debug` |
| Enable backtraces | `RUST_BACKTRACE` | `rust_backtrace` | `1` |
Note: At least one of `database_url` / `postgres_host/user/pw/db` must be defined. If both defined they must be compatible
## Testing
### Automated
Local testing is available by running
```shell
make test
```
### Manual
Test requests are included in the makefile (using `curl`)
- **Register a user** using `make users/register`
- **Check if an email is already taken** using `make users/check`
- **Login** using `make users/login`
- **Access a dummy protected route** using `make protected`
## TODO and contributing
Don't hesitate to file a bug, request a feature, or simply comment using issues.
If you want to help here's a few useful tasks I have in mind for this project:
- [ ] Email verification and email invitations
- [ ] CI
- [ ] example deployment instructions
- [ ] Write a tutorial to re-create this repo from scratch