groupHttpController.go 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588
  1. package controller
  2. import (
  3. "gopkg.in/go-playground/validator.v9"
  4. "github.com/gravitl/netmaker/models"
  5. "encoding/base64"
  6. "github.com/gravitl/netmaker/functions"
  7. "github.com/gravitl/netmaker/mongoconn"
  8. "time"
  9. "strings"
  10. "fmt"
  11. "context"
  12. "encoding/json"
  13. "net/http"
  14. "github.com/gorilla/mux"
  15. "go.mongodb.org/mongo-driver/bson"
  16. "go.mongodb.org/mongo-driver/mongo/options"
  17. "github.com/gravitl/netmaker/config"
  18. )
  19. func groupHandlers(r *mux.Router) {
  20. r.HandleFunc("/api/groups", securityCheck(http.HandlerFunc(getGroups))).Methods("GET")
  21. r.HandleFunc("/api/groups", securityCheck(http.HandlerFunc(createGroup))).Methods("POST")
  22. r.HandleFunc("/api/groups/{groupname}", securityCheck(http.HandlerFunc(getGroup))).Methods("GET")
  23. r.HandleFunc("/api/groups/{groupname}/numnodes", securityCheck(http.HandlerFunc(getGroupNodeNumber))).Methods("GET")
  24. r.HandleFunc("/api/groups/{groupname}", securityCheck(http.HandlerFunc(updateGroup))).Methods("PUT")
  25. r.HandleFunc("/api/groups/{groupname}", securityCheck(http.HandlerFunc(deleteGroup))).Methods("DELETE")
  26. r.HandleFunc("/api/groups/{groupname}/keys", securityCheck(http.HandlerFunc(createAccessKey))).Methods("POST")
  27. r.HandleFunc("/api/groups/{groupname}/keys", securityCheck(http.HandlerFunc(getAccessKeys))).Methods("GET")
  28. r.HandleFunc("/api/groups/{groupname}/keys/{name}", securityCheck(http.HandlerFunc(deleteAccessKey))).Methods("DELETE")
  29. }
  30. //Security check is middleware for every function and just checks to make sure that its the master calling
  31. //Only admin should have access to all these group-level actions
  32. //or maybe some Users once implemented
  33. func securityCheck(next http.Handler) http.HandlerFunc {
  34. return func(w http.ResponseWriter, r *http.Request) {
  35. var errorResponse = models.ErrorResponse{
  36. Code: http.StatusInternalServerError, Message: "W1R3: It's not you it's me.",
  37. }
  38. var params = mux.Vars(r)
  39. hasgroup := params["groupname"] != ""
  40. groupexists, _ := functions.GroupExists(params["groupname"])
  41. if hasgroup && !groupexists {
  42. errorResponse = models.ErrorResponse{
  43. Code: http.StatusNotFound, Message: "W1R3: This group does not exist.",
  44. }
  45. returnErrorResponse(w, r, errorResponse)
  46. } else {
  47. bearerToken := r.Header.Get("Authorization")
  48. var hasBearer = true
  49. var tokenSplit = strings.Split(bearerToken, " ")
  50. var authToken = ""
  51. if len(tokenSplit) < 2 {
  52. hasBearer = false
  53. } else {
  54. authToken = tokenSplit[1]
  55. }
  56. //all endpoints here require master so not as complicated
  57. //still might not be a good way of doing this
  58. if !hasBearer || !authenticateMaster(authToken) {
  59. errorResponse = models.ErrorResponse{
  60. Code: http.StatusUnauthorized, Message: "W1R3: You are unauthorized to access this endpoint.",
  61. }
  62. returnErrorResponse(w, r, errorResponse)
  63. } else {
  64. next.ServeHTTP(w, r)
  65. }
  66. }
  67. }
  68. }
  69. //Consider a more secure way of setting master key
  70. func authenticateMaster(tokenString string) bool {
  71. if tokenString == config.Config.Server.MasterKey {
  72. return true
  73. }
  74. return false
  75. }
  76. //simple get all groups function
  77. func getGroups(w http.ResponseWriter, r *http.Request) {
  78. //depends on list groups function
  79. //TODO: This is perhaps a more efficient way of handling ALL http handlers
  80. //Take their primary logic and put in a separate function
  81. //May be better since most http handler functionality is needed internally cross-method
  82. //E.G. a method may need to check against all groups. But it cant call this function. That's why there's ListGroups
  83. groups := functions.ListGroups()
  84. json.NewEncoder(w).Encode(groups)
  85. }
  86. func validateGroup(operation string, group models.Group) error {
  87. v := validator.New()
  88. _ = v.RegisterValidation("addressrange_valid", func(fl validator.FieldLevel) bool {
  89. isvalid := functions.IsIpv4CIDR(fl.Field().String())
  90. return isvalid
  91. })
  92. _ = v.RegisterValidation("nameid_valid", func(fl validator.FieldLevel) bool {
  93. isFieldUnique := operation == "update" || functions.IsGroupNameUnique(fl.Field().String())
  94. inGroupCharSet := functions.NameInGroupCharSet(fl.Field().String())
  95. return isFieldUnique && inGroupCharSet
  96. })
  97. _ = v.RegisterValidation("displayname_unique", func(fl validator.FieldLevel) bool {
  98. isFieldUnique := functions.IsGroupDisplayNameUnique(fl.Field().String())
  99. return isFieldUnique || operation == "update"
  100. })
  101. err := v.Struct(group)
  102. if err != nil {
  103. for _, e := range err.(validator.ValidationErrors) {
  104. fmt.Println(e)
  105. }
  106. }
  107. return err
  108. }
  109. //Get number of nodes associated with a group
  110. //May not be necessary, but I think the front end needs it? This should be reviewed after iteration 1
  111. func getGroupNodeNumber(w http.ResponseWriter, r *http.Request) {
  112. var params = mux.Vars(r)
  113. count, err := GetGroupNodeNumber(params["groupname"])
  114. if err != nil {
  115. var errorResponse = models.ErrorResponse{
  116. Code: http.StatusInternalServerError, Message: "W1R3: Error retrieving nodes.",
  117. }
  118. returnErrorResponse(w, r, errorResponse)
  119. } else {
  120. json.NewEncoder(w).Encode(count)
  121. }
  122. }
  123. //This is haphazard
  124. //I need a better folder structure
  125. //maybe a functions/ folder and then a node.go, group.go, keys.go, misc.go
  126. func GetGroupNodeNumber(groupName string) (int, error){
  127. collection := mongoconn.Client.Database("netmaker").Collection("nodes")
  128. ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  129. filter := bson.M{"group": groupName}
  130. count, err := collection.CountDocuments(ctx, filter)
  131. returncount := int(count)
  132. //not sure if this is the right way of handling this error...
  133. if err != nil {
  134. return 9999, err
  135. }
  136. defer cancel()
  137. return returncount, err
  138. }
  139. //Simple get group function
  140. func getGroup(w http.ResponseWriter, r *http.Request) {
  141. // set header.
  142. w.Header().Set("Content-Type", "application/json")
  143. var params = mux.Vars(r)
  144. var group models.Group
  145. collection := mongoconn.Client.Database("netmaker").Collection("groups")
  146. ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  147. filter := bson.M{"nameid": params["groupname"]}
  148. err := collection.FindOne(ctx, filter, options.FindOne().SetProjection(bson.M{"_id": 0})).Decode(&group)
  149. defer cancel()
  150. if err != nil {
  151. mongoconn.GetError(err, w)
  152. return
  153. }
  154. json.NewEncoder(w).Encode(group)
  155. }
  156. //Update a group
  157. func updateGroup(w http.ResponseWriter, r *http.Request) {
  158. w.Header().Set("Content-Type", "application/json")
  159. var params = mux.Vars(r)
  160. var group models.Group
  161. group, err := functions.GetParentGroup(params["groupname"])
  162. if err != nil {
  163. return
  164. }
  165. var groupChange models.Group
  166. haschange := false
  167. hasrangeupdate := false
  168. _ = json.NewDecoder(r.Body).Decode(&groupChange)
  169. if groupChange.AddressRange == "" {
  170. groupChange.AddressRange = group.AddressRange
  171. }
  172. if groupChange.NameID == "" {
  173. groupChange.NameID = group.NameID
  174. }
  175. err = validateGroup("update", groupChange)
  176. if err != nil {
  177. return
  178. }
  179. //TODO: group.Name is not update-able
  180. //group.Name acts as the ID for the group and keeps it unique and searchable by nodes
  181. //should consider renaming to group.ID
  182. //Too lazy for now.
  183. //DisplayName is the editable version and will not be used for node searches,
  184. //but will be used by front end.
  185. if groupChange.AddressRange != "" {
  186. group.AddressRange = groupChange.AddressRange
  187. var isAddressOK bool = functions.IsIpv4CIDR(groupChange.AddressRange)
  188. if !isAddressOK {
  189. return
  190. }
  191. haschange = true
  192. hasrangeupdate = true
  193. }
  194. if groupChange.DefaultListenPort != 0 {
  195. group.DefaultListenPort = groupChange.DefaultListenPort
  196. haschange = true
  197. }
  198. if groupChange.DefaultPreUp != "" {
  199. group.DefaultPreUp = groupChange.DefaultPreUp
  200. haschange = true
  201. }
  202. if groupChange.DefaultInterface != "" {
  203. group.DefaultInterface = groupChange.DefaultInterface
  204. haschange = true
  205. }
  206. if groupChange.DefaultPostUp != "" {
  207. group.DefaultPostUp = groupChange.DefaultPostUp
  208. haschange = true
  209. }
  210. if groupChange.DefaultKeepalive != 0 {
  211. group.DefaultKeepalive = groupChange.DefaultKeepalive
  212. haschange = true
  213. }
  214. if groupChange.DisplayName != "" {
  215. group.DisplayName = groupChange.DisplayName
  216. haschange = true
  217. }
  218. if groupChange.DefaultCheckInInterval != 0 {
  219. group.DefaultCheckInInterval = groupChange.DefaultCheckInInterval
  220. haschange = true
  221. }
  222. //TODO: Important. This doesn't work. This will create cases where we will
  223. //unintentionally go from allowing manual signup to disallowing
  224. //need to find a smarter way
  225. //maybe make into a text field
  226. if groupChange.AllowManualSignUp != group.AllowManualSignUp {
  227. group.AllowManualSignUp = groupChange.AllowManualSignUp
  228. haschange = true
  229. }
  230. collection := mongoconn.Client.Database("netmaker").Collection("groups")
  231. ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  232. filter := bson.M{"nameid": params["groupname"]}
  233. if haschange {
  234. group.SetGroupLastModified()
  235. }
  236. // prepare update model.
  237. update := bson.D{
  238. {"$set", bson.D{
  239. {"addressrange", group.AddressRange},
  240. {"displayname", group.DisplayName},
  241. {"defaultlistenport", group.DefaultListenPort},
  242. {"defaultpostup", group.DefaultPostUp},
  243. {"defaultpreup", group.DefaultPreUp},
  244. {"defaultkeepalive", group.DefaultKeepalive},
  245. {"defaultsaveconfig", group.DefaultSaveConfig},
  246. {"defaultinterface", group.DefaultInterface},
  247. {"nodeslastmodified", group.NodesLastModified},
  248. {"grouplastmodified", group.GroupLastModified},
  249. {"allowmanualsignup", group.AllowManualSignUp},
  250. {"defaultcheckininterval", group.DefaultCheckInInterval},
  251. }},
  252. }
  253. errN := collection.FindOneAndUpdate(ctx, filter, update).Decode(&group)
  254. defer cancel()
  255. if errN != nil {
  256. mongoconn.GetError(errN, w)
  257. fmt.Println(errN)
  258. return
  259. }
  260. //Cycles through nodes and gives them new IP's based on the new range
  261. //Pretty cool, but also pretty inefficient currently
  262. if hasrangeupdate {
  263. _ = functions.UpdateGroupNodeAddresses(params["groupname"])
  264. //json.NewEncoder(w).Encode(errG)
  265. }
  266. json.NewEncoder(w).Encode(group)
  267. }
  268. //Delete a group
  269. //Will stop you if there's any nodes associated
  270. func deleteGroup(w http.ResponseWriter, r *http.Request) {
  271. // Set header
  272. w.Header().Set("Content-Type", "application/json")
  273. var params = mux.Vars(r)
  274. var errorResponse = models.ErrorResponse{
  275. Code: http.StatusInternalServerError, Message: "W1R3: It's not you it's me.",
  276. }
  277. nodecount, err := GetGroupNodeNumber(params["groupname"])
  278. //we dont wanna leave nodes hanging. They need a group!
  279. if nodecount > 0 || err != nil {
  280. errorResponse = models.ErrorResponse{
  281. Code: http.StatusForbidden, Message: "W1R3: Node check failed. All nodes must be deleted before deleting group.",
  282. }
  283. returnErrorResponse(w, r, errorResponse)
  284. return
  285. }
  286. collection := mongoconn.Client.Database("netmaker").Collection("groups")
  287. filter := bson.M{"nameid": params["groupname"]}
  288. ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  289. deleteResult, err := collection.DeleteOne(ctx, filter)
  290. defer cancel()
  291. if err != nil {
  292. mongoconn.GetError(err, w)
  293. return
  294. }
  295. json.NewEncoder(w).Encode(deleteResult)
  296. }
  297. //Create a group
  298. //Pretty simple
  299. func createGroup(w http.ResponseWriter, r *http.Request) {
  300. w.Header().Set("Content-Type", "application/json")
  301. //TODO:
  302. //This may be needed to get error response. May be why some errors dont work
  303. //analyze different error responses and see what needs to be done
  304. //commenting out for now
  305. /*
  306. var errorResponse = models.ErrorResponse{
  307. Code: http.StatusInternalServerError, Message: "W1R3: It's not you it's me.",
  308. }
  309. */
  310. var group models.Group
  311. // we decode our body request params
  312. _ = json.NewDecoder(r.Body).Decode(&group)
  313. //TODO: Not really doing good validation here. Same as createNode, updateNode, and updateGroup
  314. //Need to implement some better validation across the board
  315. err := validateGroup("create", group)
  316. if err != nil {
  317. return
  318. }
  319. group.SetDefaults()
  320. group.SetNodesLastModified()
  321. group.SetGroupLastModified()
  322. collection := mongoconn.Client.Database("netmaker").Collection("groups")
  323. ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  324. // insert our group into the group table
  325. result, err := collection.InsertOne(ctx, group)
  326. _ = result
  327. defer cancel()
  328. if err != nil {
  329. mongoconn.GetError(err, w)
  330. return
  331. }
  332. }
  333. // BEGIN KEY MANAGEMENT SECTION
  334. // Consider a separate file for these controllers but I think same file is fine for now
  335. //TODO: Very little error handling
  336. //accesskey is created as a json string inside the Group collection item in mongo
  337. func createAccessKey(w http.ResponseWriter, r *http.Request) {
  338. w.Header().Set("Content-Type", "application/json")
  339. var params = mux.Vars(r)
  340. var group models.Group
  341. var accesskey models.AccessKey
  342. //start here
  343. group, err := functions.GetParentGroup(params["groupname"])
  344. if err != nil {
  345. return
  346. }
  347. _ = json.NewDecoder(r.Body).Decode(&accesskey)
  348. if accesskey.Name == "" {
  349. accesskey.Name = functions.GenKeyName()
  350. }
  351. if accesskey.Value == "" {
  352. accesskey.Value = functions.GenKey()
  353. }
  354. if accesskey.Uses == 0 {
  355. accesskey.Uses = 1
  356. }
  357. gconf, errG := functions.GetGlobalConfig()
  358. if errG != nil {
  359. mongoconn.GetError(errG, w)
  360. return
  361. }
  362. network := params["groupname"]
  363. address := gconf.ServerGRPC + gconf.PortGRPC
  364. accessstringdec := address + "." + network + "." + accesskey.Value
  365. accesskey.AccessString = base64.StdEncoding.EncodeToString([]byte(accessstringdec))
  366. group.AccessKeys = append(group.AccessKeys, accesskey)
  367. collection := mongoconn.Client.Database("netmaker").Collection("groups")
  368. ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  369. // Create filter
  370. filter := bson.M{"nameid": params["groupname"]}
  371. // Read update model from body request
  372. fmt.Println("Adding key to " + group.NameID)
  373. // prepare update model.
  374. update := bson.D{
  375. {"$set", bson.D{
  376. {"accesskeys", group.AccessKeys},
  377. }},
  378. }
  379. errN := collection.FindOneAndUpdate(ctx, filter, update).Decode(&group)
  380. defer cancel()
  381. if errN != nil {
  382. mongoconn.GetError(errN, w)
  383. return
  384. }
  385. w.Write([]byte(accesskey.Value))
  386. }
  387. //pretty simple get
  388. func getAccessKeys(w http.ResponseWriter, r *http.Request) {
  389. // set header.
  390. w.Header().Set("Content-Type", "application/json")
  391. var params = mux.Vars(r)
  392. var group models.Group
  393. //var keys []models.DisplayKey
  394. var keys []models.AccessKey
  395. collection := mongoconn.Client.Database("netmaker").Collection("groups")
  396. ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  397. filter := bson.M{"nameid": params["groupname"]}
  398. err := collection.FindOne(ctx, filter, options.FindOne().SetProjection(bson.M{"_id": 0})).Decode(&group)
  399. defer cancel()
  400. if err != nil {
  401. mongoconn.GetError(err, w)
  402. return
  403. }
  404. keydata, keyerr := json.Marshal(group.AccessKeys)
  405. if keyerr != nil {
  406. return
  407. }
  408. json.Unmarshal(keydata, &keys)
  409. //json.NewEncoder(w).Encode(group.AccessKeys)
  410. json.NewEncoder(w).Encode(keys)
  411. }
  412. //delete key. Has to do a little funky logic since it's not a collection item
  413. func deleteAccessKey(w http.ResponseWriter, r *http.Request) {
  414. w.Header().Set("Content-Type", "application/json")
  415. var params = mux.Vars(r)
  416. var group models.Group
  417. keyname := params["name"]
  418. //start here
  419. group, err := functions.GetParentGroup(params["groupname"])
  420. if err != nil {
  421. return
  422. }
  423. //basically, turn the list of access keys into the list of access keys before and after the item
  424. //have not done any error handling for if there's like...1 item. I think it works? need to test.
  425. for i := len(group.AccessKeys) - 1; i >= 0; i-- {
  426. currentkey:= group.AccessKeys[i]
  427. if currentkey.Name == keyname {
  428. group.AccessKeys = append(group.AccessKeys[:i],
  429. group.AccessKeys[i+1:]...)
  430. }
  431. }
  432. collection := mongoconn.Client.Database("netmaker").Collection("groups")
  433. ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  434. // Create filter
  435. filter := bson.M{"nameid": params["groupname"]}
  436. // prepare update model.
  437. update := bson.D{
  438. {"$set", bson.D{
  439. {"accesskeys", group.AccessKeys},
  440. }},
  441. }
  442. errN := collection.FindOneAndUpdate(ctx, filter, update).Decode(&group)
  443. defer cancel()
  444. if errN != nil {
  445. mongoconn.GetError(errN, w)
  446. return
  447. }
  448. }