Skip to content

fix: config parsing so viper works #294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gusfcarvalho merged 1 commit into from
Dec 23, 2025
Merged

fix: config parsing so viper works #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 44 additions & 127 deletions internal/config/sso.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ package config
import (
"errors"
"fmt"
"os"
"regexp"
"sort"
"strings"

"github.com/spf13/viper"
Expand All @@ -32,107 +29,42 @@ type SSOProviderConfig struct {
}

type SSOConfig struct {
Enabled bool `yaml:"enabled" json:"enabled" mapstructure:"enabled"`
BaseURL string `yaml:"base_url" json:"base_url" mapstructure:"base_url"`
CallbackURL string `yaml:"callback_url" json:"callback_url" mapstructure:"callback_url"`
Providers []SSOProviderConfig `yaml:"providers" json:"providers" mapstructure:"providers"`
Enabled bool `yaml:"enabled" json:"enabled" mapstructure:"enabled"`
BaseURL string `yaml:"base_url" json:"base_url" mapstructure:"base_url"`
CallbackURL string `yaml:"callback_url" json:"callback_url" mapstructure:"callback_url"`
Providers map[string]SSOProviderConfig `yaml:"providers" json:"providers" mapstructure:"providers"`
}

func LoadSSOConfig(path string) (*SSOConfig, error) {
if path == "" {
return &SSOConfig{Enabled: false}, nil
}

v := viper.New()
v := viper.NewWithOptions(viper.KeyDelimiter("::"))
v.SetConfigFile(path)
v.SetConfigType("yaml")
v.SetEnvPrefix("CCF_SSO")
v.SetEnvKeyReplacer(strings.NewReplacer(".", "_", "-", "_"))
v.SetEnvKeyReplacer(strings.NewReplacer("::", "_", ".", "_", "-", "_"))
v.AutomaticEnv()

if err := v.ReadInConfig(); err != nil {
var notFound viper.ConfigFileNotFoundError
if errors.As(err, &notFound) {
return &SSOConfig{Enabled: false}, nil
}
return nil, fmt.Errorf("failed to read SSO config file: %w", err)
}

bindSSOEnvVars(v)
var config SSOConfig
if err := v.Unmarshal(&config); err != nil {
return nil, fmt.Errorf("failed to parse SSO config file: %w", err)
}

if err := config.expandEnvVars(); err != nil {
return nil, err
}

if err := config.validate(); err != nil {
return nil, err
}

return &config, nil
}

func (c *SSOConfig) expandEnvVars() error {
var errs []string

var err error
if c.BaseURL, err = expandStringWithEnv(c.BaseURL); err != nil {
errs = append(errs, fmt.Sprintf("base_url: %v", err))
}
if c.CallbackURL, err = expandStringWithEnv(c.CallbackURL); err != nil {
errs = append(errs, fmt.Sprintf("callback_url: %v", err))
}

for i := range c.Providers {
providerName := c.Providers[i].Name

if c.Providers[i].ClientID, err = expandStringWithEnv(c.Providers[i].ClientID); err != nil {
errs = append(errs, fmt.Sprintf("%s.client_id: %v", providerName, err))
}
if c.Providers[i].ClientSecret, err = expandStringWithEnv(c.Providers[i].ClientSecret); err != nil {
errs = append(errs, fmt.Sprintf("%s.client_secret: %v", providerName, err))
}
if c.Providers[i].IssuerURL, err = expandStringWithEnv(c.Providers[i].IssuerURL); err != nil {
errs = append(errs, fmt.Sprintf("%s.issuer_url: %v", providerName, err))
}
if c.Providers[i].IconURL, err = expandStringWithEnv(c.Providers[i].IconURL); err != nil {
errs = append(errs, fmt.Sprintf("%s.icon_url: %v", providerName, err))
}

for j := range c.Providers[i].RequiredLoginGroups {
if c.Providers[i].RequiredLoginGroups[j], err = expandStringWithEnv(c.Providers[i].RequiredLoginGroups[j]); err != nil {
errs = append(errs, fmt.Sprintf("%s.required_login_groups[%d]: %v", providerName, j, err))
}
}
for j := range c.Providers[i].RequiredAdminGroups {
if c.Providers[i].RequiredAdminGroups[j], err = expandStringWithEnv(c.Providers[i].RequiredAdminGroups[j]); err != nil {
errs = append(errs, fmt.Sprintf("%s.required_admin_groups[%d]: %v", providerName, j, err))
}
}

if c.Providers[i].AuthURL, err = expandStringWithEnv(c.Providers[i].AuthURL); err != nil {
errs = append(errs, fmt.Sprintf("%s.auth_url: %v", providerName, err))
}
if c.Providers[i].TokenURL, err = expandStringWithEnv(c.Providers[i].TokenURL); err != nil {
errs = append(errs, fmt.Sprintf("%s.token_url: %v", providerName, err))
}
if c.Providers[i].UserInfoURL, err = expandStringWithEnv(c.Providers[i].UserInfoURL); err != nil {
errs = append(errs, fmt.Sprintf("%s.user_info_url: %v", providerName, err))
}
if c.Providers[i].EmailURL, err = expandStringWithEnv(c.Providers[i].EmailURL); err != nil {
errs = append(errs, fmt.Sprintf("%s.email_url: %v", providerName, err))
}
}

if len(errs) > 0 {
return fmt.Errorf("failed to expand environment variables in SSO config: %s", strings.Join(errs, "; "))
}

return nil
}

func (c *SSOConfig) validate() error {
for _, p := range c.Providers {
if !p.Enabled {
Expand All @@ -148,59 +80,10 @@ func (c *SSOConfig) validate() error {
return nil
}

var envVarPattern = regexp.MustCompile(`\$\{([^}]+)\}`)

func expandStringWithEnv(input string) (string, error) {
if input == "" {
return input, nil
}

matches := envVarPattern.FindAllStringSubmatch(input, -1)
if len(matches) == 0 {
return input, nil
}

missing := make(map[string]struct{})
replaced := envVarPattern.ReplaceAllStringFunc(input, func(token string) string {
match := envVarPattern.FindStringSubmatch(token)
if len(match) != 2 {
return ""
}
key := match[1]
if val, ok := lookupEnvWithPrefix(key); ok {
return val
}
missing[key] = struct{}{}
return ""
})

if len(missing) > 0 {
var names []string
for k := range missing {
names = append(names, k)
}
sort.Strings(names)
return "", fmt.Errorf("missing environment variables: %s", strings.Join(names, ", "))
}

return replaced, nil
}

func lookupEnvWithPrefix(key string) (string, bool) {
if val, ok := os.LookupEnv(key); ok {
return val, true
}
prefixed := fmt.Sprintf("CCF_%s", key)
if val, ok := os.LookupEnv(prefixed); ok {
return val, true
}
return "", false
}

func (c *SSOConfig) GetProvider(name string) *SSOProviderConfig {
for i := range c.Providers {
if c.Providers[i].Name == name {
return &c.Providers[i]
for _, v := range c.Providers {
if v.Name == name {
return &v
}
}
Comment on lines +84 to 88
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Returning a pointer to the loop variable v is problematic because the address of the loop variable remains the same across iterations. The returned pointer will point to the last value assigned to v after the loop completes, not the matched provider. Since Providers is now a map, you can directly return a pointer to the map value using &c.Providers[name] or use a different approach to safely return the provider.

Suggested change
for _, v := range c.Providers {
if v.Name == name {
return &v
}
}
if c == nil {
return nil
}
if p, ok := c.Providers[name]; ok {
return &p
}

Copilot uses AI. Check for mistakes.
return nil
Expand All @@ -215,3 +98,37 @@ func (c *SSOConfig) GetEnabledProviders() []SSOProviderConfig {
}
return enabled
}

func bindSSOEnvVars(v *viper.Viper) {
providers := v.GetStringMap("providers")
for name := range providers {
bindProviderEnvVars(v, name)
}
}

func bindProviderEnvVars(v *viper.Viper, name string) {
prefix := fmt.Sprintf("providers.%s", name)
fields := []string{
"name",
"display_name",
"provider",
"protocol",
"icon_url",
"required_login_groups",
"required_admin_groups",
"client_id",
"client_secret",
"issuer_url",
"auth_url",
"token_url",
"user_info_url",
"email_url",
"scopes",
"enabled",
"group_mapping",
}

for _, field := range fields {
v.MustBindEnv(fmt.Sprintf("%s.%s", prefix, field))
}
}
10 changes: 5 additions & 5 deletions internal/service/sso/service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ func TestNewService_InitializesProviders(t *testing.T) {
cfg := &config.SSOConfig{
Enabled: true,
CallbackURL: "https://app/callback",
Providers: []config.SSOProviderConfig{
{Name: "google", Protocol: "oidc", Enabled: true},
{Name: "github", Protocol: "oauth", Enabled: true},
Providers: map[string]config.SSOProviderConfig{
"google": {Name: "google", Protocol: "oidc", Enabled: true},
"github": {Name: "github", Protocol: "oauth", Enabled: true},
},
}

Expand Down Expand Up @@ -105,8 +105,8 @@ func TestService_MethodsUseRegisteredProvider(t *testing.T) {
cfg := &config.SSOConfig{
Enabled: true,
CallbackURL: "https://app/callback",
Providers: []config.SSOProviderConfig{
{Name: "google", Protocol: "oidc", Enabled: true},
Providers: map[string]config.SSOProviderConfig{
"google": {Name: "google", Protocol: "oidc", Enabled: true},
},
}
service, err := NewService(cfg, zap.NewNop().Sugar())
Expand Down
13 changes: 7 additions & 6 deletions sso.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ base_url: "http://localhost:8000" # Web UI base URL
callback_url: "http://localhost:8080/api/auth/sso/callback" # API callback URL

providers:
- name: "google"
google:
name: "google"
display_name: "Google"
provider: "google"
protocol: "oidc"
Expand All @@ -26,21 +27,21 @@ providers:
group_mapping:
"hd:container-solutions.com":
- "ccf-authorized-users"
"email:gustavo.carvalho@container-solutions.com":
"email:admin@example.com":
- "ccf-admins"
# Add additional group mappings as needed

- name: "github"
github:
name: "github"
display_name: "GitHub"
provider: "github"
protocol: "oauth"
icon_url: "https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png"
required_login_groups:
- "ccf-authorized-users"
# All Github Logins are admins
required_admin_groups: []
client_id: change-me
client_secret: change-me
client_id: "change-me"
client_secret: "change-me"
auth_url: "https://github.com/login/oauth/authorize"
token_url: "https://github.com/login/oauth/access_token"
user_info_url: "https://api.github.com/user"
Expand Down
Loading