enrollmentkeys.go 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  1. package controller
  2. import (
  3. "encoding/json"
  4. "fmt"
  5. "net/http"
  6. "time"
  7. "github.com/gorilla/mux"
  8. "github.com/gravitl/netmaker/auth"
  9. "github.com/gravitl/netmaker/logger"
  10. "github.com/gravitl/netmaker/logic"
  11. "github.com/gravitl/netmaker/models"
  12. "github.com/gravitl/netmaker/mq"
  13. "github.com/gravitl/netmaker/servercfg"
  14. )
  15. func enrollmentKeyHandlers(r *mux.Router) {
  16. r.HandleFunc("/api/v1/enrollment-keys", logic.SecurityCheck(true, http.HandlerFunc(createEnrollmentKey))).Methods(http.MethodPost)
  17. r.HandleFunc("/api/v1/enrollment-keys", logic.SecurityCheck(false, http.HandlerFunc(getEnrollmentKeys))).Methods(http.MethodGet)
  18. r.HandleFunc("/api/v1/enrollment-keys/{keyID}", logic.SecurityCheck(true, http.HandlerFunc(deleteEnrollmentKey))).Methods(http.MethodDelete)
  19. r.HandleFunc("/api/v1/host/register/{token}", http.HandlerFunc(handleHostRegister)).Methods(http.MethodPost)
  20. }
  21. // swagger:route GET /api/v1/enrollment-keys enrollmentKeys getEnrollmentKeys
  22. //
  23. // Lists all EnrollmentKeys for admins.
  24. //
  25. // Schemes: https
  26. //
  27. // Security:
  28. // oauth
  29. //
  30. // Responses:
  31. // 200: getEnrollmentKeysSlice
  32. func getEnrollmentKeys(w http.ResponseWriter, r *http.Request) {
  33. keys, err := logic.GetAllEnrollmentKeys()
  34. if err != nil {
  35. logger.Log(0, r.Header.Get("user"), "failed to fetch enrollment keys: ", err.Error())
  36. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  37. return
  38. }
  39. isMasterAdmin := r.Header.Get("ismaster") == "yes"
  40. // regular user flow
  41. user, err := logic.GetUser(r.Header.Get("user"))
  42. if err != nil && !isMasterAdmin {
  43. logger.Log(0, r.Header.Get("user"), "failed to fetch user: ", err.Error())
  44. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  45. return
  46. }
  47. // TODO drop double pointer
  48. ret := []*models.EnrollmentKey{}
  49. for _, key := range keys {
  50. if !isMasterAdmin && !logic.UserHasNetworksAccess(key.Networks, user) {
  51. continue
  52. }
  53. if err = logic.Tokenize(key, servercfg.GetAPIHost()); err != nil {
  54. logger.Log(0, r.Header.Get("user"), "failed to get token values for keys:", err.Error())
  55. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  56. return
  57. }
  58. ret = append(ret, key)
  59. }
  60. // return JSON/API formatted keys
  61. logger.Log(2, r.Header.Get("user"), "fetched enrollment keys")
  62. w.WriteHeader(http.StatusOK)
  63. json.NewEncoder(w).Encode(ret)
  64. }
  65. // swagger:route DELETE /api/v1/enrollment-keys/{keyID} enrollmentKeys deleteEnrollmentKey
  66. //
  67. // Deletes an EnrollmentKey from Netmaker server.
  68. //
  69. // Schemes: https
  70. //
  71. // Security:
  72. // oauth
  73. //
  74. // Responses:
  75. // 200: deleteEnrollmentKeyResponse
  76. func deleteEnrollmentKey(w http.ResponseWriter, r *http.Request) {
  77. var params = mux.Vars(r)
  78. keyID := params["keyID"]
  79. err := logic.DeleteEnrollmentKey(keyID)
  80. if err != nil {
  81. logger.Log(0, r.Header.Get("user"), "failed to remove enrollment key: ", err.Error())
  82. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  83. return
  84. }
  85. logger.Log(2, r.Header.Get("user"), "deleted enrollment key", keyID)
  86. w.WriteHeader(http.StatusOK)
  87. }
  88. // swagger:route POST /api/v1/enrollment-keys enrollmentKeys createEnrollmentKey
  89. //
  90. // Creates an EnrollmentKey for hosts to use on Netmaker server.
  91. //
  92. // Schemes: https
  93. //
  94. // Security:
  95. // oauth
  96. //
  97. // Responses:
  98. // 200: createEnrollmentKeyResponse
  99. func createEnrollmentKey(w http.ResponseWriter, r *http.Request) {
  100. var enrollmentKeyBody models.APIEnrollmentKey
  101. err := json.NewDecoder(r.Body).Decode(&enrollmentKeyBody)
  102. if err != nil {
  103. logger.Log(0, r.Header.Get("user"), "error decoding request body: ",
  104. err.Error())
  105. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  106. return
  107. }
  108. var newTime time.Time
  109. if enrollmentKeyBody.Expiration > 0 {
  110. newTime = time.Unix(enrollmentKeyBody.Expiration, 0)
  111. }
  112. newEnrollmentKey, err := logic.CreateEnrollmentKey(enrollmentKeyBody.UsesRemaining, newTime, enrollmentKeyBody.Networks, enrollmentKeyBody.Tags, enrollmentKeyBody.Unlimited)
  113. if err != nil {
  114. logger.Log(0, r.Header.Get("user"), "failed to create enrollment key:", err.Error())
  115. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  116. return
  117. }
  118. if err = logic.Tokenize(newEnrollmentKey, servercfg.GetAPIHost()); err != nil {
  119. logger.Log(0, r.Header.Get("user"), "failed to create enrollment key:", err.Error())
  120. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  121. return
  122. }
  123. logger.Log(2, r.Header.Get("user"), "created enrollment key")
  124. w.WriteHeader(http.StatusOK)
  125. json.NewEncoder(w).Encode(newEnrollmentKey)
  126. }
  127. // swagger:route POST /api/v1/enrollment-keys/{token} enrollmentKeys handleHostRegister
  128. //
  129. // Handles a Netclient registration with server and add nodes accordingly.
  130. //
  131. // Schemes: https
  132. //
  133. // Security:
  134. // oauth
  135. //
  136. // Responses:
  137. // 200: handleHostRegisterResponse
  138. func handleHostRegister(w http.ResponseWriter, r *http.Request) {
  139. var params = mux.Vars(r)
  140. token := params["token"]
  141. logger.Log(0, "received registration attempt with token", token)
  142. // check if token exists
  143. enrollmentKey, err := logic.DeTokenize(token)
  144. if err != nil {
  145. logger.Log(0, "invalid enrollment key used", token, err.Error())
  146. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  147. return
  148. }
  149. // get the host
  150. var newHost models.Host
  151. if err = json.NewDecoder(r.Body).Decode(&newHost); err != nil {
  152. logger.Log(0, r.Header.Get("user"), "error decoding request body: ",
  153. err.Error())
  154. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  155. return
  156. }
  157. hostExists := false
  158. // re-register host with turn just in case.
  159. if servercfg.IsUsingTurn() {
  160. err = logic.RegisterHostWithTurn(newHost.ID.String(), newHost.HostPass)
  161. if err != nil {
  162. logger.Log(0, "failed to register host with turn server: ", err.Error())
  163. }
  164. }
  165. // check if host already exists
  166. if hostExists = logic.HostExists(&newHost); hostExists && len(enrollmentKey.Networks) == 0 {
  167. logger.Log(0, "host", newHost.ID.String(), newHost.Name, "attempted to re-register with no networks")
  168. logic.ReturnErrorResponse(w, r, logic.FormatError(fmt.Errorf("host already exists"), "badrequest"))
  169. return
  170. }
  171. // version check
  172. if !logic.IsVersionComptatible(newHost.Version) {
  173. err := fmt.Errorf("bad client version on register: %s", newHost.Version)
  174. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  175. return
  176. }
  177. if newHost.TrafficKeyPublic == nil && newHost.OS != models.OS_Types.IoT {
  178. err := fmt.Errorf("missing traffic key")
  179. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  180. return
  181. }
  182. key, keyErr := logic.RetrievePublicTrafficKey()
  183. if keyErr != nil {
  184. logger.Log(0, "error retrieving key:", keyErr.Error())
  185. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  186. return
  187. }
  188. // use the token
  189. if ok := logic.TryToUseEnrollmentKey(enrollmentKey); !ok {
  190. logger.Log(0, "host", newHost.ID.String(), newHost.Name, "failed registration")
  191. logic.ReturnErrorResponse(w, r, logic.FormatError(fmt.Errorf("invalid enrollment key"), "badrequest"))
  192. return
  193. }
  194. hostPass := newHost.HostPass
  195. if !hostExists {
  196. // register host
  197. logic.CheckHostPorts(&newHost)
  198. // create EMQX credentials and ACLs for host
  199. if servercfg.GetBrokerType() == servercfg.EmqxBrokerType {
  200. if err := mq.CreateEmqxUser(newHost.ID.String(), newHost.HostPass, false); err != nil {
  201. logger.Log(0, "failed to create host credentials for EMQX: ", err.Error())
  202. return
  203. }
  204. if err := mq.CreateHostACL(newHost.ID.String(), servercfg.GetServerInfo().Server); err != nil {
  205. logger.Log(0, "failed to add host ACL rules to EMQX: ", err.Error())
  206. return
  207. }
  208. }
  209. if err = logic.CreateHost(&newHost); err != nil {
  210. logger.Log(0, "host", newHost.ID.String(), newHost.Name, "failed registration -", err.Error())
  211. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  212. return
  213. }
  214. } else {
  215. // need to revise the list of networks from key
  216. // based on the ones host currently has
  217. var networksToAdd = []string{}
  218. currentNets := logic.GetHostNetworks(newHost.ID.String())
  219. for _, newNet := range enrollmentKey.Networks {
  220. if !logic.StringSliceContains(currentNets, newNet) {
  221. networksToAdd = append(networksToAdd, newNet)
  222. }
  223. }
  224. enrollmentKey.Networks = networksToAdd
  225. }
  226. // ready the response
  227. server := servercfg.GetServerInfo()
  228. server.TrafficKey = key
  229. if servercfg.GetBrokerType() == servercfg.EmqxBrokerType {
  230. // set MQ username and password for EMQX clients
  231. server.MQUserName = newHost.ID.String()
  232. server.MQPassword = hostPass
  233. }
  234. response := models.RegisterResponse{
  235. ServerConf: server,
  236. RequestedHost: newHost,
  237. }
  238. logger.Log(0, newHost.Name, newHost.ID.String(), "registered with Netmaker")
  239. w.WriteHeader(http.StatusOK)
  240. json.NewEncoder(w).Encode(&response)
  241. // notify host of changes, peer and node updates
  242. go auth.CheckNetRegAndHostUpdate(enrollmentKey.Networks, &newHost)
  243. }