https://github.com/authorizerdev/authorizer-go
https://github.com/authorizerdev/authorizer-go
hacktoberfest
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/authorizerdev/authorizer-go
- Owner: authorizerdev
- License: mit
- Created: 2022-09-01T00:03:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T10:57:40.000Z (almost 2 years ago)
- Last Synced: 2025-03-24T09:38:25.760Z (10 months ago)
- Topics: hacktoberfest
- Language: Go
- Homepage:
- Size: 64.5 KB
- Stars: 15
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# authorizer-go
Golang SDK for [authorizer.dev](https://authorizer.dev) server. This SDK will be handy to add API middleware where you can authorize your users. It will also empower you to perform various auth operations on authorizer server.
For detailed explanation of each functions check official [docs](https://pkg.go.dev/github.com/authorizerdev/authorizer-go)
## Getting Started
**Pre-requisite**: You will need an authorizer instance up and running. Checkout how you can host your instance in the [docs](https://docs.authorizer.dev/deployment)
Follow the steps here to install authorizer-go in your golang project and use the methods of SDK to protect/authorize your APIs
Once you have deployed authorizer instance. Get `Client ID` from your authorizer instance dashboard
### Step 1: Install authorizer-go SDK
Run the following command to download authorizer-go SDK
```bash
go get github.com/authorizerdev/authorizer-go
```
### Step 2: Initialize authorizer client
**Parameters**
| Key | Type | Required | Description |
| --------------- | ------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------- |
| `clientID` | `string` | `true` | Your unique client identifier obtained from authorizer dashboard |
| `authorizerURL` | `string` | `true` | Authorizer server URL |
| `redirectURL` | `string` | `false` | Default URL to which you would like to redirect the user in case of successful signup / login / forgot password |
| `extraHeaders` | `map[string]string` | `false` | set of headers that you would like to pass with each request |
**Example**
```go
defaultHeaders := map[string]string{}
authorizerClient, err := authorizer.NewAuthorizerClient("YOUR_CLIENT_ID", "YOUR_AUHTORIZER_URL", "OPTIONAL_REDIRECT_URL", defaultHeaders)
if err != nil {
panic(err)
}
```
### Step 3: Access all the SDK methods using authorizer client instance, initialized on step 2
**Example**
```go
response, err := authorizerClient.Login(&authorizer.LoginInput{
Email: "test@yopmail.com",
Password: "Abc@123",
})
if err != nil {
panic(err)
}
```
## How to use authorizer as API gateway
> Note: This example demonstrates how to use authorizer in middleware for a [go-gin](https://github.com/gin-gonic/gin) server. But logic remains the same under the hood, where you can get auth token from `header` and validate it via authorizer SDK
```go
package main
import (
"net/http"
"strings"
"github.com/authorizerdev/authorizer-go"
"github.com/gin-gonic/gin"
)
func AuthorizeMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
/**
for open routes you can add condition here and just return with c.Next()
so that it does not validate token for those routes
*/
authHeader := c.Request.Header.Get("Authorization")
tokenSplit := strings.Split(authHeader, " ")
defaultHeaders := map[string]string{}
authorizerClient, err := authorizer.NewAuthorizerClient("YOUR_CLIENT_ID", "YOUR_AUHTORIZER_URL", "OPTIONAL_REDIRECT_URL", defaultHeaders)
if err != nil {
// unauthorized
c.AbortWithStatusJSON(401, "unauthorized")
return
}
if len(tokenSplit) < 2 || tokenSplit[1] == "" {
// unauthorized
c.AbortWithStatusJSON(401, "unauthorized")
return
}
res, err := authorizerClient.ValidateJWTToken(&authorizer.ValidateJWTTokenInput{
TokenType: authorizer.TokenTypeIDToken,
Token: tokenSplit[1],
})
if err != nil {
// unauthorized
c.AbortWithStatusJSON(401, "unauthorized")
return
}
if !res.IsValid {
// unauthorized
c.AbortWithStatusJSON(401, "unauthorized")
return
}
c.Next()
}
}
func main() {
router := gin.New()
router.Use(AuthorizeMiddleware())
router.GET("/ping", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{
"message": "pong",
})
})
router.Run(":8090")
}
```
**CURL command to test go-gin server created in example**
Copy JWT ID token from login response of authorizer `login` mutation / social media login and replace `JWT_TOKEN` below
```bash
curl --location --request GET 'http://localhost:8090/ping' \
--header 'Authorization: Bearer JWT_TOKEN'
```