auth.go 13 KB

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