migrate.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601
  1. package migrate
  2. import (
  3. "context"
  4. "encoding/json"
  5. "fmt"
  6. "log"
  7. "os"
  8. "time"
  9. "golang.org/x/exp/slog"
  10. "gorm.io/datatypes"
  11. "github.com/google/uuid"
  12. "github.com/gravitl/netmaker/database"
  13. "github.com/gravitl/netmaker/db"
  14. "github.com/gravitl/netmaker/logger"
  15. "github.com/gravitl/netmaker/logic"
  16. "github.com/gravitl/netmaker/logic/acls"
  17. "github.com/gravitl/netmaker/models"
  18. "github.com/gravitl/netmaker/mq"
  19. "github.com/gravitl/netmaker/schema"
  20. "github.com/gravitl/netmaker/servercfg"
  21. )
  22. // Run - runs all migrations
  23. func Run() {
  24. settings()
  25. updateEnrollmentKeys()
  26. assignSuperAdmin()
  27. createDefaultTagsAndPolicies()
  28. removeOldUserGrps()
  29. migrateToUUIDs()
  30. syncUsers()
  31. updateHosts()
  32. updateNodes()
  33. updateAcls()
  34. logic.MigrateToGws()
  35. migrateToEgressV1()
  36. }
  37. func assignSuperAdmin() {
  38. users, err := logic.GetUsers()
  39. if err != nil || len(users) == 0 {
  40. return
  41. }
  42. if ok, _ := logic.HasSuperAdmin(); ok {
  43. return
  44. }
  45. createdSuperAdmin := false
  46. owner := servercfg.GetOwnerEmail()
  47. if owner != "" {
  48. user, err := logic.GetUser(owner)
  49. if err != nil {
  50. log.Fatal("error getting user", "user", owner, "error", err.Error())
  51. }
  52. user.PlatformRoleID = models.SuperAdminRole
  53. err = logic.UpsertUser(*user)
  54. if err != nil {
  55. log.Fatal(
  56. "error updating user to superadmin",
  57. "user",
  58. user.UserName,
  59. "error",
  60. err.Error(),
  61. )
  62. }
  63. return
  64. }
  65. for _, u := range users {
  66. if u.IsAdmin {
  67. user, err := logic.GetUser(u.UserName)
  68. if err != nil {
  69. slog.Error("error getting user", "user", u.UserName, "error", err.Error())
  70. continue
  71. }
  72. user.PlatformRoleID = models.SuperAdminRole
  73. user.IsSuperAdmin = true
  74. err = logic.UpsertUser(*user)
  75. if err != nil {
  76. slog.Error(
  77. "error updating user to superadmin",
  78. "user",
  79. user.UserName,
  80. "error",
  81. err.Error(),
  82. )
  83. continue
  84. } else {
  85. createdSuperAdmin = true
  86. }
  87. break
  88. }
  89. }
  90. if !createdSuperAdmin {
  91. slog.Error("failed to create superadmin!!")
  92. }
  93. }
  94. func updateEnrollmentKeys() {
  95. rows, err := database.FetchRecords(database.ENROLLMENT_KEYS_TABLE_NAME)
  96. if err != nil {
  97. return
  98. }
  99. for _, row := range rows {
  100. var key models.EnrollmentKey
  101. if err = json.Unmarshal([]byte(row), &key); err != nil {
  102. continue
  103. }
  104. if key.Type != models.Undefined {
  105. logger.Log(2, "migration: enrollment key type already set")
  106. continue
  107. } else {
  108. logger.Log(2, "migration: updating enrollment key type")
  109. if key.Unlimited {
  110. key.Type = models.Unlimited
  111. } else if key.UsesRemaining > 0 {
  112. key.Type = models.Uses
  113. } else if !key.Expiration.IsZero() {
  114. key.Type = models.TimeExpiration
  115. }
  116. }
  117. data, err := json.Marshal(key)
  118. if err != nil {
  119. logger.Log(0, "migration: marshalling enrollment key: "+err.Error())
  120. continue
  121. }
  122. if err = database.Insert(key.Value, string(data), database.ENROLLMENT_KEYS_TABLE_NAME); err != nil {
  123. logger.Log(0, "migration: inserting enrollment key: "+err.Error())
  124. continue
  125. }
  126. }
  127. existingKeys, err := logic.GetAllEnrollmentKeys()
  128. if err != nil {
  129. return
  130. }
  131. // check if any tags are duplicate
  132. existingTags := make(map[string]struct{})
  133. for _, existingKey := range existingKeys {
  134. for _, t := range existingKey.Tags {
  135. existingTags[t] = struct{}{}
  136. }
  137. }
  138. networks, _ := logic.GetNetworks()
  139. for _, network := range networks {
  140. if _, ok := existingTags[network.NetID]; ok {
  141. continue
  142. }
  143. _, _ = logic.CreateEnrollmentKey(
  144. 0,
  145. time.Time{},
  146. []string{network.NetID},
  147. []string{network.NetID},
  148. []models.TagID{},
  149. true,
  150. uuid.Nil,
  151. true,
  152. false,
  153. )
  154. }
  155. }
  156. func removeOldUserGrps() {
  157. rows, err := database.FetchRecords(database.USER_GROUPS_TABLE_NAME)
  158. if err != nil {
  159. return
  160. }
  161. for key, row := range rows {
  162. userG := models.UserGroup{}
  163. _ = json.Unmarshal([]byte(row), &userG)
  164. if userG.ID == "" {
  165. database.DeleteRecord(database.USER_GROUPS_TABLE_NAME, key)
  166. }
  167. }
  168. }
  169. func updateHosts() {
  170. rows, err := database.FetchRecords(database.HOSTS_TABLE_NAME)
  171. if err != nil {
  172. logger.Log(0, "failed to fetch database records for hosts")
  173. }
  174. for _, row := range rows {
  175. var host models.Host
  176. if err := json.Unmarshal([]byte(row), &host); err != nil {
  177. logger.Log(0, "failed to unmarshal database row to host", "row", row)
  178. continue
  179. }
  180. if host.PersistentKeepalive == 0 {
  181. host.PersistentKeepalive = models.DefaultPersistentKeepAlive
  182. if err := logic.UpsertHost(&host); err != nil {
  183. logger.Log(0, "failed to upsert host", host.ID.String())
  184. continue
  185. }
  186. }
  187. if host.DNS == "" || (host.DNS != "yes" && host.DNS != "no") {
  188. if logic.GetServerSettings().ManageDNS {
  189. host.DNS = "yes"
  190. } else {
  191. host.DNS = "no"
  192. }
  193. logic.UpsertHost(&host)
  194. }
  195. if servercfg.IsPro && host.Location == "" {
  196. if host.EndpointIP != nil {
  197. host.Location = logic.GetHostLocInfo(host.EndpointIP.String(), os.Getenv("IP_INFO_TOKEN"))
  198. } else if host.EndpointIPv6 != nil {
  199. host.Location = logic.GetHostLocInfo(host.EndpointIPv6.String(), os.Getenv("IP_INFO_TOKEN"))
  200. }
  201. if host.Location != "" {
  202. logic.UpsertHost(&host)
  203. }
  204. }
  205. }
  206. }
  207. func updateNodes() {
  208. nodes, err := logic.GetAllNodes()
  209. if err != nil {
  210. slog.Error("migration failed for nodes", "error", err)
  211. return
  212. }
  213. for _, node := range nodes {
  214. node := node
  215. if node.Tags == nil {
  216. node.Tags = make(map[models.TagID]struct{})
  217. logic.UpsertNode(&node)
  218. }
  219. if node.IsIngressGateway {
  220. host, err := logic.GetHost(node.HostID.String())
  221. if err == nil {
  222. go logic.DeleteRole(models.GetRAGRoleID(node.Network, host.ID.String()), true)
  223. }
  224. }
  225. if node.IsEgressGateway {
  226. egressRanges, update := removeInterGw(node.EgressGatewayRanges)
  227. if update {
  228. node.EgressGatewayRequest.Ranges = egressRanges
  229. node.EgressGatewayRanges = egressRanges
  230. logic.UpsertNode(&node)
  231. }
  232. if len(node.EgressGatewayRequest.Ranges) > 0 && len(node.EgressGatewayRequest.RangesWithMetric) == 0 {
  233. for _, egressRangeI := range node.EgressGatewayRequest.Ranges {
  234. node.EgressGatewayRequest.RangesWithMetric = append(node.EgressGatewayRequest.RangesWithMetric, models.EgressRangeMetric{
  235. Network: egressRangeI,
  236. RouteMetric: 256,
  237. })
  238. }
  239. logic.UpsertNode(&node)
  240. }
  241. }
  242. }
  243. extclients, _ := logic.GetAllExtClients()
  244. for _, extclient := range extclients {
  245. if extclient.Tags == nil {
  246. extclient.Tags = make(map[models.TagID]struct{})
  247. logic.SaveExtClient(&extclient)
  248. }
  249. }
  250. }
  251. func removeInterGw(egressRanges []string) ([]string, bool) {
  252. update := false
  253. for i := len(egressRanges) - 1; i >= 0; i-- {
  254. if egressRanges[i] == "0.0.0.0/0" || egressRanges[i] == "::/0" {
  255. update = true
  256. egressRanges = append(egressRanges[:i], egressRanges[i+1:]...)
  257. }
  258. }
  259. return egressRanges, update
  260. }
  261. func updateAcls() {
  262. // get all networks
  263. networks, err := logic.GetNetworks()
  264. if err != nil && !database.IsEmptyRecord(err) {
  265. slog.Error("acls migration failed. error getting networks", "error", err)
  266. return
  267. }
  268. // get current acls per network
  269. for _, network := range networks {
  270. var networkAcl acls.ACLContainer
  271. networkAcl, err := networkAcl.Get(acls.ContainerID(network.NetID))
  272. if err != nil {
  273. if database.IsEmptyRecord(err) {
  274. continue
  275. }
  276. slog.Error(fmt.Sprintf("error during acls migration. error getting acls for network: %s", network.NetID), "error", err)
  277. continue
  278. }
  279. // convert old acls to new acls with clients
  280. // TODO: optimise O(n^2) operation
  281. clients, err := logic.GetNetworkExtClients(network.NetID)
  282. if err != nil {
  283. slog.Error(fmt.Sprintf("error during acls migration. error getting clients for network: %s", network.NetID), "error", err)
  284. continue
  285. }
  286. clientsIdMap := make(map[string]struct{})
  287. for _, client := range clients {
  288. clientsIdMap[client.ClientID] = struct{}{}
  289. }
  290. nodeIdsMap := make(map[string]struct{})
  291. for nodeId := range networkAcl {
  292. nodeIdsMap[string(nodeId)] = struct{}{}
  293. }
  294. /*
  295. initially, networkACL has only node acls so we add client acls to it
  296. final shape:
  297. {
  298. "node1": {
  299. "node2": 2,
  300. "client1": 2,
  301. "client2": 1,
  302. },
  303. "node2": {
  304. "node1": 2,
  305. "client1": 2,
  306. "client2": 1,
  307. },
  308. "client1": {
  309. "node1": 2,
  310. "node2": 2,
  311. "client2": 1,
  312. },
  313. "client2": {
  314. "node1": 1,
  315. "node2": 1,
  316. "client1": 1,
  317. },
  318. }
  319. */
  320. for _, client := range clients {
  321. networkAcl[acls.AclID(client.ClientID)] = acls.ACL{}
  322. // add client values to node acls and create client acls with node values
  323. for id, nodeAcl := range networkAcl {
  324. // skip if not a node
  325. if _, ok := nodeIdsMap[string(id)]; !ok {
  326. continue
  327. }
  328. if nodeAcl == nil {
  329. slog.Warn("acls migration bad data: nil node acl", "node", id, "network", network.NetID)
  330. continue
  331. }
  332. nodeAcl[acls.AclID(client.ClientID)] = acls.Allowed
  333. networkAcl[acls.AclID(client.ClientID)][id] = acls.Allowed
  334. if client.DeniedACLs == nil {
  335. continue
  336. } else if _, ok := client.DeniedACLs[string(id)]; ok {
  337. nodeAcl[acls.AclID(client.ClientID)] = acls.NotAllowed
  338. networkAcl[acls.AclID(client.ClientID)][id] = acls.NotAllowed
  339. }
  340. }
  341. // add clients to client acls response
  342. for _, c := range clients {
  343. if c.ClientID == client.ClientID {
  344. continue
  345. }
  346. networkAcl[acls.AclID(client.ClientID)][acls.AclID(c.ClientID)] = acls.Allowed
  347. if client.DeniedACLs == nil {
  348. continue
  349. } else if _, ok := client.DeniedACLs[c.ClientID]; ok {
  350. networkAcl[acls.AclID(client.ClientID)][acls.AclID(c.ClientID)] = acls.NotAllowed
  351. }
  352. }
  353. // delete oneself from its own acl
  354. delete(networkAcl[acls.AclID(client.ClientID)], acls.AclID(client.ClientID))
  355. }
  356. // remove non-existent client and node acls
  357. for objId := range networkAcl {
  358. if _, ok := nodeIdsMap[string(objId)]; ok {
  359. continue
  360. }
  361. if _, ok := clientsIdMap[string(objId)]; ok {
  362. continue
  363. }
  364. // remove all occurances of objId from all acls
  365. for objId2 := range networkAcl {
  366. delete(networkAcl[objId2], objId)
  367. }
  368. delete(networkAcl, objId)
  369. }
  370. // save new acls
  371. slog.Debug(fmt.Sprintf("(migration) saving new acls for network: %s", network.NetID), "networkAcl", networkAcl)
  372. if _, err := networkAcl.Save(acls.ContainerID(network.NetID)); err != nil {
  373. slog.Error(fmt.Sprintf("error during acls migration. error saving new acls for network: %s", network.NetID), "error", err)
  374. continue
  375. }
  376. slog.Info(fmt.Sprintf("(migration) successfully saved new acls for network: %s", network.NetID))
  377. }
  378. }
  379. func MigrateEmqx() {
  380. err := mq.SendPullSYN()
  381. if err != nil {
  382. logger.Log(0, "failed to send pull syn to clients", "error", err.Error())
  383. }
  384. time.Sleep(time.Second * 3)
  385. slog.Info("proceeding to kicking out clients from emqx")
  386. err = mq.KickOutClients()
  387. if err != nil {
  388. logger.Log(2, "failed to migrate emqx: ", "kickout-error", err.Error())
  389. }
  390. }
  391. func migrateToUUIDs() {
  392. logic.MigrateToUUIDs()
  393. }
  394. func syncUsers() {
  395. // create default network user roles for existing networks
  396. if servercfg.IsPro {
  397. networks, _ := logic.GetNetworks()
  398. for _, netI := range networks {
  399. logic.CreateDefaultNetworkRolesAndGroups(models.NetworkID(netI.NetID))
  400. }
  401. }
  402. users, err := logic.GetUsersDB()
  403. if err == nil {
  404. for _, user := range users {
  405. user := user
  406. if user.PlatformRoleID == models.AdminRole && !user.IsAdmin {
  407. user.IsAdmin = true
  408. logic.UpsertUser(user)
  409. }
  410. if user.PlatformRoleID == models.SuperAdminRole && !user.IsSuperAdmin {
  411. user.IsSuperAdmin = true
  412. }
  413. if user.PlatformRoleID.String() != "" {
  414. logic.MigrateUserRoleAndGroups(user)
  415. logic.AddGlobalNetRolesToAdmins(&user)
  416. logic.UpsertUser(user)
  417. continue
  418. }
  419. user.AuthType = models.BasicAuth
  420. if logic.IsOauthUser(&user) == nil {
  421. user.AuthType = models.OAuth
  422. }
  423. if len(user.NetworkRoles) == 0 {
  424. user.NetworkRoles = make(map[models.NetworkID]map[models.UserRoleID]struct{})
  425. }
  426. if len(user.UserGroups) == 0 {
  427. user.UserGroups = make(map[models.UserGroupID]struct{})
  428. }
  429. if user.IsSuperAdmin {
  430. user.PlatformRoleID = models.SuperAdminRole
  431. } else if user.IsAdmin {
  432. user.PlatformRoleID = models.AdminRole
  433. } else {
  434. user.PlatformRoleID = models.ServiceUser
  435. }
  436. logic.AddGlobalNetRolesToAdmins(&user)
  437. logic.MigrateUserRoleAndGroups(user)
  438. logic.UpsertUser(user)
  439. }
  440. }
  441. }
  442. func createDefaultTagsAndPolicies() {
  443. networks, err := logic.GetNetworks()
  444. if err != nil {
  445. return
  446. }
  447. for _, network := range networks {
  448. logic.CreateDefaultTags(models.NetworkID(network.NetID))
  449. logic.CreateDefaultAclNetworkPolicies(models.NetworkID(network.NetID))
  450. // delete old remote access gws policy
  451. logic.DeleteAcl(models.Acl{ID: fmt.Sprintf("%s.%s", network.NetID, "all-remote-access-gws")})
  452. }
  453. logic.MigrateAclPolicies()
  454. }
  455. func migrateToEgressV1() {
  456. nodes, _ := logic.GetAllNodes()
  457. user, err := logic.GetSuperAdmin()
  458. if err != nil {
  459. return
  460. }
  461. for _, node := range nodes {
  462. if node.IsEgressGateway {
  463. egressHost, err := logic.GetHost(node.HostID.String())
  464. if err != nil {
  465. continue
  466. }
  467. for _, rangeI := range node.EgressGatewayRequest.Ranges {
  468. e := schema.Egress{
  469. ID: uuid.New().String(),
  470. Name: fmt.Sprintf("%s egress", egressHost.Name),
  471. Description: "",
  472. Network: node.Network,
  473. Nodes: datatypes.JSONMap{
  474. node.ID.String(): 256,
  475. },
  476. Tags: make(datatypes.JSONMap),
  477. Range: rangeI,
  478. Nat: node.EgressGatewayRequest.NatEnabled == "yes",
  479. Status: true,
  480. CreatedBy: user.UserName,
  481. CreatedAt: time.Now().UTC(),
  482. }
  483. err = e.Create(db.WithContext(context.TODO()))
  484. if err == nil {
  485. acl := models.Acl{
  486. ID: uuid.New().String(),
  487. Name: "egress node policy",
  488. MetaData: "",
  489. Default: false,
  490. ServiceType: models.Any,
  491. NetworkID: models.NetworkID(node.Network),
  492. Proto: models.ALL,
  493. RuleType: models.DevicePolicy,
  494. Src: []models.AclPolicyTag{
  495. {
  496. ID: models.NodeTagID,
  497. Value: "*",
  498. },
  499. },
  500. Dst: []models.AclPolicyTag{
  501. {
  502. ID: models.EgressID,
  503. Value: e.ID,
  504. },
  505. },
  506. AllowedDirection: models.TrafficDirectionBi,
  507. Enabled: true,
  508. CreatedBy: "auto",
  509. CreatedAt: time.Now().UTC(),
  510. }
  511. logic.InsertAcl(acl)
  512. acl = models.Acl{
  513. ID: uuid.New().String(),
  514. Name: "egress node policy",
  515. MetaData: "",
  516. Default: false,
  517. ServiceType: models.Any,
  518. NetworkID: models.NetworkID(node.Network),
  519. Proto: models.ALL,
  520. RuleType: models.UserPolicy,
  521. Src: []models.AclPolicyTag{
  522. {
  523. ID: models.UserAclID,
  524. Value: "*",
  525. },
  526. },
  527. Dst: []models.AclPolicyTag{
  528. {
  529. ID: models.EgressID,
  530. Value: e.ID,
  531. },
  532. },
  533. AllowedDirection: models.TrafficDirectionBi,
  534. Enabled: true,
  535. CreatedBy: "auto",
  536. CreatedAt: time.Now().UTC(),
  537. }
  538. logic.InsertAcl(acl)
  539. }
  540. }
  541. node.IsEgressGateway = false
  542. node.EgressGatewayRequest = models.EgressGatewayRequest{}
  543. node.EgressGatewayNatEnabled = false
  544. node.EgressGatewayRanges = []string{}
  545. logic.UpsertNode(&node)
  546. }
  547. }
  548. }
  549. func settings() {
  550. _, err := database.FetchRecords(database.SERVER_SETTINGS)
  551. if database.IsEmptyRecord(err) {
  552. logic.UpsertServerSettings(logic.GetServerSettingsFromEnv())
  553. }
  554. settings := logic.GetServerSettings()
  555. if settings.AuditLogsRetentionPeriodInDays == 0 {
  556. settings.AuditLogsRetentionPeriodInDays = 7
  557. }
  558. if settings.DefaultDomain == "" {
  559. settings.DefaultDomain = servercfg.GetDefaultDomain()
  560. }
  561. logic.UpsertServerSettings(settings)
  562. }