Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rahulc0dy/micro-auth

This is an authentication microservice built using Hono.
https://github.com/rahulc0dy/micro-auth

authentication-backend deno honojs nodejs

Last synced: 13 days ago
JSON representation

This is an authentication microservice built using Hono.

Host: GitHub
URL: https://github.com/rahulc0dy/micro-auth
Owner: rahulc0dy
Created: 2025-01-20T07:44:07.000Z (14 days ago)
Default Branch: master
Last Pushed: 2025-01-20T10:30:11.000Z (14 days ago)
Last Synced: 2025-01-20T11:31:27.153Z (14 days ago)
Topics: authentication-backend, deno, honojs, nodejs
Language: TypeScript
Homepage:
Size: 11.7 KB
Stars: 0
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Authentication Microservice

A robust authentication microservice built with [Deno](https://deno.land/) and [Hono.js](https://hono.dev/). This microservice provides essential authentication features, including support for **JWT**, **OAuth**, **email/phone-password login**, and **two-factor authentication (2FA)**.

---

![Tests](https://img.shields.io/github/actions/workflow/status/rahulc0dy/micro-auth/run-tests.yml)

---

## 🚀 Features

- **🔒 JWT (JSON Web Tokens)**: Secure token-based authentication for stateless session management.
- **🌐 OAuth**: Simplified third-party authentication using providers like Google, Facebook, and GitHub.
- **📧 Email/Phone and Password Login**: Classic user authentication with support for email or phone as identifiers.
- **🛡️ Two-Factor Authentication (2FA)**: Enhanced security through OTP-based two-factor authentication.

---

## 📋 Table of Contents

- [Prerequisites](#-prerequisites)
- [Setup](#-setup)
- [Environment Variables](#-environment-variables)
- [API Endpoints](#-api-endpoints)
- [Usage](#-usage)
- [Technologies Used](#-technologies-used)
- [License](#-license)

---

## ✅ Prerequisites

- [Deno](https://deno.land/) (v1.30 or higher)
- [Git](https://git-scm.com/) (v2.0 or higher)

---

## ⚙️ Setup

1. **Clone the repository:**
```bash
git clone https://github.com/rahulc0dy/micro-auth.git
cd micro-auth
```

2. **Install dependencies:**
```bash
deno task deps
```

3. **Run the application:**
```bash
deno task start
```

---

## 🛠️ Environment Variables

Create a `.env` file in the root of your project with variables specified in the `.env.example` file.

---

## 🌐 API Endpoints

### Authentication

#### **POST** `/auth/register`
- **Description**: Register a new user with email/phone and password.
- **Request Body:**
```json
{
"email": "[email protected]",
"password": "securepassword"
}
```

#### **POST** `/auth/login`
- **Description**: Login with email/phone and password.
- **Request Body:**
```json
{
"email": "[email protected]",
"password": "securepassword"
}
```

#### **POST** `/auth/refresh`
- **Description**: Refresh the JWT token.

#### **POST** `/auth/logout`
- **Description**: Logout and invalidate the current session.

### OAuth

#### **GET** `/oauth/:provider`
- **Description**: Redirect to the OAuth provider's login page (e.g., Google).

#### **GET** `/oauth/callback`
- **Description**: Handle the OAuth callback and issue a JWT token.

### 2FA

#### **POST** `/auth/2fa/setup`
- **Description**: Generate a 2FA QR code for the user.

#### **POST** `/auth/2fa/verify`
- **Description**: Verify the OTP code for 2FA.
- **Request Body:**
```json
{
"otp": "123456"
}
```

---

## 📌 Usage

### Register a New User
```bash
curl -X POST http://localhost:8000/auth/register \
-H "Content-Type: application/json" \
-d '{ "email": "[email protected]", "password": "securepassword" }'
```

### Login
```bash
curl -X POST http://localhost:8000/auth/login \
-H "Content-Type: application/json" \
-d '{ "email": "[email protected]", "password": "securepassword" }'
```

### Set Up 2FA
```bash
curl -X POST http://localhost:8000/auth/2fa/setup \
-H "Authorization: Bearer "
```

### Verify 2FA Code
```bash
curl -X POST http://localhost:8000/auth/2fa/verify \
-H "Authorization: Bearer " \
-d '{ "otp": "123456" }'
```

---

## 🛠️ Technologies Used

- **Deno**: A modern runtime for JavaScript and TypeScript.
- **Hono.js**: Lightweight and fast web framework.
- **JWT**: Secure token management.
- **OAuth**: Simplified third-party authentication.
- **Two-Factor Authentication**: Enhanced security for user accounts.

---

## 📜 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.