1
0
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git synced 2025-04-15 11:56:49 +02:00

Rename Session Options to improve structure

This commit is contained in:
Joel Speed 2020-04-12 14:55:30 +01:00
parent 458710149c
commit e49f8542bc
No known key found for this signature in database
GPG Key ID: 6E80578D6751DEFB
5 changed files with 17 additions and 22 deletions

View File

@ -1403,7 +1403,7 @@ func TestClearSplitCookie(t *testing.T) {
opts := NewOptions() opts := NewOptions()
opts.Cookie.Name = "oauth2" opts.Cookie.Name = "oauth2"
opts.Cookie.Domains = []string{"abc"} opts.Cookie.Domains = []string{"abc"}
store, err := cookie.NewCookieSessionStore(&opts.SessionOptions, &opts.Cookie) store, err := cookie.NewCookieSessionStore(&opts.Session, &opts.Cookie)
assert.Equal(t, err, nil) assert.Equal(t, err, nil)
p := OAuthProxy{CookieName: opts.Cookie.Name, CookieDomains: opts.Cookie.Domains, sessionStore: store} p := OAuthProxy{CookieName: opts.Cookie.Name, CookieDomains: opts.Cookie.Domains, sessionStore: store}
var rw = httptest.NewRecorder() var rw = httptest.NewRecorder()
@ -1432,7 +1432,7 @@ func TestClearSingleCookie(t *testing.T) {
opts := NewOptions() opts := NewOptions()
opts.Cookie.Name = "oauth2" opts.Cookie.Name = "oauth2"
opts.Cookie.Domains = []string{"abc"} opts.Cookie.Domains = []string{"abc"}
store, err := cookie.NewCookieSessionStore(&opts.SessionOptions, &opts.Cookie) store, err := cookie.NewCookieSessionStore(&opts.Session, &opts.Cookie)
assert.Equal(t, err, nil) assert.Equal(t, err, nil)
p := OAuthProxy{CookieName: opts.Cookie.Name, CookieDomains: opts.Cookie.Domains, sessionStore: store} p := OAuthProxy{CookieName: opts.Cookie.Name, CookieDomains: opts.Cookie.Domains, sessionStore: store}
var rw = httptest.NewRecorder() var rw = httptest.NewRecorder()

View File

@ -66,8 +66,7 @@ type Options struct {
Cookie options.CookieOptions Cookie options.CookieOptions
// Embed SessionOptions Session options.SessionOptions
options.SessionOptions
Upstreams []string `flag:"upstream" cfg:"upstreams" env:"OAUTH2_PROXY_UPSTREAMS"` Upstreams []string `flag:"upstream" cfg:"upstreams" env:"OAUTH2_PROXY_UPSTREAMS"`
SkipAuthRegex []string `flag:"skip-auth-regex" cfg:"skip_auth_regex" env:"OAUTH2_PROXY_SKIP_AUTH_REGEX"` SkipAuthRegex []string `flag:"skip-auth-regex" cfg:"skip_auth_regex" env:"OAUTH2_PROXY_SKIP_AUTH_REGEX"`
@ -164,7 +163,7 @@ func NewOptions() *Options {
Expire: time.Duration(168) * time.Hour, Expire: time.Duration(168) * time.Hour,
Refresh: time.Duration(0), Refresh: time.Duration(0),
}, },
SessionOptions: options.SessionOptions{ Session: options.SessionOptions{
Type: "cookie", Type: "cookie",
}, },
SetXAuthRequest: false, SetXAuthRequest: false,
@ -412,8 +411,8 @@ func (o *Options) Validate() error {
} }
} }
o.SessionOptions.Cipher = cipher o.Session.Cipher = cipher
sessionStore, err := sessions.NewSessionStore(&o.SessionOptions, &o.Cookie) sessionStore, err := sessions.NewSessionStore(&o.Session, &o.Cookie)
if err != nil { if err != nil {
msgs = append(msgs, fmt.Sprintf("error initialising session storage: %v", err)) msgs = append(msgs, fmt.Sprintf("error initialising session storage: %v", err))
} else { } else {

View File

@ -6,29 +6,25 @@ import "github.com/oauth2-proxy/oauth2-proxy/pkg/encryption"
type SessionOptions struct { type SessionOptions struct {
Type string `flag:"session-store-type" cfg:"session_store_type" env:"OAUTH2_PROXY_SESSION_STORE_TYPE"` Type string `flag:"session-store-type" cfg:"session_store_type" env:"OAUTH2_PROXY_SESSION_STORE_TYPE"`
Cipher *encryption.Cipher Cipher *encryption.Cipher
CookieStoreOptions Redis RedisStoreOptions
RedisStoreOptions
} }
// CookieSessionStoreType is used to indicate the CookieSessionStore should be // CookieSessionStoreType is used to indicate the CookieSessionStore should be
// used for storing sessions. // used for storing sessions.
var CookieSessionStoreType = "cookie" var CookieSessionStoreType = "cookie"
// CookieStoreOptions contains configuration options for the CookieSessionStore.
type CookieStoreOptions struct{}
// RedisSessionStoreType is used to indicate the RedisSessionStore should be // RedisSessionStoreType is used to indicate the RedisSessionStore should be
// used for storing sessions. // used for storing sessions.
var RedisSessionStoreType = "redis" var RedisSessionStoreType = "redis"
// RedisStoreOptions contains configuration options for the RedisSessionStore. // RedisStoreOptions contains configuration options for the RedisSessionStore.
type RedisStoreOptions struct { type RedisStoreOptions struct {
RedisConnectionURL string `flag:"redis-connection-url" cfg:"redis_connection_url" env:"OAUTH2_PROXY_REDIS_CONNECTION_URL"` ConnectionURL string `flag:"redis-connection-url" cfg:"redis_connection_url" env:"OAUTH2_PROXY_REDIS_CONNECTION_URL"`
UseSentinel bool `flag:"redis-use-sentinel" cfg:"redis_use_sentinel" env:"OAUTH2_PROXY_REDIS_USE_SENTINEL"` UseSentinel bool `flag:"redis-use-sentinel" cfg:"redis_use_sentinel" env:"OAUTH2_PROXY_REDIS_USE_SENTINEL"`
SentinelMasterName string `flag:"redis-sentinel-master-name" cfg:"redis_sentinel_master_name" env:"OAUTH2_PROXY_REDIS_SENTINEL_MASTER_NAME"` SentinelMasterName string `flag:"redis-sentinel-master-name" cfg:"redis_sentinel_master_name" env:"OAUTH2_PROXY_REDIS_SENTINEL_MASTER_NAME"`
SentinelConnectionURLs []string `flag:"redis-sentinel-connection-urls" cfg:"redis_sentinel_connection_urls" env:"OAUTH2_PROXY_REDIS_SENTINEL_CONNECTION_URLS"` SentinelConnectionURLs []string `flag:"redis-sentinel-connection-urls" cfg:"redis_sentinel_connection_urls" env:"OAUTH2_PROXY_REDIS_SENTINEL_CONNECTION_URLS"`
UseCluster bool `flag:"redis-use-cluster" cfg:"redis_use_cluster" env:"OAUTH2_PROXY_REDIS_USE_CLUSTER"` UseCluster bool `flag:"redis-use-cluster" cfg:"redis_use_cluster" env:"OAUTH2_PROXY_REDIS_USE_CLUSTER"`
ClusterConnectionURLs []string `flag:"redis-cluster-connection-urls" cfg:"redis_cluster_connection_urls" env:"OAUTH2_PROXY_REDIS_CLUSTER_CONNECTION_URLS"` ClusterConnectionURLs []string `flag:"redis-cluster-connection-urls" cfg:"redis_cluster_connection_urls" env:"OAUTH2_PROXY_REDIS_CLUSTER_CONNECTION_URLS"`
RedisCAPath string `flag:"redis-ca-path" cfg:"redis_ca_path" env:"OAUTH2_PROXY_REDIS_CA_PATH"` CAPath string `flag:"redis-ca-path" cfg:"redis_ca_path" env:"OAUTH2_PROXY_REDIS_CA_PATH"`
RedisInsecureTLS bool `flag:"redis-insecure-skip-tls-verify" cfg:"redis_insecure_skip_tls_verify" env:"OAUTH2_PROXY_REDIS_INSECURE_SKIP_TLS_VERIFY"` InsecureSkipTLSVerify bool `flag:"redis-insecure-skip-tls-verify" cfg:"redis_insecure_skip_tls_verify" env:"OAUTH2_PROXY_REDIS_INSECURE_SKIP_TLS_VERIFY"`
} }

View File

@ -40,7 +40,7 @@ type SessionStore struct {
// NewRedisSessionStore initialises a new instance of the SessionStore from // NewRedisSessionStore initialises a new instance of the SessionStore from
// the configuration given // the configuration given
func NewRedisSessionStore(opts *options.SessionOptions, cookieOpts *options.CookieOptions) (sessions.SessionStore, error) { func NewRedisSessionStore(opts *options.SessionOptions, cookieOpts *options.CookieOptions) (sessions.SessionStore, error) {
client, err := newRedisCmdable(opts.RedisStoreOptions) client, err := newRedisCmdable(opts.Redis)
if err != nil { if err != nil {
return nil, fmt.Errorf("error constructing redis client: %v", err) return nil, fmt.Errorf("error constructing redis client: %v", err)
} }
@ -74,16 +74,16 @@ func newRedisCmdable(opts options.RedisStoreOptions) (Client, error) {
return newClusterClient(client), nil return newClusterClient(client), nil
} }
opt, err := redis.ParseURL(opts.RedisConnectionURL) opt, err := redis.ParseURL(opts.ConnectionURL)
if err != nil { if err != nil {
return nil, fmt.Errorf("unable to parse redis url: %s", err) return nil, fmt.Errorf("unable to parse redis url: %s", err)
} }
if opts.RedisInsecureTLS { if opts.InsecureSkipTLSVerify {
opt.TLSConfig.InsecureSkipVerify = true opt.TLSConfig.InsecureSkipVerify = true
} }
if opts.RedisCAPath != "" { if opts.CAPath != "" {
rootCAs, err := x509.SystemCertPool() rootCAs, err := x509.SystemCertPool()
if err != nil { if err != nil {
logger.Printf("failed to load system cert pool for redis connection, falling back to empty cert pool") logger.Printf("failed to load system cert pool for redis connection, falling back to empty cert pool")
@ -91,9 +91,9 @@ func newRedisCmdable(opts options.RedisStoreOptions) (Client, error) {
if rootCAs == nil { if rootCAs == nil {
rootCAs = x509.NewCertPool() rootCAs = x509.NewCertPool()
} }
certs, err := ioutil.ReadFile(opts.RedisCAPath) certs, err := ioutil.ReadFile(opts.CAPath)
if err != nil { if err != nil {
return nil, fmt.Errorf("failed to load %q, %v", opts.RedisCAPath, err) return nil, fmt.Errorf("failed to load %q, %v", opts.CAPath, err)
} }
// Append our cert to the system pool // Append our cert to the system pool

View File

@ -428,7 +428,7 @@ var _ = Describe("NewSessionStore", func() {
mr, err = miniredis.Run() mr, err = miniredis.Run()
Expect(err).ToNot(HaveOccurred()) Expect(err).ToNot(HaveOccurred())
opts.Type = options.RedisSessionStoreType opts.Type = options.RedisSessionStoreType
opts.RedisConnectionURL = "redis://" + mr.Addr() opts.Redis.ConnectionURL = "redis://" + mr.Addr()
}) })
AfterEach(func() { AfterEach(func() {