oauth.go 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. package model
  2. import (
  3. "strconv"
  4. "strings"
  5. "errors"
  6. )
  7. const OIDC_DEFAULT_SCOPES = "openid,profile,email"
  8. const (
  9. // make sure the value shouldbe lowercase
  10. OauthTypeGithub string = "github"
  11. OauthTypeGoogle string = "google"
  12. OauthTypeOidc string = "oidc"
  13. OauthTypeWebauth string = "webauth"
  14. )
  15. // Validate the oauth type
  16. func ValidateOauthType(oauthType string) error {
  17. switch oauthType {
  18. case OauthTypeGithub, OauthTypeGoogle, OauthTypeOidc, OauthTypeWebauth:
  19. return nil
  20. default:
  21. return errors.New("invalid Oauth type")
  22. }
  23. }
  24. const (
  25. OauthNameGithub string = "GitHub"
  26. OauthNameGoogle string = "Google"
  27. OauthNameOidc string = "OIDC"
  28. OauthNameWebauth string = "WebAuth"
  29. )
  30. const (
  31. UserEndpointGithub string = "https://api.github.com/user"
  32. IssuerGoogle string = "https://accounts.google.com"
  33. )
  34. type Oauth struct {
  35. IdModel
  36. Op string `json:"op"`
  37. OauthType string `json:"oauth_type"`
  38. ClientId string `json:"client_id"`
  39. ClientSecret string `json:"client_secret"`
  40. RedirectUrl string `json:"redirect_url"`
  41. AutoRegister *bool `json:"auto_register"`
  42. Scopes string `json:"scopes"`
  43. Issuer string `json:"issuer"`
  44. TimeModel
  45. }
  46. // Helper function to format oauth info, it's used in the update and create method
  47. func (oa *Oauth) FormatOauthInfo() error {
  48. oauthType := strings.TrimSpace(oa.OauthType)
  49. err := ValidateOauthType(oa.OauthType)
  50. if err != nil {
  51. return err
  52. }
  53. // check if the op is empty, set the default value
  54. op := strings.TrimSpace(oa.Op)
  55. if op == "" {
  56. switch oauthType {
  57. case OauthTypeGithub:
  58. oa.Op = OauthNameGithub
  59. case OauthTypeGoogle:
  60. oa.Op = OauthNameGoogle
  61. case OauthTypeOidc:
  62. oa.Op = OauthNameOidc
  63. case OauthTypeWebauth:
  64. oa.Op = OauthNameWebauth
  65. default:
  66. oa.Op = oauthType
  67. }
  68. }
  69. // check the issuer, if the oauth type is google and the issuer is empty, set the issuer to the default value
  70. issuer := strings.TrimSpace(oa.Issuer)
  71. // If the oauth type is google and the issuer is empty, set the issuer to the default value
  72. if oauthType == OauthTypeGoogle && issuer == "" {
  73. oa.Issuer = IssuerGoogle
  74. }
  75. return nil
  76. }
  77. type OauthUser struct {
  78. OpenId string `json:"open_id" gorm:"not null;index"`
  79. Name string `json:"name"`
  80. Username string `json:"username"`
  81. Email string `json:"email"`
  82. VerifiedEmail bool `json:"verified_email,omitempty"`
  83. Picture string `json:"picture,omitempty"`
  84. }
  85. func (ou *OauthUser) ToUser(user *User, overideUsername bool) {
  86. if overideUsername {
  87. user.Username = ou.Username
  88. }
  89. user.Email = ou.Email
  90. user.Nickname = ou.Name
  91. user.Avatar = ou.Picture
  92. }
  93. type OauthUserBase struct {
  94. Name string `json:"name"`
  95. Email string `json:"email"`
  96. }
  97. type OidcUser struct {
  98. OauthUserBase
  99. Sub string `json:"sub"`
  100. VerifiedEmail bool `json:"email_verified"`
  101. PreferredUsername string `json:"preferred_username"`
  102. Picture string `json:"picture"`
  103. }
  104. func (ou *OidcUser) ToOauthUser() *OauthUser {
  105. var username string
  106. // 使用 PreferredUsername,如果不存在,降级到 Email 前缀
  107. if ou.PreferredUsername != "" {
  108. username = ou.PreferredUsername
  109. } else {
  110. username = strings.ToLower(strings.Split(ou.Email, "@")[0])
  111. }
  112. return &OauthUser{
  113. OpenId: ou.Sub,
  114. Name: ou.Name,
  115. Username: username,
  116. Email: ou.Email,
  117. VerifiedEmail: ou.VerifiedEmail,
  118. Picture: ou.Picture,
  119. }
  120. }
  121. type GithubUser struct {
  122. OauthUserBase
  123. Id int `json:"id"`
  124. Login string `json:"login"`
  125. AvatarUrl string `json:"avatar_url"`
  126. VerifiedEmail bool `json:"verified_email"`
  127. }
  128. func (gu *GithubUser) ToOauthUser() *OauthUser {
  129. username := strings.ToLower(gu.Login)
  130. return &OauthUser{
  131. OpenId: strconv.Itoa(gu.Id),
  132. Name: gu.Name,
  133. Username: username,
  134. Email: gu.Email,
  135. VerifiedEmail: gu.VerifiedEmail,
  136. Picture: gu.AvatarUrl,
  137. }
  138. }
  139. type OauthList struct {
  140. Oauths []*Oauth `json:"list"`
  141. Pagination
  142. }