enrollmentkeys.go 8.3 KB

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