README
¶
Go-Auth
This project is only for learning purposes. A simple microservice for storing user credentials and authenticating them.
The REST api is documented and generated with OpenApi spec. The tool for generation is deepmap/oapi-codegen.
Setup
Prerequisites
-
Golang 1.18 or higher
-
running MySQL Database instance
- use files in /SQL to setup the db
- dsn for the database is setup in app.go at 24th line
Actions to run
git clone https://github.com/Nesquiko/go-auth.gitcd go-authgo run .
Interact
To interact with running Go-Auth service, either go through the OpenApi spec and use a client of your choice. Or use Postman, you can import the collection and environment in /postman dir.
Interaction flow
- signup new user
- log in with credentials, and get unauthenticated token
- setup 2FA
- verify 2FA TOTP password, and get fully authenticated token
- use test endpoint test endpoint if you are correctly authenticated
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
app
Package app is provides functions for starting the Go-Auth application.
|
Package app is provides functions for starting the Go-Auth application. |
|
db
Package db provides functions for interacting with a database.
|
Package db provides functions for interacting with a database. |
|
security
Package security provides functions for encryption of passwords and JWT token handling.
|
Package security provides functions for encryption of passwords and JWT token handling. |
|
server
Package server provides functions for handling different API endpoints of the Go-Auth application.
|
Package server provides functions for handling different API endpoints of the Go-Auth application. |
Click to show internal directories.
Click to hide internal directories.