https://github.com/haydenhargreaves/authenticationserver
User authentication server built with the Gin framework, PostgreSQL database, and UUID-keys for user authentication.
https://github.com/haydenhargreaves/authenticationserver
authentication gin-gonic golang postgresql-database user-authentication user-management
Last synced: 8 months ago
JSON representation
User authentication server built with the Gin framework, PostgreSQL database, and UUID-keys for user authentication.
- Host: GitHub
- URL: https://github.com/haydenhargreaves/authenticationserver
- Owner: haydenhargreaves
- License: mit
- Created: 2023-09-27T15:13:59.000Z (over 2 years ago)
- Default Branch: v2.0.0
- Last Pushed: 2024-02-24T18:47:15.000Z (about 2 years ago)
- Last Synced: 2025-04-01T20:28:13.575Z (about 1 year ago)
- Topics: authentication, gin-gonic, golang, postgresql-database, user-authentication, user-management
- Language: Go
- Homepage:
- Size: 261 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://go.dev/)
[](https://www.postgresql.org/)
[](https://gin-gonic.com/)
# Authentication Server Version 2.0.0
A simple user authentication server built with the Gin framework, PostgreSQL database,
and UUID-keys for user authentication. This server app is designed to authenticate
users using simple HTTP requests. It provides a secure and efficient way to verify
user identities and grant access to protected resources.
## 🗝 Table of Contents
- [Features](#🗝-features)
- [Getting Started](#🗝-getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Download Binary](#download-binary)
- [Database](#database)
- [Usage](#🗝-usage)
- [Overview](#overview)
- [Applications](#applications)
- [Users](#users)
- [Contributing](#🗝-contributing)
- [License](#🗝-license)
## 🗝 Features
- **User Authentication**: Authenticate users using a unique UUID-key.
- **Application Management**: Create, read, update, and delete applications.
- **User Management**: Create, read, update, and delete user accounts.
- **Password Security**: Secure user passwords using a simple yet effective hashing algorithm.
- **Logging**: Log user and application activity to the stdout.
## 🗝 Getting Started
Follow these steps to get the project up and running on your local machine.
### Prerequisites
- **Go** (+1.16)
- **PostgreSQL** database
- **Git** (optional)
### Installation
1. Clone the repository to your local machine using the following command:
```bash
git clone https://github.com/Azpect3120/AuthenticationServer.git && cd AuthenticationServer
```
2. Install the project dependencies using the following command:
```bash
go mod tidy
```
3. Setup your PostgreSQL database and configure the database connection in the `.env` file:
```.env
# This url can found in the dashboard of most PSQL hosts or can be constructed using the required pieces
# REQUIRED
DB_URL=postgresql://username:password@localhost:5432/Database
# The port the server will listen on. Default is 3000
# OPTIONAL
AUTH_SERVER_PORT=3000
```
4. Build and run the server:
```bash
go build -o ./bin/server ./cmd/main.go && ./bin/server
# or
go run ./cmd/main.go
```
### Download Binary
If you do not have Go installed on your machine, you can download the binary from the releases page.
Select the appropriate binary for your operating system and architecture, then run the binary in your terminal.
### Database
Once the server is up and running you will need to connect to a PostgreSQL database.
If you would like the code to work out of the box, you may copy the database schema provided below.
```sql
-- UUID extension for use in creating and storing
-- UUID value types
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
-- Table for storing applications. The applications
-- do not have any duplicate restraints beyond their
-- id (uuid).
CREATE TABLE IF NOT EXISTS applications (
id uuid PRIMARY KEY DEFAULT uuid_generate_v4(),
name TEXT,
columns TEXT[],
createdat TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
lastupdatedat TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
-- Table for storing users. The users do not have any
-- duplicate restraints beyond their id (uuid).
CREATE TABLE IF NOT EXISTS users (
id uuid PRIMARY KEY DEFAULT uuid_generate_v4(),
applicationid UUID REFERENCES applications(id),
username TEXT,
firstname TEXT,
lastname TEXT,
fullname TEXT,
email TEXT,
password TEXT,
data TEXT, -- Stringified JSON
createdat TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
lastupdatedat TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
```
## 🗝 Usage
### Overview
The server is designed to be used as a simple RESTful API. It provides endpoints for creating,
reading, updating, and deleting applications and users. The server also provides endpoints for
authenticating users and applications. The server logs user and application activity to the stdout.
Applications are used to group users together and provide a way to manage user access to resources.
The owner of this server is responsible for managing applications and the data stored within them.
The data stored in the applications is dynamic and can be used to store the most common data as well
as a wild card `data` field for custom data. Any data stored in the `data` field is expected to be
a string, which can be handled on the front end as needed, a stringified JSON object for example.
The server will not validate the data stored in the `data` field, it is up to the owner of the server
to validate and parse the data as needed.
**Valid data columns are:**
- `username` : The username of the user
- `first` : The first name of the user
- `last` : The last name of the user
- `full` : The full name of the user
- `email` : The email of the user
- `password` : The password of the user
- `data` : Wild card data field for custom data
All applications have a handful of default columns that cannot be removed and must be left as is.
These columns are: `id`, `applicationid`, `createdat`, and `lastupdatedat`. The `id` column is the
unique identifier for the user. The `applicationid` column is the unique identifier for the application
the user is stored in. The `createdat` column is the timestamp of when the user was created. Finally,
the `lastupdatedat` column is the timestamp of when the user was last updated.
### Applications
- `GET /v2/applications` : Get all applications. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#get-all-applications)
- `GET /v2/applications/:id` : Get an application by id. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#get-an-application)
- `POST /v2/applications` : Create a new application. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#create-an-application)
- `PATCH /v2/applications/:id` : Update part of an application by id. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#update-an-application-(part))
- `PUT /v2/applications/:id` : Update an entire application by id. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#update-an-application-(full))
- `DELETE /v2/applications/:id` : Delete an application by id. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#delete-an-application)
### Users
- `GET /v2/applications/:id/users` : Get all users in an application. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#get-all-users)
- `GET /v2/applications/:id/users/:id` : Get a user by id in an application. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#get-a-user)
- `POST /v2/applications/:id/users` : Create a new user in an application. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#create-a-user)
- `POST v2/applications/:id/validate` : Validate a users credentials. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#validate-a-user)
- `PATCH /v2/applications/:id/users/:id` : Update part of a user by id in an application. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#update-a-user)
- `DELETE /v2/applications/:id/users/:id` : Delete a user by id in an application. [e.g](https://github.com/Azpect3120/AuthenticationServer/blob/v2.0.0/docs/exmaples.md#delete-a-user)
## 🗝 Contributing
This project is open source, therefore contributions are encouraged! If you'd like to contribute to this project, please follow these steps:
1. Fork the project.
1. Create a new branch for your feature or bug fix.
1. Make your changes.
1. Test your changes thoroughly.
1. Create a pull request.
## 🗝 License
This project is licensed under azpect3120 the **MIT License**
View [LICENSE](https://github.com/azpect3120/AuthenticationServer/blob/v2.0.0/LICENSE)