enrollmentkeys.go 8.3 KB

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