Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kjpou1/token-auth-server
Token-based Authorization server
https://github.com/kjpou1/token-auth-server
authentication deno server typescript
Last synced: 11 days ago
JSON representation
Token-based Authorization server
- Host: GitHub
- URL: https://github.com/kjpou1/token-auth-server
- Owner: kjpou1
- License: mit
- Created: 2021-12-26T06:29:51.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-28T09:01:02.000Z (almost 3 years ago)
- Last Synced: 2023-03-22T14:48:22.577Z (over 1 year ago)
- Topics: authentication, deno, server, typescript
- Language: TypeScript
- Homepage:
- Size: 593 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
### main branch
[](https://github.com/kjpou1/token-auth-server/actions/workflows/ci.yml)
---
# Token Authentication Server
Implementation of a Token-Based identity and authorization server.
Key implementation details
- Uses tokens to authenticate users.
- Refresh Token Rotation implementation guaranting that every time an application exchanges a refresh token to get a new access token, a new refresh token is also returned.
- Automatic Refresh Token reuse detection deactivating the user and marking the user record as compromised.
- All tokens are given a expiration
- Only the minimum needed information is kept in the token.
## Pre Requirements
[Docker Compose](https://docs.docker.com/compose/install/) is used to execute the project and is described below. [Docker Desktop](https://docs.docker.com/desktop/) includes [Compose](https://docs.docker.com/compose/install/) along with other Docker apps, so most users do not need to install Compose separately.
- ### Docker Desktop
- [Install Docker Desktop on Mac](https://docs.docker.com/desktop/mac/install/)
- [Install Docker Desktop on Windows](https://docs.docker.com/desktop/windows/install/)
- ### Clone this repository:
```
$ git clone https://github.com/kjpou1/token-auth-server.git
$ cd token-auth-server
```
- ### Minimal Configuration:
Setup the default user seed information for api:
- First create the `.env` file
- Mac
```
$ cd api
$ touch .env
```
- Windows
```
cd api
copy .env+
```
- Open and add the following configuration entries:
``` bash
#===========================
## Database seed information
#===========================
# The default name of the user
SEED_NAME=Admin
# The default email of the user
[email protected]
# The default password of the seeded user
SEED_PASSWORD=
```
:exclamation: Note: Make sure to provide a SEED_PASSWORD value or an error will be issued during startup
## Quickstart - Running locally
Start up the [docker compose](https://docs.docker.com/compose/install/) file provided in the main directory.
- ### Run interactively
```
docker compose up --build
```
- ### Run in background task
```
docker compose up -d --build
```
This may take a while on first run while everything is being downloaded, built and installed.
By default the auth server can be reached at `http://localhost:3001/api/vi/`
## Authentication Forms
There are a couple of delivered forms that one can use.
They use a redirect after a successful action.
- Sign In with redirect - http://localhost:3001/auth-forms/signin
- Register with redirect - http://localhost:3001/auth-forms/register