package redis import ( "context" "crypto/aes" "crypto/cipher" "crypto/rand" "crypto/x509" "encoding/base64" "encoding/hex" "fmt" "io" "io/ioutil" "net/http" "strings" "time" "github.com/go-redis/redis/v7" "github.com/oauth2-proxy/oauth2-proxy/pkg/apis/options" "github.com/oauth2-proxy/oauth2-proxy/pkg/apis/sessions" "github.com/oauth2-proxy/oauth2-proxy/pkg/cookies" "github.com/oauth2-proxy/oauth2-proxy/pkg/encryption" "github.com/oauth2-proxy/oauth2-proxy/pkg/logger" ) // TicketData is a structure representing the ticket used in server session storage type TicketData struct { TicketID string Secret []byte } // SessionStore is an implementation of the sessions.SessionStore // interface that stores sessions in redis type SessionStore struct { CookieCipher encryption.Cipher Cookie *options.Cookie Client Client } // NewRedisSessionStore initialises a new instance of the SessionStore from // the configuration given func NewRedisSessionStore(opts *options.SessionOptions, cookieOpts *options.Cookie) (sessions.SessionStore, error) { cfbCipher, err := encryption.NewCFBCipher(encryption.SecretBytes(cookieOpts.Secret)) if err != nil { return nil, fmt.Errorf("error initialising cipher: %v", err) } client, err := newRedisCmdable(opts.Redis) if err != nil { return nil, fmt.Errorf("error constructing redis client: %v", err) } rs := &SessionStore{ Client: client, CookieCipher: cfbCipher, Cookie: cookieOpts, } return rs, nil } func newRedisCmdable(opts options.RedisStoreOptions) (Client, error) { if opts.UseSentinel && opts.UseCluster { return nil, fmt.Errorf("options redis-use-sentinel and redis-use-cluster are mutually exclusive") } if opts.UseSentinel { addrs, err := parseRedisURLs(opts.SentinelConnectionURLs) if err != nil { return nil, fmt.Errorf("could not parse redis urls: %v", err) } client := redis.NewFailoverClient(&redis.FailoverOptions{ MasterName: opts.SentinelMasterName, SentinelAddrs: addrs, }) return newClient(client), nil } if opts.UseCluster { addrs, err := parseRedisURLs(opts.ClusterConnectionURLs) if err != nil { return nil, fmt.Errorf("could not parse redis urls: %v", err) } client := redis.NewClusterClient(&redis.ClusterOptions{ Addrs: addrs, }) return newClusterClient(client), nil } opt, err := redis.ParseURL(opts.ConnectionURL) if err != nil { return nil, fmt.Errorf("unable to parse redis url: %s", err) } if opts.InsecureSkipTLSVerify { opt.TLSConfig.InsecureSkipVerify = true } if opts.CAPath != "" { rootCAs, err := x509.SystemCertPool() if err != nil { logger.Printf("failed to load system cert pool for redis connection, falling back to empty cert pool") } if rootCAs == nil { rootCAs = x509.NewCertPool() } certs, err := ioutil.ReadFile(opts.CAPath) if err != nil { return nil, fmt.Errorf("failed to load %q, %v", opts.CAPath, err) } // Append our cert to the system pool if ok := rootCAs.AppendCertsFromPEM(certs); !ok { logger.Printf("no certs appended, using system certs only") } opt.TLSConfig.RootCAs = rootCAs } client := redis.NewClient(opt) return newClient(client), nil } // parseRedisURLs parses a list of redis urls and returns a list // of addresses in the form of host:port that can be used to connnect to Redis func parseRedisURLs(urls []string) ([]string, error) { addrs := []string{} for _, u := range urls { parsedURL, err := redis.ParseURL(u) if err != nil { return nil, fmt.Errorf("unable to parse redis url: %v", err) } addrs = append(addrs, parsedURL.Addr) } return addrs, nil } // Save takes a sessions.SessionState and stores the information from it // to redies, and adds a new ticket cookie on the HTTP response writer func (store *SessionStore) Save(rw http.ResponseWriter, req *http.Request, s *sessions.SessionState) error { if s.CreatedAt == nil || s.CreatedAt.IsZero() { now := time.Now() s.CreatedAt = &now } // Old sessions that we are refreshing would have a request cookie // New sessions don't, so we ignore the error. storeValue will check requestCookie requestCookie, _ := req.Cookie(store.Cookie.Name) ctx := req.Context() ticketString, err := store.saveSession(ctx, s, store.Cookie.Expire, requestCookie) if err != nil { return err } ticketCookie := store.makeCookie( req, ticketString, store.Cookie.Expire, *s.CreatedAt, ) http.SetCookie(rw, ticketCookie) return nil } // Load reads sessions.SessionState information from a ticket // cookie within the HTTP request object func (store *SessionStore) Load(req *http.Request) (*sessions.SessionState, error) { requestCookie, err := req.Cookie(store.Cookie.Name) if err != nil { return nil, fmt.Errorf("error loading session: %s", err) } val, _, ok := encryption.Validate(requestCookie, store.Cookie.Secret, store.Cookie.Expire) if !ok { return nil, fmt.Errorf("cookie signature not valid") } ctx := req.Context() session, err := store.loadSessionFromTicket(ctx, string(val)) if err != nil { return nil, fmt.Errorf("error loading session: %s", err) } return session, nil } // Clear clears any saved session information for a given ticket cookie // from redis, and then clears the session func (store *SessionStore) Clear(rw http.ResponseWriter, req *http.Request) error { // We go ahead and clear the cookie first, always. clearCookie := store.makeCookie( req, "", time.Hour*-1, time.Now(), ) http.SetCookie(rw, clearCookie) // If there was an existing cookie we should clear the session in redis requestCookie, err := req.Cookie(store.Cookie.Name) if err != nil && err == http.ErrNoCookie { // No existing cookie so can't clear redis return nil } else if err != nil { return fmt.Errorf("error retrieving cookie: %v", err) } val, _, ok := encryption.Validate(requestCookie, store.Cookie.Secret, store.Cookie.Expire) if !ok { return fmt.Errorf("cookie signature not valid") } // We only return an error if we had an issue with redis // If there's an issue decoding the ticket, ignore it ticket, _ := decodeTicket(store.Cookie.Name, string(val)) if ticket != nil { ctx := req.Context() err := store.Client.Del(ctx, ticket.asHandle(store.Cookie.Name)) if err != nil { return fmt.Errorf("error clearing cookie from redis: %s", err) } } return nil } // saveSession encodes a session with a GCM cipher & saves the data into Redis func (store *SessionStore) saveSession(ctx context.Context, s *sessions.SessionState, expiration time.Duration, requestCookie *http.Cookie) (string, error) { ticket, err := store.getTicket(requestCookie) if err != nil { return "", fmt.Errorf("error getting ticket: %v", err) } c, err := encryption.NewGCMCipher(ticket.Secret) if err != nil { return "", fmt.Errorf("error initiating cipher block %s", err) } // Use AES-GCM since it provides authenticated encryption // AES-CFB used in cookies has the cookie signing SHA to get around the lack of // authentication in AES-CFB ciphertext, err := s.EncodeSessionState(c, false) if err != nil { return "", err } handle := ticket.asHandle(store.Cookie.Name) err = store.Client.Set(ctx, handle, ciphertext, expiration) if err != nil { return "", err } return ticket.encodeTicket(store.Cookie.Name), nil } // loadSessionFromTicket loads the session based on the ticket value func (store *SessionStore) loadSessionFromTicket(ctx context.Context, value string) (*sessions.SessionState, error) { ticket, err := decodeTicket(store.Cookie.Name, value) if err != nil { return nil, err } resultBytes, err := store.Client.Get(ctx, ticket.asHandle(store.Cookie.Name)) if err != nil { return nil, err } c, err := encryption.NewGCMCipher(ticket.Secret) if err != nil { return nil, err } session, err := sessions.DecodeSessionState(resultBytes, c, false) if err != nil { // The GCM cipher will error due to a legacy JSON payload not passing // the authentication check part of AES GCM encryption. // In that case, we can attempt to fallback to try a legacy load legacyCipher := encryption.NewBase64Cipher(store.CookieCipher) return legacyV5DecodeSession(resultBytes, ticket, legacyCipher) } return session, nil } // legacyV5DecodeSession loads the session based on the ticket value // This fallback uses V5 style encryption of Base64 + AES CFB func legacyV5DecodeSession(resultBytes []byte, ticket *TicketData, c encryption.Cipher) (*sessions.SessionState, error) { block, err := aes.NewCipher(ticket.Secret) if err != nil { return nil, err } // Use secret as the IV too, because each entry has it's own key stream := cipher.NewCFBDecrypter(block, ticket.Secret) stream.XORKeyStream(resultBytes, resultBytes) session, err := sessions.LegacyV5DecodeSessionState(string(resultBytes), c) if err != nil { return nil, err } return session, nil } // makeCookie makes a cookie, signing the value if present func (store *SessionStore) makeCookie(req *http.Request, value string, expires time.Duration, now time.Time) *http.Cookie { if value != "" { value = encryption.SignedValue(store.Cookie.Secret, store.Cookie.Name, []byte(value), now) } return cookies.MakeCookieFromOptions( req, store.Cookie.Name, value, store.Cookie, expires, now, ) } // getTicket retrieves an existing ticket from the cookie if present, // or creates a new ticket func (store *SessionStore) getTicket(requestCookie *http.Cookie) (*TicketData, error) { if requestCookie == nil { return newTicket() } // An existing cookie exists, try to retrieve the ticket val, _, ok := encryption.Validate(requestCookie, store.Cookie.Secret, store.Cookie.Expire) if !ok { // Cookie is invalid, create a new ticket return newTicket() } // Valid cookie, decode the ticket ticket, err := decodeTicket(store.Cookie.Name, string(val)) if err != nil { // If we can't decode the ticket we have to create a new one return newTicket() } return ticket, nil } func newTicket() (*TicketData, error) { rawID := make([]byte, 16) if _, err := io.ReadFull(rand.Reader, rawID); err != nil { return nil, fmt.Errorf("failed to create new ticket ID %s", err) } // ticketID is hex encoded ticketID := hex.EncodeToString(rawID) secret := make([]byte, aes.BlockSize) if _, err := io.ReadFull(rand.Reader, secret); err != nil { return nil, fmt.Errorf("failed to create initialization vector %s", err) } ticket := &TicketData{ TicketID: ticketID, Secret: secret, } return ticket, nil } func (ticket *TicketData) asHandle(prefix string) string { return fmt.Sprintf("%s-%s", prefix, ticket.TicketID) } func decodeTicket(cookieName string, ticketString string) (*TicketData, error) { prefix := cookieName + "-" if !strings.HasPrefix(ticketString, prefix) { return nil, fmt.Errorf("failed to decode ticket handle") } trimmedTicket := strings.TrimPrefix(ticketString, prefix) ticketParts := strings.Split(trimmedTicket, ".") if len(ticketParts) != 2 { return nil, fmt.Errorf("failed to decode ticket") } ticketID, secretBase64 := ticketParts[0], ticketParts[1] // ticketID must be a hexadecimal string _, err := hex.DecodeString(ticketID) if err != nil { return nil, fmt.Errorf("server ticket failed sanity checks") } secret, err := base64.RawURLEncoding.DecodeString(secretBase64) if err != nil { return nil, fmt.Errorf("failed to decode initialization vector %s", err) } ticketData := &TicketData{ TicketID: ticketID, Secret: secret, } return ticketData, nil } func (ticket *TicketData) encodeTicket(prefix string) string { handle := ticket.asHandle(prefix) ticketString := handle + "." + base64.RawURLEncoding.EncodeToString(ticket.Secret) return ticketString }