package config import ( "encoding/base64" "fmt" "io/ioutil" "net/url" "os" "sync" "testing" "github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp/cmpopts" "github.com/spf13/viper" ) var cmpOptIgnoreUnexported = cmpopts.IgnoreUnexported(Options{}) func Test_Validate(t *testing.T) { t.Parallel() testOptions := func() *Options { o := NewDefaultOptions() o.SharedKey = "test" o.Services = "all" o.CertFile = "./testdata/example-cert.pem" o.KeyFile = "./testdata/example-key.pem" return o } good := testOptions() badServices := testOptions() badServices.Services = "blue" badSecret := testOptions() badSecret.SharedKey = "" badSecret.Services = "authenticate" badSecretAllServices := testOptions() badSecretAllServices.SharedKey = "" badPolicyFile := testOptions() badPolicyFile.PolicyFile = "file" tests := []struct { name string testOpts *Options wantErr bool }{ {"good default with no env settings", good, false}, {"invalid service type", badServices, true}, {"missing shared secret", badSecret, true}, {"missing shared secret but all service", badSecretAllServices, false}, {"policy file specified", badPolicyFile, true}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { err := tt.testOpts.Validate() if (err != nil) != tt.wantErr { t.Errorf("Validate() error = %v, wantErr %v", err, tt.wantErr) return } }) } } func Test_bindEnvs(t *testing.T) { o := new(Options) o.viper = viper.New() v := viper.New() os.Clearenv() defer os.Unsetenv("POMERIUM_DEBUG") defer os.Unsetenv("POLICY") defer os.Unsetenv("HEADERS") os.Setenv("POMERIUM_DEBUG", "true") os.Setenv("POLICY", "mypolicy") os.Setenv("HEADERS", `{"X-Custom-1":"foo", "X-Custom-2":"bar"}`) err := bindEnvs(o, v) if err != nil { t.Fatalf("failed to bind options to env vars: %s", err) } err = v.Unmarshal(o) if err != nil { t.Errorf("Could not unmarshal %#v: %s", o, err) } o.viper = v if !o.Debug { t.Errorf("Failed to load POMERIUM_DEBUG from environment") } if o.Services != "" { t.Errorf("Somehow got SERVICES from environment without configuring it") } if o.PolicyEnv != "mypolicy" { t.Errorf("Failed to bind policy env var to PolicyEnv") } if o.HeadersEnv != `{"X-Custom-1":"foo", "X-Custom-2":"bar"}` { t.Errorf("Failed to bind headers env var to HeadersEnv") } } func Test_parseHeaders(t *testing.T) { // t.Parallel() tests := []struct { name string want map[string]string envHeaders string viperHeaders interface{} wantErr bool }{ {"good env", map[string]string{"X-Custom-1": "foo", "X-Custom-2": "bar"}, `{"X-Custom-1":"foo", "X-Custom-2":"bar"}`, map[string]string{"X": "foo"}, false}, {"good env not_json", map[string]string{"X-Custom-1": "foo", "X-Custom-2": "bar"}, `X-Custom-1:foo,X-Custom-2:bar`, map[string]string{"X": "foo"}, false}, {"bad env", map[string]string{}, "xyyyy", map[string]string{"X": "foo"}, true}, {"bad env not_json", map[string]string{"X-Custom-1": "foo", "X-Custom-2": "bar"}, `X-Custom-1:foo,X-Custom-2bar`, map[string]string{"X": "foo"}, true}, {"bad viper", map[string]string{}, "", "notaheaderstruct", true}, {"good viper", map[string]string{"X-Custom-1": "foo", "X-Custom-2": "bar"}, "", map[string]string{"X-Custom-1": "foo", "X-Custom-2": "bar"}, false}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { var ( o *Options mu sync.Mutex ) mu.Lock() defer mu.Unlock() o = NewDefaultOptions() o.viperSet("headers", tt.viperHeaders) o.viperSet("HeadersEnv", tt.envHeaders) o.HeadersEnv = tt.envHeaders err := o.parseHeaders() if (err != nil) != tt.wantErr { t.Errorf("Error condition unexpected: err=%s", err) } if !tt.wantErr && !cmp.Equal(tt.want, o.Headers) { t.Errorf("Did get expected headers: %s", cmp.Diff(tt.want, o.Headers)) } }) } } func Test_parsePolicyFile(t *testing.T) { t.Parallel() source := "https://pomerium.io" sourceURL, _ := url.ParseRequestURI(source) dest := "https://httpbin.org" destURL, _ := url.ParseRequestURI(dest) tests := []struct { name string policyBytes []byte want []Policy wantErr bool }{ {"simple json", []byte(fmt.Sprintf(`{"policy":[{"from": "%s","to":"%s"}]}`, source, dest)), []Policy{{From: source, To: dest, Source: sourceURL, Destination: destURL}}, false}, {"bad from", []byte(`{"policy":[{"from": "%","to":"httpbin.org"}]}`), nil, true}, {"bad to", []byte(`{"policy":[{"from": "pomerium.io","to":"%"}]}`), nil, true}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { tempFile, _ := ioutil.TempFile("", "*.json") defer tempFile.Close() defer os.Remove(tempFile.Name()) tempFile.Write(tt.policyBytes) var o Options o.viper = viper.New() o.viper.SetConfigFile(tempFile.Name()) if err := o.viper.ReadInConfig(); err != nil { t.Fatal(err) } err := o.parsePolicy() if (err != nil) != tt.wantErr { t.Errorf("parsePolicyEnv() error = %v, wantErr %v", err, tt.wantErr) return } if err == nil { if diff := cmp.Diff(o.Policies, tt.want); diff != "" { t.Errorf("parsePolicyEnv() = diff:%s", diff) } } }) } } func Test_Checksum(t *testing.T) { o := NewDefaultOptions() oldChecksum := o.Checksum() o.SharedKey = "changemeplease" newChecksum := o.Checksum() if newChecksum == oldChecksum { t.Errorf("Checksum() failed to update old = %s, new = %s", oldChecksum, newChecksum) } if newChecksum == "" || oldChecksum == "" { t.Error("Checksum() not returning data") } if o.Checksum() != newChecksum { t.Error("Checksum() inconsistent") } } func TestOptionsFromViper(t *testing.T) { t.Parallel() opts := []cmp.Option{ cmpopts.IgnoreFields(Options{}, "CookieSecret", "GRPCInsecure", "GRPCAddr", "AuthorizeURL", "AuthorizeURLString", "DefaultUpstreamTimeout", "CookieRefresh", "CookieExpire", "Services", "Addr", "RefreshCooldown", "LogLevel", "KeyFile", "CertFile", "SharedKey", "ReadTimeout", "ReadHeaderTimeout", "IdleTimeout", "GRPCClientTimeout", "GRPCClientDNSRoundRobin"), cmpopts.IgnoreFields(Policy{}, "Source", "Destination"), cmpOptIgnoreUnexported, } tests := []struct { name string configBytes []byte want *Options wantErr bool }{ {"good", []byte(`{"insecure_server":true,"policy":[{"from": "https://from.example","to":"https://to.example"}]}`), &Options{ Policies: []Policy{{From: "https://from.example", To: "https://to.example"}}, CookieName: "_pomerium", CookieSecure: true, InsecureServer: true, CookieHTTPOnly: true, Headers: map[string]string{ "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", "X-Content-Type-Options": "nosniff", "X-Frame-Options": "SAMEORIGIN", "X-XSS-Protection": "1; mode=block", }}, false}, {"good disable header", []byte(`{"insecure_server":true,"headers": {"disable":"true"},"policy":[{"from": "https://from.example","to":"https://to.example"}]}`), &Options{ Policies: []Policy{{From: "https://from.example", To: "https://to.example"}}, CookieName: "_pomerium", CookieSecure: true, CookieHTTPOnly: true, InsecureServer: true, Headers: map[string]string{}}, false}, {"bad url", []byte(`{"policy":[{"from": "https://","to":"https://to.example"}]}`), nil, true}, {"bad policy", []byte(`{"policy":[{"allow_public_unauthenticated_access": "dog","to":"https://to.example"}]}`), nil, true}, {"bad file", []byte(`{''''}`), nil, true}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { tempFile, _ := ioutil.TempFile("", "*.json") defer tempFile.Close() defer os.Remove(tempFile.Name()) tempFile.Write(tt.configBytes) got, err := optionsFromViper(tempFile.Name()) if (err != nil) != tt.wantErr { t.Errorf("optionsFromViper() error = %v, wantErr %v", err, tt.wantErr) return } if diff := cmp.Diff(got, tt.want, opts...); diff != "" { t.Errorf("NewOptionsFromConfig() = %s", diff) } }) } } func Test_NewOptionsFromConfigEnvVar(t *testing.T) { tests := []struct { name string envKeyPairs map[string]string wantErr bool }{ {"good", map[string]string{"INSECURE_SERVER": "true", "SHARED_SECRET": "YixWi1MYh77NMECGGIJQevoonYtVF+ZPRkQZrrmeRqM="}, false}, {"bad no shared secret", map[string]string{"INSECURE_SERVER": "true", "SERVICES": "authenticate"}, true}, {"good no shared secret in all mode", map[string]string{"INSECURE_SERVER": "true"}, false}, {"bad header", map[string]string{"HEADERS": "x;y;z", "INSECURE_SERVER": "true", "SHARED_SECRET": "YixWi1MYh77NMECGGIJQevoonYtVF+ZPRkQZrrmeRqM="}, true}, {"bad authenticate url", map[string]string{"AUTHENTICATE_SERVICE_URL": "authenticate.example", "INSECURE_SERVER": "true", "SHARED_SECRET": "YixWi1MYh77NMECGGIJQevoonYtVF+ZPRkQZrrmeRqM="}, true}, {"bad authorize url", map[string]string{"AUTHORIZE_SERVICE_URL": "authorize.example", "INSECURE_SERVER": "true", "SHARED_SECRET": "YixWi1MYh77NMECGGIJQevoonYtVF+ZPRkQZrrmeRqM="}, true}, {"bad cert base64", map[string]string{"CERTIFICATE": "bad cert", "SHARED_SECRET": "YixWi1MYh77NMECGGIJQevoonYtVF+ZPRkQZrrmeRqM="}, true}, {"bad cert key base64", map[string]string{"CERTIFICATE_KEY": "bad cert", "SHARED_SECRET": "YixWi1MYh77NMECGGIJQevoonYtVF+ZPRkQZrrmeRqM="}, true}, {"bad no certs no insecure mode set", map[string]string{"SHARED_SECRET": "YixWi1MYh77NMECGGIJQevoonYtVF+ZPRkQZrrmeRqM="}, true}, {"good disable headers ", map[string]string{"HEADERS": "disable:true", "INSECURE_SERVER": "true", "SHARED_SECRET": "YixWi1MYh77NMECGGIJQevoonYtVF+ZPRkQZrrmeRqM="}, false}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { for k, v := range tt.envKeyPairs { os.Setenv(k, v) defer os.Unsetenv(k) } _, err := NewOptionsFromConfig("") if (err != nil) != tt.wantErr { t.Errorf("NewOptionsFromConfig() error = %v, wantErr %v", err, tt.wantErr) return } }) } } type mockService struct { fail bool Updated bool } func (m *mockService) UpdateOptions(o Options) error { m.Updated = true if m.fail { return fmt.Errorf("failed") } return nil } func Test_HandleConfigUpdate(t *testing.T) { tests := []struct { name string oldEnvKeyPairs map[string]string newEnvKeyPairs map[string]string service *mockService wantUpdate bool }{ {"good", map[string]string{ "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, map[string]string{ "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, &mockService{fail: false}, true}, {"good set debug", map[string]string{ "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, map[string]string{ "POMERIUM_DEBUG": "true", "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, &mockService{fail: false}, true}, {"bad", map[string]string{ "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, map[string]string{ "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, &mockService{fail: true}, true}, {"bad policy file unmarshal error", map[string]string{ "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, map[string]string{ "POLICY": base64.StdEncoding.EncodeToString([]byte("{json:}")), "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, &mockService{fail: false}, false}, {"bad header key", map[string]string{ "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, map[string]string{ "SERVICES": "error", "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, &mockService{fail: false}, false}, {"bad header header value", map[string]string{ "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, map[string]string{ "HEADERS": "x;y;z", "INSECURE_SERVER": "true", "AUTHENTICATE_SERVICE_URL": "https://authenticate.example", "AUTHORIZE_SERVICE_URL": "https://authorize.example"}, &mockService{fail: false}, false}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { for k, v := range tt.oldEnvKeyPairs { os.Setenv(k, v) } oldOpts, err := NewOptionsFromConfig("") if err != nil { t.Fatal(err) } for k := range tt.oldEnvKeyPairs { os.Unsetenv(k) } for k, v := range tt.newEnvKeyPairs { os.Setenv(k, v) defer os.Unsetenv(k) } HandleConfigUpdate("", oldOpts, []OptionsUpdater{tt.service}) if tt.service.Updated != tt.wantUpdate { t.Errorf("Failed to update config on service") } }) } }