auth.go 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  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/oauth2"
  12. "github.com/gorilla/websocket"
  13. "github.com/gravitl/netmaker/logger"
  14. "github.com/gravitl/netmaker/logic"
  15. "github.com/gravitl/netmaker/logic/pro/netcache"
  16. "github.com/gravitl/netmaker/models"
  17. "github.com/gravitl/netmaker/servercfg"
  18. )
  19. // == consts ==
  20. const (
  21. init_provider = "initprovider"
  22. get_user_info = "getuserinfo"
  23. handle_callback = "handlecallback"
  24. handle_login = "handlelogin"
  25. google_provider_name = "google"
  26. azure_ad_provider_name = "azure-ad"
  27. github_provider_name = "github"
  28. oidc_provider_name = "oidc"
  29. verify_user = "verifyuser"
  30. auth_key = "netmaker_auth"
  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. var _, err = fetchPassValue(logic.RandomString(64))
  70. if err != nil {
  71. logger.Log(0, err.Error())
  72. return ""
  73. }
  74. var currentFrontendURL = servercfg.GetFrontendURL()
  75. if currentFrontendURL == "" {
  76. return ""
  77. }
  78. var authInfo = servercfg.GetAuthProviderInfo()
  79. var serverConn = servercfg.GetAPIHost()
  80. if strings.Contains(serverConn, "localhost") || strings.Contains(serverConn, "127.0.0.1") {
  81. serverConn = "http://" + serverConn
  82. logger.Log(1, "localhost OAuth detected, proceeding with insecure http redirect: (", serverConn, ")")
  83. } else {
  84. serverConn = "https://" + serverConn
  85. logger.Log(1, "external OAuth detected, proceeding with https redirect: ("+serverConn+")")
  86. }
  87. if authInfo[0] == "oidc" {
  88. functions[init_provider].(func(string, string, string, string))(serverConn+"/api/oauth/callback", authInfo[1], authInfo[2], authInfo[3])
  89. return authInfo[0]
  90. }
  91. functions[init_provider].(func(string, string, string))(serverConn+"/api/oauth/callback", authInfo[1], authInfo[2])
  92. return authInfo[0]
  93. }
  94. // HandleAuthCallback - handles oauth callback
  95. // Note: not included in API reference as part of the OAuth process itself.
  96. func HandleAuthCallback(w http.ResponseWriter, r *http.Request) {
  97. if auth_provider == nil {
  98. w.Header().Set("Content-Type", "text/html; charset=utf-8")
  99. _, _ = fmt.Fprintln(w, oauthNotConfigured)
  100. return
  101. }
  102. var functions = getCurrentAuthFunctions()
  103. if functions == nil {
  104. return
  105. }
  106. state, _ := getStateAndCode(r)
  107. _, err := netcache.Get(state) // if in netcache proceeed with node registration login
  108. if err == nil || errors.Is(err, netcache.ErrExpired) {
  109. switch len(state) {
  110. case node_signin_length:
  111. logger.Log(0, "proceeding with node SSO callback")
  112. HandleNodeSSOCallback(w, r)
  113. case headless_signin_length:
  114. logger.Log(0, "proceeding with headless SSO callback")
  115. HandleHeadlessSSOCallback(w, r)
  116. default:
  117. logger.Log(1, "invalid state length: ", fmt.Sprintf("%d", len(state)))
  118. }
  119. } else { // handle normal login
  120. functions[handle_callback].(func(http.ResponseWriter, *http.Request))(w, r)
  121. }
  122. }
  123. // swagger:route GET /api/oauth/login nodes HandleAuthLogin
  124. //
  125. // Handles OAuth login.
  126. //
  127. // Schemes: https
  128. //
  129. // Security:
  130. // oauth
  131. func HandleAuthLogin(w http.ResponseWriter, r *http.Request) {
  132. if auth_provider == nil {
  133. var referer = r.Header.Get("referer")
  134. if referer != "" {
  135. http.Redirect(w, r, referer+"login?oauth=callback-error", http.StatusTemporaryRedirect)
  136. return
  137. }
  138. w.Header().Set("Content-Type", "text/html; charset=utf-8")
  139. _, _ = fmt.Fprintln(w, oauthNotConfigured)
  140. return
  141. }
  142. var functions = getCurrentAuthFunctions()
  143. if functions == nil {
  144. return
  145. }
  146. functions[handle_login].(func(http.ResponseWriter, *http.Request))(w, r)
  147. }
  148. // IsOauthUser - returns
  149. func IsOauthUser(user *models.User) error {
  150. var currentValue, err = fetchPassValue("")
  151. if err != nil {
  152. return err
  153. }
  154. var bCryptErr = bcrypt.CompareHashAndPassword([]byte(user.Password), []byte(currentValue))
  155. return bCryptErr
  156. }
  157. // HandleHeadlessSSO - handles the OAuth login flow for headless interfaces such as Netmaker CLI via websocket
  158. func HandleHeadlessSSO(w http.ResponseWriter, r *http.Request) {
  159. conn, err := upgrader.Upgrade(w, r, nil)
  160. if err != nil {
  161. logger.Log(0, "error during connection upgrade for headless sign-in:", err.Error())
  162. return
  163. }
  164. if conn == nil {
  165. logger.Log(0, "failed to establish web-socket connection during headless sign-in")
  166. return
  167. }
  168. defer conn.Close()
  169. req := &netcache.CValue{User: "", Pass: ""}
  170. stateStr := logic.RandomString(headless_signin_length)
  171. if err = netcache.Set(stateStr, req); err != nil {
  172. logger.Log(0, "Failed to process sso request -", err.Error())
  173. return
  174. }
  175. timeout := make(chan bool, 1)
  176. answer := make(chan string, 1)
  177. defer close(answer)
  178. defer close(timeout)
  179. if auth_provider == nil {
  180. if err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")); err != nil {
  181. logger.Log(0, "error during message writing:", err.Error())
  182. }
  183. return
  184. }
  185. redirectUrl = fmt.Sprintf("https://%s/api/oauth/register/%s", servercfg.GetAPIConnString(), stateStr)
  186. if err = conn.WriteMessage(websocket.TextMessage, []byte(redirectUrl)); err != nil {
  187. logger.Log(0, "error during message writing:", err.Error())
  188. }
  189. go func() {
  190. for {
  191. cachedReq, err := netcache.Get(stateStr)
  192. if err != nil {
  193. if strings.Contains(err.Error(), "expired") {
  194. logger.Log(0, "timeout occurred while waiting for SSO")
  195. timeout <- true
  196. break
  197. }
  198. continue
  199. } else if cachedReq.Pass != "" {
  200. logger.Log(0, "SSO process completed for user ", cachedReq.User)
  201. answer <- cachedReq.Pass
  202. break
  203. }
  204. time.Sleep(500) // try it 2 times per second to see if auth is completed
  205. }
  206. }()
  207. select {
  208. case result := <-answer:
  209. if err = conn.WriteMessage(websocket.TextMessage, []byte(result)); err != nil {
  210. logger.Log(0, "Error during message writing:", err.Error())
  211. }
  212. case <-timeout:
  213. logger.Log(0, "Authentication server time out for headless SSO login")
  214. if err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")); err != nil {
  215. logger.Log(0, "Error during message writing:", err.Error())
  216. }
  217. }
  218. if err = netcache.Del(stateStr); err != nil {
  219. logger.Log(0, "failed to remove SSO cache entry", err.Error())
  220. }
  221. if err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")); err != nil {
  222. logger.Log(0, "write close:", err.Error())
  223. }
  224. }
  225. // == private methods ==
  226. func addUser(email string) error {
  227. var hasAdmin, err = logic.HasAdmin()
  228. if err != nil {
  229. logger.Log(1, "error checking for existence of admin user during OAuth login for", email, "; user not added")
  230. return err
  231. } // generate random password to adapt to current model
  232. var newPass, fetchErr = fetchPassValue("")
  233. if fetchErr != nil {
  234. return fetchErr
  235. }
  236. var newUser = models.User{
  237. UserName: email,
  238. Password: newPass,
  239. }
  240. if !hasAdmin { // must be first attempt, create an admin
  241. if err = logic.CreateAdmin(&newUser); err != nil {
  242. logger.Log(1, "error creating admin from user,", email, "; user not added")
  243. } else {
  244. logger.Log(1, "admin created from user,", email, "; was first user added")
  245. }
  246. } else { // otherwise add to db as admin..?
  247. // TODO: add ability to add users with preemptive permissions
  248. newUser.IsAdmin = false
  249. if err = logic.CreateUser(&newUser); err != nil {
  250. logger.Log(1, "error creating user,", email, "; user not added")
  251. } else {
  252. logger.Log(0, "user created from ", email)
  253. }
  254. }
  255. return nil
  256. }
  257. func fetchPassValue(newValue string) (string, error) {
  258. type valueHolder struct {
  259. Value string `json:"value" bson:"value"`
  260. }
  261. var b64NewValue = base64.StdEncoding.EncodeToString([]byte(newValue))
  262. var newValueHolder = &valueHolder{
  263. Value: b64NewValue,
  264. }
  265. var data, marshalErr = json.Marshal(newValueHolder)
  266. if marshalErr != nil {
  267. return "", marshalErr
  268. }
  269. var currentValue, err = logic.FetchAuthSecret(auth_key, string(data))
  270. if err != nil {
  271. return "", err
  272. }
  273. var unmarshErr = json.Unmarshal([]byte(currentValue), newValueHolder)
  274. if unmarshErr != nil {
  275. return "", unmarshErr
  276. }
  277. var b64CurrentValue, b64Err = base64.StdEncoding.DecodeString(newValueHolder.Value)
  278. if b64Err != nil {
  279. logger.Log(0, "could not decode pass")
  280. return "", nil
  281. }
  282. return string(b64CurrentValue), nil
  283. }
  284. func getStateAndCode(r *http.Request) (string, string) {
  285. var state, code string
  286. if r.FormValue("state") != "" && r.FormValue("code") != "" {
  287. state = r.FormValue("state")
  288. code = r.FormValue("code")
  289. } else if r.URL.Query().Get("state") != "" && r.URL.Query().Get("code") != "" {
  290. state = r.URL.Query().Get("state")
  291. code = r.URL.Query().Get("code")
  292. }
  293. return state, code
  294. }
  295. func (user *OAuthUser) getUserName() string {
  296. var userName string
  297. if user.Email != "" {
  298. userName = user.Email
  299. } else if user.Login != "" {
  300. userName = user.Login
  301. } else if user.UserPrincipalName != "" {
  302. userName = user.UserPrincipalName
  303. } else if user.Name != "" {
  304. userName = user.Name
  305. }
  306. return userName
  307. }
  308. func isStateCached(state string) bool {
  309. _, err := netcache.Get(state)
  310. return err == nil || strings.Contains(err.Error(), "expired")
  311. }