github.go 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. package auth
  2. import (
  3. "context"
  4. "encoding/json"
  5. "errors"
  6. "fmt"
  7. "io"
  8. "net/http"
  9. "strings"
  10. "github.com/gravitl/netmaker/database"
  11. "github.com/gravitl/netmaker/logger"
  12. "github.com/gravitl/netmaker/logic"
  13. "github.com/gravitl/netmaker/models"
  14. proLogic "github.com/gravitl/netmaker/pro/logic"
  15. "github.com/gravitl/netmaker/servercfg"
  16. "golang.org/x/oauth2"
  17. "golang.org/x/oauth2/github"
  18. )
  19. var github_functions = map[string]interface{}{
  20. init_provider: initGithub,
  21. get_user_info: getGithubUserInfo,
  22. handle_callback: handleGithubCallback,
  23. handle_login: handleGithubLogin,
  24. verify_user: verifyGithubUser,
  25. }
  26. // == handle github authentication here ==
  27. func initGithub(redirectURL string, clientID string, clientSecret string) {
  28. auth_provider = &oauth2.Config{
  29. RedirectURL: redirectURL,
  30. ClientID: clientID,
  31. ClientSecret: clientSecret,
  32. Scopes: []string{"read:user", "user:email"},
  33. Endpoint: github.Endpoint,
  34. }
  35. }
  36. func handleGithubLogin(w http.ResponseWriter, r *http.Request) {
  37. var oauth_state_string = logic.RandomString(user_signin_length)
  38. if auth_provider == nil {
  39. handleOauthNotConfigured(w)
  40. return
  41. }
  42. if err := logic.SetState(oauth_state_string); err != nil {
  43. handleOauthNotConfigured(w)
  44. return
  45. }
  46. var url = auth_provider.AuthCodeURL(oauth_state_string)
  47. http.Redirect(w, r, url, http.StatusTemporaryRedirect)
  48. }
  49. func handleGithubCallback(w http.ResponseWriter, r *http.Request) {
  50. var rState, rCode = getStateAndCode(r)
  51. var content, err = getGithubUserInfo(rState, rCode)
  52. if err != nil {
  53. logger.Log(1, "error when getting user info from github:", err.Error())
  54. if strings.Contains(err.Error(), "invalid oauth state") || strings.Contains(err.Error(), "failed to fetch user email from SSO state") {
  55. handleOauthNotValid(w)
  56. return
  57. }
  58. handleOauthNotConfigured(w)
  59. return
  60. }
  61. var inviteExists bool
  62. // check if invite exists for User
  63. in, err := logic.GetUserInvite(content.Email)
  64. if err == nil {
  65. inviteExists = true
  66. }
  67. // check if user approval is already pending
  68. if !inviteExists && logic.IsPendingUser(content.Email) {
  69. handleOauthUserSignUpApprovalPending(w)
  70. return
  71. }
  72. // if user exists with provider ID, convert them into email ID
  73. user, err := logic.GetUser(content.Login)
  74. if err == nil {
  75. // if user exists, then ensure user's auth type is
  76. // oauth before proceeding.
  77. if user.AuthType == models.BasicAuth {
  78. logger.Log(0, "invalid auth type: basic_auth")
  79. handleAuthTypeMismatch(w)
  80. return
  81. }
  82. // checks if user exists with email
  83. _, err := logic.GetUser(content.Email)
  84. if err != nil {
  85. user.UserName = content.Email
  86. user.ExternalIdentityProviderID = content.Login
  87. database.DeleteRecord(database.USERS_TABLE_NAME, content.Login)
  88. d, _ := json.Marshal(user)
  89. database.Insert(user.UserName, string(d), database.USERS_TABLE_NAME)
  90. }
  91. }
  92. _, err = logic.GetUser(content.Email)
  93. if err != nil {
  94. if database.IsEmptyRecord(err) { // user must not exist, so try to make one
  95. if inviteExists {
  96. // create user
  97. user, err := proLogic.PrepareOauthUserFromInvite(in)
  98. if err != nil {
  99. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  100. return
  101. }
  102. user.ExternalIdentityProviderID = content.Login
  103. if err = logic.CreateUser(&user); err != nil {
  104. handleSomethingWentWrong(w)
  105. return
  106. }
  107. logic.DeleteUserInvite(content.Email)
  108. logic.DeletePendingUser(content.Email)
  109. } else {
  110. if !isEmailAllowed(content.Email) {
  111. handleOauthUserNotAllowedToSignUp(w)
  112. return
  113. }
  114. err = logic.InsertPendingUser(&models.User{
  115. UserName: content.Email,
  116. })
  117. if err != nil {
  118. handleSomethingWentWrong(w)
  119. return
  120. }
  121. handleFirstTimeOauthUserSignUp(w)
  122. return
  123. }
  124. } else {
  125. handleSomethingWentWrong(w)
  126. return
  127. }
  128. }
  129. user, err = logic.GetUser(content.Email)
  130. if err != nil {
  131. handleOauthUserNotFound(w)
  132. return
  133. }
  134. userRole, err := logic.GetRole(user.PlatformRoleID)
  135. if err != nil {
  136. handleSomethingWentWrong(w)
  137. return
  138. }
  139. if userRole.DenyDashboardAccess {
  140. handleOauthUserNotAllowed(w)
  141. return
  142. }
  143. var newPass, fetchErr = logic.FetchPassValue("")
  144. if fetchErr != nil {
  145. return
  146. }
  147. // send a netmaker jwt token
  148. var authRequest = models.UserAuthParams{
  149. UserName: content.Email,
  150. Password: newPass,
  151. }
  152. var jwt, jwtErr = logic.VerifyAuthRequest(authRequest)
  153. if jwtErr != nil {
  154. logger.Log(1, "could not parse jwt for user", authRequest.UserName)
  155. return
  156. }
  157. logger.Log(1, "completed github OAuth sigin in for", content.Email)
  158. http.Redirect(w, r, servercfg.GetFrontendURL()+"/login?login="+jwt+"&user="+content.Email, http.StatusPermanentRedirect)
  159. }
  160. func getGithubUserInfo(state, code string) (*OAuthUser, error) {
  161. oauth_state_string, isValid := logic.IsStateValid(state)
  162. if (!isValid || state != oauth_state_string) && !isStateCached(state) {
  163. return nil, fmt.Errorf("invalid oauth state")
  164. }
  165. var token, err = auth_provider.Exchange(context.Background(), code, oauth2.SetAuthURLParam("prompt", "login"))
  166. if err != nil {
  167. return nil, fmt.Errorf("code exchange failed: %s", err.Error())
  168. }
  169. if !token.Valid() {
  170. return nil, fmt.Errorf("GitHub code exchange yielded invalid token")
  171. }
  172. var data []byte
  173. data, err = json.Marshal(token)
  174. if err != nil {
  175. return nil, fmt.Errorf("failed to convert token to json: %s", err.Error())
  176. }
  177. var httpClient = &http.Client{}
  178. var httpReq, reqErr = http.NewRequest("GET", "https://api.github.com/user", nil)
  179. if reqErr != nil {
  180. return nil, fmt.Errorf("failed to create request to GitHub")
  181. }
  182. httpReq.Header.Set("Authorization", "token "+token.AccessToken)
  183. response, err := httpClient.Do(httpReq)
  184. if err != nil {
  185. return nil, fmt.Errorf("failed getting user info: %s", err.Error())
  186. }
  187. defer response.Body.Close()
  188. contents, err := io.ReadAll(response.Body)
  189. if err != nil {
  190. return nil, fmt.Errorf("failed reading response body: %s", err.Error())
  191. }
  192. var userInfo = &OAuthUser{}
  193. if err = json.Unmarshal(contents, userInfo); err != nil {
  194. return nil, fmt.Errorf("failed parsing email from response data: %s", err.Error())
  195. }
  196. userInfo.AccessToken = string(data)
  197. if userInfo.Email == "" {
  198. // if user's email is not made public, get the info from the github emails api
  199. logger.Log(2, "fetching user email from github api")
  200. userInfo.Email, err = getGithubEmailsInfo(token.AccessToken)
  201. if err != nil {
  202. logger.Log(0, "failed to fetch user's email from github: ", err.Error())
  203. }
  204. }
  205. if userInfo.Email == "" {
  206. err = errors.New("failed to fetch user email from SSO state")
  207. return userInfo, err
  208. }
  209. return userInfo, nil
  210. }
  211. func verifyGithubUser(token *oauth2.Token) bool {
  212. return token.Valid()
  213. }
  214. func getGithubEmailsInfo(accessToken string) (string, error) {
  215. var httpClient = &http.Client{}
  216. var httpReq, reqErr = http.NewRequest("GET", "https://api.github.com/user/emails", nil)
  217. if reqErr != nil {
  218. return "", fmt.Errorf("failed to create request to GitHub")
  219. }
  220. httpReq.Header.Add("Accept", "application/vnd.github.v3+json")
  221. httpReq.Header.Set("Authorization", "token "+accessToken)
  222. response, err := httpClient.Do(httpReq)
  223. if err != nil {
  224. return "", fmt.Errorf("failed getting user info: %s", err.Error())
  225. }
  226. defer response.Body.Close()
  227. contents, err := io.ReadAll(response.Body)
  228. if err != nil {
  229. return "", fmt.Errorf("failed reading response body: %s", err.Error())
  230. }
  231. emailsInfo := []interface{}{}
  232. err = json.Unmarshal(contents, &emailsInfo)
  233. if err != nil {
  234. return "", err
  235. }
  236. for _, info := range emailsInfo {
  237. emailInfoMap := info.(map[string]interface{})
  238. if emailInfoMap["primary"].(bool) {
  239. return emailInfoMap["email"].(string), nil
  240. }
  241. }
  242. return "", errors.New("email not found")
  243. }