authutil.go 12 KB

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