17 "github.com/18F/hmacauth"
18 "github.com/bitly/oauth2_proxy/cookie"
19 "github.com/bitly/oauth2_proxy/providers"
22const SignatureHeader = "GAP-Signature"
24var SignatureHeaders []string = []string{
32 "X-Forwarded-Access-Token",
37type OAuthProxy struct {
44 CookieExpire time.Duration
45 CookieRefresh time.Duration
46 Validator func(string) bool
53 OAuthCallbackPath string
56 redirectURL *url.URL // the url to receive requests at
57 provider providers.Provider
60 HtpasswdFile *HtpasswdFile
61 DisplayHtpasswdForm bool
65 SkipProviderButton bool
67 BasicAuthPassword string
69 CookieCipher *cookie.Cipher
70 skipAuthRegex []string
71 skipAuthPreflight bool
72 compiledRegex []*regexp.Regexp
73 templates *template.Template
77type UpstreamProxy struct {
80 auth hmacauth.HmacAuth
83func (u *UpstreamProxy) ServeHTTP(w http.ResponseWriter, r *http.Request) {
84 w.Header().Set("GAP-Upstream-Address", u.upstream)
86 r.Header.Set("GAP-Auth", w.Header().Get("GAP-Auth"))
89 u.handler.ServeHTTP(w, r)
92func NewReverseProxy(target *url.URL) (proxy *httputil.ReverseProxy) {
93 return httputil.NewSingleHostReverseProxy(target)
95func setProxyUpstreamHostHeader(proxy *httputil.ReverseProxy, target *url.URL) {
96 director := proxy.Director
97 proxy.Director = func(req *http.Request) {
99 // use RequestURI so that we aren't unescaping encoded slashes in the request path
100 req.Host = target.Host
101 req.URL.Opaque = req.RequestURI
102 req.URL.RawQuery = ""
105func setProxyDirector(proxy *httputil.ReverseProxy) {
106 director := proxy.Director
107 proxy.Director = func(req *http.Request) {
109 // use RequestURI so that we aren't unescaping encoded slashes in the request path
110 req.URL.Opaque = req.RequestURI
111 req.URL.RawQuery = ""
114func NewFileServer(path string, filesystemPath string) (proxy http.Handler) {
115 return http.StripPrefix(path, http.FileServer(http.Dir(filesystemPath)))
118func NewOAuthProxy(opts *Options, validator func(string) bool) *OAuthProxy {
119 serveMux := http.NewServeMux()
120 var auth hmacauth.HmacAuth
121 if sigData := opts.signatureData; sigData != nil {
122 auth = hmacauth.NewHmacAuth(sigData.hash, []byte(sigData.key),
123 SignatureHeader, SignatureHeaders)
125 for _, u := range opts.proxyURLs {
128 case "http", "https":
130 log.Printf("mapping path %q => upstream %q", path, u)
131 proxy := NewReverseProxy(u)
132 if !opts.PassHostHeader {
133 setProxyUpstreamHostHeader(proxy, u)
135 setProxyDirector(proxy)
137 serveMux.Handle(path,
138 &UpstreamProxy{u.Host, proxy, auth})
140 if u.Fragment != "" {
143 log.Printf("mapping path %q => file system %q", path, u.Path)
144 proxy := NewFileServer(path, u.Path)
145 serveMux.Handle(path, &UpstreamProxy{path, proxy, nil})
147 panic(fmt.Sprintf("unknown upstream protocol %s", u.Scheme))
150 for _, u := range opts.CompiledRegex {
151 log.Printf("compiled skip-auth-regex => %q", u)
154 redirectURL := opts.redirectURL
155 redirectURL.Path = fmt.Sprintf("%s/callback", opts.ProxyPrefix)
157 log.Printf("OAuthProxy configured for %s Client ID: %s", opts.provider.Data().ProviderName, opts.ClientID)
158 domain := opts.CookieDomain
162 refresh := "disabled"
163 if opts.CookieRefresh != time.Duration(0) {
164 refresh = fmt.Sprintf("after %s", opts.CookieRefresh)
167 log.Printf("Cookie settings: name:%s secure(https):%v httponly:%v expiry:%s domain:%s refresh:%s", opts.CookieName, opts.CookieSecure, opts.CookieHttpOnly, opts.CookieExpire, domain, refresh)
169 var cipher *cookie.Cipher
170 if opts.PassAccessToken || (opts.CookieRefresh != time.Duration(0)) {
172 cipher, err = cookie.NewCipher(secretBytes(opts.CookieSecret))
174 log.Fatal("cookie-secret error: ", err)
179 CookieName: opts.CookieName,
180 CSRFCookieName: fmt.Sprintf("%v_%v", opts.CookieName, "csrf"),
181 CookieSeed: opts.CookieSecret,
182 CookieDomain: opts.CookieDomain,
183 CookieSecure: opts.CookieSecure,
184 CookieHttpOnly: opts.CookieHttpOnly,
185 CookieExpire: opts.CookieExpire,
186 CookieRefresh: opts.CookieRefresh,
187 Validator: validator,
189 RobotsPath: "/robots.txt",
191 SignInPath: fmt.Sprintf("%s/sign_in", opts.ProxyPrefix),
192 SignOutPath: fmt.Sprintf("%s/sign_out", opts.ProxyPrefix),
193 OAuthStartPath: fmt.Sprintf("%s/start", opts.ProxyPrefix),
194 OAuthCallbackPath: fmt.Sprintf("%s/callback", opts.ProxyPrefix),
195 AuthOnlyPath: fmt.Sprintf("%s/auth", opts.ProxyPrefix),
197 ProxyPrefix: opts.ProxyPrefix,
198 provider: opts.provider,
200 redirectURL: redirectURL,
201 skipAuthRegex: opts.SkipAuthRegex,
202 skipAuthPreflight: opts.SkipAuthPreflight,
203 compiledRegex: opts.CompiledRegex,
204 SetXAuthRequest: opts.SetXAuthRequest,
205 PassBasicAuth: opts.PassBasicAuth,
206 PassUserHeaders: opts.PassUserHeaders,
207 BasicAuthPassword: opts.BasicAuthPassword,
208 PassAccessToken: opts.PassAccessToken,
209 SkipProviderButton: opts.SkipProviderButton,
210 CookieCipher: cipher,
211 templates: loadTemplates(opts.CustomTemplatesDir),
216func (p *OAuthProxy) GetRedirectURI(host string) string {
217 // default to the request Host if not set
218 if p.redirectURL.Host != "" {
219 return p.redirectURL.String()
234func (p *OAuthProxy) displayCustomLoginForm() bool {
235 return p.HtpasswdFile != nil && p.DisplayHtpasswdForm
238func (p *OAuthProxy) redeemCode(host, code string) (s *providers.SessionState, err error) {
240 return nil, errors.New("missing code")
242 redirectURI := p.GetRedirectURI(host)
243 s, err = p.provider.Redeem(redirectURI, code)
249 s.Email, err = p.provider.GetEmailAddress(s)
254func (p *OAuthProxy) MakeSessionCookie(req *http.Request, value string, expiration time.Duration, now time.Time) *http.Cookie {
256 value = cookie.SignedValue(p.CookieSeed, p.CookieName, value, now)
257 if len(value) > 4096 {
258 // Cookies cannot be larger than 4kb
259 log.Printf("WARNING - Cookie Size: %d bytes", len(value))
262 return p.makeCookie(req, p.CookieName, value, expiration, now)
265func (p *OAuthProxy) MakeCSRFCookie(req *http.Request, value string, expiration time.Duration, now time.Time) *http.Cookie {
266 return p.makeCookie(req, p.CSRFCookieName, value, expiration, now)
269func (p *OAuthProxy) makeCookie(req *http.Request, name string, value string, expiration time.Duration, now time.Time) *http.Cookie {
271 if h, _, err := net.SplitHostPort(domain); err == nil {
274 if p.CookieDomain != "" {
275 if !strings.HasSuffix(domain, p.CookieDomain) {
276 log.Printf("Warning: request host is %q but using configured cookie domain of %q", domain, p.CookieDomain)
278 domain = p.CookieDomain
286 HttpOnly: p.CookieHttpOnly,
287 Secure: p.CookieSecure,
288 Expires: now.Add(expiration),
292func (p *OAuthProxy) ClearCSRFCookie(rw http.ResponseWriter, req *http.Request) {
293 http.SetCookie(rw, p.MakeCSRFCookie(req, "", time.Hour*-1, time.Now()))
296func (p *OAuthProxy) SetCSRFCookie(rw http.ResponseWriter, req *http.Request, val string) {
297 http.SetCookie(rw, p.MakeCSRFCookie(req, val, p.CookieExpire, time.Now()))
300func (p *OAuthProxy) ClearSessionCookie(rw http.ResponseWriter, req *http.Request) {
301 http.SetCookie(rw, p.MakeSessionCookie(req, "", time.Hour*-1, time.Now()))
304func (p *OAuthProxy) SetSessionCookie(rw http.ResponseWriter, req *http.Request, val string) {
305 http.SetCookie(rw, p.MakeSessionCookie(req, val, p.CookieExpire, time.Now()))
308func (p *OAuthProxy) LoadCookiedSession(req *http.Request) (*providers.SessionState, time.Duration, error) {
309 var age time.Duration
310 c, err := req.Cookie(p.CookieName)
312 // always http.ErrNoCookie
313 return nil, age, fmt.Errorf("Cookie %q not present", p.CookieName)
315 val, timestamp, ok := cookie.Validate(c, p.CookieSeed, p.CookieExpire)
317 return nil, age, errors.New("Cookie Signature not valid")
320 session, err := p.provider.SessionFromCookie(val, p.CookieCipher)
325 age = time.Now().Truncate(time.Second).Sub(timestamp)
326 return session, age, nil
329func (p *OAuthProxy) SaveSession(rw http.ResponseWriter, req *http.Request, s *providers.SessionState) error {
330 value, err := p.provider.CookieForSession(s, p.CookieCipher)
334 p.SetSessionCookie(rw, req, value)
338func (p *OAuthProxy) RobotsTxt(rw http.ResponseWriter) {
339 rw.WriteHeader(http.StatusOK)
340 fmt.Fprintf(rw, "User-agent: *\nDisallow: /")
343func (p *OAuthProxy) PingPage(rw http.ResponseWriter) {
344 rw.WriteHeader(http.StatusOK)
345 fmt.Fprintf(rw, "OK")
348func (p *OAuthProxy) ErrorPage(rw http.ResponseWriter, code int, title string, message string) {
349 log.Printf("ErrorPage %d %s %s", code, title, message)
356 Title: fmt.Sprintf("%d %s", code, title),
358 ProxyPrefix: p.ProxyPrefix,
360 p.templates.ExecuteTemplate(rw, "error.html", t)
363func (p *OAuthProxy) SignInPage(rw http.ResponseWriter, req *http.Request, code int) {
364 p.ClearSessionCookie(rw, req)
367 redirect_url := req.URL.RequestURI()
368 if req.Header.Get("X-Auth-Request-Redirect") != "" {
369 redirect_url = req.Header.Get("X-Auth-Request-Redirect")
371 if redirect_url == p.SignInPath {
384 ProviderName: p.provider.Data().ProviderName,
385 SignInMessage: p.SignInMessage,
386 CustomLogin: p.displayCustomLoginForm(),
387 Redirect: redirect_url,
389 ProxyPrefix: p.ProxyPrefix,
390 Footer: template.HTML(p.Footer),
392 p.templates.ExecuteTemplate(rw, "sign_in.html", t)
395func (p *OAuthProxy) ManualSignIn(rw http.ResponseWriter, req *http.Request) (string, bool) {
396 if req.Method != "POST" || p.HtpasswdFile == nil {
399 user := req.FormValue("username")
400 passwd := req.FormValue("password")
405 if p.HtpasswdFile.Validate(user, passwd) {
406 log.Printf("authenticated %q via HtpasswdFile", user)
412func (p *OAuthProxy) GetRedirect(req *http.Request) (redirect string, err error) {
413 err = req.ParseForm()
418 redirect = req.Form.Get("rd")
419 if redirect == "" || !strings.HasPrefix(redirect, "/") || strings.HasPrefix(redirect, "//") {
426func (p *OAuthProxy) IsWhitelistedRequest(req *http.Request) (ok bool) {
427 isPreflightRequestAllowed := p.skipAuthPreflight && req.Method == "OPTIONS"
428 return isPreflightRequestAllowed || p.IsWhitelistedPath(req.URL.Path)
431func (p *OAuthProxy) IsWhitelistedPath(path string) (ok bool) {
432 for _, u := range p.compiledRegex {
433 ok = u.MatchString(path)
441func getRemoteAddr(req *http.Request) (s string) {
443 if req.Header.Get("X-Real-IP") != "" {
444 s += fmt.Sprintf(" (%q)", req.Header.Get("X-Real-IP"))
449func (p *OAuthProxy) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
450 switch path := req.URL.Path; {
451 case path == p.RobotsPath:
453 case path == p.PingPath:
455 case p.IsWhitelistedRequest(req):
456 p.serveMux.ServeHTTP(rw, req)
457 case path == p.SignInPath:
459 case path == p.SignOutPath:
461 case path == p.OAuthStartPath:
462 p.OAuthStart(rw, req)
463 case path == p.OAuthCallbackPath:
464 p.OAuthCallback(rw, req)
465 case path == p.AuthOnlyPath:
466 p.AuthenticateOnly(rw, req)
472func (p *OAuthProxy) SignIn(rw http.ResponseWriter, req *http.Request) {
473 redirect, err := p.GetRedirect(req)
475 p.ErrorPage(rw, 500, "Internal Error", err.Error())
479 user, ok := p.ManualSignIn(rw, req)
481 session := &providers.SessionState{User: user}
482 p.SaveSession(rw, req, session)
483 http.Redirect(rw, req, redirect, 302)
485 p.SignInPage(rw, req, 200)
489func (p *OAuthProxy) SignOut(rw http.ResponseWriter, req *http.Request) {
490 p.ClearSessionCookie(rw, req)
491 http.Redirect(rw, req, "/", 302)
494func (p *OAuthProxy) OAuthStart(rw http.ResponseWriter, req *http.Request) {
495 nonce, err := cookie.Nonce()
497 p.ErrorPage(rw, 500, "Internal Error", err.Error())
500 p.SetCSRFCookie(rw, req, nonce)
501 redirect, err := p.GetRedirect(req)
503 p.ErrorPage(rw, 500, "Internal Error", err.Error())
506 redirectURI := p.GetRedirectURI(req.Host)
507 http.Redirect(rw, req, p.provider.GetLoginURL(redirectURI, fmt.Sprintf("%v:%v", nonce, redirect)), 302)
510func (p *OAuthProxy) OAuthCallback(rw http.ResponseWriter, req *http.Request) {
511 remoteAddr := getRemoteAddr(req)
513 // finish the oauth cycle
514 err := req.ParseForm()
516 p.ErrorPage(rw, 500, "Internal Error", err.Error())
519 errorString := req.Form.Get("error")
520 if errorString != "" {
521 p.ErrorPage(rw, 403, "Permission Denied", errorString)
525 session, err := p.redeemCode(req.Host, req.Form.Get("code"))
527 log.Printf("%s error redeeming code %s", remoteAddr, err)
528 p.ErrorPage(rw, 500, "Internal Error", "Internal Error")
532 s := strings.SplitN(req.Form.Get("state"), ":", 2)
534 p.ErrorPage(rw, 500, "Internal Error", "Invalid State")
539 c, err := req.Cookie(p.CSRFCookieName)
541 p.ErrorPage(rw, 403, "Permission Denied", err.Error())
544 p.ClearCSRFCookie(rw, req)
545 if c.Value != nonce {
546 log.Printf("%s csrf token mismatch, potential attack", remoteAddr)
547 p.ErrorPage(rw, 403, "Permission Denied", "csrf failed")
551 if !strings.HasPrefix(redirect, "/") || strings.HasPrefix(redirect, "//") {
555 // set cookie, or deny
556 if p.Validator(session.Email) && p.provider.ValidateGroup(session.Email) {
557 log.Printf("%s authentication complete %s", remoteAddr, session)
558 err := p.SaveSession(rw, req, session)
560 log.Printf("%s %s", remoteAddr, err)
561 p.ErrorPage(rw, 500, "Internal Error", "Internal Error")
564 http.Redirect(rw, req, redirect, 302)
566 log.Printf("%s Permission Denied: %q is unauthorized", remoteAddr, session.Email)
567 p.ErrorPage(rw, 403, "Permission Denied", "Invalid Account")
571func (p *OAuthProxy) AuthenticateOnly(rw http.ResponseWriter, req *http.Request) {
572 status := p.Authenticate(rw, req)
573 if status == http.StatusAccepted {
574 rw.WriteHeader(http.StatusAccepted)
576 http.Error(rw, "unauthorized request", http.StatusUnauthorized)
580func (p *OAuthProxy) Proxy(rw http.ResponseWriter, req *http.Request) {
581 status := p.Authenticate(rw, req)
582 if status == http.StatusInternalServerError {
583 p.ErrorPage(rw, http.StatusInternalServerError,
584 "Internal Error", "Internal Error")
585 } else if status == http.StatusForbidden {
586 if p.SkipProviderButton {
587 p.OAuthStart(rw, req)
589 p.SignInPage(rw, req, http.StatusForbidden)
592 p.serveMux.ServeHTTP(rw, req)
596func (p *OAuthProxy) Authenticate(rw http.ResponseWriter, req *http.Request) int {
597 var saveSession, clearSession, revalidated bool
598 remoteAddr := getRemoteAddr(req)
600 session, sessionAge, err := p.LoadCookiedSession(req)
602 log.Printf("%s %s", remoteAddr, err)
604 if session != nil && sessionAge > p.CookieRefresh && p.CookieRefresh != time.Duration(0) {
605 log.Printf("%s refreshing %s old session cookie for %s (refresh after %s)", remoteAddr, sessionAge, session, p.CookieRefresh)
609 if ok, err := p.provider.RefreshSessionIfNeeded(session); err != nil {
610 log.Printf("%s removing session. error refreshing access token %s %s", remoteAddr, err, session)
618 if session != nil && session.IsExpired() {
619 log.Printf("%s removing session. token expired %s", remoteAddr, session)
625 if saveSession && !revalidated && session != nil && session.AccessToken != "" {
626 if !p.provider.ValidateSessionState(session) {
627 log.Printf("%s removing session. error validating %s", remoteAddr, session)
634 if session != nil && session.Email != "" && !p.Validator(session.Email) {
635 log.Printf("%s Permission Denied: removing session %s", remoteAddr, session)
641 if saveSession && session != nil {
642 err := p.SaveSession(rw, req, session)
644 log.Printf("%s %s", remoteAddr, err)
645 return http.StatusInternalServerError
650 p.ClearSessionCookie(rw, req)
654 session, err = p.CheckBasicAuth(req)
656 log.Printf("%s %s", remoteAddr, err)
661 return http.StatusForbidden
664 // At this point, the user is authenticated. proxy normally
666 req.SetBasicAuth(session.User, p.BasicAuthPassword)
667 req.Header["X-Forwarded-User"] = []string{session.User}
668 if session.Email != "" {
669 req.Header["X-Forwarded-Email"] = []string{session.Email}
672 if p.PassUserHeaders {
673 req.Header["X-Forwarded-User"] = []string{session.User}
674 if session.Email != "" {
675 req.Header["X-Forwarded-Email"] = []string{session.Email}
678 if p.SetXAuthRequest {
679 rw.Header().Set("X-Auth-Request-User", session.User)
680 if session.Email != "" {
681 rw.Header().Set("X-Auth-Request-Email", session.Email)
684 if p.PassAccessToken && session.AccessToken != "" {
685 req.Header["X-Forwarded-Access-Token"] = []string{session.AccessToken}
687 if session.Email == "" {
688 rw.Header().Set("GAP-Auth", session.User)
690 rw.Header().Set("GAP-Auth", session.Email)
692 return http.StatusAccepted
695func (p *OAuthProxy) CheckBasicAuth(req *http.Request) (*providers.SessionState, error) {
696 if p.HtpasswdFile == nil {
699 auth := req.Header.Get("Authorization")
703 s := strings.SplitN(auth, " ", 2)
704 if len(s) != 2 || s[0] != "Basic" {
705 return nil, fmt.Errorf("invalid Authorization header %s", req.Header.Get("Authorization"))
707 b, err := b64.StdEncoding.DecodeString(s[1])
711 pair := strings.SplitN(string(b), ":", 2)
713 return nil, fmt.Errorf("invalid format %s", b)
715 if p.HtpasswdFile.Validate(pair[0], pair[1]) {
716 log.Printf("authenticated %q via basic auth", pair[0])
717 return &providers.SessionState{User: pair[0]}, nil
719 return nil, fmt.Errorf("%s not in HtpasswdFile", pair[0])
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list