feat: oauth2(client_credential mode) support with swagger

AAStarCommunity · Mar 2, 2024 · d5846fb · d5846fb
1 parent ab0cb73
commit d5846fb
Show file tree

Hide file tree

Showing 18 changed files with 345 additions and 61 deletions.
diff --git a/cmd/server/main.go b/cmd/server/main.go
@@ -29,6 +29,13 @@ func runMode() string {
  return *aPort
 }
 
+// @contact.name AAStar Support
+// @contact.url https://aastar.xyz
+// @securityDefinitions.apikey JWT
+// @in header
+// @name Authorization
+// @description Type 'Bearer \<TOKEN\>' to correctly set the AccessToken
+// @BasePath /api
 func main() {
  port := runMode()
  _ = routers.SetRouters().Run(port)

diff --git a/conf/appsettings.yaml b/conf/appsettings.yaml
@@ -0,0 +1,4 @@
+jwt:
+ security: hello-eth-paymaster
+ realm: aastar
+ idkey: id
diff --git a/conf/conf.go b/conf/conf.go
@@ -9,7 +9,7 @@ import (
 var once sync.Once
 
 type Conf struct {
- // TODO: Add Conf Structure Here
+ Jwt JWT
 }
 
 var conf *Conf

diff --git a/conf/jwt.go b/conf/jwt.go
@@ -0,0 +1,28 @@
+package conf
+
+import "sync"
+
+type JWT struct {
+ Security string
+ Realm string
+ IdKey string
+}
+
+var jwt *JWT
+
+var onceJwt sync.Once
+
+// GetJwtKey represents jwt object
+func GetJwtKey() *JWT {
+ onceJwt.Do(func() {
+ if jwt == nil {
+ j := getConf().Jwt
+ jwt = &JWT{
+ Security: j.Security,
+ Realm: j.Realm,
+ }
+ }
+ })
+
+ return jwt
+}
diff --git a/docs/docs.go b/docs/docs.go
@@ -10,14 +10,49 @@ const docTemplate = `{
  "info": {
  "description": "{{escape .Description}}",
  "title": "{{.Title}}",
- "contact": {},
+ "contact": {
+ "name": "AAStar Support",
+ "url": "https://aastar.xyz"
+ },
  "version": "{{.Version}}"
  },
  "host": "{{.Host}}",
  "basePath": "{{.BasePath}}",
  "paths": {
+ "/api/auth": {
+ "post": {
+ "description": "Get AccessToken By ApiKey",
+ "consumes": [
+ "application/json"
+ ],
+ "tags": [
+ "Auth"
+ ],
+ "parameters": [
+ {
+ "description": "AccessToken Model",
+ "name": "credential",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/models.ClientCredential"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ }
+ },
  "/api/v1/get-support-entrypoint": {
  "get": {
+ "security": [
+ {
+ "JWT": []
+ }
+ ],
  "description": "get the support entrypoint",
  "consumes": [
  "application/json"
@@ -34,6 +69,11 @@ const docTemplate = `{
  },
  "/api/v1/get-support-strategy": {
  "get": {
+ "security": [
+ {
+ "JWT": []
+ }
+ ],
  "description": "get the support strategy",
  "consumes": [
  "application/json"
@@ -53,6 +93,11 @@ const docTemplate = `{
  },
  "/api/v1/try-pay-user-operation": {
  "post": {
+ "security": [
+ {
+ "JWT": []
+ }
+ ],
  "description": "sponsor the userOp",
  "consumes": [
  "application/json"
@@ -67,6 +112,24 @@ const docTemplate = `{
  }
  }
  }
+ },
+ "definitions": {
+ "models.ClientCredential": {
+ "type": "object",
+ "properties": {
+ "apiKey": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "securityDefinitions": {
+ "JWT": {
+ "description": "Type 'Bearer \\\u003cTOKEN\\\u003e' to correctly set the AccessToken",
+ "type": "apiKey",
+ "name": "Authorization",
+ "in": "header"
+ }
  }
 }`
 

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -1,11 +1,46 @@
 {
  "swagger": "2.0",
  "info": {
- "contact": {}
+ "contact": {
+ "name": "AAStar Support",
+ "url": "https://aastar.xyz"
+ }
  },
  "paths": {
+ "/api/auth": {
+ "post": {
+ "description": "Get AccessToken By ApiKey",
+ "consumes": [
+ "application/json"
+ ],
+ "tags": [
+ "Auth"
+ ],
+ "parameters": [
+ {
+ "description": "AccessToken Model",
+ "name": "credential",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/models.ClientCredential"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ }
+ },
  "/api/v1/get-support-entrypoint": {
  "get": {
+ "security": [
+ {
+ "JWT": []
+ }
+ ],
  "description": "get the support entrypoint",
  "consumes": [
  "application/json"
@@ -22,6 +57,11 @@
  },
  "/api/v1/get-support-strategy": {
  "get": {
+ "security": [
+ {
+ "JWT": []
+ }
+ ],
  "description": "get the support strategy",
  "consumes": [
  "application/json"
@@ -41,6 +81,11 @@
  },
  "/api/v1/try-pay-user-operation": {
  "post": {
+ "security": [
+ {
+ "JWT": []
+ }
+ ],
  "description": "sponsor the userOp",
  "consumes": [
  "application/json"
@@ -55,5 +100,23 @@
  }
  }
  }
+ },
+ "definitions": {
+ "models.ClientCredential": {
+ "type": "object",
+ "properties": {
+ "apiKey": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "securityDefinitions": {
+ "JWT": {
+ "description": "Type 'Bearer \\\u003cTOKEN\\\u003e' to correctly set the AccessToken",
+ "type": "apiKey",
+ "name": "Authorization",
+ "in": "header"
+ }
  }
 }
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -1,6 +1,31 @@
+definitions:
+ models.ClientCredential:
+ properties:
+ apiKey:
+ type: string
+ type: object
 info:
- contact: {}
+ contact:
+ name: AAStar Support
+ url: https://aastar.xyz
 paths:
+ /api/auth:
+ post:
+ consumes:
+ - application/json
+ description: Get AccessToken By ApiKey
+ parameters:
+ - description: AccessToken Model
+ in: body
+ name: credential
+ required: true
+ schema:
+ $ref: '#/definitions/models.ClientCredential'
+ responses:
+ "200":
+ description: OK
+ tags:
+ - Auth
  /api/v1/get-support-entrypoint:
  get:
  consumes:
@@ -9,6 +34,8 @@ paths:
  responses:
  "200":
  description: OK
+ security:
+ - JWT: []
  tags:
  - Sponsor
  /api/v1/get-support-strategy:
@@ -21,6 +48,8 @@ paths:
  responses:
  "200":
  description: OK
+ security:
+ - JWT: []
  tags:
  - Sponsor
  /api/v1/try-pay-user-operation:
@@ -31,6 +60,14 @@ paths:
  responses:
  "200":
  description: OK
+ security:
+ - JWT: []
  tags:
  - Sponsor
+securityDefinitions:
+ JWT:
+ description: Type 'Bearer \<TOKEN\>' to correctly set the AccessToken
+ in: header
+ name: Authorization
+ type: apiKey
 swagger: "2.0"
diff --git a/go.mod b/go.mod
@@ -3,11 +3,13 @@ module AAStarCommunity/EthPaymaster_BackService
 go 1.22.0
 
 require (
+ github.com/appleboy/gin-jwt/v2 v2.9.2
  github.com/gin-contrib/cors v1.5.0
  github.com/gin-gonic/gin v1.9.1
  github.com/swaggo/files v1.0.1
  github.com/swaggo/gin-swagger v1.6.0
  github.com/swaggo/swag v1.16.3
+ gorm.io/gorm v1.25.7
  k8s.io/apimachinery v0.29.2
 )
 
@@ -26,6 +28,9 @@ require (
  github.com/go-playground/universal-translator v0.18.1 // indirect
  github.com/go-playground/validator/v10 v10.18.0 // indirect
  github.com/goccy/go-json v0.10.2 // indirect
+ github.com/golang-jwt/jwt/v4 v4.5.0 // indirect
+ github.com/jinzhu/inflection v1.0.0 // indirect
+ github.com/jinzhu/now v1.1.5 // indirect
  github.com/josharian/intern v1.0.0 // indirect
  github.com/json-iterator/go v1.1.12 // indirect
  github.com/klauspost/cpuid/v2 v2.2.7 // indirect