import_host_settings_test.go 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. package service
  2. import (
  3. "testing"
  4. "github.com/mhsanaei/3x-ui/v3/internal/database"
  5. "github.com/mhsanaei/3x-ui/v3/internal/database/model"
  6. )
  7. // An imported database carries the source machine's listen addresses,
  8. // certificates and node identity. Keeping this machine's own values is what
  9. // stops the panel from becoming unreachable on its own address after a restore.
  10. func TestImportKeepsHostBoundSettings(t *testing.T) {
  11. setupConflictDB(t)
  12. db := database.GetDB()
  13. mine := map[string]string{
  14. "webPort": "8443",
  15. "webCertFile": "/etc/ssl/this-host.pem",
  16. "webBasePath": "/mine/",
  17. "subURI": "https://this-host.example/sub/",
  18. "panelGuid": "this-host-guid",
  19. "nodeMtlsClientCertPem": "this-host-leaf",
  20. }
  21. for key, value := range mine {
  22. if err := db.Create(&model.Setting{Key: key, Value: value}).Error; err != nil {
  23. t.Fatalf("seed %s: %v", key, err)
  24. }
  25. }
  26. // A setting that belongs to the configuration, not the machine.
  27. if err := db.Create(&model.Setting{Key: "remarkTemplate", Value: "mine"}).Error; err != nil {
  28. t.Fatal(err)
  29. }
  30. kept := captureHostBoundSettings()
  31. if len(kept.values) != len(mine) {
  32. t.Fatalf("captured %d host settings, want %d: %v", len(kept.values), len(mine), kept.values)
  33. }
  34. // Stand in for the import: every row now holds the source machine's value.
  35. for key := range mine {
  36. if err := db.Model(&model.Setting{}).Where("key = ?", key).
  37. Update("value", "from-imported-file").Error; err != nil {
  38. t.Fatalf("overwrite %s: %v", key, err)
  39. }
  40. }
  41. if err := db.Model(&model.Setting{}).Where("key = ?", "remarkTemplate").
  42. Update("value", "from-imported-file").Error; err != nil {
  43. t.Fatal(err)
  44. }
  45. restoreHostBoundSettings(kept)
  46. for key, want := range mine {
  47. var got model.Setting
  48. if err := db.Where("key = ?", key).First(&got).Error; err != nil {
  49. t.Fatalf("read back %s: %v", key, err)
  50. }
  51. if got.Value != want {
  52. t.Fatalf("setting %s = %q after import, want this machine's %q", key, got.Value, want)
  53. }
  54. }
  55. var carried model.Setting
  56. if err := db.Where("key = ?", "remarkTemplate").First(&carried).Error; err != nil {
  57. t.Fatal(err)
  58. }
  59. if carried.Value != "from-imported-file" {
  60. t.Fatalf("remarkTemplate = %q, want the imported value: only host-bound keys may survive", carried.Value)
  61. }
  62. }
  63. // A certificate path this machine never set must not be inherited from the
  64. // source. Lazily minted material is the opposite case and is covered below.
  65. func TestImportDropsHostBoundSettingsThisMachineNeverHad(t *testing.T) {
  66. setupConflictDB(t)
  67. db := database.GetDB()
  68. kept := captureHostBoundSettings()
  69. for _, key := range []string{"webCertFile", "subCertFile"} {
  70. if err := db.Create(&model.Setting{Key: key, Value: "from-imported-file"}).Error; err != nil {
  71. t.Fatalf("seed imported %s: %v", key, err)
  72. }
  73. }
  74. restoreHostBoundSettings(kept)
  75. for _, key := range []string{"webCertFile", "subCertFile"} {
  76. var count int64
  77. if err := db.Model(&model.Setting{}).Where("key = ?", key).Count(&count).Error; err != nil {
  78. t.Fatal(err)
  79. }
  80. if count != 0 {
  81. t.Fatalf("imported %s survived although this machine had no row for it", key)
  82. }
  83. }
  84. }
  85. // Node mTLS material is minted on demand, so a fresh install has no row and the
  86. // imported copy is the only one there is — including the CA private key (#6227).
  87. func TestImportKeepsLazilyMintedMaterialThisMachineNeverHad(t *testing.T) {
  88. setupConflictDB(t)
  89. db := database.GetDB()
  90. kept := captureHostBoundSettings()
  91. for _, key := range []string{"nodeMtlsCaCertPem", "nodeMtlsCaKeyPem", "nodeMtlsClientCertPem", "nodeMtlsClientKeyPem", "nodeMtlsClientCAPem"} {
  92. if err := db.Create(&model.Setting{Key: key, Value: "from-imported-file"}).Error; err != nil {
  93. t.Fatalf("seed imported %s: %v", key, err)
  94. }
  95. }
  96. restoreHostBoundSettings(kept)
  97. for _, key := range []string{"nodeMtlsCaCertPem", "nodeMtlsCaKeyPem", "nodeMtlsClientCertPem", "nodeMtlsClientKeyPem", "nodeMtlsClientCAPem"} {
  98. var got model.Setting
  99. if err := db.Where("key = ?", key).First(&got).Error; err != nil {
  100. t.Fatalf("%s was dropped; restoring a backup onto a reinstalled panel would lose it: %v", key, err)
  101. }
  102. }
  103. }
  104. // An empty local value is the normal state once Panel Settings has been saved:
  105. // GORM's Assign(struct) dropped it, so the source machine's path survived.
  106. func TestImportRestoresEmptyLocalValueOverImported(t *testing.T) {
  107. setupConflictDB(t)
  108. db := database.GetDB()
  109. if err := db.Create(&model.Setting{Key: "webCertFile", Value: ""}).Error; err != nil {
  110. t.Fatalf("seed local empty: %v", err)
  111. }
  112. kept := captureHostBoundSettings()
  113. if err := db.Model(&model.Setting{}).Where("key = ?", "webCertFile").
  114. Update("value", "/etc/ssl/source-host.pem").Error; err != nil {
  115. t.Fatalf("seed imported: %v", err)
  116. }
  117. restoreHostBoundSettings(kept)
  118. var got model.Setting
  119. if err := db.Where("key = ?", "webCertFile").First(&got).Error; err != nil {
  120. t.Fatal(err)
  121. }
  122. if got.Value != "" {
  123. t.Fatalf("webCertFile = %q, want the empty local value back: the panel still points at the source machine's certificate", got.Value)
  124. }
  125. }