8000 Mask secret config values in the startup log by inada-s-ai[bot] · Pull Request #452 · inada-s/gdxsv · GitHub
[go: up one dir, main page]

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion gdxsv/lbs_gce.go
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ func GoGceAllocRole(region, role string) bool {
Region: region,
Role: role,
LobbyPublicAddr: conf.LobbyPublicAddr,
RelaySecret: conf.RelaySecret,
RelaySecret: string(conf.RelaySecret),
})
if err != nil {
logger.Error("gce alloc failed", zap.String("role", role), zap.String("region", region), zap.Error(err))
Expand Down
2 changes: 1 addition & 1 deletion gdxsv/lbs_relay_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ func TestLbsRelay_StatusNeedsSecret(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
conf.RelaySecret = tt.lbsSecret
conf.RelaySecret = Secret(tt.lbsSecret)
lbs := &Lbs{relayPeers: map[string]*LbsPeer{}, relayLastNeeded: map[string]time.Time{}}
p := &LbsPeer{app: lbs, logger: logger}
defaultLbsHandlers[lbsExtRelayStatus](p, status(tt.sentSecret))
Expand Down
18 changes: 16 additions & 2 deletions gdxsv/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ type Config struct {
RelayPublicAddr6 string `env:"GDXSV_RELAY_PUBLIC_ADDR6" envDefault:""` // [ipv6]:port, same port
RelayRegion string `env:"GDXSV_RELAY_REGION" envDefault:""` // relay: where it runs
RelayRegions string `env:"GDXSV_RELAY_REGIONS" envDefault:""` // lbs: comma separated regions it may start relays in
RelaySecret string `env:"GDXSV_RELAY_SECRET" envDefault:""` // shared by lbs and relays; lbs accepts no relay without it
RelaySecret Secret `env:"GDXSV_RELAY_SECRET" envDefault:""` // shared by lbs and relays; lbs accepts no relay without it
LobbyRegion string `env:"GDXSV_LOBBY_REGION" envDefault:"asia-northeast1"` // lbs: the GCP region nearest lbs, to pick the live spectator uplink

SpectatorMaxSubscribers int `env:"GDXSV_SPECTATOR_MAX_SUBSCRIBERS" envDefault:"4096"`
Expand All @@ -87,7 +87,7 @@ type Config struct {
GCPKeyPath string `env:"GDXSV_GCP_KEY_PATH" envDefault:""` // service account key; default credentials when empty
GCEOnDemand bool `env:"GDXSV_GCE_ONDEMAND" envDefault:"false"` // lbs: start mcs / relay VMs on GCE (lbs_gce.go)
ReplayBucket string `env:"GDXSV_REPLAY_BUCKET" envDefault:""` // lbs: GCS bucket for /lbs/replay_upload, off when empty
WebhookUrl string `env:"GDXSV_WEBHOOK_URL" envDefault:""`
WebhookUrl Secret `env:"GDXSV_WEBHOOK_URL" envDefault:""`

DBName string `env:"GDXSV_DB_NAME" envDefault:"gdxsv.db"`
}
Expand Down Expand Up @@ -414,3 +414,17 @@ func main() {
os.Exit(1)
}
}

// Secret is kept out of the logged config.
type Secret string

func (s Secret) String() string {
if s == "" {
return ""
}
return "***"
}

func (s Secret) MarshalText() ([]byte, error) {
return []byte(s.String()), nil
}
2 changes: 1 addition & 1 deletion gdxsv/relay.go
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ func mainRelay() {
lastConnected := time.Now()
for {
status := RelayStatus{Region: conf.RelayRegion, PublicAddr: conf.RelayPublicAddr, PublicAddr6: conf.RelayPublicAddr6,
Secret: conf.RelaySecret}
Secret: string(conf.RelaySecret)}
err := relay.DialAndSyncWithLbs(conf.LobbyPublicAddr, status, &lastConnected)
if err == ErrRelayShutdown {
logger.Info("relay shutdown requested by lbs")
Expand Down
2 changes: 1 addition & 1 deletion gdxsv/webhook.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func WebhookPostSimpleText(text string) {
return
}

res, err := http.Post(conf.WebhookUrl, "application/x-www-form-urlencoded", bytes.NewBuffer(body))
res, err := http.Post(string(conf.WebhookUrl), "application/x-www-form-urlencoded", bytes.NewBuffer(body))
if err != nil {
logger.Warn("http.Post", zap.Error(err))
return
Expand Down
Loading
0