Goodnessuc / AuthSystem

Some sort of auth (authentication and authorization) systems rollouts since I'd use them often

AuthSystem 🥷🏽🔐 (WIP)

A Complete Backend Service with User Authentication and Authorization

Table of Contents

• Description
• Features
• Getting Started
  • Prerequisites
  • Installation and Setup
• Docker Deployment
  • Prerequisites
  • Running with Docker Compose
• Testing
• Technologies and Tools
• Contributions
• License

Description

This repository contains a backend service developed in GoLang that handles user authentication and authorization.

It includes functionalities like user registration, login, password reset, social authentication (e.g., GitHub, Google), and JWT authentication.

The service is designed with security in mind, implementing measures to prevent common attacks such as SQL injection, CSRF attacks, and brute force attacks.

Features

• User Management
• User Authentication
  • User Registration: Allows new users to create an account.
  • User Login: Allows existing users to log in.
  • User Logout: Allows users to log out.
  • RBAC: Implements Role-Based Access Control (RBAC) for users.
• Session Management
  • Create Session: Creates a session when a user logs in.
  • Destroy Session: Destroys the session when a user logs out.
• Password Management
  • Password Reset: Allows users to reset their password.
  • Password Hashing: Hashes passwords before storing them in the database.
• Social Authentication: Allows users to log in using their social media accounts.
  • GitHub Authentication: Allows users to log in through GitHub
  • Google Authentication: Allows users to log in through Google
• JWT Authentication: Uses JSON Web Tokens (JWT) for secure information transmission.
• Security Measures
  • SQL Injection Prevention: Prevents SQL injection attacks.
  • CSRF Prevention: Prevents Cross-Site Request Forgery (CSRF) attacks.
  • Slowloris Prevention: Prevents Slowloris Attacks

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Go (version 1.15 or later)
• Make

Installation and Setup

1. Clone the repository

git clone https://github.com/goodnessuc/authsystem.git

2. Change directory to the project folder

cd authsystem

3. Install dependencies

make install

4. Build the application

make build

5. Run the application

./cmd/server/main.go

Docker Deployment

Prerequisites

• Docker
• Docker Compose

Running with Docker Compose

1. Ensure that Docker and Docker Compose are installed on your machine.
2. Navigate to the project directory:

cd authsystem

3. Build and run the application and its services using Docker Compose:

docker-compose up --build

To stop the services, simply run:

docker-compose down

Testing

To run the tests, run the following command:

make test

Technologies and Tools

• Go - The programming language used
• GORM - Database ORM tool
• The Gin Gonic Framework - Go based HTTP routing tool
• JWT - JSON Web Tokens for authentication
• Docker - Containerization tool
• Docker Compose - Tool for defining and running multi-container Docker applications
• PostgreSQL - Database
• OAuth 2.0 - Open standard for access delegation
• Make - Build automation tool

Contributions

Contributions, issues, and feature requests are welcome!

License

MIT