network.go 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. package models
  2. import (
  3. "encoding/json"
  4. "errors"
  5. "fmt"
  6. "reflect"
  7. "strings"
  8. "time"
  9. "github.com/go-playground/validator/v10"
  10. "github.com/gravitl/netmaker/database"
  11. "github.com/gravitl/netmaker/servercfg"
  12. )
  13. //Network Struct
  14. //At some point, need to replace all instances of Name with something else like Identifier
  15. type Network struct {
  16. AddressRange string `json:"addressrange" bson:"addressrange" validate:"required,cidr"`
  17. AddressRange6 string `json:"addressrange6" bson:"addressrange6" validate:"regexp=^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$"`
  18. DisplayName string `json:"displayname,omitempty" bson:"displayname,omitempty" validate:"omitempty,min=1,max=20,displayname_valid"`
  19. NetID string `json:"netid" bson:"netid" validate:"required,min=1,max=12,netid_valid"`
  20. NodesLastModified int64 `json:"nodeslastmodified" bson:"nodeslastmodified"`
  21. NetworkLastModified int64 `json:"networklastmodified" bson:"networklastmodified"`
  22. DefaultInterface string `json:"defaultinterface" bson:"defaultinterface" validate:"min=1,max=15"`
  23. DefaultListenPort int32 `json:"defaultlistenport,omitempty" bson:"defaultlistenport,omitempty" validate:"omitempty,min=1024,max=65535"`
  24. NodeLimit int32 `json:"nodelimit" bson:"nodelimit"`
  25. DefaultPostUp string `json:"defaultpostup" bson:"defaultpostup"`
  26. DefaultPostDown string `json:"defaultpostdown" bson:"defaultpostdown"`
  27. KeyUpdateTimeStamp int64 `json:"keyupdatetimestamp" bson:"keyupdatetimestamp"`
  28. DefaultKeepalive int32 `json:"defaultkeepalive" bson:"defaultkeepalive" validate:"omitempty,max=1000"`
  29. DefaultSaveConfig string `json:"defaultsaveconfig" bson:"defaultsaveconfig" validate:"checkyesorno"`
  30. AccessKeys []AccessKey `json:"accesskeys" bson:"accesskeys"`
  31. AllowManualSignUp string `json:"allowmanualsignup" bson:"allowmanualsignup" validate:"checkyesorno"`
  32. IsLocal string `json:"islocal" bson:"islocal" validate:"checkyesorno"`
  33. IsDualStack string `json:"isdualstack" bson:"isdualstack" validate:"checkyesorno"`
  34. IsIPv4 string `json:"isipv4" bson:"isipv4" validate:"checkyesorno"`
  35. IsIPv6 string `json:"isipv6" bson:"isipv6" validate:"checkyesorno"`
  36. IsGRPCHub string `json:"isgrpchub" bson:"isgrpchub" validate:"checkyesorno"`
  37. LocalRange string `json:"localrange" bson:"localrange" validate:"omitempty,cidr"`
  38. DefaultCheckInInterval int32 `json:"checkininterval,omitempty" bson:"checkininterval,omitempty" validate:"omitempty,numeric,min=2,max=100000"`
  39. DefaultUDPHolePunch string `json:"defaultudpholepunch" bson:"defaultudpholepunch" validate:"checkyesorno"`
  40. DefaultExtClientDNS string `json:"defaultextclientdns" bson:"defaultextclientdns"`
  41. }
  42. type SaveData struct { // put sensitive fields here
  43. NetID string `json:"netid" bson:"netid" validate:"required,min=1,max=12,netid_valid"`
  44. }
  45. const STRING_FIELD_TYPE = "string"
  46. const INT64_FIELD_TYPE = "int64"
  47. const INT32_FIELD_TYPE = "int32"
  48. const ACCESS_KEY_TYPE = "[]AccessKey"
  49. var FIELD_TYPES = []string{STRING_FIELD_TYPE, INT64_FIELD_TYPE, INT32_FIELD_TYPE, ACCESS_KEY_TYPE}
  50. var FIELDS = map[string][]string{
  51. // "id": {"ID", "string"},
  52. "addressrange": {"AddressRange", STRING_FIELD_TYPE},
  53. "addressrange6": {"AddressRange6", STRING_FIELD_TYPE},
  54. "displayname": {"DisplayName", STRING_FIELD_TYPE},
  55. "netid": {"NetID", STRING_FIELD_TYPE},
  56. "nodeslastmodified": {"NodesLastModified", INT64_FIELD_TYPE},
  57. "networklastmodified": {"NetworkLastModified", INT64_FIELD_TYPE},
  58. "defaultinterface": {"DefaultInterface", STRING_FIELD_TYPE},
  59. "defaultlistenport": {"DefaultListenPort", INT32_FIELD_TYPE},
  60. "nodelimit": {"NodeLimit", INT32_FIELD_TYPE},
  61. "defaultpostup": {"DefaultPostUp", STRING_FIELD_TYPE},
  62. "defaultpostdown": {"DefaultPostDown", STRING_FIELD_TYPE},
  63. "keyupdatetimestamp": {"KeyUpdateTimeStamp", INT64_FIELD_TYPE},
  64. "defaultkeepalive": {"DefaultKeepalive", INT32_FIELD_TYPE},
  65. "defaultsaveconfig": {"DefaultSaveConfig", STRING_FIELD_TYPE},
  66. "accesskeys": {"AccessKeys", ACCESS_KEY_TYPE},
  67. "allowmanualsignup": {"AllowManualSignUp", STRING_FIELD_TYPE},
  68. "islocal": {"IsLocal", STRING_FIELD_TYPE},
  69. "isdualstack": {"IsDualStack", STRING_FIELD_TYPE},
  70. "isipv4": {"IsIPv4", STRING_FIELD_TYPE},
  71. "isipv6": {"IsIPv6", STRING_FIELD_TYPE},
  72. "isgrpchub": {"IsGRPCHub", STRING_FIELD_TYPE},
  73. "localrange": {"LocalRange", STRING_FIELD_TYPE},
  74. "checkininterval": {"DefaultCheckInInterval", INT32_FIELD_TYPE},
  75. "defaultudpholepunch": {"DefaultUDPHolePunch", STRING_FIELD_TYPE},
  76. }
  77. func (network *Network) FieldExists(field string) bool {
  78. return len(FIELDS[field]) > 0
  79. }
  80. func (network *Network) NetIDInNetworkCharSet() bool {
  81. charset := "abcdefghijklmnopqrstuvwxyz1234567890-_."
  82. for _, char := range network.NetID {
  83. if !strings.Contains(charset, strings.ToLower(string(char))) {
  84. return false
  85. }
  86. }
  87. return true
  88. }
  89. func (network *Network) DisplayNameInNetworkCharSet() bool {
  90. charset := "abcdefghijklmnopqrstuvwxyz1234567890-_./;% ^#()!@$*"
  91. for _, char := range network.DisplayName {
  92. if !strings.Contains(charset, strings.ToLower(string(char))) {
  93. return false
  94. }
  95. }
  96. return true
  97. }
  98. // Anyway, returns all the networks
  99. func GetNetworks() ([]Network, error) {
  100. var networks []Network
  101. collection, err := database.FetchRecords(database.NETWORKS_TABLE_NAME)
  102. if err != nil {
  103. return networks, err
  104. }
  105. for _, value := range collection {
  106. var network Network
  107. if err := json.Unmarshal([]byte(value), &network); err != nil {
  108. return networks, err
  109. }
  110. // add network our array
  111. networks = append(networks, network)
  112. }
  113. return networks, err
  114. }
  115. func (network *Network) IsNetworkDisplayNameUnique() (bool, error) {
  116. isunique := true
  117. records, err := GetNetworks()
  118. if err != nil && !database.IsEmptyRecord(err) {
  119. return false, err
  120. }
  121. for i := 0; i < len(records); i++ {
  122. if network.NetID == records[i].DisplayName {
  123. isunique = false
  124. }
  125. }
  126. return isunique, nil
  127. }
  128. //Checks to see if any other networks have the same name (id)
  129. func (network *Network) IsNetworkNameUnique() (bool, error) {
  130. isunique := true
  131. dbs, err := GetNetworks()
  132. if err != nil && !database.IsEmptyRecord(err) {
  133. return false, err
  134. }
  135. for i := 0; i < len(dbs); i++ {
  136. if network.NetID == dbs[i].NetID {
  137. isunique = false
  138. }
  139. }
  140. return isunique, nil
  141. }
  142. func (network *Network) Validate(isUpdate bool) error {
  143. v := validator.New()
  144. _ = v.RegisterValidation("netid_valid", func(fl validator.FieldLevel) bool {
  145. inCharSet := network.NetIDInNetworkCharSet()
  146. if isUpdate {
  147. return inCharSet
  148. }
  149. isFieldUnique, _ := network.IsNetworkNameUnique()
  150. return isFieldUnique && inCharSet
  151. })
  152. //
  153. _ = v.RegisterValidation("displayname_valid", func(fl validator.FieldLevel) bool {
  154. isFieldUnique, _ := network.IsNetworkDisplayNameUnique()
  155. inCharSet := network.DisplayNameInNetworkCharSet()
  156. if isUpdate {
  157. return inCharSet
  158. }
  159. return isFieldUnique && inCharSet
  160. })
  161. _ = v.RegisterValidation("checkyesorno", func(fl validator.FieldLevel) bool {
  162. return CheckYesOrNo(fl)
  163. })
  164. err := v.Struct(network)
  165. if err != nil {
  166. for _, e := range err.(validator.ValidationErrors) {
  167. fmt.Println(e)
  168. }
  169. }
  170. return err
  171. }
  172. //TODO:
  173. //Not sure if we need the below two functions. Got rid of one of the calls. May want to revisit
  174. func (network *Network) SetNodesLastModified() {
  175. network.NodesLastModified = time.Now().Unix()
  176. }
  177. func (network *Network) SetNetworkLastModified() {
  178. network.NetworkLastModified = time.Now().Unix()
  179. }
  180. func (network *Network) SetDefaults() {
  181. if network.DefaultUDPHolePunch == "" {
  182. if servercfg.IsClientMode() {
  183. network.DefaultUDPHolePunch = "yes"
  184. } else {
  185. network.DefaultUDPHolePunch = "no"
  186. }
  187. }
  188. if network.IsLocal == "" {
  189. network.IsLocal = "no"
  190. }
  191. if network.IsGRPCHub == "" {
  192. network.IsGRPCHub = "no"
  193. }
  194. if network.DisplayName == "" {
  195. network.DisplayName = network.NetID
  196. }
  197. if network.DefaultInterface == "" {
  198. if len(network.NetID) < 13 {
  199. network.DefaultInterface = "nm-" + network.NetID
  200. } else {
  201. network.DefaultInterface = network.NetID
  202. }
  203. }
  204. if network.DefaultListenPort == 0 {
  205. network.DefaultListenPort = 51821
  206. }
  207. if network.NodeLimit == 0 {
  208. network.NodeLimit = 999999999
  209. }
  210. if network.DefaultSaveConfig == "" {
  211. network.DefaultSaveConfig = "no"
  212. }
  213. if network.DefaultKeepalive == 0 {
  214. network.DefaultKeepalive = 20
  215. }
  216. //Check-In Interval for Nodes, In Seconds
  217. if network.DefaultCheckInInterval == 0 {
  218. network.DefaultCheckInInterval = 30
  219. }
  220. if network.AllowManualSignUp == "" {
  221. network.AllowManualSignUp = "no"
  222. }
  223. if network.IsDualStack == "" {
  224. network.IsDualStack = "no"
  225. }
  226. if network.IsDualStack == "yes" {
  227. network.IsIPv6 = "yes"
  228. network.IsIPv4 = "yes"
  229. } else {
  230. network.IsIPv6 = "no"
  231. network.IsIPv4 = "yes"
  232. }
  233. }
  234. func (network *Network) CopyValues(newNetwork *Network, fieldName string) {
  235. reflection := reflect.ValueOf(newNetwork)
  236. value := reflect.Indirect(reflection).FieldByName(FIELDS[fieldName][0])
  237. if value.IsValid() && len(FIELDS[fieldName]) == 2 {
  238. fieldData := FIELDS[fieldName]
  239. for _, indexVal := range FIELD_TYPES {
  240. if indexVal == fieldData[1] {
  241. currentReflection := reflect.ValueOf(network)
  242. reflect.Indirect(currentReflection).FieldByName(FIELDS[fieldName][0]).Set(value)
  243. }
  244. }
  245. }
  246. }
  247. func (currentNetwork *Network) Update(newNetwork *Network) (bool, bool, error) {
  248. if err := newNetwork.Validate(true); err != nil {
  249. return false, false, err
  250. }
  251. if newNetwork.NetID == currentNetwork.NetID {
  252. hasrangeupdate := newNetwork.AddressRange != currentNetwork.AddressRange
  253. localrangeupdate := newNetwork.LocalRange != currentNetwork.LocalRange
  254. if data, err := json.Marshal(newNetwork); err != nil {
  255. return false, false, err
  256. } else {
  257. newNetwork.SetNetworkLastModified()
  258. err = database.Insert(newNetwork.NetID, string(data), database.NETWORKS_TABLE_NAME)
  259. return hasrangeupdate, localrangeupdate, err
  260. }
  261. }
  262. // copy values
  263. return false, false, errors.New("failed to update network " + newNetwork.NetID + ", cannot change netid.")
  264. }
  265. func (network *Network) SetNetworkNodesLastModified() error {
  266. timestamp := time.Now().Unix()
  267. network.NodesLastModified = timestamp
  268. data, err := json.Marshal(&network)
  269. if err != nil {
  270. return err
  271. }
  272. err = database.Insert(network.NetID, string(data), database.NETWORKS_TABLE_NAME)
  273. if err != nil {
  274. return err
  275. }
  276. return nil
  277. }
  278. func GetNetwork(networkname string) (Network, error) {
  279. var network Network
  280. networkData, err := database.FetchRecord(database.NETWORKS_TABLE_NAME, networkname)
  281. if err != nil {
  282. return network, err
  283. }
  284. if err = json.Unmarshal([]byte(networkData), &network); err != nil {
  285. return Network{}, err
  286. }
  287. return network, nil
  288. }