enrollmentkeys.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355
  1. package controller
  2. import (
  3. "encoding/json"
  4. "fmt"
  5. "net/http"
  6. "time"
  7. "github.com/google/uuid"
  8. "github.com/gorilla/mux"
  9. "github.com/gravitl/netmaker/auth"
  10. "github.com/gravitl/netmaker/logger"
  11. "github.com/gravitl/netmaker/logic"
  12. "github.com/gravitl/netmaker/models"
  13. "github.com/gravitl/netmaker/mq"
  14. "github.com/gravitl/netmaker/servercfg"
  15. "golang.org/x/exp/slog"
  16. )
  17. func enrollmentKeyHandlers(r *mux.Router) {
  18. r.HandleFunc("/api/v1/enrollment-keys", logic.SecurityCheck(true, http.HandlerFunc(createEnrollmentKey))).
  19. Methods(http.MethodPost)
  20. r.HandleFunc("/api/v1/enrollment-keys", logic.SecurityCheck(true, http.HandlerFunc(getEnrollmentKeys))).
  21. Methods(http.MethodGet)
  22. r.HandleFunc("/api/v1/enrollment-keys/{keyID}", logic.SecurityCheck(true, http.HandlerFunc(deleteEnrollmentKey))).
  23. Methods(http.MethodDelete)
  24. r.HandleFunc("/api/v1/host/register/{token}", http.HandlerFunc(handleHostRegister)).
  25. Methods(http.MethodPost)
  26. r.HandleFunc("/api/v1/enrollment-keys/{keyID}", logic.SecurityCheck(true, http.HandlerFunc(updateEnrollmentKey))).
  27. Methods(http.MethodPut)
  28. }
  29. // swagger:route GET /api/v1/enrollment-keys enrollmentKeys getEnrollmentKeys
  30. //
  31. // Lists all EnrollmentKeys for admins.
  32. //
  33. // Schemes: https
  34. //
  35. // Security:
  36. // oauth
  37. //
  38. // Responses:
  39. // 200: EnrollmentKeys
  40. func getEnrollmentKeys(w http.ResponseWriter, r *http.Request) {
  41. keys, err := logic.GetAllEnrollmentKeys()
  42. if err != nil {
  43. logger.Log(0, r.Header.Get("user"), "failed to fetch enrollment keys: ", err.Error())
  44. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  45. return
  46. }
  47. ret := []*models.EnrollmentKey{}
  48. for _, key := range keys {
  49. key := key
  50. if err = logic.Tokenize(key, servercfg.GetAPIHost()); err != nil {
  51. logger.Log(0, r.Header.Get("user"), "failed to get token values for keys:", err.Error())
  52. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  53. return
  54. }
  55. ret = append(ret, key)
  56. }
  57. // return JSON/API formatted keys
  58. logger.Log(2, r.Header.Get("user"), "fetched enrollment keys")
  59. w.WriteHeader(http.StatusOK)
  60. json.NewEncoder(w).Encode(ret)
  61. }
  62. // swagger:route DELETE /api/v1/enrollment-keys/{keyid} enrollmentKeys deleteEnrollmentKey
  63. //
  64. // Deletes an EnrollmentKey from Netmaker server.
  65. //
  66. // Schemes: https
  67. //
  68. // Security:
  69. // oauth
  70. //
  71. // Responses:
  72. // 200: okResponse
  73. func deleteEnrollmentKey(w http.ResponseWriter, r *http.Request) {
  74. params := mux.Vars(r)
  75. keyID := params["keyID"]
  76. err := logic.DeleteEnrollmentKey(keyID)
  77. if err != nil {
  78. logger.Log(0, r.Header.Get("user"), "failed to remove enrollment key: ", err.Error())
  79. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  80. return
  81. }
  82. logger.Log(2, r.Header.Get("user"), "deleted enrollment key", keyID)
  83. w.WriteHeader(http.StatusOK)
  84. }
  85. // swagger:route POST /api/v1/enrollment-keys enrollmentKeys createEnrollmentKey
  86. //
  87. // Creates an EnrollmentKey for hosts to use on Netmaker server.
  88. //
  89. // Schemes: https
  90. //
  91. // Security:
  92. // oauth
  93. //
  94. // Responses:
  95. // 200: EnrollmentKey
  96. func createEnrollmentKey(w http.ResponseWriter, r *http.Request) {
  97. var enrollmentKeyBody models.APIEnrollmentKey
  98. err := json.NewDecoder(r.Body).Decode(&enrollmentKeyBody)
  99. if err != nil {
  100. logger.Log(0, r.Header.Get("user"), "error decoding request body: ",
  101. err.Error())
  102. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  103. return
  104. }
  105. var newTime time.Time
  106. if enrollmentKeyBody.Expiration > 0 {
  107. newTime = time.Unix(enrollmentKeyBody.Expiration, 0)
  108. }
  109. relayId := uuid.Nil
  110. if enrollmentKeyBody.Relay != "" {
  111. relayId, err = uuid.Parse(enrollmentKeyBody.Relay)
  112. if err != nil {
  113. logger.Log(0, r.Header.Get("user"), "error parsing relay id: ", err.Error())
  114. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  115. return
  116. }
  117. }
  118. newEnrollmentKey, err := logic.CreateEnrollmentKey(
  119. enrollmentKeyBody.UsesRemaining,
  120. newTime,
  121. enrollmentKeyBody.Networks,
  122. enrollmentKeyBody.Tags,
  123. enrollmentKeyBody.Unlimited,
  124. relayId,
  125. )
  126. if err != nil {
  127. logger.Log(0, r.Header.Get("user"), "failed to create enrollment key:", err.Error())
  128. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  129. return
  130. }
  131. if err = logic.Tokenize(newEnrollmentKey, servercfg.GetAPIHost()); err != nil {
  132. logger.Log(0, r.Header.Get("user"), "failed to create enrollment key:", err.Error())
  133. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  134. return
  135. }
  136. logger.Log(2, r.Header.Get("user"), "created enrollment key")
  137. w.WriteHeader(http.StatusOK)
  138. json.NewEncoder(w).Encode(newEnrollmentKey)
  139. }
  140. // swagger:route PUT /api/v1/enrollment-keys/:id enrollmentKeys updateEnrollmentKey
  141. //
  142. // Updates an EnrollmentKey for hosts to use on Netmaker server. Updates only the relay to use.
  143. //
  144. // Schemes: https
  145. //
  146. // Security:
  147. // oauth
  148. //
  149. // Responses:
  150. // 200: EnrollmentKey
  151. func updateEnrollmentKey(w http.ResponseWriter, r *http.Request) {
  152. var enrollmentKeyBody models.APIEnrollmentKey
  153. params := mux.Vars(r)
  154. keyId := params["keyID"]
  155. err := json.NewDecoder(r.Body).Decode(&enrollmentKeyBody)
  156. if err != nil {
  157. slog.Error("error decoding request body", "error", err)
  158. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  159. return
  160. }
  161. relayId := uuid.Nil
  162. if enrollmentKeyBody.Relay != "" {
  163. relayId, err = uuid.Parse(enrollmentKeyBody.Relay)
  164. if err != nil {
  165. slog.Error("error parsing relay id", "error", err)
  166. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  167. return
  168. }
  169. }
  170. newEnrollmentKey, err := logic.UpdateEnrollmentKey(keyId, relayId)
  171. if err != nil {
  172. slog.Error("failed to update enrollment key", "error", err)
  173. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  174. return
  175. }
  176. if err = logic.Tokenize(newEnrollmentKey, servercfg.GetAPIHost()); err != nil {
  177. slog.Error("failed to update enrollment key", "error", err)
  178. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  179. return
  180. }
  181. slog.Info("updated enrollment key", "id", keyId)
  182. w.WriteHeader(http.StatusOK)
  183. json.NewEncoder(w).Encode(newEnrollmentKey)
  184. }
  185. // swagger:route POST /api/v1/enrollment-keys/{token} enrollmentKeys handleHostRegister
  186. //
  187. // Handles a Netclient registration with server and add nodes accordingly.
  188. //
  189. // Schemes: https
  190. //
  191. // Security:
  192. // oauth
  193. //
  194. // Responses:
  195. // 200: RegisterResponse
  196. func handleHostRegister(w http.ResponseWriter, r *http.Request) {
  197. params := mux.Vars(r)
  198. token := params["token"]
  199. logger.Log(0, "received registration attempt with token", token)
  200. // check if token exists
  201. enrollmentKey, err := logic.DeTokenize(token)
  202. if err != nil {
  203. logger.Log(0, "invalid enrollment key used", token, err.Error())
  204. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  205. return
  206. }
  207. // get the host
  208. var newHost models.Host
  209. if err = json.NewDecoder(r.Body).Decode(&newHost); err != nil {
  210. logger.Log(0, r.Header.Get("user"), "error decoding request body: ",
  211. err.Error())
  212. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  213. return
  214. }
  215. // re-register host with turn just in case.
  216. if servercfg.IsUsingTurn() {
  217. err = logic.RegisterHostWithTurn(newHost.ID.String(), newHost.HostPass)
  218. if err != nil {
  219. logger.Log(0, "failed to register host with turn server: ", err.Error())
  220. }
  221. }
  222. // check if host already exists
  223. hostExists := false
  224. if hostExists = logic.HostExists(&newHost); hostExists && len(enrollmentKey.Networks) == 0 {
  225. logger.Log(
  226. 0,
  227. "host",
  228. newHost.ID.String(),
  229. newHost.Name,
  230. "attempted to re-register with no networks",
  231. )
  232. logic.ReturnErrorResponse(
  233. w,
  234. r,
  235. logic.FormatError(fmt.Errorf("host already exists"), "badrequest"),
  236. )
  237. return
  238. }
  239. // version check
  240. if !logic.IsVersionComptatible(newHost.Version) {
  241. err := fmt.Errorf("bad client version on register: %s", newHost.Version)
  242. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  243. return
  244. }
  245. if newHost.TrafficKeyPublic == nil && newHost.OS != models.OS_Types.IoT {
  246. err := fmt.Errorf("missing traffic key")
  247. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  248. return
  249. }
  250. key, keyErr := logic.RetrievePublicTrafficKey()
  251. if keyErr != nil {
  252. logger.Log(0, "error retrieving key:", keyErr.Error())
  253. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  254. return
  255. }
  256. // use the token
  257. if ok := logic.TryToUseEnrollmentKey(enrollmentKey); !ok {
  258. logger.Log(0, "host", newHost.ID.String(), newHost.Name, "failed registration")
  259. logic.ReturnErrorResponse(
  260. w,
  261. r,
  262. logic.FormatError(fmt.Errorf("invalid enrollment key"), "badrequest"),
  263. )
  264. return
  265. }
  266. hostPass := newHost.HostPass
  267. if !hostExists {
  268. newHost.PersistentKeepalive = models.DefaultPersistentKeepAlive
  269. // register host
  270. logic.CheckHostPorts(&newHost)
  271. // create EMQX credentials and ACLs for host
  272. if servercfg.GetBrokerType() == servercfg.EmqxBrokerType {
  273. if err := mq.CreateEmqxUser(newHost.ID.String(), newHost.HostPass, false); err != nil {
  274. logger.Log(0, "failed to create host credentials for EMQX: ", err.Error())
  275. return
  276. }
  277. if err := mq.CreateHostACL(newHost.ID.String(), servercfg.GetServerInfo().Server); err != nil {
  278. logger.Log(0, "failed to add host ACL rules to EMQX: ", err.Error())
  279. return
  280. }
  281. }
  282. if err = logic.CreateHost(&newHost); err != nil {
  283. logger.Log(
  284. 0,
  285. "host",
  286. newHost.ID.String(),
  287. newHost.Name,
  288. "failed registration -",
  289. err.Error(),
  290. )
  291. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  292. return
  293. }
  294. } else {
  295. // need to revise the list of networks from key
  296. // based on the ones host currently has
  297. networksToAdd := []string{}
  298. currentNets := logic.GetHostNetworks(newHost.ID.String())
  299. for _, newNet := range enrollmentKey.Networks {
  300. if !logic.StringSliceContains(currentNets, newNet) {
  301. networksToAdd = append(networksToAdd, newNet)
  302. }
  303. }
  304. enrollmentKey.Networks = networksToAdd
  305. currHost, err := logic.GetHost(newHost.ID.String())
  306. if err != nil {
  307. slog.Error("failed registration", "hostID", newHost.ID.String(), "hostName", newHost.Name, "error", err.Error())
  308. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  309. return
  310. }
  311. logic.UpdateHostFromClient(&newHost, currHost)
  312. err = logic.UpsertHost(currHost)
  313. if err != nil {
  314. slog.Error("failed to update host", "id", currHost.ID, "error", err)
  315. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  316. return
  317. }
  318. }
  319. // ready the response
  320. server := servercfg.GetServerInfo()
  321. server.TrafficKey = key
  322. if servercfg.GetBrokerType() == servercfg.EmqxBrokerType {
  323. // set MQ username and password for EMQX clients
  324. server.MQUserName = newHost.ID.String()
  325. server.MQPassword = hostPass
  326. }
  327. response := models.RegisterResponse{
  328. ServerConf: server,
  329. RequestedHost: newHost,
  330. }
  331. logger.Log(0, newHost.Name, newHost.ID.String(), "registered with Netmaker")
  332. w.WriteHeader(http.StatusOK)
  333. json.NewEncoder(w).Encode(&response)
  334. // notify host of changes, peer and node updates
  335. go auth.CheckNetRegAndHostUpdate(enrollmentKey.Networks, &newHost, enrollmentKey.Relay)
  336. }