mirror of
https://github.com/Dvorinka/Containr.git
synced 2026-10-28 07:41:27 +00:00
feat(services): env doctor — surface empty vars, bad refs, unreadable secrets
GET /services/:id/env-check (read scope) reports, without exposing values:
- unresolved: ${{service.KEY}} refs that don't match a sibling service/env
- empty: variables with blank values
- unreadable: secrets whose ciphertext fails decryption (key rotation)
install.sh now generates SECRETS_KEY explicitly (was falling back to
JWT_SECRET — a rotation would orphan ciphertext). .env.example documents it.
Surfaces: CLI `services env-check`, MCP containr_services_env_check
(90 tools), OpenAPI path, and a warning banner in the service Variables
panel listing each issue.
Verified live: injected a bogus ${{nosuchservice.PORT}} var plus an
unreadable ciphertext row; the endpoint flagged both, ok=false.
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
This commit is contained in:
1 parent
dbc87bf34c
commit
d135e5fd4b
13 files changed
+269
-3
No files matched your search
@@ -279,6 +279,7 @@ func SetupRoutes(router *gin.Engine, db *database.DB, redis *database.Redis, cfg
|
||||
read.GET("/services/:id/deployments", handleGetDeployments)
|
||||
read.GET("/services/:id/domains", handleListServiceDomains)
|
||||
read.GET("/services/:id/domains/check", handleCheckServiceDomains)
|
||||
read.GET("/services/:id/env-check", handleServiceEnvCheck)
|
||||
read.GET("/deployments", handleGetRecentDeployments)
|
||||
read.GET("/deployments/:id", handleGetDeployment)
|
||||
|
||||
|
||||
@@ -638,3 +638,112 @@ func runtimeScaleService(c *gin.Context, serviceID string, replicas int) error {
|
||||
_, _ = db.Exec(`UPDATE services SET replicas = $1, updated_at = $2 WHERE id = $3`, replicas, time.Now(), service.ID)
|
||||
return nil
|
||||
}
|
||||
|
||||
// handleServiceEnvCheck reports environment problems without exposing
|
||||
// values: empty vars, ${{service.KEY}} refs that fail to resolve, and
|
||||
// secrets whose ciphertext can't be decrypted (key rotation).
|
||||
func handleServiceEnvCheck(c *gin.Context) {
|
||||
dbVal, exists := c.Get("db")
|
||||
if !exists {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "Database connection not available"})
|
||||
return
|
||||
}
|
||||
db := dbVal.(*database.DB)
|
||||
service, ok := loadReadableService(c, db)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
|
||||
rows, err := db.Query(
|
||||
`SELECT key, value, COALESCE(is_secret, false) FROM environment_variables WHERE service_id = $1`,
|
||||
service.ID,
|
||||
)
|
||||
if err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
|
||||
return
|
||||
}
|
||||
defer rows.Close()
|
||||
|
||||
var unresolved, empty, unreadable []string
|
||||
var raw []struct{ key, val string }
|
||||
for rows.Next() {
|
||||
var k, v string
|
||||
var secret bool
|
||||
if err := rows.Scan(&k, &v, &secret); err != nil {
|
||||
continue
|
||||
}
|
||||
decrypted := secrets.Decrypt(v)
|
||||
if secret && secrets.IsEncrypted(v) && decrypted == v {
|
||||
// Ciphertext failed to decrypt — Decrypt returns the input.
|
||||
unreadable = append(unreadable, k)
|
||||
continue
|
||||
}
|
||||
if strings.TrimSpace(decrypted) == "" {
|
||||
empty = append(empty, k)
|
||||
}
|
||||
raw = append(raw, struct{ key, val string }{k, decrypted})
|
||||
}
|
||||
|
||||
// Project siblings for ${{name.KEY}} resolution.
|
||||
siblingIDs := map[string]string{}
|
||||
svcRows, err := db.Query(`SELECT id, name FROM services WHERE project_id = $1`, service.ProjectID)
|
||||
if err == nil {
|
||||
for svcRows.Next() {
|
||||
var id, name string
|
||||
if err := svcRows.Scan(&id, &name); err == nil {
|
||||
siblingIDs[strings.ToLower(name)] = id
|
||||
}
|
||||
}
|
||||
svcRows.Close()
|
||||
}
|
||||
|
||||
resolvable := func(serviceName, key string) bool {
|
||||
id, ok := siblingIDs[strings.ToLower(serviceName)]
|
||||
if !ok {
|
||||
return false
|
||||
}
|
||||
if strings.EqualFold(key, "HOST") {
|
||||
return true
|
||||
}
|
||||
if strings.EqualFold(key, "PORT") {
|
||||
var port int
|
||||
if err := db.QueryRow(`SELECT COALESCE(port, 0) FROM services WHERE id = $1`, id).Scan(&port); err == nil {
|
||||
return port > 0
|
||||
}
|
||||
return false
|
||||
}
|
||||
var n int
|
||||
if err := db.QueryRow(
|
||||
`SELECT COUNT(*) FROM environment_variables WHERE service_id = $1 AND key = $2`,
|
||||
id, key,
|
||||
).Scan(&n); err == nil {
|
||||
return n > 0
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
for _, kv := range raw {
|
||||
for _, match := range refVarPattern.FindAllStringSubmatch(kv.val, -1) {
|
||||
if len(match) == 3 && !resolvable(match[1], match[2]) {
|
||||
unresolved = append(unresolved, fmt.Sprintf("%s → %s", kv.key, match[0]))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if unresolved == nil {
|
||||
unresolved = []string{}
|
||||
}
|
||||
if empty == nil {
|
||||
empty = []string{}
|
||||
}
|
||||
if unreadable == nil {
|
||||
unreadable = []string{}
|
||||
}
|
||||
okResult := len(unresolved) == 0 && len(empty) == 0 && len(unreadable) == 0
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"ok": okResult,
|
||||
"unresolved": unresolved,
|
||||
"empty": empty,
|
||||
"unreadable": unreadable,
|
||||
})
|
||||
}
|
||||
@@ -530,5 +530,38 @@ func init() {
|
||||
|
||||
domainsAddCmd.Flags().Bool("default", false, "set as the default domain")
|
||||
servicesDomainsCmd.AddCommand(domainsListCmd, domainsAddCmd, domainsRemoveCmd, domainsDefaultCmd, domainsCheckCmd)
|
||||
ServicesCmd.AddCommand(servicesListCmd, servicesGetCmd, servicesCreateCmd, servicesUpdateCmd, servicesDeleteCmd, servicesDomainsCmd, servicesCloneCmd, servicesMoveCmd)
|
||||
ServicesCmd.AddCommand(servicesListCmd, servicesGetCmd, servicesCreateCmd, servicesUpdateCmd, servicesDeleteCmd, servicesDomainsCmd, servicesCloneCmd, servicesMoveCmd, servicesEnvCheckCmd)
|
||||
}
|
||||
|
||||
var servicesEnvCheckCmd = &cobra.Command{
|
||||
Use: "env-check <id>",
|
||||
Short: "Diagnose service environment: empty vars, unresolved ${{refs}}",
|
||||
Args: cobra.ExactArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
c, err := client()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
data, err := c.Do("GET", "/services/"+args[0]+"/env-check", nil)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if JSONMode() {
|
||||
PrintRaw(data)
|
||||
return nil
|
||||
}
|
||||
m, _ := unwrapObject(data)
|
||||
if b, ok := m["ok"].(bool); ok && b {
|
||||
fmt.Println("env check: ok")
|
||||
return nil
|
||||
}
|
||||
for _, group := range []string{"unresolved", "empty", "unreadable"} {
|
||||
if list, ok := m[group].([]interface{}); ok {
|
||||
for _, item := range list {
|
||||
fmt.Printf("%s: %v\n", group, item)
|
||||
}
|
||||
}
|
||||
}
|
||||
return &APIError{Message: "env check failed", ExitCode: ExitError}
|
||||
},
|
||||
}
|
||||
@@ -60,6 +60,7 @@ func init() {
|
||||
register(spec{"containr_services_restart", "Restart a service", "POST", "/services/{id}/restart", []string{"id"}, nil, false})
|
||||
register(spec{"containr_services_sleep", "Put a service to sleep immediately (scale to zero)", "POST", "/services/{id}/sleep", []string{"id"}, nil, false})
|
||||
register(spec{"containr_services_wake", "Wake a sleeping service", "POST", "/services/{id}/wake", []string{"id"}, nil, false})
|
||||
register(spec{"containr_services_env_check", "Diagnose service env: returns ok plus unresolved ${{refs}}, empty vars, and undecryptable secrets", "GET", "/services/{id}/env-check", []string{"id"}, nil, false})
|
||||
register(spec{"containr_services_redeploy", "Rebuild and redeploy a service", "POST", "/services/{id}/redeploy", []string{"id"}, nil, false})
|
||||
register(spec{"containr_services_clone", "Clone a service (config, volumes, domains, variables) into the same or another project. Args: id, name, project_id, environment.", "POST", "/services/{id}/clone", []string{"id"}, nil, false})
|
||||
register(spec{"containr_services_move", "Move a service to another project the caller owns. Args: id, project_id (required).", "POST", "/services/{id}/move", []string{"id"}, []string{"project_id"}, false})
|
||||
|
||||
Reference in new issue
Block a user