Add jwt crypto module, support unit test for config module
Signed-off-by: Asai Neko<sugar@sne.moe>
This commit is contained in:
@@ -1,6 +1,7 @@
|
|||||||
SERVER_ADDRESS=:8000
|
SERVER_ADDRESS=:8000
|
||||||
SERVER_DEBUG_MODE=true
|
SERVER_DEBUG_MODE=true
|
||||||
SERVER_FILE_LOGGER=false
|
SERVER_FILE_LOGGER=false
|
||||||
|
SERVER_JWT_SECRET=test
|
||||||
DATABASE_TYPE=postgres
|
DATABASE_TYPE=postgres
|
||||||
DATABASE_HOST=127.0.0.1
|
DATABASE_HOST=127.0.0.1
|
||||||
DATABASE_NAME=postgres
|
DATABASE_NAME=postgres
|
||||||
|
|||||||
@@ -2,17 +2,29 @@ package config
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
"log"
|
||||||
|
"os"
|
||||||
|
|
||||||
"github.com/spf13/viper"
|
"github.com/spf13/viper"
|
||||||
)
|
)
|
||||||
|
|
||||||
func Init() {
|
func Init() {
|
||||||
|
// Set config path by env
|
||||||
|
confPath := os.Getenv("CONFIG_PATH")
|
||||||
|
if confPath == "" {
|
||||||
|
confPath = "config.yaml"
|
||||||
|
}
|
||||||
|
|
||||||
// Read global config
|
// Read global config
|
||||||
viper.SetConfigFile("config.yaml")
|
viper.SetConfigFile(confPath)
|
||||||
viper.SetDefault("Server", serverDef)
|
viper.SetDefault("Server", serverDef)
|
||||||
viper.SetDefault("Database", databaseDef)
|
viper.SetDefault("Database", databaseDef)
|
||||||
conf := &config{}
|
conf := &config{}
|
||||||
if err := viper.ReadInConfig(); err != nil {
|
if err := viper.ReadInConfig(); err != nil {
|
||||||
|
// Dont generate config when using dev mode
|
||||||
|
if os.Getenv("GO_ENV") == "test" || os.Getenv("CONFIG_PATH") != "" {
|
||||||
|
log.Fatalf("[Config] failed to read config %s: %v", confPath, err)
|
||||||
|
}
|
||||||
|
|
||||||
log.Println("Can't read config, trying to modify!")
|
log.Println("Can't read config, trying to modify!")
|
||||||
if err := viper.WriteConfig(); err != nil {
|
if err := viper.WriteConfig(); err != nil {
|
||||||
log.Fatal("[Config] Error writing config: ", err)
|
log.Fatal("[Config] Error writing config: ", err)
|
||||||
@@ -24,17 +36,9 @@ func Init() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func Get(key string) any {
|
func Get(key string) any {
|
||||||
viper.SetConfigFile("config.yaml")
|
|
||||||
if err := viper.ReadInConfig(); err != nil {
|
|
||||||
log.Fatal("[Config] Error reading config: ", err)
|
|
||||||
}
|
|
||||||
return viper.Get(key)
|
return viper.Get(key)
|
||||||
}
|
}
|
||||||
|
|
||||||
func Set(key string, value any) {
|
func Set(key string, value any) {
|
||||||
viper.SetConfigFile("config.yaml")
|
|
||||||
if err := viper.ReadInConfig(); err != nil {
|
|
||||||
log.Fatal("[Config] Error reading config: ", err)
|
|
||||||
}
|
|
||||||
viper.Set(key, value)
|
viper.Set(key, value)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ var serverDef = server{
|
|||||||
Address: ":8000",
|
Address: ":8000",
|
||||||
DebugMode: false,
|
DebugMode: false,
|
||||||
FileLogger: false,
|
FileLogger: false,
|
||||||
|
JwtSecret: "something",
|
||||||
}
|
}
|
||||||
|
|
||||||
var databaseDef = database{
|
var databaseDef = database{
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ func SetEnvConf(key string, sub string) {
|
|||||||
|
|
||||||
func EnvInit() {
|
func EnvInit() {
|
||||||
var dict = map[string][]string{
|
var dict = map[string][]string{
|
||||||
"server": {"address", "debug_mode", "file_logger"},
|
"server": {"address", "debug_mode", "file_logger", "jwt_secret"},
|
||||||
"database": {"type", "host", "name", "username", "password"},
|
"database": {"type", "host", "name", "username", "password"},
|
||||||
}
|
}
|
||||||
for key, value := range dict {
|
for key, value := range dict {
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ type server struct {
|
|||||||
Address string `yaml:"address"`
|
Address string `yaml:"address"`
|
||||||
DebugMode bool `yaml:"debug_mode"`
|
DebugMode bool `yaml:"debug_mode"`
|
||||||
FileLogger bool `yaml:"file_logger"`
|
FileLogger bool `yaml:"file_logger"`
|
||||||
|
JwtSecret string `yaml:"jwt_secret"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type database struct {
|
type database struct {
|
||||||
|
|||||||
@@ -21,6 +21,13 @@ func (self *User) GetByEmail(email string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (self *User) GetByUserId(userId string) error {
|
||||||
|
if err := Database.Where("user_id = ?", userId).First(&self).Error; err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func (self *User) SetCheckinState(email string, state bool) error {
|
func (self *User) SetCheckinState(email string, state bool) error {
|
||||||
if err := Database.Where("email = ?", email).First(&self).Error; err != nil {
|
if err := Database.Where("email = ?", email).First(&self).Error; err != nil {
|
||||||
return err
|
return err
|
||||||
|
|||||||
1
go.mod
1
go.mod
@@ -17,6 +17,7 @@ require (
|
|||||||
github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
|
github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
|
||||||
github.com/goccy/go-json v0.10.5 // indirect
|
github.com/goccy/go-json v0.10.5 // indirect
|
||||||
github.com/goccy/go-yaml v1.19.1 // indirect
|
github.com/goccy/go-yaml v1.19.1 // indirect
|
||||||
|
github.com/golang-jwt/jwt/v5 v5.3.0 // indirect
|
||||||
github.com/google/uuid v1.6.0 // indirect
|
github.com/google/uuid v1.6.0 // indirect
|
||||||
github.com/jackc/pgpassfile v1.0.0 // indirect
|
github.com/jackc/pgpassfile v1.0.0 // indirect
|
||||||
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
|
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
|
||||||
|
|||||||
2
go.sum
2
go.sum
@@ -28,6 +28,8 @@ github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4=
|
|||||||
github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M=
|
github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M=
|
||||||
github.com/goccy/go-yaml v1.19.1 h1:3rG3+v8pkhRqoQ/88NYNMHYVGYztCOCIZ7UQhu7H+NE=
|
github.com/goccy/go-yaml v1.19.1 h1:3rG3+v8pkhRqoQ/88NYNMHYVGYztCOCIZ7UQhu7H+NE=
|
||||||
github.com/goccy/go-yaml v1.19.1/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
|
github.com/goccy/go-yaml v1.19.1/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
|
||||||
|
github.com/golang-jwt/jwt/v5 v5.3.0 h1:pv4AsKCKKZuqlgs5sUmn4x8UlGa0kEVt/puTpKx9vvo=
|
||||||
|
github.com/golang-jwt/jwt/v5 v5.3.0/go.mod h1:fxCRLWMO43lRc8nhHWY6LGqRcf+1gQWArsqaEUEa5bE=
|
||||||
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
|
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
|
||||||
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||||
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||||
|
|||||||
77
internal/crypto/jwt/jwt.go
Normal file
77
internal/crypto/jwt/jwt.go
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
package jwt
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"nixcn-cms/config"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/gin-gonic/gin"
|
||||||
|
"github.com/golang-jwt/jwt/v5"
|
||||||
|
"github.com/google/uuid"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Claims struct {
|
||||||
|
UserID uuid.UUID `json:"user_id"`
|
||||||
|
jwt.RegisteredClaims
|
||||||
|
}
|
||||||
|
|
||||||
|
func JWTAuth() gin.HandlerFunc {
|
||||||
|
var JwtSecret = []byte(config.Get("server.jwt_secret").(string))
|
||||||
|
return func(c *gin.Context) {
|
||||||
|
auth := c.GetHeader("Authorization")
|
||||||
|
if auth == "" {
|
||||||
|
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{
|
||||||
|
"error": "missing Authorization header",
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
parts := strings.SplitN(auth, " ", 2)
|
||||||
|
if len(parts) != 2 || parts[0] != "Bearer" {
|
||||||
|
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{
|
||||||
|
"error": "invalid Authorization header format",
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
tokenStr := parts[1]
|
||||||
|
|
||||||
|
token, err := jwt.ParseWithClaims(tokenStr, &Claims{}, func(token *jwt.Token) (interface{}, error) {
|
||||||
|
return JwtSecret, nil
|
||||||
|
})
|
||||||
|
|
||||||
|
if err != nil || !token.Valid {
|
||||||
|
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{
|
||||||
|
"error": "invalid or expired token",
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
claims, ok := token.Claims.(*Claims)
|
||||||
|
if !ok {
|
||||||
|
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{
|
||||||
|
"error": "invalid token claims",
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
c.Set("user_id", claims.UserID)
|
||||||
|
c.Next()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func GenerateToken(userID uuid.UUID, application string) (string, error) {
|
||||||
|
var JwtSecret = []byte(config.Get("server.jwt_secret").(string))
|
||||||
|
claims := Claims{
|
||||||
|
UserID: userID,
|
||||||
|
RegisteredClaims: jwt.RegisteredClaims{
|
||||||
|
ExpiresAt: jwt.NewNumericDate(time.Now().Add(24 * time.Hour)),
|
||||||
|
IssuedAt: jwt.NewNumericDate(time.Now()),
|
||||||
|
Issuer: application,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
|
||||||
|
return token.SignedString(JwtSecret)
|
||||||
|
}
|
||||||
95
internal/crypto/jwt/jwt_test.go
Normal file
95
internal/crypto/jwt/jwt_test.go
Normal file
@@ -0,0 +1,95 @@
|
|||||||
|
package jwt
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"nixcn-cms/config"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/gin-gonic/gin"
|
||||||
|
"github.com/golang-jwt/jwt/v5"
|
||||||
|
"github.com/google/uuid"
|
||||||
|
)
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
os.Setenv("GO_ENV", "test")
|
||||||
|
config.Init()
|
||||||
|
}
|
||||||
|
|
||||||
|
func generateTestToken(userID uuid.UUID, expire time.Duration) string {
|
||||||
|
var JwtSecret = []byte(config.Get("server.jwt_secret").(string))
|
||||||
|
claims := Claims{
|
||||||
|
UserID: userID,
|
||||||
|
RegisteredClaims: jwt.RegisteredClaims{
|
||||||
|
ExpiresAt: jwt.NewNumericDate(time.Now().Add(expire)),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
|
||||||
|
tokenStr, _ := token.SignedString(JwtSecret)
|
||||||
|
return tokenStr
|
||||||
|
}
|
||||||
|
func TestJWTAuth_MissingToken(t *testing.T) {
|
||||||
|
gin.SetMode(gin.TestMode)
|
||||||
|
|
||||||
|
r := gin.New()
|
||||||
|
r.Use(JWTAuth())
|
||||||
|
r.GET("/test", func(c *gin.Context) {
|
||||||
|
c.JSON(200, gin.H{"ok": true})
|
||||||
|
})
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/test", nil)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
r.ServeHTTP(w, req)
|
||||||
|
|
||||||
|
if w.Code != http.StatusUnauthorized {
|
||||||
|
t.Fatalf("expected 401, got %d", w.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func TestJWTAuth_InvalidToken(t *testing.T) {
|
||||||
|
gin.SetMode(gin.TestMode)
|
||||||
|
|
||||||
|
r := gin.New()
|
||||||
|
r.Use(JWTAuth())
|
||||||
|
r.GET("/test", func(c *gin.Context) {
|
||||||
|
c.JSON(200, gin.H{"ok": true})
|
||||||
|
})
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/test", nil)
|
||||||
|
req.Header.Set("Authorization", "Bearer invalid.token.here")
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
r.ServeHTTP(w, req)
|
||||||
|
|
||||||
|
if w.Code != http.StatusUnauthorized {
|
||||||
|
t.Fatalf("expected 401, got %d", w.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func TestJWTAuth_ValidToken(t *testing.T) {
|
||||||
|
gin.SetMode(gin.TestMode)
|
||||||
|
|
||||||
|
r := gin.New()
|
||||||
|
r.Use(JWTAuth())
|
||||||
|
r.GET("/test", func(c *gin.Context) {
|
||||||
|
userID := c.GetUint("user_id")
|
||||||
|
c.JSON(200, gin.H{
|
||||||
|
"user_id": userID,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
uuid, _ := uuid.NewUUID()
|
||||||
|
token := generateTestToken(uuid, time.Hour)
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/test", nil)
|
||||||
|
req.Header.Set("Authorization", "Bearer "+token)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
r.ServeHTTP(w, req)
|
||||||
|
|
||||||
|
if w.Code != http.StatusOK {
|
||||||
|
t.Fatalf("expected 200, got %d", w.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
2
justfile
2
justfile
@@ -17,3 +17,5 @@ build:
|
|||||||
|
|
||||||
run:
|
run:
|
||||||
cd {{ output_dir }} && {{ exec_path }}{{ if os() == "windows" { ".exe" } else { "" } }}
|
cd {{ output_dir }} && {{ exec_path }}{{ if os() == "windows" { ".exe" } else { "" } }}
|
||||||
|
test:
|
||||||
|
cd {{output_dir}} && CONFIG_PATH={{output_dir}}/config.yaml GO_ENV=test go test -C .. ./...
|
||||||
|
|||||||
5
service/check/checkin.go
Normal file
5
service/check/checkin.go
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
package check
|
||||||
|
|
||||||
|
func Checkin() {
|
||||||
|
|
||||||
|
}
|
||||||
@@ -1,8 +1,13 @@
|
|||||||
package check
|
package check
|
||||||
|
|
||||||
import "github.com/gin-gonic/gin"
|
import (
|
||||||
|
"nixcn-cms/internal/crypto/jwt"
|
||||||
|
|
||||||
|
"github.com/gin-gonic/gin"
|
||||||
|
)
|
||||||
|
|
||||||
func Handler(r *gin.RouterGroup) {
|
func Handler(r *gin.RouterGroup) {
|
||||||
|
r.Use(jwt.JWTAuth())
|
||||||
r.GET("/test", func(ctx *gin.Context) {
|
r.GET("/test", func(ctx *gin.Context) {
|
||||||
ctx.JSON(200, gin.H{"Test": "Test"})
|
ctx.JSON(200, gin.H{"Test": "Test"})
|
||||||
})
|
})
|
||||||
|
|||||||
Reference in New Issue
Block a user