auth.go 8.3 KB

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