goauth-boilerplate

README

Golang JWT Auth Boilerplate

Golang boilerplate project to have a quick setup of server with JWT Authentication

Key Features • How To Use • Api • License

Key Features

• DB instance prepared - easy to create needed structures with goose library.
• Logs of information from the request/response.
• PII - simple example to parse body in logger middleware and hide personal ident. information (password).
• Fiber framework - fast golang web library.
• SignUp - prepared endpoint to register the user.
• SignIn - authenticate user and get access & refresh tokens.
• OAuth2.0 - authenticate user and get access & refresh tokens by 3rd parties (as an example with Google)
• Refresh - refresh tokens.
• Easy-to-test - project structured in a way to make it simple and easy to mock everything and test.
• Docker-Compose for DB

How it works?

JWT auth with login and password

+--------+                                           +---------------+
|        |--(A)------- Authorization Grant --------->|               |
|        |                                           |               |
|        |<-(B)----------- Access Token -------------|               |
|        |               & Refresh Token             |               |
|        |                                           |               |
|        |                                           |               |
|        |--(C)----------- Access Token ------------>|               |
|        |                                           |               |
|        |<-(D)--------- Protected Resource ---------| Authorization |
| Client |                                           |     Server    |
|        |--(E)----------- Access Token ------------>|               |
|        |                                           |               |
|        |<-(F)-------- Invalid Token Error ---------|               |
|        |                                           |               |
|        |                                           |               |
|        |--(G)----------- Refresh Token ----------->|               |
|        |                                           |               |
|        |<-(H)----------- Access Token -------------|               |
+--------+           & Optional Refresh Token        +---------------+

Login with OAuth 2.0 (Google example)

+-------+                                +--------+                               +------+
|       |--(1)---- Log in with Google -->|        |                               |      |
|       |                                |        |                               |      |
|  User |<-(2)- Redirect to Google Auth--|  Go    |                               |Google|
|       |                                |  App   |                               |OAuth2|
|       |--(3)----- Auth Code ---------->|        |                               |Server|
|       |                                |        |--(4)-- Exchange Auth Code --->|      |
|       |                                |        |<-(5)---- Access Token --------|      |
|       |                                |        |                               |      |
|       |                                |        |--(6)--- Request User Info --->|      |
|       |                                |        |<-(7)-- User Info Response ----|      |
|       |<-(8)-- Generated JWT Tokens ---|        |                               |      |
+-------+                                +--------+                               +------+

How To Use

Environment variables

# App configs
APPLICATION_NAME=my_app
SERVER_PORT=4000

# DB configs
DB_HOST=localhost
DB_PORT=5432
DB_USER=user
DB_PASSWORD=password
DB_NAME=postgres
DB_SCHEMA=goauth

# JWT configs
JWT_SECRET_KEY=test
JWT_ACCESS_TOKEN_HOURS=1
JWT_REFRESH_TOKEN_HOURS=24

# Google auth configs
GOOGLE_CLIENT_ID=client_id
GOOGLE_CLIENT_SECRET=client_secret
GOOGLE_CALLBACK_URL=http://localhost:4000/api/v1/oauth2/google/callback

# Clone this repository
$ git clone https://github.com/antlko/goauth-boilerplate.git

# Go into the repository
$ cd goauth-boilerplate

# Copy default envs and change .env as you want
$ cp .env.dist .env

# Deploy postgres container on demand
$ docker-compose up -d

# Run the app
$ go run main.go

Api

Endpoints for auth. by Login and Password

POST /api/v1/auth/signup
{
"login":"test",
"email":"test@gmail.com",
"password":"test"
}

POST /api/v1/auth/signin
{
"login":"test",
"password":"test"
}

Endpoint to refresh access token

POST /api/v1/auth/token/refresh
{
"refresh_token":"your_refresh_token"
}

Endpoints to login with google

POST /api/v1/oauth2/google/signin
GET /api/v1/oauth2/google/callback

Example of usage the protected endpoint

GET /api/v1/protected/user
Authorization: Bearer your_access_token

License

MIT