metadata.go 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. package network
  2. import (
  3. "encoding/json"
  4. "fmt"
  5. "os"
  6. "path/filepath"
  7. "strings"
  8. "sync"
  9. "time"
  10. )
  11. var defaultMetadataPath = "/etc/debtik/metadata.json"
  12. var defaultRoles = []RoleTag{
  13. {ID: "wan", Name: "WAN", Color: "amber", Description: "Public internet uplink interfaces", Builtin: true},
  14. {ID: "lan", Name: "LAN", Color: "blue", Description: "Local area network", Builtin: true},
  15. {ID: "dmz", Name: "DMZ", Color: "purple", Description: "Demilitarized zone / Public services", Builtin: true},
  16. {ID: "guest", Name: "GUEST", Color: "cyan", Description: "Isolated guest network", Builtin: true},
  17. {ID: "iot", Name: "IOT", Color: "emerald", Description: "Smart devices & sensors", Builtin: true},
  18. {ID: "mgmt", Name: "MGMT", Color: "rose", Description: "Management & OOB network", Builtin: true},
  19. }
  20. // MetadataManager manages user annotations for interfaces.
  21. type MetadataManager struct {
  22. mu sync.RWMutex
  23. filePath string
  24. store MetadataStore
  25. }
  26. func NewMetadataManager(customPath string) *MetadataManager {
  27. p := defaultMetadataPath
  28. if customPath != "" {
  29. p = customPath
  30. }
  31. mm := &MetadataManager{
  32. filePath: p,
  33. store: MetadataStore{
  34. Interfaces: make(map[string]InterfaceMetadata),
  35. },
  36. }
  37. mm.load()
  38. return mm
  39. }
  40. func (mm *MetadataManager) load() {
  41. mm.mu.Lock()
  42. defer mm.mu.Unlock()
  43. data, err := os.ReadFile(mm.filePath)
  44. if err == nil {
  45. _ = json.Unmarshal(data, &mm.store)
  46. }
  47. if mm.store.Interfaces == nil {
  48. mm.store.Interfaces = make(map[string]InterfaceMetadata)
  49. }
  50. if len(mm.store.Roles) == 0 {
  51. mm.store.Roles = make([]RoleTag, len(defaultRoles))
  52. copy(mm.store.Roles, defaultRoles)
  53. _ = mm.saveLocked()
  54. }
  55. }
  56. func (mm *MetadataManager) save() error {
  57. mm.mu.Lock()
  58. defer mm.mu.Unlock()
  59. return mm.saveLocked()
  60. }
  61. func (mm *MetadataManager) saveLocked() error {
  62. dir := filepath.Dir(mm.filePath)
  63. if err := os.MkdirAll(dir, 0755); err != nil {
  64. return err
  65. }
  66. data, err := json.MarshalIndent(mm.store, "", " ")
  67. if err != nil {
  68. return err
  69. }
  70. return os.WriteFile(mm.filePath, data, 0644)
  71. }
  72. // GetRolesWithUsage returns all role tags with assigned interface details.
  73. func (mm *MetadataManager) GetRolesWithUsage() []RoleTagWithUsage {
  74. mm.mu.RLock()
  75. defer mm.mu.RUnlock()
  76. roles := mm.store.Roles
  77. if len(roles) == 0 {
  78. roles = defaultRoles
  79. }
  80. result := make([]RoleTagWithUsage, len(roles))
  81. for i, r := range roles {
  82. ru := RoleTagWithUsage{
  83. RoleTag: r,
  84. Interfaces: make([]string, 0),
  85. }
  86. for ifaceName, meta := range mm.store.Interfaces {
  87. if strings.EqualFold(meta.Role, r.Name) || strings.EqualFold(meta.Role, r.ID) {
  88. ru.Interfaces = append(ru.Interfaces, ifaceName)
  89. }
  90. }
  91. ru.AssignedCount = len(ru.Interfaces)
  92. result[i] = ru
  93. }
  94. return result
  95. }
  96. // GetRoles returns all role tags.
  97. func (mm *MetadataManager) GetRoles() []RoleTag {
  98. mm.mu.RLock()
  99. defer mm.mu.RUnlock()
  100. if len(mm.store.Roles) == 0 {
  101. return defaultRoles
  102. }
  103. return append([]RoleTag(nil), mm.store.Roles...)
  104. }
  105. // GetRole returns a specific role tag by ID.
  106. func (mm *MetadataManager) GetRole(id string) (*RoleTag, error) {
  107. mm.mu.RLock()
  108. defer mm.mu.RUnlock()
  109. for _, r := range mm.store.Roles {
  110. if strings.EqualFold(r.ID, id) || strings.EqualFold(r.Name, id) {
  111. rCopy := r
  112. return &rCopy, nil
  113. }
  114. }
  115. return nil, fmt.Errorf("role tag '%s' not found", id)
  116. }
  117. // SaveRole creates or updates a role tag.
  118. func (mm *MetadataManager) SaveRole(role RoleTag) (*RoleTag, error) {
  119. mm.mu.Lock()
  120. defer mm.mu.Unlock()
  121. name := strings.TrimSpace(role.Name)
  122. if name == "" {
  123. return nil, fmt.Errorf("role name cannot be empty")
  124. }
  125. color := strings.ToLower(strings.TrimSpace(role.Color))
  126. if color == "" {
  127. color = "blue"
  128. }
  129. role.Color = color
  130. role.Name = name
  131. id := strings.TrimSpace(role.ID)
  132. if id == "" {
  133. slug := strings.ToLower(strings.ReplaceAll(name, " ", "-"))
  134. id = slug
  135. for _, existing := range mm.store.Roles {
  136. if existing.ID == id {
  137. id = fmt.Sprintf("%s-%d", slug, time.Now().Unix()%10000)
  138. break
  139. }
  140. }
  141. }
  142. role.ID = id
  143. found := false
  144. for i, existing := range mm.store.Roles {
  145. if strings.EqualFold(existing.ID, id) {
  146. oldName := existing.Name
  147. role.Builtin = existing.Builtin
  148. mm.store.Roles[i] = role
  149. found = true
  150. // If name changed, migrate assigned interfaces
  151. if oldName != "" && !strings.EqualFold(oldName, name) {
  152. for ifName, meta := range mm.store.Interfaces {
  153. if strings.EqualFold(meta.Role, oldName) {
  154. meta.Role = name
  155. mm.store.Interfaces[ifName] = meta
  156. }
  157. }
  158. }
  159. break
  160. }
  161. }
  162. if !found {
  163. mm.store.Roles = append(mm.store.Roles, role)
  164. }
  165. if err := mm.saveLocked(); err != nil {
  166. return nil, err
  167. }
  168. return &role, nil
  169. }
  170. // DeleteRole removes a role tag.
  171. func (mm *MetadataManager) DeleteRole(id string) error {
  172. mm.mu.Lock()
  173. defer mm.mu.Unlock()
  174. idx := -1
  175. var deletedRole RoleTag
  176. for i, r := range mm.store.Roles {
  177. if strings.EqualFold(r.ID, id) {
  178. idx = i
  179. deletedRole = r
  180. break
  181. }
  182. }
  183. if idx == -1 {
  184. return fmt.Errorf("role tag '%s' not found", id)
  185. }
  186. mm.store.Roles = append(mm.store.Roles[:idx], mm.store.Roles[idx+1:]...)
  187. // Reset any interfaces that used this role to "LAN" or empty
  188. for ifName, meta := range mm.store.Interfaces {
  189. if strings.EqualFold(meta.Role, deletedRole.Name) || strings.EqualFold(meta.Role, deletedRole.ID) {
  190. meta.Role = "LAN"
  191. mm.store.Interfaces[ifName] = meta
  192. }
  193. }
  194. return mm.saveLocked()
  195. }
  196. func (mm *MetadataManager) Get(name string) InterfaceMetadata {
  197. mm.mu.RLock()
  198. defer mm.mu.RUnlock()
  199. return mm.store.Interfaces[name]
  200. }
  201. func (mm *MetadataManager) Set(name string, role, desc string) error {
  202. mm.mu.Lock()
  203. defer mm.mu.Unlock()
  204. meta := mm.store.Interfaces[name]
  205. meta.Role = role
  206. meta.Description = desc
  207. mm.store.Interfaces[name] = meta
  208. return mm.saveLocked()
  209. }
  210. // SetMAC associates a physical MAC address with an interface name.
  211. func (mm *MetadataManager) SetMAC(name, mac string) error {
  212. mm.mu.Lock()
  213. defer mm.mu.Unlock()
  214. mac = strings.ToLower(strings.TrimSpace(mac))
  215. meta := mm.store.Interfaces[name]
  216. if meta.MAC == mac {
  217. return nil
  218. }
  219. meta.MAC = mac
  220. mm.store.Interfaces[name] = meta
  221. return mm.saveLocked()
  222. }
  223. // GetAllMACs returns a map of target interface name to its recorded MAC address.
  224. func (mm *MetadataManager) GetAllMACs() map[string]string {
  225. mm.mu.RLock()
  226. defer mm.mu.RUnlock()
  227. res := make(map[string]string)
  228. for name, meta := range mm.store.Interfaces {
  229. if meta.MAC != "" {
  230. res[name] = strings.ToLower(meta.MAC)
  231. }
  232. }
  233. return res
  234. }
  235. func (mm *MetadataManager) AddIP(name, cidr string) error {
  236. mm.mu.Lock()
  237. defer mm.mu.Unlock()
  238. meta := mm.store.Interfaces[name]
  239. for _, ip := range meta.IPAddresses {
  240. if ip == cidr {
  241. return nil
  242. }
  243. }
  244. meta.IPAddresses = append(meta.IPAddresses, cidr)
  245. meta.AutoUp = true
  246. mm.store.Interfaces[name] = meta
  247. return mm.saveLocked()
  248. }
  249. func (mm *MetadataManager) RemoveIP(name, cidr string) error {
  250. mm.mu.Lock()
  251. defer mm.mu.Unlock()
  252. meta := mm.store.Interfaces[name]
  253. var updated []string
  254. for _, ip := range meta.IPAddresses {
  255. if ip != cidr {
  256. updated = append(updated, ip)
  257. }
  258. }
  259. meta.IPAddresses = updated
  260. mm.store.Interfaces[name] = meta
  261. return mm.saveLocked()
  262. }
  263. func (mm *MetadataManager) GetAllWithIPs() map[string][]string {
  264. mm.mu.RLock()
  265. defer mm.mu.RUnlock()
  266. res := make(map[string][]string)
  267. for name, meta := range mm.store.Interfaces {
  268. if len(meta.IPAddresses) > 0 {
  269. res[name] = append([]string(nil), meta.IPAddresses...)
  270. }
  271. }
  272. return res
  273. }
  274. func (mm *MetadataManager) Delete(name string) error {
  275. mm.mu.Lock()
  276. defer mm.mu.Unlock()
  277. delete(mm.store.Interfaces, name)
  278. return mm.saveLocked()
  279. }
  280. // Rename migrates interface metadata when an interface is renamed.
  281. func (mm *MetadataManager) Rename(oldName, newName string) error {
  282. mm.mu.Lock()
  283. defer mm.mu.Unlock()
  284. if meta, exists := mm.store.Interfaces[oldName]; exists {
  285. delete(mm.store.Interfaces, oldName)
  286. mm.store.Interfaces[newName] = meta
  287. return mm.saveLocked()
  288. }
  289. return nil
  290. }