auth.go 9.6 KB

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