host_session.go 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  1. package auth
  2. import (
  3. "encoding/json"
  4. "fmt"
  5. "strings"
  6. "time"
  7. "github.com/google/uuid"
  8. "github.com/gorilla/websocket"
  9. "github.com/gravitl/netmaker/logger"
  10. "github.com/gravitl/netmaker/logic"
  11. "github.com/gravitl/netmaker/logic/hostactions"
  12. "github.com/gravitl/netmaker/logic/pro/netcache"
  13. "github.com/gravitl/netmaker/models"
  14. "github.com/gravitl/netmaker/mq"
  15. "github.com/gravitl/netmaker/servercfg"
  16. "golang.org/x/exp/slog"
  17. )
  18. // SessionHandler - called by the HTTP router when user
  19. // is calling netclient with join/register -s parameter in order to authenticate
  20. // via SSO mechanism by OAuth2 protocol flow.
  21. // This triggers a session start and it is managed by the flow implemented here and callback
  22. // When this method finishes - the auth flow has finished either OK or by timeout or any other error occured
  23. func SessionHandler(conn *websocket.Conn) {
  24. defer conn.Close()
  25. // If reached here we have a session from user to handle...
  26. messageType, message, err := conn.ReadMessage()
  27. if err != nil {
  28. logger.Log(0, "Error during message reading:", err.Error())
  29. return
  30. }
  31. var registerMessage models.RegisterMsg
  32. if err = json.Unmarshal(message, &registerMessage); err != nil {
  33. logger.Log(0, "Failed to unmarshall data err=", err.Error())
  34. return
  35. }
  36. if registerMessage.RegisterHost.ID == uuid.Nil {
  37. logger.Log(0, "invalid host registration attempted")
  38. return
  39. }
  40. req := new(netcache.CValue)
  41. req.Value = string(registerMessage.RegisterHost.ID.String())
  42. req.Network = registerMessage.Network
  43. req.Host = registerMessage.RegisterHost
  44. req.ALL = registerMessage.JoinAll
  45. req.Pass = ""
  46. req.User = registerMessage.User
  47. if len(req.User) > 0 && len(registerMessage.Password) == 0 {
  48. logger.Log(0, "invalid host registration attempted")
  49. return
  50. }
  51. // Add any extra parameter provided in the configuration to the Authorize Endpoint request??
  52. stateStr := logic.RandomString(node_signin_length)
  53. if err := netcache.Set(stateStr, req); err != nil {
  54. logger.Log(0, "Failed to process sso request -", err.Error())
  55. return
  56. }
  57. // Wait for the user to finish his auth flow...
  58. timeout := make(chan bool, 1)
  59. answer := make(chan netcache.CValue, 1)
  60. defer close(answer)
  61. defer close(timeout)
  62. if len(registerMessage.User) > 0 { // handle basic auth
  63. logger.Log(0, "user registration attempted with host:", registerMessage.RegisterHost.Name, "user:", registerMessage.User)
  64. if !servercfg.IsBasicAuthEnabled() {
  65. err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, ""))
  66. if err != nil {
  67. logger.Log(0, "error during message writing:", err.Error())
  68. }
  69. }
  70. _, err := logic.VerifyAuthRequest(models.UserAuthParams{
  71. UserName: registerMessage.User,
  72. Password: registerMessage.Password,
  73. })
  74. if err != nil {
  75. err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, ""))
  76. if err != nil {
  77. logger.Log(0, "error during message writing:", err.Error())
  78. }
  79. return
  80. }
  81. req.Pass = req.Host.ID.String()
  82. user, err := logic.GetUser(req.User)
  83. if err != nil {
  84. logger.Log(0, "failed to get user", req.User, "from database")
  85. err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, ""))
  86. if err != nil {
  87. logger.Log(0, "error during message writing:", err.Error())
  88. }
  89. return
  90. }
  91. if !user.IsAdmin && !user.IsSuperAdmin {
  92. logger.Log(0, "user", req.User, "is neither an admin or superadmin. denying registeration")
  93. conn.WriteMessage(messageType, []byte("cannot register with a non-admin or non-superadmin"))
  94. err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, ""))
  95. if err != nil {
  96. logger.Log(0, "error during message writing:", err.Error())
  97. }
  98. return
  99. }
  100. if err = netcache.Set(stateStr, req); err != nil { // give the user's host access in the DB
  101. logger.Log(0, "machine failed to complete join on network,", registerMessage.Network, "-", err.Error())
  102. return
  103. }
  104. } else { // handle SSO / OAuth
  105. if auth_provider == nil {
  106. err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, ""))
  107. if err != nil {
  108. logger.Log(0, "error during message writing:", err.Error())
  109. }
  110. return
  111. }
  112. logger.Log(0, "user registration attempted with host:", registerMessage.RegisterHost.Name, "via SSO")
  113. redirectUrl = fmt.Sprintf("https://%s/api/oauth/register/%s", servercfg.GetAPIConnString(), stateStr)
  114. err = conn.WriteMessage(messageType, []byte(redirectUrl))
  115. if err != nil {
  116. logger.Log(0, "error during message writing:", err.Error())
  117. }
  118. }
  119. go func() {
  120. for {
  121. cachedReq, err := netcache.Get(stateStr)
  122. if err != nil {
  123. if strings.Contains(err.Error(), "expired") {
  124. logger.Log(1, "timeout occurred while waiting for SSO registration")
  125. timeout <- true
  126. break
  127. }
  128. continue
  129. } else if len(cachedReq.User) > 0 {
  130. logger.Log(0, "host SSO process completed for user", cachedReq.User)
  131. answer <- *cachedReq
  132. break
  133. }
  134. time.Sleep(500) // try it 2 times per second to see if auth is completed
  135. }
  136. }()
  137. select {
  138. case result := <-answer: // a read from req.answerCh has occurred
  139. // add the host, if not exists, handle like enrollment registration
  140. hostPass := result.Host.HostPass
  141. if !logic.HostExists(&result.Host) { // check if host already exists, add if not
  142. if servercfg.GetBrokerType() == servercfg.EmqxBrokerType {
  143. if err := mq.CreateEmqxUser(result.Host.ID.String(), result.Host.HostPass, false); err != nil {
  144. logger.Log(0, "failed to create host credentials for EMQX: ", err.Error())
  145. return
  146. }
  147. if err := mq.CreateHostACL(result.Host.ID.String(), servercfg.GetServerInfo().Server); err != nil {
  148. logger.Log(0, "failed to add host ACL rules to EMQX: ", err.Error())
  149. return
  150. }
  151. }
  152. logic.CheckHostPorts(&result.Host)
  153. if err := logic.CreateHost(&result.Host); err != nil {
  154. handleHostRegErr(conn, err)
  155. return
  156. }
  157. }
  158. key, keyErr := logic.RetrievePublicTrafficKey()
  159. if keyErr != nil {
  160. handleHostRegErr(conn, err)
  161. return
  162. }
  163. currHost, err := logic.GetHost(result.Host.ID.String())
  164. if err != nil {
  165. handleHostRegErr(conn, err)
  166. return
  167. }
  168. var currentNetworks = []string{}
  169. if result.ALL {
  170. currentNets, err := logic.GetNetworks()
  171. if err == nil && len(currentNets) > 0 {
  172. for i := range currentNets {
  173. currentNetworks = append(currentNetworks, currentNets[i].NetID)
  174. }
  175. }
  176. } else if len(result.Network) > 0 {
  177. currentNetworks = append(currentNetworks, result.Network)
  178. }
  179. var netsToAdd = []string{} // track the networks not currently owned by host
  180. hostNets := logic.GetHostNetworks(currHost.ID.String())
  181. for _, newNet := range currentNetworks {
  182. if !logic.StringSliceContains(hostNets, newNet) {
  183. if len(result.User) > 0 {
  184. _, err := isUserIsAllowed(result.User, newNet, false)
  185. if err != nil {
  186. logger.Log(0, "unauthorized user", result.User, "attempted to register to network", newNet)
  187. handleHostRegErr(conn, err)
  188. return
  189. }
  190. }
  191. netsToAdd = append(netsToAdd, newNet)
  192. }
  193. }
  194. server := servercfg.GetServerInfo()
  195. server.TrafficKey = key
  196. if servercfg.GetBrokerType() == servercfg.EmqxBrokerType {
  197. // set MQ username and password for EMQX clients
  198. server.MQUserName = result.Host.ID.String()
  199. server.MQPassword = hostPass
  200. }
  201. result.Host.HostPass = ""
  202. response := models.RegisterResponse{
  203. ServerConf: server,
  204. RequestedHost: result.Host,
  205. }
  206. reponseData, err := json.Marshal(&response)
  207. if err != nil {
  208. handleHostRegErr(conn, err)
  209. return
  210. }
  211. if err = conn.WriteMessage(messageType, reponseData); err != nil {
  212. logger.Log(0, "error during message writing:", err.Error())
  213. }
  214. go CheckNetRegAndHostUpdate(netsToAdd[:], &result.Host, uuid.Nil)
  215. case <-timeout: // the read from req.answerCh has timed out
  216. if err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")); err != nil {
  217. logger.Log(0, "error during timeout message writing:", err.Error())
  218. }
  219. }
  220. // The entry is not needed anymore, but we will let the producer to close it to avoid panic cases
  221. if err = netcache.Del(stateStr); err != nil {
  222. logger.Log(0, "failed to remove node SSO cache entry", err.Error())
  223. }
  224. // Cleanly close the connection by sending a close message and then
  225. // waiting (with timeout) for the server to close the connection.
  226. if err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")); err != nil {
  227. logger.Log(0, "write close:", err.Error())
  228. return
  229. }
  230. }
  231. // CheckNetRegAndHostUpdate - run through networks and send a host update
  232. func CheckNetRegAndHostUpdate(networks []string, h *models.Host, relayNodeId uuid.UUID) {
  233. // publish host update through MQ
  234. for i := range networks {
  235. network := networks[i]
  236. if ok, _ := logic.NetworkExists(network); ok {
  237. newNode, err := logic.UpdateHostNetwork(h, network, true)
  238. if err != nil {
  239. logger.Log(0, "failed to add host to network:", h.ID.String(), h.Name, network, err.Error())
  240. continue
  241. }
  242. if relayNodeId != uuid.Nil && !newNode.IsRelayed {
  243. newNode.IsRelayed = true
  244. newNode.RelayedBy = relayNodeId.String()
  245. slog.Info(fmt.Sprintf("adding relayed node %s to relay %s on network %s", newNode.ID.String(), relayNodeId.String(), network))
  246. if err := logic.UpsertNode(newNode); err != nil {
  247. slog.Error("failed to update node", "nodeid", relayNodeId.String())
  248. }
  249. }
  250. logger.Log(1, "added new node", newNode.ID.String(), "to host", h.Name)
  251. hostactions.AddAction(models.HostUpdate{
  252. Action: models.JoinHostToNetwork,
  253. Host: *h,
  254. Node: *newNode,
  255. })
  256. if h.IsDefault {
  257. // make host failover
  258. logic.CreateFailOver(*newNode)
  259. // make host remote access gateway
  260. logic.CreateIngressGateway(network, newNode.ID.String(), models.IngressRequest{})
  261. }
  262. }
  263. }
  264. if servercfg.IsMessageQueueBackend() {
  265. mq.HostUpdate(&models.HostUpdate{
  266. Action: models.RequestAck,
  267. Host: *h,
  268. })
  269. if err := mq.PublishPeerUpdate(false); err != nil {
  270. logger.Log(0, "failed to publish peer update during registration -", err.Error())
  271. }
  272. }
  273. }
  274. func handleHostRegErr(conn *websocket.Conn, err error) {
  275. _ = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, ""))
  276. if err != nil {
  277. logger.Log(0, "error during host registration via auth:", err.Error())
  278. }
  279. }