auth.go 13 KB

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