auth.go 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  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 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(0, "proceeding with node SSO callback")
  107. HandleNodeSSOCallback(w, r)
  108. case headless_signin_length:
  109. logger.Log(0, "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. func HandleAuthLogin(w http.ResponseWriter, r *http.Request) {
  127. if auth_provider == nil {
  128. handleOauthNotConfigured(w)
  129. return
  130. }
  131. var functions = getCurrentAuthFunctions()
  132. if functions == nil {
  133. return
  134. }
  135. if servercfg.GetFrontendURL() == "" {
  136. handleOauthNotConfigured(w)
  137. return
  138. }
  139. functions[handle_login].(func(http.ResponseWriter, *http.Request))(w, r)
  140. }
  141. // IsOauthUser - returns
  142. func IsOauthUser(user *models.User) error {
  143. var currentValue, err = fetchPassValue("")
  144. if err != nil {
  145. return err
  146. }
  147. var bCryptErr = bcrypt.CompareHashAndPassword([]byte(user.Password), []byte(currentValue))
  148. return bCryptErr
  149. }
  150. // HandleHeadlessSSO - handles the OAuth login flow for headless interfaces such as Netmaker CLI via websocket
  151. func HandleHeadlessSSO(w http.ResponseWriter, r *http.Request) {
  152. conn, err := upgrader.Upgrade(w, r, nil)
  153. if err != nil {
  154. logger.Log(0, "error during connection upgrade for headless sign-in:", err.Error())
  155. return
  156. }
  157. if conn == nil {
  158. logger.Log(0, "failed to establish web-socket connection during headless sign-in")
  159. return
  160. }
  161. defer conn.Close()
  162. req := &netcache.CValue{User: "", Pass: ""}
  163. stateStr := logic.RandomString(headless_signin_length)
  164. if err = netcache.Set(stateStr, req); err != nil {
  165. logger.Log(0, "Failed to process sso request -", err.Error())
  166. return
  167. }
  168. timeout := make(chan bool, 1)
  169. answer := make(chan string, 1)
  170. defer close(answer)
  171. defer close(timeout)
  172. if auth_provider == nil {
  173. if err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")); err != nil {
  174. logger.Log(0, "error during message writing:", err.Error())
  175. }
  176. return
  177. }
  178. redirectUrl = fmt.Sprintf("https://%s/api/oauth/register/%s", servercfg.GetAPIConnString(), stateStr)
  179. if err = conn.WriteMessage(websocket.TextMessage, []byte(redirectUrl)); err != nil {
  180. logger.Log(0, "error during message writing:", err.Error())
  181. }
  182. go func() {
  183. for {
  184. cachedReq, err := netcache.Get(stateStr)
  185. if err != nil {
  186. if strings.Contains(err.Error(), "expired") {
  187. logger.Log(0, "timeout occurred while waiting for SSO")
  188. timeout <- true
  189. break
  190. }
  191. continue
  192. } else if cachedReq.Pass != "" {
  193. logger.Log(0, "SSO process completed for user ", cachedReq.User)
  194. answer <- cachedReq.Pass
  195. break
  196. }
  197. time.Sleep(500) // try it 2 times per second to see if auth is completed
  198. }
  199. }()
  200. select {
  201. case result := <-answer:
  202. if err = conn.WriteMessage(websocket.TextMessage, []byte(result)); err != nil {
  203. logger.Log(0, "Error during message writing:", err.Error())
  204. }
  205. case <-timeout:
  206. logger.Log(0, "Authentication server time out for headless SSO login")
  207. if err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")); err != nil {
  208. logger.Log(0, "Error during message writing:", err.Error())
  209. }
  210. }
  211. if err = netcache.Del(stateStr); err != nil {
  212. logger.Log(0, "failed to remove SSO cache entry", err.Error())
  213. }
  214. if err = conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")); err != nil {
  215. logger.Log(0, "write close:", err.Error())
  216. }
  217. }
  218. // == private methods ==
  219. func addUser(email string) error {
  220. var hasAdmin, err = logic.HasAdmin()
  221. if err != nil {
  222. logger.Log(1, "error checking for existence of admin user during OAuth login for", email, "; user not added")
  223. return err
  224. } // generate random password to adapt to current model
  225. var newPass, fetchErr = fetchPassValue("")
  226. if fetchErr != nil {
  227. return fetchErr
  228. }
  229. var newUser = models.User{
  230. UserName: email,
  231. Password: newPass,
  232. }
  233. if !hasAdmin { // must be first attempt, create an admin
  234. if err = logic.CreateAdmin(&newUser); err != nil {
  235. logger.Log(1, "error creating admin from user,", email, "; user not added")
  236. } else {
  237. logger.Log(1, "admin created from user,", email, "; was first user added")
  238. }
  239. } else { // otherwise add to db as admin..?
  240. // TODO: add ability to add users with preemptive permissions
  241. newUser.IsAdmin = false
  242. if err = logic.CreateUser(&newUser); err != nil {
  243. logger.Log(1, "error creating user,", email, "; user not added")
  244. } else {
  245. logger.Log(0, "user created from ", email)
  246. }
  247. }
  248. return nil
  249. }
  250. func fetchPassValue(newValue string) (string, error) {
  251. type valueHolder struct {
  252. Value string `json:"value" bson:"value"`
  253. }
  254. var b64NewValue = base64.StdEncoding.EncodeToString([]byte(newValue))
  255. var newValueHolder = &valueHolder{
  256. Value: b64NewValue,
  257. }
  258. var data, marshalErr = json.Marshal(newValueHolder)
  259. if marshalErr != nil {
  260. return "", marshalErr
  261. }
  262. var currentValue, err = logic.FetchAuthSecret(auth_key, string(data))
  263. if err != nil {
  264. return "", err
  265. }
  266. var unmarshErr = json.Unmarshal([]byte(currentValue), newValueHolder)
  267. if unmarshErr != nil {
  268. return "", unmarshErr
  269. }
  270. var b64CurrentValue, b64Err = base64.StdEncoding.DecodeString(newValueHolder.Value)
  271. if b64Err != nil {
  272. logger.Log(0, "could not decode pass")
  273. return "", nil
  274. }
  275. return string(b64CurrentValue), nil
  276. }
  277. func getStateAndCode(r *http.Request) (string, string) {
  278. var state, code string
  279. if r.FormValue("state") != "" && r.FormValue("code") != "" {
  280. state = r.FormValue("state")
  281. code = r.FormValue("code")
  282. } else if r.URL.Query().Get("state") != "" && r.URL.Query().Get("code") != "" {
  283. state = r.URL.Query().Get("state")
  284. code = r.URL.Query().Get("code")
  285. }
  286. return state, code
  287. }
  288. func (user *OAuthUser) getUserName() string {
  289. var userName string
  290. if user.Email != "" {
  291. userName = user.Email
  292. } else if user.Login != "" {
  293. userName = user.Login
  294. } else if user.UserPrincipalName != "" {
  295. userName = user.UserPrincipalName
  296. } else if user.Name != "" {
  297. userName = user.Name
  298. }
  299. return userName
  300. }
  301. func isStateCached(state string) bool {
  302. _, err := netcache.Get(state)
  303. return err == nil || strings.Contains(err.Error(), "expired")
  304. }