auth.go 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  1. package auth
  2. import (
  3. "errors"
  4. "fmt"
  5. "net/http"
  6. "strings"
  7. "time"
  8. "github.com/gorilla/websocket"
  9. "github.com/gravitl/netmaker/logger"
  10. "github.com/gravitl/netmaker/logic"
  11. "github.com/gravitl/netmaker/logic/pro/netcache"
  12. "github.com/gravitl/netmaker/servercfg"
  13. "golang.org/x/oauth2"
  14. )
  15. // == consts ==
  16. const (
  17. init_provider = "initprovider"
  18. get_user_info = "getuserinfo"
  19. handle_callback = "handlecallback"
  20. handle_login = "handlelogin"
  21. google_provider_name = "google"
  22. azure_ad_provider_name = "azure-ad"
  23. github_provider_name = "github"
  24. oidc_provider_name = "oidc"
  25. verify_user = "verifyuser"
  26. user_signin_length = 16
  27. node_signin_length = 64
  28. headless_signin_length = 32
  29. )
  30. // OAuthUser - generic OAuth strategy user
  31. type OAuthUser struct {
  32. Name string `json:"name" bson:"name"`
  33. Email string `json:"email" bson:"email"`
  34. Login string `json:"login" bson:"login"`
  35. UserPrincipalName string `json:"userPrincipalName" bson:"userPrincipalName"`
  36. AccessToken string `json:"accesstoken" bson:"accesstoken"`
  37. }
  38. var (
  39. auth_provider *oauth2.Config
  40. upgrader = websocket.Upgrader{}
  41. )
  42. func getCurrentAuthFunctions() map[string]interface{} {
  43. var authInfo = servercfg.GetAuthProviderInfo()
  44. var authProvider = authInfo[0]
  45. switch authProvider {
  46. case google_provider_name:
  47. return google_functions
  48. case azure_ad_provider_name:
  49. return azure_ad_functions
  50. case github_provider_name:
  51. return github_functions
  52. case oidc_provider_name:
  53. return oidc_functions
  54. default:
  55. return nil
  56. }
  57. }
  58. // InitializeAuthProvider - initializes the auth provider if any is present
  59. func InitializeAuthProvider() string {
  60. var functions = getCurrentAuthFunctions()
  61. if functions == nil {
  62. return ""
  63. }
  64. logger.Log(0, "setting oauth secret")
  65. var err = logic.SetAuthSecret(logic.RandomString(64))
  66. if err != nil {
  67. logger.FatalLog("failed to set auth_secret", err.Error())
  68. }
  69. var authInfo = servercfg.GetAuthProviderInfo()
  70. var serverConn = servercfg.GetAPIHost()
  71. if strings.Contains(serverConn, "localhost") || strings.Contains(serverConn, "127.0.0.1") {
  72. serverConn = "http://" + serverConn
  73. logger.Log(1, "localhost OAuth detected, proceeding with insecure http redirect: (", serverConn, ")")
  74. } else {
  75. serverConn = "https://" + serverConn
  76. logger.Log(1, "external OAuth detected, proceeding with https redirect: ("+serverConn+")")
  77. }
  78. if authInfo[0] == "oidc" {
  79. functions[init_provider].(func(string, string, string, string))(serverConn+"/api/oauth/callback", authInfo[1], authInfo[2], authInfo[3])
  80. return authInfo[0]
  81. }
  82. functions[init_provider].(func(string, string, string))(serverConn+"/api/oauth/callback", authInfo[1], authInfo[2])
  83. return authInfo[0]
  84. }
  85. // HandleAuthCallback - handles oauth callback
  86. // Note: not included in API reference as part of the OAuth process itself.
  87. func HandleAuthCallback(w http.ResponseWriter, r *http.Request) {
  88. if auth_provider == nil {
  89. handleOauthNotConfigured(w)
  90. return
  91. }
  92. var functions = getCurrentAuthFunctions()
  93. if functions == nil {
  94. return
  95. }
  96. state, _ := getStateAndCode(r)
  97. _, err := netcache.Get(state) // if in netcache proceeed with node registration login
  98. if err == nil || errors.Is(err, netcache.ErrExpired) {
  99. switch len(state) {
  100. case node_signin_length:
  101. logger.Log(1, "proceeding with host SSO callback")
  102. HandleHostSSOCallback(w, r)
  103. case headless_signin_length:
  104. logger.Log(1, "proceeding with headless SSO callback")
  105. HandleHeadlessSSOCallback(w, r)
  106. default:
  107. logger.Log(1, "invalid state length: ", fmt.Sprintf("%d", len(state)))
  108. }
  109. } else { // handle normal login
  110. functions[handle_callback].(func(http.ResponseWriter, *http.Request))(w, r)
  111. }
  112. }
  113. // swagger:route GET /api/oauth/login nodes HandleAuthLogin
  114. //
  115. // Handles OAuth login.
  116. //
  117. // Schemes: https
  118. //
  119. // Security:
  120. // oauth
  121. // Responses:
  122. // 200: okResponse
  123. func HandleAuthLogin(w http.ResponseWriter, r *http.Request) {
  124. if auth_provider == nil {
  125. handleOauthNotConfigured(w)
  126. return
  127. }
  128. var functions = getCurrentAuthFunctions()
  129. if functions == nil {
  130. return
  131. }
  132. if servercfg.GetFrontendURL() == "" {
  133. handleOauthNotConfigured(w)
  134. return
  135. }
  136. functions[handle_login].(func(http.ResponseWriter, *http.Request))(w, r)
  137. }
  138. // HandleHeadlessSSO - handles the OAuth login flow for headless interfaces such as Netmaker CLI via websocket
  139. func HandleHeadlessSSO(w http.ResponseWriter, r *http.Request) {
  140. conn, err := upgrader.Upgrade(w, r, nil)
  141. if err != nil {
  142. logger.Log(0, "error during connection upgrade for headless sign-in:", err.Error())
  143. return
  144. }
  145. if conn == nil {
  146. logger.Log(0, "failed to establish web-socket connection during headless sign-in")
  147. return
  148. }
  149. defer conn.Close()
  150. req := &netcache.CValue{User: "", Pass: ""}
  151. stateStr := logic.RandomString(headless_signin_length)
  152. if err = netcache.Set(stateStr, req); err != nil {
  153. logger.Log(0, "Failed to process sso request -", err.Error())
  154. return
  155. }
  156. timeout := make(chan bool, 1)
  157. answer := make(chan string, 1)
  158. defer close(answer)
  159. defer close(timeout)
  160. if auth_provider == nil {
  161. if err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")); err != nil {
  162. logger.Log(0, "error during message writing:", err.Error())
  163. }
  164. return
  165. }
  166. redirectUrl = fmt.Sprintf("https://%s/api/oauth/register/%s", servercfg.GetAPIConnString(), stateStr)
  167. if err = conn.WriteMessage(websocket.TextMessage, []byte(redirectUrl)); err != nil {
  168. logger.Log(0, "error during message writing:", err.Error())
  169. }
  170. go func() {
  171. for {
  172. cachedReq, err := netcache.Get(stateStr)
  173. if err != nil {
  174. if strings.Contains(err.Error(), "expired") {
  175. logger.Log(0, "timeout occurred while waiting for SSO")
  176. timeout <- true
  177. break
  178. }
  179. continue
  180. } else if cachedReq.Pass != "" {
  181. logger.Log(0, "SSO process completed for user ", cachedReq.User)
  182. answer <- cachedReq.Pass
  183. break
  184. }
  185. time.Sleep(500) // try it 2 times per second to see if auth is completed
  186. }
  187. }()
  188. select {
  189. case result := <-answer:
  190. if err = conn.WriteMessage(websocket.TextMessage, []byte(result)); err != nil {
  191. logger.Log(0, "Error during message writing:", err.Error())
  192. }
  193. case <-timeout:
  194. logger.Log(0, "Authentication server time out for headless SSO login")
  195. if err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")); err != nil {
  196. logger.Log(0, "Error during message writing:", err.Error())
  197. }
  198. }
  199. if err = netcache.Del(stateStr); err != nil {
  200. logger.Log(0, "failed to remove SSO cache entry", err.Error())
  201. }
  202. if err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")); err != nil {
  203. logger.Log(0, "write close:", err.Error())
  204. }
  205. }
  206. // == private methods ==
  207. func getStateAndCode(r *http.Request) (string, string) {
  208. var state, code string
  209. if r.FormValue("state") != "" && r.FormValue("code") != "" {
  210. state = r.FormValue("state")
  211. code = r.FormValue("code")
  212. } else if r.URL.Query().Get("state") != "" && r.URL.Query().Get("code") != "" {
  213. state = r.URL.Query().Get("state")
  214. code = r.URL.Query().Get("code")
  215. }
  216. return state, code
  217. }
  218. func (user *OAuthUser) getUserName() string {
  219. var userName string
  220. if user.Email != "" {
  221. userName = user.Email
  222. } else if user.Login != "" {
  223. userName = user.Login
  224. } else if user.UserPrincipalName != "" {
  225. userName = user.UserPrincipalName
  226. } else if user.Name != "" {
  227. userName = user.Name
  228. }
  229. return userName
  230. }
  231. func isStateCached(state string) bool {
  232. _, err := netcache.Get(state)
  233. return err == nil || strings.Contains(err.Error(), "expired")
  234. }
  235. // isEmailAllowed - checks if email is allowed to signup
  236. func isEmailAllowed(email string) bool {
  237. allowedDomains := servercfg.GetAllowedEmailDomains()
  238. domains := strings.Split(allowedDomains, ",")
  239. if len(domains) == 1 && domains[0] == "*" {
  240. return true
  241. }
  242. emailParts := strings.Split(email, "@")
  243. if len(emailParts) < 2 {
  244. return false
  245. }
  246. baseDomainOfEmail := emailParts[1]
  247. for _, domain := range domains {
  248. if domain == baseDomainOfEmail {
  249. return true
  250. }
  251. }
  252. return false
  253. }