user.go 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
  1. package service
  2. import (
  3. "errors"
  4. "github.com/lejianwen/rustdesk-api/v2/model"
  5. "github.com/lejianwen/rustdesk-api/v2/utils"
  6. "math/rand"
  7. "strconv"
  8. "strings"
  9. "time"
  10. "github.com/gin-gonic/gin"
  11. "gorm.io/gorm"
  12. )
  13. type UserService struct {
  14. }
  15. // InfoById 根据用户id取用户信息
  16. func (us *UserService) InfoById(id uint) *model.User {
  17. u := &model.User{}
  18. DB.Where("id = ?", id).First(u)
  19. return u
  20. }
  21. // InfoByUsername 根据用户名取用户信息
  22. func (us *UserService) InfoByUsername(un string) *model.User {
  23. u := &model.User{}
  24. DB.Where("username = ?", un).First(u)
  25. return u
  26. }
  27. // InfoByEmail 根据邮箱取用户信息
  28. func (us *UserService) InfoByEmail(email string) *model.User {
  29. u := &model.User{}
  30. DB.Where("email = ?", email).First(u)
  31. return u
  32. }
  33. // InfoByOpenid 根据openid取用户信息
  34. func (us *UserService) InfoByOpenid(openid string) *model.User {
  35. u := &model.User{}
  36. DB.Where("openid = ?", openid).First(u)
  37. return u
  38. }
  39. // InfoByUsernamePassword 根据用户名密码取用户信息
  40. func (us *UserService) InfoByUsernamePassword(username, password string) *model.User {
  41. if Config.Ldap.Enable {
  42. u, err := AllService.LdapService.Authenticate(username, password)
  43. if err == nil {
  44. return u
  45. }
  46. Logger.Errorf("LDAP authentication failed, %v", err)
  47. Logger.Warn("Fallback to local database")
  48. }
  49. u := &model.User{}
  50. DB.Where("username = ? and password = ?", username, us.EncryptPassword(password)).First(u)
  51. return u
  52. }
  53. // InfoByAccesstoken 根据accesstoken取用户信息
  54. func (us *UserService) InfoByAccessToken(token string) (*model.User, *model.UserToken) {
  55. u := &model.User{}
  56. ut := &model.UserToken{}
  57. DB.Where("token = ?", token).First(ut)
  58. if ut.Id == 0 {
  59. return u, ut
  60. }
  61. if ut.ExpiredAt < time.Now().Unix() {
  62. return u, ut
  63. }
  64. DB.Where("id = ?", ut.UserId).First(u)
  65. return u, ut
  66. }
  67. // GenerateToken 生成token
  68. func (us *UserService) GenerateToken(u *model.User) string {
  69. if len(Jwt.Key) > 0 {
  70. return Jwt.GenerateToken(u.Id)
  71. }
  72. return utils.Md5(u.Username + time.Now().String())
  73. }
  74. // Login 登录
  75. func (us *UserService) Login(u *model.User, llog *model.LoginLog) *model.UserToken {
  76. token := us.GenerateToken(u)
  77. ut := &model.UserToken{
  78. UserId: u.Id,
  79. Token: token,
  80. DeviceUuid: llog.Uuid,
  81. DeviceId: llog.DeviceId,
  82. ExpiredAt: us.UserTokenExpireTimestamp(),
  83. }
  84. DB.Create(ut)
  85. llog.UserTokenId = ut.UserId
  86. DB.Create(llog)
  87. if llog.Uuid != "" {
  88. AllService.PeerService.UuidBindUserId(llog.DeviceId, llog.Uuid, u.Id)
  89. }
  90. return ut
  91. }
  92. // CurUser 获取当前用户
  93. func (us *UserService) CurUser(c *gin.Context) *model.User {
  94. user, _ := c.Get("curUser")
  95. u, ok := user.(*model.User)
  96. if !ok {
  97. return nil
  98. }
  99. return u
  100. }
  101. func (us *UserService) List(page, pageSize uint, where func(tx *gorm.DB)) (res *model.UserList) {
  102. res = &model.UserList{}
  103. res.Page = int64(page)
  104. res.PageSize = int64(pageSize)
  105. tx := DB.Model(&model.User{})
  106. if where != nil {
  107. where(tx)
  108. }
  109. tx.Count(&res.Total)
  110. tx.Scopes(Paginate(page, pageSize))
  111. tx.Find(&res.Users)
  112. return
  113. }
  114. func (us *UserService) ListByIds(ids []uint) (res []*model.User) {
  115. DB.Where("id in ?", ids).Find(&res)
  116. return res
  117. }
  118. // ListByGroupId 根据组id取用户列表
  119. func (us *UserService) ListByGroupId(groupId, page, pageSize uint) (res *model.UserList) {
  120. res = us.List(page, pageSize, func(tx *gorm.DB) {
  121. tx.Where("group_id = ?", groupId)
  122. })
  123. return
  124. }
  125. // ListIdsByGroupId 根据组id取用户id列表
  126. func (us *UserService) ListIdsByGroupId(groupId uint) (ids []uint) {
  127. DB.Model(&model.User{}).Where("group_id = ?", groupId).Pluck("id", &ids)
  128. return ids
  129. }
  130. // ListIdAndNameByGroupId 根据组id取用户id和用户名列表
  131. func (us *UserService) ListIdAndNameByGroupId(groupId uint) (res []*model.User) {
  132. DB.Model(&model.User{}).Where("group_id = ?", groupId).Select("id, username").Find(&res)
  133. return res
  134. }
  135. // EncryptPassword 加密密码
  136. func (us *UserService) EncryptPassword(password string) string {
  137. return utils.Md5(password + "rustdesk-api")
  138. }
  139. // CheckUserEnable 判断用户是否禁用
  140. func (us *UserService) CheckUserEnable(u *model.User) bool {
  141. return u.Status == model.COMMON_STATUS_ENABLE
  142. }
  143. // Create 创建
  144. func (us *UserService) Create(u *model.User) error {
  145. // The initial username should be formatted, and the username should be unique
  146. if us.IsUsernameExists(u.Username) {
  147. return errors.New("UsernameExists")
  148. }
  149. u.Username = us.formatUsername(u.Username)
  150. u.Password = us.EncryptPassword(u.Password)
  151. res := DB.Create(u).Error
  152. return res
  153. }
  154. // GetUuidByToken 根据token和user取uuid
  155. func (us *UserService) GetUuidByToken(u *model.User, token string) string {
  156. ut := &model.UserToken{}
  157. err := DB.Where("user_id = ? and token = ?", u.Id, token).First(ut).Error
  158. if err != nil {
  159. return ""
  160. }
  161. return ut.DeviceUuid
  162. }
  163. // Logout 退出登录 -> 删除token, 解绑uuid
  164. func (us *UserService) Logout(u *model.User, token string) error {
  165. uuid := us.GetUuidByToken(u, token)
  166. err := DB.Where("user_id = ? and token = ?", u.Id, token).Delete(&model.UserToken{}).Error
  167. if err != nil {
  168. return err
  169. }
  170. if uuid != "" {
  171. AllService.PeerService.UuidUnbindUserId(uuid, u.Id)
  172. }
  173. return nil
  174. }
  175. // Delete 删除用户和oauth信息
  176. func (us *UserService) Delete(u *model.User) error {
  177. userCount := us.getAdminUserCount()
  178. if userCount <= 1 && us.IsAdmin(u) {
  179. return errors.New("The last admin user cannot be deleted")
  180. }
  181. tx := DB.Begin()
  182. // 删除用户
  183. if err := tx.Delete(u).Error; err != nil {
  184. tx.Rollback()
  185. return err
  186. }
  187. // 删除关联的 OAuth 信息
  188. if err := tx.Where("user_id = ?", u.Id).Delete(&model.UserThird{}).Error; err != nil {
  189. tx.Rollback()
  190. return err
  191. }
  192. // 删除关联的ab
  193. if err := tx.Where("user_id = ?", u.Id).Delete(&model.AddressBook{}).Error; err != nil {
  194. tx.Rollback()
  195. return err
  196. }
  197. // 删除关联的abc
  198. if err := tx.Where("user_id = ?", u.Id).Delete(&model.AddressBookCollection{}).Error; err != nil {
  199. tx.Rollback()
  200. return err
  201. }
  202. // 删除关联的abcr
  203. if err := tx.Where("user_id = ?", u.Id).Delete(&model.AddressBookCollectionRule{}).Error; err != nil {
  204. tx.Rollback()
  205. return err
  206. }
  207. tx.Commit()
  208. // 删除关联的peer
  209. if err := AllService.PeerService.EraseUserId(u.Id); err != nil {
  210. Logger.Warn("User deleted successfully, but failed to unlink peer.")
  211. return nil
  212. }
  213. return nil
  214. }
  215. // Update 更新
  216. func (us *UserService) Update(u *model.User) error {
  217. currentUser := us.InfoById(u.Id)
  218. // 如果当前用户是管理员并且 IsAdmin 不为空,进行检查
  219. if us.IsAdmin(currentUser) {
  220. adminCount := us.getAdminUserCount()
  221. // 如果这是唯一的管理员,确保不能禁用或取消管理员权限
  222. if adminCount <= 1 && (!us.IsAdmin(u) || u.Status == model.COMMON_STATUS_DISABLED) {
  223. return errors.New("The last admin user cannot be disabled or demoted")
  224. }
  225. }
  226. return DB.Model(u).Updates(u).Error
  227. }
  228. // FlushToken 清空token
  229. func (us *UserService) FlushToken(u *model.User) error {
  230. return DB.Where("user_id = ?", u.Id).Delete(&model.UserToken{}).Error
  231. }
  232. // FlushTokenByUuid 清空token
  233. func (us *UserService) FlushTokenByUuid(uuid string) error {
  234. return DB.Where("device_uuid = ?", uuid).Delete(&model.UserToken{}).Error
  235. }
  236. // FlushTokenByUuids 清空token
  237. func (us *UserService) FlushTokenByUuids(uuids []string) error {
  238. return DB.Where("device_uuid in (?)", uuids).Delete(&model.UserToken{}).Error
  239. }
  240. // UpdatePassword 更新密码
  241. func (us *UserService) UpdatePassword(u *model.User, password string) error {
  242. u.Password = us.EncryptPassword(password)
  243. err := DB.Model(u).Update("password", u.Password).Error
  244. if err != nil {
  245. return err
  246. }
  247. err = us.FlushToken(u)
  248. return err
  249. }
  250. // IsAdmin 是否管理员
  251. func (us *UserService) IsAdmin(u *model.User) bool {
  252. return u != nil && *u.IsAdmin
  253. }
  254. // RouteNames
  255. func (us *UserService) RouteNames(u *model.User) []string {
  256. if us.IsAdmin(u) {
  257. return model.AdminRouteNames
  258. }
  259. return model.UserRouteNames
  260. }
  261. // InfoByOauthId 根据oauth的name和openId取用户信息
  262. func (us *UserService) InfoByOauthId(op string, openId string) *model.User {
  263. ut := AllService.OauthService.UserThirdInfo(op, openId)
  264. if ut.Id == 0 {
  265. return nil
  266. }
  267. u := us.InfoById(ut.UserId)
  268. if u.Id == 0 {
  269. return nil
  270. }
  271. return u
  272. }
  273. // RegisterByOauth 注册
  274. func (us *UserService) RegisterByOauth(oauthUser *model.OauthUser, op string) (error, *model.User) {
  275. Lock.Lock("registerByOauth")
  276. defer Lock.UnLock("registerByOauth")
  277. ut := AllService.OauthService.UserThirdInfo(op, oauthUser.OpenId)
  278. if ut.Id != 0 {
  279. return nil, us.InfoById(ut.UserId)
  280. }
  281. err, oauthType := AllService.OauthService.GetTypeByOp(op)
  282. if err != nil {
  283. return err, nil
  284. }
  285. //check if this email has been registered
  286. email := oauthUser.Email
  287. // only email is not empty
  288. if email != "" {
  289. email = strings.ToLower(email)
  290. // update email to oauthUser, in case it contain upper case
  291. oauthUser.Email = email
  292. // call this, if find user by email, it will update the email to local database
  293. user, ldapErr := AllService.LdapService.GetUserInfoByEmailLocal(email)
  294. // If we enable ldap, and the error is not ErrLdapUserNotFound, return the error because we could not sure if the user is not found in ldap
  295. if !(errors.Is(ldapErr, ErrLdapNotEnabled) || errors.Is(ldapErr, ErrLdapUserNotFound) || ldapErr == nil) {
  296. return ldapErr, user
  297. }
  298. if user.Id == 0 {
  299. // this means the user is not found in ldap, maybe ldao is not enabled
  300. user = us.InfoByEmail(email)
  301. }
  302. if user.Id != 0 {
  303. ut.FromOauthUser(user.Id, oauthUser, oauthType, op)
  304. DB.Create(ut)
  305. return nil, user
  306. }
  307. }
  308. tx := DB.Begin()
  309. ut = &model.UserThird{}
  310. ut.FromOauthUser(0, oauthUser, oauthType, op)
  311. // The initial username should be formatted
  312. username := us.formatUsername(oauthUser.Username)
  313. usernameUnique := us.GenerateUsernameByOauth(username)
  314. user := &model.User{
  315. Username: usernameUnique,
  316. GroupId: 1,
  317. }
  318. oauthUser.ToUser(user, false)
  319. tx.Create(user)
  320. if user.Id == 0 {
  321. tx.Rollback()
  322. return errors.New("OauthRegisterFailed"), user
  323. }
  324. ut.UserId = user.Id
  325. tx.Create(ut)
  326. tx.Commit()
  327. return nil, user
  328. }
  329. // GenerateUsernameByOauth 生成用户名
  330. func (us *UserService) GenerateUsernameByOauth(name string) string {
  331. for us.IsUsernameExists(name) {
  332. name += strconv.Itoa(rand.Intn(10)) // Append a random digit (0-9)
  333. }
  334. return name
  335. }
  336. // UserThirdsByUserId
  337. func (us *UserService) UserThirdsByUserId(userId uint) (res []*model.UserThird) {
  338. DB.Where("user_id = ?", userId).Find(&res)
  339. return res
  340. }
  341. func (us *UserService) UserThirdInfo(userId uint, op string) *model.UserThird {
  342. ut := &model.UserThird{}
  343. DB.Where("user_id = ? and op = ?", userId, op).First(ut)
  344. return ut
  345. }
  346. // FindLatestUserIdFromLoginLogByUuid 根据uuid查找最后登录的用户id
  347. func (us *UserService) FindLatestUserIdFromLoginLogByUuid(uuid string) uint {
  348. llog := &model.LoginLog{}
  349. DB.Where("uuid = ?", uuid).Order("id desc").First(llog)
  350. return llog.UserId
  351. }
  352. // IsPasswordEmptyById 根据用户id判断密码是否为空,主要用于第三方登录的自动注册
  353. func (us *UserService) IsPasswordEmptyById(id uint) bool {
  354. u := &model.User{}
  355. if DB.Where("id = ?", id).First(u).Error != nil {
  356. return false
  357. }
  358. return u.Password == ""
  359. }
  360. // IsPasswordEmptyByUsername 根据用户id判断密码是否为空,主要用于第三方登录的自动注册
  361. func (us *UserService) IsPasswordEmptyByUsername(username string) bool {
  362. u := &model.User{}
  363. if DB.Where("username = ?", username).First(u).Error != nil {
  364. return false
  365. }
  366. return u.Password == ""
  367. }
  368. // IsPasswordEmptyByUser 判断密码是否为空,主要用于第三方登录的自动注册
  369. func (us *UserService) IsPasswordEmptyByUser(u *model.User) bool {
  370. return us.IsPasswordEmptyById(u.Id)
  371. }
  372. // Register 注册, 如果用户名已存在则返回nil
  373. func (us *UserService) Register(username string, email string, password string, status model.StatusCode) *model.User {
  374. u := &model.User{
  375. Username: username,
  376. Email: email,
  377. Password: password,
  378. GroupId: 1,
  379. Status: status,
  380. }
  381. err := us.Create(u)
  382. if err != nil {
  383. return nil
  384. }
  385. return u
  386. }
  387. func (us *UserService) TokenList(page uint, size uint, f func(tx *gorm.DB)) *model.UserTokenList {
  388. res := &model.UserTokenList{}
  389. res.Page = int64(page)
  390. res.PageSize = int64(size)
  391. tx := DB.Model(&model.UserToken{})
  392. if f != nil {
  393. f(tx)
  394. }
  395. tx.Count(&res.Total)
  396. tx.Scopes(Paginate(page, size))
  397. tx.Find(&res.UserTokens)
  398. return res
  399. }
  400. func (us *UserService) TokenInfoById(id uint) *model.UserToken {
  401. ut := &model.UserToken{}
  402. DB.Where("id = ?", id).First(ut)
  403. return ut
  404. }
  405. func (us *UserService) DeleteToken(l *model.UserToken) error {
  406. return DB.Delete(l).Error
  407. }
  408. // Helper functions, used for formatting username
  409. func (us *UserService) formatUsername(username string) string {
  410. username = strings.ReplaceAll(username, " ", "")
  411. username = strings.ToLower(username)
  412. return username
  413. }
  414. // Helper functions, getUserCount
  415. func (us *UserService) getUserCount() int64 {
  416. var count int64
  417. DB.Model(&model.User{}).Count(&count)
  418. return count
  419. }
  420. // helper functions, getAdminUserCount
  421. func (us *UserService) getAdminUserCount() int64 {
  422. var count int64
  423. DB.Model(&model.User{}).Where("is_admin = ?", true).Count(&count)
  424. return count
  425. }
  426. // UserTokenExpireTimestamp 生成用户token过期时间
  427. func (us *UserService) UserTokenExpireTimestamp() int64 {
  428. exp := Config.App.TokenExpire
  429. if exp == 0 {
  430. //默认七天
  431. exp = 604800
  432. }
  433. return time.Now().Add(exp).Unix()
  434. }
  435. func (us *UserService) RefreshAccessToken(ut *model.UserToken) {
  436. ut.ExpiredAt = us.UserTokenExpireTimestamp()
  437. DB.Model(ut).Update("expired_at", ut.ExpiredAt)
  438. }
  439. func (us *UserService) AutoRefreshAccessToken(ut *model.UserToken) {
  440. if ut.ExpiredAt-time.Now().Unix() < 86400 {
  441. us.RefreshAccessToken(ut)
  442. }
  443. }
  444. func (us *UserService) BatchDeleteUserToken(ids []uint) error {
  445. return DB.Where("id in ?", ids).Delete(&model.UserToken{}).Error
  446. }
  447. func (us *UserService) VerifyJWT(token string) (uint, error) {
  448. return Jwt.ParseToken(token)
  449. }
  450. // IsUsernameExists 判断用户名是否存在, it will check the internal database and LDAP(if enabled)
  451. func (us *UserService) IsUsernameExists(username string) bool {
  452. return us.IsUsernameExistsLocal(username) || AllService.LdapService.IsUsernameExists(username)
  453. }
  454. func (us *UserService) IsUsernameExistsLocal(username string) bool {
  455. u := &model.User{}
  456. DB.Where("username = ?", username).First(u)
  457. return u.Id != 0
  458. }
  459. func (us *UserService) IsEmailExistsLdap(email string) bool {
  460. return AllService.LdapService.IsEmailExists(email)
  461. }