auth.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528
  1. package logic
  2. import (
  3. "context"
  4. "encoding/base64"
  5. "encoding/json"
  6. "errors"
  7. "fmt"
  8. "time"
  9. "github.com/gravitl/netmaker/db"
  10. "github.com/gravitl/netmaker/schema"
  11. "github.com/go-playground/validator/v10"
  12. "golang.org/x/crypto/bcrypt"
  13. "golang.org/x/exp/slog"
  14. "github.com/gravitl/netmaker/database"
  15. "github.com/gravitl/netmaker/logger"
  16. "github.com/gravitl/netmaker/models"
  17. )
  18. const (
  19. auth_key = "netmaker_auth"
  20. )
  21. const (
  22. DashboardApp = "dashboard"
  23. NetclientApp = "netclient"
  24. NetmakerDesktopApp = "netmaker-desktop"
  25. )
  26. var (
  27. superUser = models.User{}
  28. )
  29. func ClearSuperUserCache() {
  30. superUser = models.User{}
  31. }
  32. var ResetAuthProvider = func() {}
  33. var ResetIDPSyncHook = func() {}
  34. // HasSuperAdmin - checks if server has an superadmin/owner
  35. func HasSuperAdmin() (bool, error) {
  36. if superUser.IsSuperAdmin {
  37. return true, nil
  38. }
  39. collection, err := database.FetchRecords(database.USERS_TABLE_NAME)
  40. if err != nil {
  41. if database.IsEmptyRecord(err) {
  42. return false, nil
  43. } else {
  44. return true, err
  45. }
  46. }
  47. for _, value := range collection { // filter for isadmin true
  48. var user models.User
  49. err = json.Unmarshal([]byte(value), &user)
  50. if err != nil {
  51. continue
  52. }
  53. if user.PlatformRoleID == models.SuperAdminRole || user.IsSuperAdmin {
  54. return true, nil
  55. }
  56. }
  57. return false, err
  58. }
  59. // GetUsersDB - gets users
  60. func GetUsersDB() ([]models.User, error) {
  61. var users []models.User
  62. collection, err := database.FetchRecords(database.USERS_TABLE_NAME)
  63. if err != nil {
  64. return users, err
  65. }
  66. for _, value := range collection {
  67. var user models.User
  68. err = json.Unmarshal([]byte(value), &user)
  69. if err != nil {
  70. continue // get users
  71. }
  72. users = append(users, user)
  73. }
  74. return users, err
  75. }
  76. // GetUsers - gets users
  77. func GetUsers() ([]models.ReturnUser, error) {
  78. var users []models.ReturnUser
  79. collection, err := database.FetchRecords(database.USERS_TABLE_NAME)
  80. if err != nil {
  81. return users, err
  82. }
  83. for _, value := range collection {
  84. var user models.ReturnUser
  85. err = json.Unmarshal([]byte(value), &user)
  86. if err != nil {
  87. continue // get users
  88. }
  89. users = append(users, user)
  90. }
  91. return users, err
  92. }
  93. // IsOauthUser - returns
  94. func IsOauthUser(user *models.User) error {
  95. var currentValue, err = FetchPassValue("")
  96. if err != nil {
  97. return err
  98. }
  99. var bCryptErr = bcrypt.CompareHashAndPassword([]byte(user.Password), []byte(currentValue))
  100. return bCryptErr
  101. }
  102. func FetchPassValue(newValue string) (string, error) {
  103. type valueHolder struct {
  104. Value string `json:"value" bson:"value"`
  105. }
  106. newValueHolder := valueHolder{}
  107. var currentValue, err = FetchAuthSecret()
  108. if err != nil {
  109. return "", err
  110. }
  111. var unmarshErr = json.Unmarshal([]byte(currentValue), &newValueHolder)
  112. if unmarshErr != nil {
  113. return "", unmarshErr
  114. }
  115. var b64CurrentValue, b64Err = base64.StdEncoding.DecodeString(newValueHolder.Value)
  116. if b64Err != nil {
  117. logger.Log(0, "could not decode pass")
  118. return "", nil
  119. }
  120. return string(b64CurrentValue), nil
  121. }
  122. // CreateUser - creates a user
  123. func CreateUser(user *models.User) error {
  124. // check if user exists
  125. if _, err := GetUser(user.UserName); err == nil {
  126. return errors.New("user exists")
  127. }
  128. SetUserDefaults(user)
  129. if err := IsGroupsValid(user.UserGroups); err != nil {
  130. return errors.New("invalid groups: " + err.Error())
  131. }
  132. if err := IsNetworkRolesValid(user.NetworkRoles); err != nil {
  133. return errors.New("invalid network roles: " + err.Error())
  134. }
  135. var err = ValidateUser(user)
  136. if err != nil {
  137. logger.Log(0, "failed to validate user", err.Error())
  138. return err
  139. }
  140. // encrypt that password so we never see it again
  141. hash, err := bcrypt.GenerateFromPassword([]byte(user.Password), 5)
  142. if err != nil {
  143. logger.Log(0, "error encrypting pass", err.Error())
  144. return err
  145. }
  146. // set password to encrypted password
  147. user.Password = string(hash)
  148. user.AuthType = models.BasicAuth
  149. if IsOauthUser(user) == nil {
  150. user.AuthType = models.OAuth
  151. }
  152. AddGlobalNetRolesToAdmins(user)
  153. // create user will always be called either from API or Dashboard.
  154. _, err = CreateUserJWT(user.UserName, user.PlatformRoleID, DashboardApp)
  155. if err != nil {
  156. logger.Log(0, "failed to generate token", err.Error())
  157. return err
  158. }
  159. // connect db
  160. data, err := json.Marshal(user)
  161. if err != nil {
  162. logger.Log(0, "failed to marshal", err.Error())
  163. return err
  164. }
  165. err = database.Insert(user.UserName, string(data), database.USERS_TABLE_NAME)
  166. if err != nil {
  167. logger.Log(0, "failed to insert user", err.Error())
  168. return err
  169. }
  170. return nil
  171. }
  172. // CreateSuperAdmin - creates an super admin user
  173. func CreateSuperAdmin(u *models.User) error {
  174. hassuperadmin, err := HasSuperAdmin()
  175. if err != nil {
  176. return err
  177. }
  178. if hassuperadmin {
  179. return errors.New("superadmin user already exists")
  180. }
  181. u.PlatformRoleID = models.SuperAdminRole
  182. return CreateUser(u)
  183. }
  184. // VerifyAuthRequest - verifies an auth request
  185. func VerifyAuthRequest(authRequest models.UserAuthParams, appName string) (string, error) {
  186. var result models.User
  187. if authRequest.UserName == "" {
  188. return "", errors.New("username can't be empty")
  189. } else if authRequest.Password == "" {
  190. return "", errors.New("password can't be empty")
  191. }
  192. // Search DB for node with Mac Address. Ignore pending nodes (they should not be able to authenticate with API until approved).
  193. record, err := database.FetchRecord(database.USERS_TABLE_NAME, authRequest.UserName)
  194. if err != nil {
  195. return "", errors.New("incorrect credentials")
  196. }
  197. if err = json.Unmarshal([]byte(record), &result); err != nil {
  198. return "", errors.New("error unmarshalling user json: " + err.Error())
  199. }
  200. // compare password from request to stored password in database
  201. // might be able to have a common hash (certificates?) and compare those so that a password isn't passed in in plain text...
  202. // TODO: Consider a way of hashing the password client side before sending, or using certificates
  203. if err = bcrypt.CompareHashAndPassword([]byte(result.Password), []byte(authRequest.Password)); err != nil {
  204. return "", errors.New("incorrect credentials")
  205. }
  206. if result.IsMFAEnabled {
  207. tokenString, err := CreatePreAuthToken(authRequest.UserName)
  208. if err != nil {
  209. slog.Error("error creating jwt", "error", err)
  210. return "", err
  211. }
  212. return tokenString, nil
  213. } else {
  214. // Create a new JWT for the node
  215. tokenString, err := CreateUserJWT(authRequest.UserName, result.PlatformRoleID, appName)
  216. if err != nil {
  217. slog.Error("error creating jwt", "error", err)
  218. return "", err
  219. }
  220. // update last login time
  221. result.LastLoginTime = time.Now().UTC()
  222. err = UpsertUser(result)
  223. if err != nil {
  224. slog.Error("error upserting user", "error", err)
  225. return "", err
  226. }
  227. return tokenString, nil
  228. }
  229. }
  230. // UpsertUser - updates user in the db
  231. func UpsertUser(user models.User) error {
  232. data, err := json.Marshal(&user)
  233. if err != nil {
  234. slog.Error("error marshalling user", "user", user.UserName, "error", err.Error())
  235. return err
  236. }
  237. if err = database.Insert(user.UserName, string(data), database.USERS_TABLE_NAME); err != nil {
  238. slog.Error("error inserting user", "user", user.UserName, "error", err.Error())
  239. return err
  240. }
  241. if user.IsSuperAdmin {
  242. superUser = user
  243. }
  244. return nil
  245. }
  246. // UpdateUser - updates a given user
  247. func UpdateUser(userchange, user *models.User) (*models.User, error) {
  248. // check if user exists
  249. if _, err := GetUser(user.UserName); err != nil {
  250. return &models.User{}, err
  251. }
  252. queryUser := user.UserName
  253. if userchange.UserName != "" && user.UserName != userchange.UserName {
  254. // check if username is available
  255. if _, err := GetUser(userchange.UserName); err == nil {
  256. return &models.User{}, errors.New("username exists already")
  257. }
  258. if userchange.UserName == MasterUser {
  259. return &models.User{}, errors.New("username not allowed")
  260. }
  261. user.UserName = userchange.UserName
  262. }
  263. if userchange.Password != "" {
  264. if len(userchange.Password) < 5 {
  265. return &models.User{}, errors.New("password requires min 5 characters")
  266. }
  267. // encrypt that password so we never see it again
  268. hash, err := bcrypt.GenerateFromPassword([]byte(userchange.Password), 5)
  269. if err != nil {
  270. return userchange, err
  271. }
  272. // set password to encrypted password
  273. userchange.Password = string(hash)
  274. user.Password = userchange.Password
  275. }
  276. if err := IsGroupsValid(userchange.UserGroups); err != nil {
  277. return userchange, errors.New("invalid groups: " + err.Error())
  278. }
  279. if err := IsNetworkRolesValid(userchange.NetworkRoles); err != nil {
  280. return userchange, errors.New("invalid network roles: " + err.Error())
  281. }
  282. if userchange.DisplayName != "" {
  283. if user.ExternalIdentityProviderID != "" &&
  284. user.DisplayName != userchange.DisplayName {
  285. return userchange, errors.New("display name cannot be updated for external user")
  286. }
  287. user.DisplayName = userchange.DisplayName
  288. }
  289. if user.ExternalIdentityProviderID != "" &&
  290. userchange.AccountDisabled != user.AccountDisabled {
  291. return userchange, errors.New("account status cannot be updated for external user")
  292. }
  293. // Reset Gw Access for service users
  294. go UpdateUserGwAccess(*user, *userchange)
  295. if userchange.PlatformRoleID != "" {
  296. user.PlatformRoleID = userchange.PlatformRoleID
  297. }
  298. for groupID := range userchange.UserGroups {
  299. _, ok := user.UserGroups[groupID]
  300. if !ok {
  301. group, err := GetUserGroup(groupID)
  302. if err != nil {
  303. return userchange, err
  304. }
  305. if group.ExternalIdentityProviderID != "" {
  306. return userchange, errors.New("cannot modify membership of external groups")
  307. }
  308. }
  309. }
  310. for groupID := range user.UserGroups {
  311. _, ok := userchange.UserGroups[groupID]
  312. if !ok {
  313. group, err := GetUserGroup(groupID)
  314. if err != nil {
  315. return userchange, err
  316. }
  317. if group.ExternalIdentityProviderID != "" {
  318. return userchange, errors.New("cannot modify membership of external groups")
  319. }
  320. }
  321. }
  322. user.IsMFAEnabled = userchange.IsMFAEnabled
  323. if !user.IsMFAEnabled {
  324. user.TOTPSecret = ""
  325. }
  326. user.UserGroups = userchange.UserGroups
  327. user.NetworkRoles = userchange.NetworkRoles
  328. AddGlobalNetRolesToAdmins(user)
  329. err := ValidateUser(user)
  330. if err != nil {
  331. return &models.User{}, err
  332. }
  333. if err = database.DeleteRecord(database.USERS_TABLE_NAME, queryUser); err != nil {
  334. return &models.User{}, err
  335. }
  336. data, err := json.Marshal(&user)
  337. if err != nil {
  338. return &models.User{}, err
  339. }
  340. if err = database.Insert(user.UserName, string(data), database.USERS_TABLE_NAME); err != nil {
  341. return &models.User{}, err
  342. }
  343. logger.Log(1, "updated user", queryUser)
  344. return user, nil
  345. }
  346. // ValidateUser - validates a user model
  347. func ValidateUser(user *models.User) error {
  348. // check if role is valid
  349. _, err := GetRole(user.PlatformRoleID)
  350. if err != nil {
  351. return errors.New("failed to fetch platform role " + user.PlatformRoleID.String())
  352. }
  353. v := validator.New()
  354. _ = v.RegisterValidation("in_charset", func(fl validator.FieldLevel) bool {
  355. isgood := user.NameInCharSet()
  356. return isgood
  357. })
  358. err = v.Struct(user)
  359. if err != nil {
  360. for _, e := range err.(validator.ValidationErrors) {
  361. logger.Log(2, e.Error())
  362. }
  363. }
  364. return err
  365. }
  366. // DeleteUser - deletes a given user
  367. func DeleteUser(user string) error {
  368. if userRecord, err := database.FetchRecord(database.USERS_TABLE_NAME, user); err != nil || len(userRecord) == 0 {
  369. return errors.New("user does not exist")
  370. }
  371. err := database.DeleteRecord(database.USERS_TABLE_NAME, user)
  372. if err != nil {
  373. return err
  374. }
  375. go RemoveUserFromAclPolicy(user)
  376. return (&schema.UserAccessToken{UserName: user}).DeleteAllUserTokens(db.WithContext(context.TODO()))
  377. }
  378. func SetAuthSecret(secret string) error {
  379. type valueHolder struct {
  380. Value string `json:"value" bson:"value"`
  381. }
  382. record, err := FetchAuthSecret()
  383. if err == nil {
  384. v := valueHolder{}
  385. json.Unmarshal([]byte(record), &v)
  386. if v.Value != "" {
  387. return nil
  388. }
  389. }
  390. var b64NewValue = base64.StdEncoding.EncodeToString([]byte(secret))
  391. newValueHolder := valueHolder{
  392. Value: b64NewValue,
  393. }
  394. d, _ := json.Marshal(newValueHolder)
  395. return database.Insert(auth_key, string(d), database.GENERATED_TABLE_NAME)
  396. }
  397. // FetchAuthSecret - manages secrets for oauth
  398. func FetchAuthSecret() (string, error) {
  399. var record, err = database.FetchRecord(database.GENERATED_TABLE_NAME, auth_key)
  400. if err != nil {
  401. return "", err
  402. }
  403. return record, nil
  404. }
  405. // GetState - gets an SsoState from DB, if expired returns error
  406. func GetState(state string) (*models.SsoState, error) {
  407. var s models.SsoState
  408. record, err := database.FetchRecord(database.SSO_STATE_CACHE, state)
  409. if err != nil {
  410. return &s, err
  411. }
  412. if err = json.Unmarshal([]byte(record), &s); err != nil {
  413. return &s, err
  414. }
  415. if s.IsExpired() {
  416. return &s, fmt.Errorf("state expired")
  417. }
  418. return &s, nil
  419. }
  420. // SetState - sets a state with new expiration
  421. func SetState(appName, state string) error {
  422. s := models.SsoState{
  423. AppName: appName,
  424. Value: state,
  425. Expiration: time.Now().Add(models.DefaultExpDuration),
  426. }
  427. data, err := json.Marshal(&s)
  428. if err != nil {
  429. return err
  430. }
  431. return database.Insert(state, string(data), database.SSO_STATE_CACHE)
  432. }
  433. // IsStateValid - checks if given state is valid or not
  434. // deletes state after call is made to clean up, should only be called once per sign-in
  435. func IsStateValid(state string) (string, bool) {
  436. s, err := GetState(state)
  437. if err != nil {
  438. logger.Log(2, "error retrieving oauth state:", err.Error())
  439. return "", false
  440. }
  441. if s.Value != "" {
  442. if err = delState(state); err != nil {
  443. logger.Log(2, "error deleting oauth state:", err.Error())
  444. return "", false
  445. }
  446. }
  447. return s.Value, true
  448. }
  449. // delState - removes a state from cache/db
  450. func delState(state string) error {
  451. return database.DeleteRecord(database.SSO_STATE_CACHE, state)
  452. }