auth.go 10 KB

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