config: OIDCConfig — YAML + env overlay with defaults
This commit is contained in:
@@ -31,6 +31,8 @@ type Config struct {
|
||||
// testing — production deployments are always behind a TLS proxy
|
||||
// and the cookie must be Secure.
|
||||
CookieSecure bool `yaml:"cookie_secure"`
|
||||
OIDCRaw *OIDCConfig `yaml:"oidc"`
|
||||
OIDC *OIDCConfig `yaml:"-"`
|
||||
}
|
||||
|
||||
// Load resolves config in this order:
|
||||
@@ -91,6 +93,16 @@ func Load(yamlPath string) (Config, error) {
|
||||
}
|
||||
}
|
||||
|
||||
var rawOIDC OIDCConfig
|
||||
if c.OIDCRaw != nil {
|
||||
rawOIDC = *c.OIDCRaw
|
||||
}
|
||||
oidc, err := loadOIDC(envSnapshot(), rawOIDC)
|
||||
if err != nil {
|
||||
return c, err
|
||||
}
|
||||
c.OIDC = oidc
|
||||
|
||||
return c, c.validate()
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,103 @@
|
||||
// internal/server/config/oidc.go — OIDC subsection of the server
|
||||
// config. Disabled when oidc.issuer is empty or absent.
|
||||
package config
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
)
|
||||
|
||||
// OIDCConfig is the OIDC sub-block. The struct doubles as YAML schema;
|
||||
// loadOIDC applies env overlays on top and fills defaults.
|
||||
type OIDCConfig struct {
|
||||
Issuer string `yaml:"issuer"`
|
||||
ClientID string `yaml:"client_id"`
|
||||
ClientSecret string `yaml:"client_secret"`
|
||||
DisplayName string `yaml:"display_name"`
|
||||
Scopes []string `yaml:"scopes"`
|
||||
RoleClaim string `yaml:"role_claim"`
|
||||
RoleMapping map[string]string `yaml:"role_mapping"`
|
||||
RedirectURL string `yaml:"redirect_url"`
|
||||
}
|
||||
|
||||
// loadOIDC merges YAML + env, applies defaults, validates. Returns
|
||||
// nil + nil when OIDC is disabled (issuer empty after merge); a
|
||||
// non-nil OIDCConfig means the caller should wire OIDC.
|
||||
//
|
||||
// Env vars (override YAML when set):
|
||||
//
|
||||
// RM_OIDC_ISSUER, RM_OIDC_CLIENT_ID, RM_OIDC_CLIENT_SECRET,
|
||||
// RM_OIDC_CLIENT_SECRET_FILE, RM_OIDC_DISPLAY_NAME,
|
||||
// RM_OIDC_REDIRECT_URL.
|
||||
//
|
||||
// envs is passed in (rather than read with os.LookupEnv) so unit
|
||||
// tests can supply a fake env map.
|
||||
func loadOIDC(envs map[string]string, yaml OIDCConfig) (*OIDCConfig, error) {
|
||||
c := yaml
|
||||
if v, ok := envs["RM_OIDC_ISSUER"]; ok {
|
||||
c.Issuer = v
|
||||
}
|
||||
if v, ok := envs["RM_OIDC_CLIENT_ID"]; ok {
|
||||
c.ClientID = v
|
||||
}
|
||||
if v, ok := envs["RM_OIDC_CLIENT_SECRET"]; ok {
|
||||
c.ClientSecret = v
|
||||
}
|
||||
if v, ok := envs["RM_OIDC_CLIENT_SECRET_FILE"]; ok && v != "" {
|
||||
body, err := os.ReadFile(v)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("config: oidc client_secret_file: %w", err)
|
||||
}
|
||||
c.ClientSecret = string(body)
|
||||
}
|
||||
if v, ok := envs["RM_OIDC_DISPLAY_NAME"]; ok {
|
||||
c.DisplayName = v
|
||||
}
|
||||
if v, ok := envs["RM_OIDC_REDIRECT_URL"]; ok {
|
||||
c.RedirectURL = v
|
||||
}
|
||||
|
||||
if c.Issuer == "" {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
if c.ClientID == "" {
|
||||
return nil, errors.New("config: oidc.client_id required when issuer is set")
|
||||
}
|
||||
if c.ClientSecret == "" {
|
||||
return nil, errors.New("config: oidc.client_secret required when issuer is set")
|
||||
}
|
||||
if len(c.RoleMapping) == 0 {
|
||||
return nil, errors.New("config: oidc.role_mapping must have at least one entry")
|
||||
}
|
||||
|
||||
if c.DisplayName == "" {
|
||||
c.DisplayName = "SSO"
|
||||
}
|
||||
if c.RoleClaim == "" {
|
||||
c.RoleClaim = "groups"
|
||||
}
|
||||
if len(c.Scopes) == 0 {
|
||||
c.Scopes = []string{"openid", "profile", "email", "groups"}
|
||||
}
|
||||
return &c, nil
|
||||
}
|
||||
|
||||
// envSnapshot reads the OIDC env vars into a map. Lets the production
|
||||
// loadOIDC call site stay env-driven while tests pass an explicit
|
||||
// map.
|
||||
func envSnapshot() map[string]string {
|
||||
keys := []string{
|
||||
"RM_OIDC_ISSUER", "RM_OIDC_CLIENT_ID", "RM_OIDC_CLIENT_SECRET",
|
||||
"RM_OIDC_CLIENT_SECRET_FILE", "RM_OIDC_DISPLAY_NAME",
|
||||
"RM_OIDC_REDIRECT_URL",
|
||||
}
|
||||
out := make(map[string]string, len(keys))
|
||||
for _, k := range keys {
|
||||
if v, ok := os.LookupEnv(k); ok {
|
||||
out[k] = v
|
||||
}
|
||||
}
|
||||
return out
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
package config
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestOIDCParseDisabledWhenIssuerEmpty(t *testing.T) {
|
||||
t.Parallel()
|
||||
c, err := loadOIDC(map[string]string{}, OIDCConfig{})
|
||||
if err != nil {
|
||||
t.Fatalf("load: %v", err)
|
||||
}
|
||||
if c != nil {
|
||||
t.Errorf("expected nil OIDC config when issuer empty; got %+v", c)
|
||||
}
|
||||
}
|
||||
|
||||
func TestOIDCRejectMissingClientID(t *testing.T) {
|
||||
t.Parallel()
|
||||
yaml := OIDCConfig{Issuer: "https://x", ClientSecret: "s"}
|
||||
if _, err := loadOIDC(map[string]string{}, yaml); err == nil {
|
||||
t.Error("expected error for missing client_id")
|
||||
}
|
||||
}
|
||||
|
||||
func TestOIDCRejectMissingClientSecret(t *testing.T) {
|
||||
t.Parallel()
|
||||
yaml := OIDCConfig{Issuer: "https://x", ClientID: "rm"}
|
||||
if _, err := loadOIDC(map[string]string{}, yaml); err == nil {
|
||||
t.Error("expected error for missing client_secret")
|
||||
}
|
||||
}
|
||||
|
||||
func TestOIDCDefaultsApplied(t *testing.T) {
|
||||
t.Parallel()
|
||||
yaml := OIDCConfig{
|
||||
Issuer: "https://x", ClientID: "rm", ClientSecret: "s",
|
||||
RoleMapping: map[string]string{"a": "admin"},
|
||||
}
|
||||
c, err := loadOIDC(map[string]string{}, yaml)
|
||||
if err != nil {
|
||||
t.Fatalf("load: %v", err)
|
||||
}
|
||||
if c.RoleClaim != "groups" {
|
||||
t.Errorf("role_claim default: got %q want groups", c.RoleClaim)
|
||||
}
|
||||
if c.DisplayName != "SSO" {
|
||||
t.Errorf("display_name default: got %q want SSO", c.DisplayName)
|
||||
}
|
||||
wantScopes := []string{"openid", "profile", "email", "groups"}
|
||||
if len(c.Scopes) != len(wantScopes) {
|
||||
t.Errorf("scopes default: got %v want %v", c.Scopes, wantScopes)
|
||||
}
|
||||
}
|
||||
|
||||
func TestOIDCEnvOverrides(t *testing.T) {
|
||||
t.Parallel()
|
||||
yaml := OIDCConfig{
|
||||
Issuer: "https://from-yaml", ClientID: "yaml-id", ClientSecret: "yaml-secret",
|
||||
RoleMapping: map[string]string{"x": "admin"},
|
||||
}
|
||||
envs := map[string]string{
|
||||
"RM_OIDC_ISSUER": "https://from-env",
|
||||
"RM_OIDC_CLIENT_ID": "env-id",
|
||||
"RM_OIDC_CLIENT_SECRET": "env-secret",
|
||||
}
|
||||
c, err := loadOIDC(envs, yaml)
|
||||
if err != nil {
|
||||
t.Fatalf("load: %v", err)
|
||||
}
|
||||
if c.Issuer != "https://from-env" || c.ClientID != "env-id" || c.ClientSecret != "env-secret" {
|
||||
t.Errorf("env override: got %+v", c)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user