restapi_auth_oauth2.go 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399
  1. package otoauth2
  2. import (
  3. "context"
  4. "crypto/rand"
  5. "crypto/tls"
  6. "crypto/x509"
  7. "encoding/base64"
  8. "encoding/json"
  9. "fmt"
  10. "io"
  11. "net/http"
  12. "os"
  13. "time"
  14. authTypes "github.com/OliveTin/OliveTin/internal/auth/authpublic"
  15. config "github.com/OliveTin/OliveTin/internal/config"
  16. log "github.com/sirupsen/logrus"
  17. "golang.org/x/oauth2"
  18. )
  19. type OAuth2Handler struct {
  20. cfg *config.Config
  21. registeredStates map[string]*oauth2State
  22. registeredProviders map[string]*oauth2.Config
  23. }
  24. func NewOAuth2Handler(cfg *config.Config) *OAuth2Handler {
  25. h := &OAuth2Handler{
  26. cfg: cfg,
  27. }
  28. h.registeredStates = make(map[string]*oauth2State)
  29. h.registeredProviders = make(map[string]*oauth2.Config)
  30. for providerName, providerConfig := range cfg.AuthOAuth2Providers {
  31. completeProviderConfig(providerName, providerConfig)
  32. newConfig := &oauth2.Config{
  33. ClientID: providerConfig.ClientID,
  34. ClientSecret: providerConfig.ClientSecret,
  35. Scopes: providerConfig.Scopes,
  36. Endpoint: oauth2.Endpoint{
  37. AuthURL: providerConfig.AuthUrl,
  38. TokenURL: providerConfig.TokenUrl,
  39. },
  40. RedirectURL: cfg.AuthOAuth2RedirectURL,
  41. }
  42. h.registeredProviders[providerName] = newConfig
  43. log.Debugf("Dumping newly registered provider: %v = %+v", providerName, providerConfig)
  44. }
  45. return h
  46. }
  47. type oauth2State struct {
  48. providerConfig *oauth2.Config
  49. providerName string
  50. Username string
  51. Usergroup string
  52. }
  53. func assignIfEmpty(target *string, value string) {
  54. if *target == "" {
  55. *target = value
  56. }
  57. }
  58. func completeProviderConfig(providerName string, providerConfig *config.OAuth2Provider) {
  59. dbConfig, ok := oauth2ProviderDatabase[providerName]
  60. if ok {
  61. assignIfEmpty(&providerConfig.Name, dbConfig.Name)
  62. assignIfEmpty(&providerConfig.Title, dbConfig.Title)
  63. assignIfEmpty(&providerConfig.WhoamiUrl, dbConfig.WhoamiUrl)
  64. assignIfEmpty(&providerConfig.TokenUrl, dbConfig.TokenUrl)
  65. assignIfEmpty(&providerConfig.AuthUrl, dbConfig.AuthUrl)
  66. assignIfEmpty(&providerConfig.Icon, dbConfig.Icon)
  67. assignIfEmpty(&providerConfig.UsernameField, dbConfig.UsernameField)
  68. if providerConfig.Scopes == nil {
  69. providerConfig.Scopes = dbConfig.Scopes
  70. }
  71. } else {
  72. log.Warnf("Provider not found in database: %v", providerName)
  73. }
  74. }
  75. func (h *OAuth2Handler) getOAuth2Config(providerName string) (*oauth2.Config, error) {
  76. config, ok := h.registeredProviders[providerName]
  77. if !ok {
  78. return nil, fmt.Errorf("provider not found in config: %v", providerName)
  79. }
  80. return config, nil
  81. }
  82. func randString(nByte int) (string, error) {
  83. b := make([]byte, nByte)
  84. if _, err := io.ReadFull(rand.Reader, b); err != nil {
  85. return "", err
  86. }
  87. return base64.URLEncoding.EncodeToString(b), nil
  88. }
  89. func (h *OAuth2Handler) cookieSecure(r *http.Request) bool {
  90. useTLS := r.TLS != nil || r.Header.Get("X-Forwarded-Proto") == "https"
  91. return useTLS || h.cfg.Security.ForceSecureCookies
  92. }
  93. func (h *OAuth2Handler) setOAuthCallbackCookie(w http.ResponseWriter, r *http.Request, name, value string) {
  94. cookie := &http.Cookie{
  95. Name: name,
  96. Value: value,
  97. MaxAge: 900, // 15 minutes
  98. Secure: h.cookieSecure(r),
  99. HttpOnly: true,
  100. Path: "/",
  101. SameSite: http.SameSiteLaxMode,
  102. }
  103. http.SetCookie(w, cookie)
  104. }
  105. func (h *OAuth2Handler) HandleOAuthLogin(w http.ResponseWriter, r *http.Request) {
  106. state, err := randString(16)
  107. if err != nil {
  108. http.Error(w, err.Error(), http.StatusInternalServerError)
  109. return
  110. }
  111. providerName := r.URL.Query().Get("provider")
  112. provider, err := h.getOAuth2Config(providerName)
  113. if err != nil {
  114. log.Errorf("Failed to get provider config: %v %v", providerName, err)
  115. http.Error(w, err.Error(), http.StatusBadRequest)
  116. return
  117. }
  118. h.registeredStates[state] = &oauth2State{
  119. providerConfig: provider,
  120. providerName: providerName,
  121. Username: "",
  122. }
  123. h.setOAuthCallbackCookie(w, r, "olivetin-sid-oauth", state)
  124. log.Infof("OAuth2 state: %v mapped to provider %v (found: %v), now redirecting", state, providerName, provider != nil)
  125. http.Redirect(w, r, provider.AuthCodeURL(state), http.StatusFound)
  126. }
  127. func (h *OAuth2Handler) validateStateMatch(queryState, cookieState string) bool {
  128. return queryState == cookieState
  129. }
  130. func (h *OAuth2Handler) checkOAuthCallbackCookie(w http.ResponseWriter, r *http.Request) (*oauth2State, string, bool) {
  131. cookie, err := r.Cookie("olivetin-sid-oauth")
  132. if err != nil {
  133. log.Errorf("Failed to get state cookie: %v", err)
  134. http.Error(w, "State not found", http.StatusBadRequest)
  135. return nil, "", false
  136. }
  137. state := cookie.Value
  138. if !h.validateStateMatch(r.URL.Query().Get("state"), state) {
  139. log.Errorf("State mismatch: %v != %v", r.URL.Query().Get("state"), state)
  140. http.Error(w, "State mismatch", http.StatusBadRequest)
  141. return nil, state, false
  142. }
  143. registeredState, ok := h.registeredStates[state]
  144. if !ok {
  145. log.Errorf("State not found in server: %v", state)
  146. http.Error(w, "State not found in server", http.StatusBadRequest)
  147. return nil, state, false
  148. }
  149. return registeredState, state, true
  150. }
  151. type HttpClientSettings struct {
  152. Transport *http.Transport
  153. Timeout time.Duration
  154. }
  155. func getOAuth2HttpClient(providerConfig *config.OAuth2Provider) *HttpClientSettings {
  156. config := &HttpClientSettings{
  157. Transport: &http.Transport{
  158. TLSClientConfig: &tls.Config{InsecureSkipVerify: providerConfig.InsecureSkipVerify},
  159. },
  160. Timeout: time.Duration(min(3, providerConfig.CallbackTimeout)) * time.Second,
  161. }
  162. if providerConfig.CertBundlePath != "" {
  163. config.Transport.TLSClientConfig.RootCAs = getOAuthCertBundle(providerConfig)
  164. }
  165. return config
  166. }
  167. func getOAuthCertBundle(providerConfig *config.OAuth2Provider) *x509.CertPool {
  168. caCert, err := os.ReadFile(providerConfig.CertBundlePath)
  169. if err != nil {
  170. log.Errorf("OAuth2 Cert Bundle - failed to read file: %v", err)
  171. return nil
  172. }
  173. caCertPool := x509.NewCertPool()
  174. if ok := caCertPool.AppendCertsFromPEM(caCert); !ok {
  175. log.Errorf("OAuth2 Cert Bundle - failed to append certificates from PEM")
  176. }
  177. return caCertPool
  178. }
  179. func (h *OAuth2Handler) exchangeOAuthCode(ctx context.Context, providerConfig *oauth2.Config, code string, clientSettings *HttpClientSettings) (*oauth2.Token, error) {
  180. exchangeClient := &http.Client{
  181. Transport: clientSettings.Transport,
  182. Timeout: clientSettings.Timeout,
  183. }
  184. ctx = context.WithValue(ctx, oauth2.HTTPClient, exchangeClient)
  185. return providerConfig.Exchange(ctx, code)
  186. }
  187. func (h *OAuth2Handler) createUserInfoClient(ctx context.Context, providerConfig *oauth2.Config, tok *oauth2.Token, clientSettings *HttpClientSettings) *http.Client {
  188. return &http.Client{
  189. Transport: &oauth2.Transport{
  190. Source: providerConfig.TokenSource(ctx, tok),
  191. Base: clientSettings.Transport,
  192. },
  193. Timeout: clientSettings.Timeout,
  194. }
  195. }
  196. func (h *OAuth2Handler) computeUsergroup(userinfo *UserInfo, providerConfig *config.OAuth2Provider) string {
  197. usergroup := userinfo.Usergroup
  198. if providerConfig != nil && providerConfig.AddToUsergroup != "" {
  199. if usergroup != "" {
  200. usergroup = usergroup + " " + providerConfig.AddToUsergroup
  201. } else {
  202. usergroup = providerConfig.AddToUsergroup
  203. }
  204. }
  205. return usergroup
  206. }
  207. func (h *OAuth2Handler) HandleOAuthCallback(w http.ResponseWriter, r *http.Request) {
  208. log.Infof("OAuth2 Callback received")
  209. registeredState, state, ok := h.checkOAuthCallbackCookie(w, r)
  210. if !ok {
  211. return
  212. }
  213. code := r.FormValue("code")
  214. log.WithFields(log.Fields{
  215. "state": state,
  216. "token-code": code,
  217. }).Debug("OAuth2 Token Code")
  218. providerConfig := h.cfg.AuthOAuth2Providers[registeredState.providerName]
  219. clientSettings := getOAuth2HttpClient(providerConfig)
  220. ctx := context.Background()
  221. tok, err := h.exchangeOAuthCode(ctx, registeredState.providerConfig, code, clientSettings)
  222. if err != nil {
  223. log.Errorf("Failed to exchange code: %v", err)
  224. http.Error(w, "Failed to exchange code", http.StatusBadRequest)
  225. return
  226. }
  227. userInfoClient := h.createUserInfoClient(ctx, registeredState.providerConfig, tok, clientSettings)
  228. userinfo := getUserInfo(h.cfg, userInfoClient, providerConfig)
  229. h.registeredStates[state].Username = userinfo.Username
  230. h.registeredStates[state].Usergroup = h.computeUsergroup(userinfo, providerConfig)
  231. http.Redirect(w, r, "/", http.StatusFound)
  232. }
  233. type UserInfo struct {
  234. Username string
  235. Usergroup string
  236. }
  237. //gocyclo:ignore
  238. func getUserInfo(cfg *config.Config, client *http.Client, provider *config.OAuth2Provider) *UserInfo {
  239. ret := &UserInfo{}
  240. res, err := client.Get(provider.WhoamiUrl)
  241. if err != nil {
  242. log.Errorf("Failed to get user data: %v", err)
  243. return ret
  244. }
  245. if res.StatusCode != http.StatusOK {
  246. log.Errorf("Failed to get user data: %v", res.StatusCode)
  247. return ret
  248. }
  249. defer res.Body.Close()
  250. contents, err := io.ReadAll(res.Body)
  251. if err != nil {
  252. log.Errorf("Failed to read user data: %v", err)
  253. return ret
  254. }
  255. var userData map[string]any
  256. if cfg.InsecureAllowDumpOAuth2UserData {
  257. log.Debugf("OAuth2 User Data: %v+", string(contents))
  258. }
  259. err = json.Unmarshal([]byte(contents), &userData)
  260. if err != nil {
  261. log.Errorf("Failed to unmarshal user data: %v", err)
  262. return ret
  263. }
  264. ret.Username = getDataField(userData, provider.UsernameField)
  265. ret.Usergroup = getDataField(userData, provider.UserGroupField)
  266. return ret
  267. }
  268. func getDataField(data map[string]any, field string) string {
  269. if field == "" {
  270. return ""
  271. }
  272. val, ok := data[field]
  273. if !ok {
  274. log.Errorf("Failed to get field from user data: %v / %v", data, field)
  275. return ""
  276. }
  277. stringVal, ok := val.(string)
  278. if !ok {
  279. log.Errorf("Field %v is not a string: %v", field, val)
  280. return ""
  281. }
  282. return stringVal
  283. }
  284. func (h *OAuth2Handler) CheckUserFromOAuth2Cookie(context *authTypes.AuthCheckingContext) *authTypes.AuthenticatedUser {
  285. cookie, err := context.Request.Cookie("olivetin-sid-oauth")
  286. user := &authTypes.AuthenticatedUser{}
  287. if err != nil {
  288. return nil
  289. }
  290. if cookie.Value == "" {
  291. return nil
  292. }
  293. serverState, found := h.registeredStates[cookie.Value]
  294. if !found {
  295. log.WithFields(log.Fields{
  296. "sid": cookie.Value,
  297. "provider": "oauth2",
  298. }).Warnf("Stale session")
  299. return nil
  300. }
  301. user.Username = serverState.Username
  302. user.UsergroupLine = serverState.Usergroup
  303. user.Provider = "oauth2"
  304. user.SID = cookie.Value
  305. return user
  306. }