https://github.com/zhashkevych/auth
Simple HTTP Authentication REST API ready for use in your projects
https://github.com/zhashkevych/auth
Last synced: 5 months ago
JSON representation
Simple HTTP Authentication REST API ready for use in your projects
- Host: GitHub
- URL: https://github.com/zhashkevych/auth
- Owner: zhashkevych
- Created: 2020-03-26T13:07:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-31T15:31:50.000Z (over 5 years ago)
- Last Synced: 2025-04-18T15:16:37.801Z (6 months ago)
- Language: Go
- Size: 21.5 KB
- Stars: 26
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HTTP Authentication Server
## Blog Post
## Requirements
- docker & docker-compose
## Run Project
Set your signing key and hash salt in config file `pkg/config/config.yml` before running server
Use ```make run``` to build and run docker containers with application itself and mongodb instance
## Parse Token
You can import `github.com/zhashkevych/auth/pkg/parser` into your Go application and user `ParseToken()` to validate and parse token claims.
#### See example at `cmd/example/main.go -username=user -pass=pass`
You can run example using `go run main.go` but make sure you have golang installed on your machine
## Authentication Middleware Example Using Go/Gin
```golang
func Middleware(c *gin.Context) {
authHeader := c.GetHeader("Authorization")
if authHeader == "" {
c.AbortWithStatus(http.StatusUnauthorized)
return
}
headerParts := strings.Split(authHeader, " ")
if len(headerParts) != 2 {
c.AbortWithStatus(http.StatusUnauthorized)
return
}
if headerParts[0] != "Bearer" {
c.AbortWithStatus(http.StatusUnauthorized)
return
}
err := parser.ParseToken(headerParts[1], SIGNING_KEY)
if err != nil {
status := http.StatusBadRequest
if err == auth.ErrInvalidAccessToken {
status = http.StatusUnauthorized
}
c.AbortWithStatus(status)
return
}
}
```
## API:
### POST /auth/sign-up
Registers new user
#### Example Input:
```
{
"username": "user",
"password": "password"
}
```
#### Example Response:
```
{
"status": "ok",
"message": "user created successfully"
}
```
### POST /auth/sign-in
Generates JWT Token
#### Example Input:
```
{
"username": "user",
"password": "password"
}
```
#### Example Response:
```
{
"status": "ok",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7InVzZXJuYW1lIjoidXNlciIsInBhc3N3b3JkIjoiNWJhYTYxZTRjOWI5M2YzZjA2ODIyNTBiNmNmODMzMWI3ZWU2OGZkOCJ9fQ.UvCbjhn7o17cvvYRK3rr6ih0Ro_VvZZpKWns1sOH-CE"
}
```