authutil.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. package authutil
  2. import (
  3. "context"
  4. "fmt"
  5. "github.com/go-micro/plugins/v4/auth/jwt"
  6. "github.com/go-redsync/redsync/v4"
  7. "github.com/go-redsync/redsync/v4/redis/goredis/v9"
  8. "github.com/google/uuid"
  9. goredislib "github.com/redis/go-redis/v9"
  10. "github.com/sirupsen/logrus"
  11. "go-micro.dev/v4/auth"
  12. "os"
  13. "os/signal"
  14. "sghgogs.com/micro/common"
  15. "sghgogs.com/micro/common/errorcode"
  16. "strconv"
  17. "strings"
  18. "sync"
  19. "syscall"
  20. "time"
  21. )
  22. var (
  23. JWTAuthService *JWTAuth
  24. jwtAuthServiceOnce sync.Once
  25. )
  26. const (
  27. expiry = time.Second * time.Duration(24*3600)
  28. // expiry = time.Second * time.Duration(1*3600)
  29. )
  30. type JWTAuth struct {
  31. Mu *redsync.Redsync
  32. Client *goredislib.Client
  33. Auth auth.Auth
  34. namespace string
  35. Enable bool
  36. }
  37. func NewJWTAuth(client *goredislib.Client, namespace string, enable bool) *JWTAuth {
  38. jwtAuthServiceOnce.Do(func() {
  39. newAuth := jwt.NewAuth(
  40. auth.Namespace(namespace),
  41. auth.PrivateKey("LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlKS3dJQkFBS0NBZ0VBOFNiSlA1WGJFaWRSbTViMnNOcExHbzJlV2ZVNU9KZTBpemdySHdEOEg3RjZQa1BkCi9SbDkvMXBNVjdNaU8zTEh3dGhIQzJCUllxcisxd0Zkb1pDR0JZckxhWHVYRnFLMHZ1WmhQcUUzYXpqdUlIUXUKMEJIL2xYUU1xeUVxRjVNSTJ6ZWpDNHpNenIxNU9OK2dFNEpuaXBqcC9DZGpPUEFEbUpHK0JKOXFlRS9RUGVtLwptVWRJVC9MYUY3a1F4eVlLNVZLbitOZ09Xek1sektBQXBDbjdUVEtCVWU4RlpHNldTWDdMVjBlTEdIc29pYnhsCm85akRqbFk1b0JPY3pmcWVOV0hLNUdYQjdRd3BMTmg5NDZQelpucW9hcFdVZStZL1JPaUhpekpUY3I1Wk1TTDUKd2xFcThoTmhtaG01Tk5lL08rR2dqQkROU2ZVaDA2K3E0bmdtYm1OWDVoODM4QmJqUmN5YzM2ZHd6NkpVK2R1bwpSdFFoZ2lZOTEwcFBmOWJhdVhXcXdVQ1VhNHFzSHpqS1IwTC9OMVhYQXlsQ0RqeWVnWnp6Y093MkNIOFNrZkZVCnJnTHJQYkVCOWVnY0drMzgrYnBLczNaNlJyNSt0bkQxQklQSUZHTGVJMFVPQzAreGlCdjBvenhJRE9GbldhOVUKVEdEeFV4OG9qOFZJZVJuV0RxNk1jMWlKcDhVeWNpQklUUnR3NGRabzcweG1mbmVJV3pyM0tTTmFoU29nSmRSMApsYVF6QXVQM2FpV1hJTXAyc2M4U2MrQmwrTGpYbUJveEJyYUJIaDlLa0pKRWNnQUZ3czJib2pDbEpPWXhvRi9YCmdGS1NzSW5IRHJIVk95V1BCZTNmYWRFYzc3YituYi9leE96cjFFcnhoR2c5akZtcmtPK3M0eEdodjZNQ0F3RUEKQVFLQ0FnRUFqUzc1Q2VvUlRRcUtBNzZaaFNiNGEzNVlKRENtcEpSazFsRTNKYnFzNFYxRnhXaDBjZmJYeG9VMgpSdTRRYjUrZWhsdWJGSFQ2a1BxdG9uRWhRVExjMUNmVE9WbHJOb3hocDVZM2ZyUmlQcnNnNXcwK1R3RUtrcFJUCnltanJQTXdQbGxCM2U0NmVaYmVXWGc3R3FFVmptMGcxVFRRK0tocVM4R0w3VGJlTFhRN1ZTem9ydTNCNVRKMVEKeEN6TVB0dnQ2eDYrU3JrcmhvZG1iT3VNRkpDam1TbWxmck9pZzQ4Zkc3NUpERHRObXpLWHBEUVJpYUNodFJhVQpQRHpmUTlTamhYdFFqdkZvWFFFT3BqdkZVRjR2WldNUWNQNUw1VklDM3JRSWp4MFNzQTN6S0FwakVUbjJHNjN2CktZby8zVWttbzhkUCtGRHA3NCs5a3pLNHFFaFJycEl3bEtiN0VOZWtDUXZqUFl1K3pyKzMyUXdQNTJ2L2FveWQKdjJJaUY3M2laTU1vZDhhYjJuQStyVEI2T0cvOVlSYk5kV21tay9VTi9jUHYrN214TmZ6Y1d1ZU1XcThxMXh4eAptNTNpR0NSQ29PQ1lDQk4zcUFkb1JwYW5xd3lCOUxrLzFCQjBHUld3MjgxK3VhNXNYRnZBVDBKeTVURnduMncvClU1MlJKWFlNOXVhMFBvd214b0RDUWRuNFZYVkdNZGdXaHN4aXhHRlYwOUZObWJJQWJaN0xaWGtkS1gzc1ZVbTcKWU1WYWIzVVo2bEhtdXYzT1NzcHNVUlRqN1hiRzZpaVVlaDU1aW91OENWbnRndWtFcnEzQTQwT05FVzhjNDBzOQphVTBGaSs4eWZpQTViaVZHLzF0bWlucUVERkhuQStnWk1xNEhlSkZxcWZxaEZKa1JwRGtDZ2dFQkFQeGR1NGNKCm5Da1duZDdPWFlHMVM3UDdkVWhRUzgwSDlteW9uZFc5bGFCQm84RWRPeTVTZzNOUmsxQ2pNZFZ1a3FMcjhJSnkKeStLWk15SVpvSlJvbllaMEtIUUVMR3ZLbzFOS2NLQ1FJbnYvWHVCdFJpRzBVb1pQNVkwN0RpRFBRQWpYUjlXUwpBc0EzMmQ1eEtFOC91Y3h0MjVQVzJFakNBUmtVeHQ5d0tKazN3bC9JdXVYRlExTDdDWjJsOVlFUjlHeWxUbzhNCmxXUEY3YndtUFV4UVNKaTNVS0FjTzZweTVUU1lkdWQ2aGpQeXJwSXByNU42VGpmTlRFWkVBeU9LbXVpOHVkUkoKMUg3T3RQVEhGZElKQjNrNEJnRDZtRE1HbjB2SXBLaDhZN3NtRUZBbFkvaXlCZjMvOHk5VHVMb1BycEdqR3RHbgp4Y2RpMHFud2p0SGFNbFVDZ2dFQkFQU2Z0dVFCQ2dTU2JLUSswUEFSR2VVeEQyTmlvZk1teENNTmdHUzJ5Ull3CjRGaGV4ZWkwMVJoaFk1NjE3UjduR1dzb0czd1RQa3dvRTJtbE1aQkoxeWEvUU9RRnQ3WG02OVl0RGh0T2FWbDgKL0o4dlVuSTBtWmxtT2pjTlRoYnVPZDlNSDlRdGxIRUMxMlhYdHJNb3Fsb0U2a05TT0pJalNxYm9wcDRXc1BqcApvZTZ0Nkdyd1RhOHBHeUJWWS90Mi85Ym5ORHVPVlpjODBaODdtY2gzcDNQclBqU3h5di9saGxYMFMwYUdHTkhTCk1XVjdUa25OaGo1TWlIRXFnZ1pZemtBWTkyd1JoVENnU1A2M0VNcitUWXFudXVuMXJHbndPYm95TDR2aFRpV0UKcU42UDNCTFlCZ1FpMllDTDludEJrOEl6RHZyd096dW5GVnhhZ0g5SVVoY0NnZ0VCQUwzQXlLa1BlOENWUmR6cQpzL284VkJDZmFSOFhhUGRnSGxTek1BSXZpNXEwNENqckRyMlV3MHZwTVdnM1hOZ0xUT3g5bFJpd3NrYk9SRmxHCmhhd3hRUWlBdkk0SE9WTlBTU0R1WHVNTG5USTQ0S0RFNlMrY2cxU0VMS2pWbDVqcDNFOEpkL1RJMVpLc0xBQUsKZTNHakM5UC9ZbE8xL21ndW4xNjVkWk01cFAwWHBPb2FaeFV2RHFFTktyekR0V1g0RngyOTZlUzdaSFJodFpCNwovQ2t1VUhlcmxrN2RDNnZzdWhTaTh2eTM3c0tPbmQ0K3c4cVM4czhZYVZxSDl3ZzVScUxxakp0bmJBUnc3alVDCm9KQ053M1hNdnc3clhaYzRTbnhVQUNMRGJNV2lLQy9xL1ZGWW9oTEs2WkpUVkJscWd5cjBSYzBRWmpDMlNJb0kKMjRwRWt3VUNnZ0VCQUpqb0FJVVNsVFY0WlVwaExXN3g4WkxPa01UWjBVdFFyd2NPR0hSYndPUUxGeUNGMVFWNQppejNiR2s4SmZyZHpVdk1sTmREZm9uQXVHTHhQa3VTVEUxWlg4L0xVRkJveXhyV3dvZ0cxaUtwME11QTV6em90CjROai9DbUtCQVkvWnh2anA5M2RFS21aZGxWQkdmeUFMeWpmTW5MWUovZXh5L09YSnhPUktZTUttSHg4M08zRWsKMWhvb0FwbTZabTIzMjRGME1iVU1ham5Idld2ZjhHZGJTNk5zcHd4L0dkbk1tYVMrdUJMVUhVMkNLbmc1bEIwVAp4OWJITmY0dXlPbTR0dXRmNzhCd1R5V3UreEdrVW0zZ2VZMnkvR1hqdDZyY2l1ajFGNzFDenZzcXFmZThTcDdJCnd6SHdxcTNzVHR5S2lCYTZuYUdEYWpNR1pKYSt4MVZJV204Q2dnRUJBT001ajFZR25Ba0pxR0czQWJSVDIvNUMKaVVxN0loYkswOGZsSGs5a2YwUlVjZWc0ZVlKY3dIRXJVaE4rdWQyLzE3MC81dDYra0JUdTVZOUg3bkpLREtESQpoeEg5SStyamNlVkR0RVNTRkluSXdDQ1lrOHhOUzZ0cHZMV1U5b0pibGFKMlZsalV2NGRFWGVQb0hkREh1Zk9ZClVLa0lsV2E3Uit1QzNEOHF5U1JrQnFLa3ZXZ1RxcFNmTVNkc1ZTeFIzU2Q4SVhFSHFjTDNUNEtMWGtYNEdEamYKMmZOSTFpZkx6ekhJMTN3Tk5IUTVRNU9SUC9pell2QzVzZkx4U2ZIUXJiMXJZVkpKWkI5ZjVBUjRmWFpHSVFsbApjMG8xd0JmZFlqMnZxVDlpR09IQnNSSTlSL2M2RzJQcUt3aFRpSzJVR2lmVFNEUVFuUkF6b2tpQVkrbE8vUjQ9Ci0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0tCg=="),
  42. auth.PublicKey("LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQ0lqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FnOEFNSUlDQ2dLQ0FnRUE4U2JKUDVYYkVpZFJtNWIyc05wTApHbzJlV2ZVNU9KZTBpemdySHdEOEg3RjZQa1BkL1JsOS8xcE1WN01pTzNMSHd0aEhDMkJSWXFyKzF3RmRvWkNHCkJZckxhWHVYRnFLMHZ1WmhQcUUzYXpqdUlIUXUwQkgvbFhRTXF5RXFGNU1JMnplakM0ek16cjE1T04rZ0U0Sm4KaXBqcC9DZGpPUEFEbUpHK0JKOXFlRS9RUGVtL21VZElUL0xhRjdrUXh5WUs1VktuK05nT1d6TWx6S0FBcENuNwpUVEtCVWU4RlpHNldTWDdMVjBlTEdIc29pYnhsbzlqRGpsWTVvQk9jemZxZU5XSEs1R1hCN1F3cExOaDk0NlB6ClpucW9hcFdVZStZL1JPaUhpekpUY3I1Wk1TTDV3bEVxOGhOaG1obTVOTmUvTytHZ2pCRE5TZlVoMDYrcTRuZ20KYm1OWDVoODM4QmJqUmN5YzM2ZHd6NkpVK2R1b1J0UWhnaVk5MTBwUGY5YmF1WFdxd1VDVWE0cXNIempLUjBMLwpOMVhYQXlsQ0RqeWVnWnp6Y093MkNIOFNrZkZVcmdMclBiRUI5ZWdjR2szOCticEtzM1o2UnI1K3RuRDFCSVBJCkZHTGVJMFVPQzAreGlCdjBvenhJRE9GbldhOVVUR0R4VXg4b2o4VkllUm5XRHE2TWMxaUpwOFV5Y2lCSVRSdHcKNGRabzcweG1mbmVJV3pyM0tTTmFoU29nSmRSMGxhUXpBdVAzYWlXWElNcDJzYzhTYytCbCtMalhtQm94QnJhQgpIaDlLa0pKRWNnQUZ3czJib2pDbEpPWXhvRi9YZ0ZLU3NJbkhEckhWT3lXUEJlM2ZhZEVjNzdiK25iL2V4T3pyCjFFcnhoR2c5akZtcmtPK3M0eEdodjZNQ0F3RUFBUT09Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQo="),
  43. )
  44. pool := goredis.NewPool(client) // or, pool := redigo.NewPool(...)
  45. // Create an instance of redisync to be used to obtain a mutual exclusion
  46. // lock.
  47. rs := redsync.New(pool)
  48. JWTAuthService = &JWTAuth{
  49. Mu: rs,
  50. Client: client,
  51. Auth: newAuth,
  52. namespace: namespace,
  53. Enable: enable,
  54. }
  55. handleSignals(client)
  56. })
  57. return JWTAuthService
  58. }
  59. // GenerateToken 示例:生成令牌
  60. func (svc *JWTAuth) GenerateToken(userID int64, provider, withType, secret string, scopes []string, md map[string]string) (*auth.Account, error) {
  61. var account *auth.Account
  62. lock := svc.Mu.NewMutex(fmt.Sprintf("generate-token-lock-%d", userID))
  63. // 获取锁,保证原子性
  64. if err := lock.Lock(); err != nil {
  65. return account, err
  66. }
  67. defer lock.Unlock()
  68. // 很重要
  69. md["expiry"] = fmt.Sprintf("%d", time.Now().Add(expiry).Unix())
  70. generate, err := svc.Auth.Generate(
  71. fmt.Sprintf("%d", userID),
  72. auth.WithType(withType),
  73. auth.WithProvider(provider),
  74. auth.WithScopes(strings.Join(scopes, ",")),
  75. auth.WithSecret(secret),
  76. auth.WithMetadata(md),
  77. )
  78. if err != nil {
  79. code := common.FailedToGenerateTokenErrorCode
  80. return account, errorcode.New(svc.namespace, common.ErrorMessage[code], int32(code))
  81. }
  82. return generate, nil
  83. }
  84. func (svc *JWTAuth) RefreshToken(token string) (*auth.Token, error) {
  85. var authToken *auth.Token
  86. lock := svc.Mu.NewMutex("refresh-generate-token-lock")
  87. // 获取锁,保证原子性
  88. if err := lock.Lock(); err != nil {
  89. return authToken, err
  90. }
  91. defer lock.Unlock()
  92. inspect, err := svc.Auth.Inspect(token)
  93. if err != nil {
  94. return authToken, err
  95. }
  96. inspect.Metadata["expiry"] = fmt.Sprintf("%d", time.Now().Add(expiry).Unix())
  97. generate, err := svc.Auth.Generate(
  98. inspect.Metadata["id"],
  99. auth.WithType("user"),
  100. auth.WithProvider("system"),
  101. auth.WithScopes(strings.Join(inspect.Scopes, ",")),
  102. auth.WithSecret(inspect.Metadata["password"]),
  103. auth.WithMetadata(inspect.Metadata),
  104. )
  105. if err != nil {
  106. code := common.FailedToGenerateTokenErrorCode
  107. return authToken, errorcode.New(svc.namespace, common.ErrorMessage[code], int32(code))
  108. }
  109. userId, _ := strconv.ParseInt(inspect.Metadata["id"], 10, 64)
  110. return svc.Token(userId, generate.Secret)
  111. }
  112. // Token 重新刷新token
  113. func (svc *JWTAuth) Token(userID int64, accessToken string) (*auth.Token, error) {
  114. var authToken *auth.Token
  115. lock := svc.Mu.NewMutex(fmt.Sprintf("token-lock-%d", userID))
  116. // 获取锁,保证原子性
  117. if err := lock.Lock(); err != nil {
  118. return authToken, err
  119. }
  120. defer lock.Unlock()
  121. return svc.Auth.Token(
  122. auth.WithExpiry(expiry),
  123. auth.WithCredentials(fmt.Sprintf("%d", userID), accessToken),
  124. auth.WithToken(accessToken),
  125. )
  126. }
  127. // Inspect 检测token 有效期
  128. func (svc *JWTAuth) Inspect(accessToken string) (*auth.Account, error) {
  129. var account *auth.Account
  130. lock := svc.Mu.NewMutex(fmt.Sprintf("inspect-lock-%d", uuid.New()))
  131. // 获取锁,保证原子性
  132. if err := lock.Lock(); err != nil {
  133. return account, err
  134. }
  135. defer lock.Unlock()
  136. return svc.Auth.Inspect(accessToken)
  137. }
  138. // StoreToken 存储令牌到Redis
  139. func (svc *JWTAuth) StoreToken(ctx context.Context, ID int64, name, accessToken string) error {
  140. lock := svc.Mu.NewMutex(fmt.Sprintf("store-token-lock-%d", ID))
  141. // 获取锁
  142. if err := lock.Lock(); err != nil {
  143. return err
  144. }
  145. access := fmt.Sprintf("auth:access-token:%v:%s", ID, name)
  146. err := svc.Client.Set(ctx, access, accessToken, expiry).Err()
  147. if err != nil {
  148. err = errorcode.New(svc.namespace, common.ErrorMessage[common.FailedToStoreTokenErrorCode], int32(common.FailedToStoreTokenErrorCode))
  149. logrus.Error(err)
  150. return err
  151. }
  152. return nil
  153. }
  154. // StoreRevoke 从Redis中删除令牌
  155. func (svc *JWTAuth) StoreRevoke(ctx context.Context, ID int64, name string) error {
  156. lock := svc.Mu.NewMutex(fmt.Sprintf("store-revoke-lock-%d", ID))
  157. // 获取锁
  158. if err := lock.Lock(); err != nil {
  159. return err
  160. }
  161. defer lock.Unlock()
  162. access := fmt.Sprintf("auth:access-token:%v:%s", ID, name)
  163. err := svc.Client.Del(ctx, access).Err()
  164. if err != nil {
  165. err = errorcode.New(svc.namespace, common.ErrorMessage[common.TokenDeletionFailedErrorCode], int32(common.TokenDeletionFailedErrorCode))
  166. logrus.Error(err)
  167. return err
  168. }
  169. return nil
  170. }
  171. // StoreVerify 检查是否在有效期内
  172. func (svc *JWTAuth) StoreVerify(ID int64, name string, accessToken string) bool {
  173. lock := svc.Mu.NewMutex(fmt.Sprintf("store-verify-lock-%d", ID))
  174. // 获取锁
  175. if err := lock.Lock(); err != nil {
  176. // 处理获取锁失败的情况
  177. return false
  178. }
  179. defer lock.Unlock()
  180. token := fmt.Sprintf("auth:access-token:%v:%s", ID, name)
  181. return svc.Client.Get(context.Background(), token).Val() == accessToken
  182. }
  183. // Blacklist 将令牌添加到 Redis 黑名单并设置过期时间。
  184. func (svc *JWTAuth) Blacklist(accessToken string) error {
  185. lock := svc.Mu.NewMutex(fmt.Sprintf("blacklist-lock-%d", uuid.New()))
  186. // 获取锁
  187. if err := lock.Lock(); err != nil {
  188. return err
  189. }
  190. defer lock.Unlock()
  191. // 将令牌添加到 Redis,并设置过期时间
  192. return svc.Client.Set(context.Background(), accessToken, "blacklisted", expiry).Err()
  193. }
  194. // IsBlacklisted 检查令牌是否在黑名单中。
  195. func (svc *JWTAuth) IsBlacklisted(accessToken string) (bool, error) {
  196. lock := svc.Mu.NewMutex(fmt.Sprintf("is-blacklisted-lock-%d", uuid.New()))
  197. // 获取锁
  198. if err := lock.Lock(); err != nil {
  199. // 处理获取锁失败的情况
  200. return false, err
  201. }
  202. defer lock.Unlock()
  203. // 检查令牌是否存在于 Redis 中
  204. _, err := svc.Client.Get(context.Background(), accessToken).Result()
  205. if err == goredislib.Nil {
  206. return false, nil
  207. } else if err != nil {
  208. return false, err
  209. }
  210. return true, nil
  211. }
  212. // CleanupExpiredTokens 定期清理 Redis 黑名单中的过期令牌。
  213. func (svc *JWTAuth) CleanupExpiredTokens(interval time.Duration) {
  214. ticker := time.NewTicker(interval)
  215. defer ticker.Stop()
  216. for {
  217. select {
  218. case <-ticker.C:
  219. svc.cleanupExpiredTokens()
  220. }
  221. }
  222. }
  223. func (svc *JWTAuth) cleanupExpiredTokens() {
  224. lock := svc.Mu.NewMutex("cleanup-expired-tokens-lock")
  225. // 获取锁
  226. if err := lock.Lock(); err != nil {
  227. // 处理获取锁失败的情况
  228. return
  229. }
  230. defer lock.Unlock()
  231. // 遍历并从 Redis 中删除过期的键
  232. iter := svc.Client.Scan(context.Background(), 0, "*", 0).Iterator()
  233. for iter.Next(context.Background()) {
  234. key := iter.Val()
  235. ttl := svc.Client.TTL(context.Background(), key).Val()
  236. if ttl.Seconds() <= 0 {
  237. svc.Client.Del(context.Background(), key)
  238. }
  239. }
  240. }
  241. // handleSignals 在应用程序退出时处理信号
  242. func handleSignals(client *goredislib.Client) {
  243. c := make(chan os.Signal, 1)
  244. signal.Notify(c, syscall.SIGINT, syscall.SIGTERM)
  245. go func() {
  246. <-c
  247. fmt.Println("Closing Redis connection...")
  248. if err := client.Close(); err != nil {
  249. fmt.Println("Error closing Redis connection:", err)
  250. } else {
  251. fmt.Println("Redis connection closed.")
  252. }
  253. os.Exit(0)
  254. }()
  255. }