Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/giwrgosgln/node-jwt-authentication

This API provides endpoints for user registration, login, token refreshing, and logout, including JWT-based authentication with access and refresh tokens.
https://github.com/giwrgosgln/node-jwt-authentication

bcrypt dotenv express-js jwt-authentication node-js postgresql typescipt

Last synced: 3 days ago
JSON representation

This API provides endpoints for user registration, login, token refreshing, and logout, including JWT-based authentication with access and refresh tokens.

Host: GitHub
URL: https://github.com/giwrgosgln/node-jwt-authentication
Owner: GiwrgosGln
Created: 2024-12-24T12:10:05.000Z (11 days ago)
Default Branch: main
Last Pushed: 2024-12-25T15:55:45.000Z (9 days ago)
Last Synced: 2024-12-25T16:23:50.804Z (9 days ago)
Topics: bcrypt, dotenv, express-js, jwt-authentication, node-js, postgresql, typescipt
Language: TypeScript
Homepage:
Size: 129 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Authentication API

This API provides endpoints for user registration, login, token refreshing, and logout, including JWT-based authentication with access and refresh tokens.

## Tech Stack

- **Node.js**: JavaScript runtime environment
- **Express**: Web framework for Node.js
- **PostgreSQL**: Relational database for storing user and token data
- **JWT (jsonwebtoken)**: For generating and verifying JSON Web Tokens
- **argon2**: For hashing passwords
- **TypeScript**: For static typing in JavaScript
- **dotenv**: For managing environment variables

## Base URL

- The base URL for all endpoints is assumed to be `http://yourapi.com/api`.

## Endpoints

### POST /register

#### Description

Registers a new user with the provided email and password.

#### Request

- **URL**: `/register`
- **Method**: `POST`
- **Headers**:
- `Content-Type: application/json`
- **Body Parameters**:
- `email` (string, required): The email address of the user.
- `password` (string, required): The password for the user account.

#### Response

- **Success (201)**:
- **Body**:
```json
{
"message": "User created successfully"
}
```
- **Error (400)**:
- **Body**:
```json
{
"message": "User already exists"
}
```
- **Error (500)**:
- **Body**:
```json
{
"message": "Error creating user"
}
```

### POST /login

#### Description

Logs in a user with the provided email and password, generating access and refresh tokens.

#### Request

- **URL**: `/login`
- **Method**: `POST`
- **Headers**:
- `Content-Type: application/json`
- **Body Parameters**:
- `email` (string, required): The email address of the user.
- `password` (string, required): The password for the user account.

#### Response

- **Success (200)**:
- **Cookies**:
- `refreshToken`: A secure, HTTP-only cookie containing the refresh token.
- **Body**:
```json
{
"accessToken": "yourAccessToken"
}
```
- **Error (400)**:
- **Body**:
```json
{
"message": "User not found"
}
```
- **Body**:
```json
{
"message": "Invalid password"
}
```
- **Error (500)**:
- **Body**:
```json
{
"message": "Error logging in"
}
```

### POST /refresh

#### Description

Refreshes the access token using the refresh token.

#### Request

- **URL**: `/refresh`
- **Method**: `POST`
- **Headers**:
- `Content-Type: application/json`
- **Cookies**:
- `refreshToken`: The refresh token stored as an HTTP-only cookie.

#### Response

- **Success (200)**:
- **Body**:
```json
{
"accessToken": "newAccessToken"
}
```
- **Error (401)**:
- **Body**:
```json
{
"message": "Invalid or expired refresh token"
}
```

### POST /logout

#### Description

Logs out the user by invalidating the refresh token.

#### Request

- **URL**: `/logout`
- **Method**: `POST`
- **Headers**:
- `Content-Type: application/json`
- **Cookies**:
- `refreshToken`: The refresh token stored as an HTTP-only cookie.

#### Response

- **Success (200)**:
- **Body**:
```json
{
"message": "Logged out successfully"
}
```

## Notes

- The `register` endpoint creates a new user and stores their hashed password in the database.
- The `login` endpoint generates JWT access and refresh tokens upon successful authentication. The refresh token is stored in the database and sent as a cookie to the client.
- The `refresh` endpoint issues a new access token if the provided refresh token is valid.
- The `logout` endpoint invalidates the refresh token, effectively logging out the user.
- Ensure that the environment variables `JWT_ACCESS_SECRET` and `JWT_REFRESH_SECRET` are set for token generation.
- The `refreshToken` cookie is configured to be secure and HTTP-only, which helps protect it from being accessed by JavaScript in the browser.

This documentation assumes the existence of a service layer (`userService` and `authService`) that handles database interactions. Adjust the base URL and endpoint paths as necessary for your specific application setup.