auth.go 9.7 KB

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