Skip to content

Latest commit

 

History

History
111 lines (70 loc) · 3.83 KB

README.md

File metadata and controls

111 lines (70 loc) · 3.83 KB
Raw

Docker-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

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. It needs to be applied with CUE. Examples commands to do that are included in the makefile

For instance for a complete deployment on the current kubernetes context:

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

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