enrollmentkeys.go 8.8 KB

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