enrollmentkeys.go 8.9 KB

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