Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

Fix: restrict instance name to digits, underscores, and letters (#19680)

Lynn780081177da4
diff --git a/internal/handler/providers.go b/internal/handler/providers.go
index 384077a2ab..ea5cea02e0 100644
--- a/internal/handler/providers.go
+++ b/internal/handler/providers.go
@@ -26,6 +26,7 @@ import (
"ragflow/internal/dao"
"ragflow/internal/entity/models"
"ragflow/internal/service"
+ "regexp"
"sort"
"strings"
"time"
@@ -351,6 +352,22 @@ type CreateProviderInstanceRequest struct {
ModelInfo []service.CreateInstanceModelInfo `json:"model_info"`
}
+// instanceNamePattern restricts an instance name to digits, underscores, and
+// ASCII letters in both cases.
+var instanceNamePattern = regexp.MustCompile(`^[0-9A-Za-z_]+$`)
+
+// validateInstanceName rejects an empty instance name or one carrying any
+// character outside digits, underscores, and ASCII letters.
+func validateInstanceName(instanceName string) error {
+ if instanceName == "" {
+ return errors.New("instance name is required")
+ }
+ if !instanceNamePattern.MatchString(instanceName) {
+ return errors.New("instance name may only contain digits, underscores, and letters")
+ }
+ return nil
+}
+
// normalizeAPIKey accepts api_key as either a JSON string or a JSON object
// (credential bundles such as XunFei Spark's
// {"spark_api_password": ..., "spark_app_id": ..., ...}) and normalizes it to
@@ -385,6 +402,11 @@ func (h *ProviderHandler) CreateProviderInstance(c *gin.Context) {
return
}
+ if err := validateInstanceName(req.InstanceName); err != nil {
+ common.ErrorWithCode(c, common.CodeBadRequest, err.Error())
+ return
+ }
+
userID := c.GetString("user_id")
apiKey := normalizeAPIKey(req.APIKey)
diff --git a/internal/handler/providers_test.go b/internal/handler/providers_test.go
index a88632d5b1..6cb9e189af 100644
--- a/internal/handler/providers_test.go
+++ b/internal/handler/providers_test.go
@@ -111,6 +111,46 @@ func decodeProviderHandlerResponse(t *testing.T, recorder *httptest.ResponseReco
return body
}
+func TestValidateInstanceName(t *testing.T) {
+ tests := []struct {
+ name string
+ valid bool
+ }{
+ {name: "my_instance", valid: true},
+ {name: "Instance123", valid: true},
+ {name: "_123", valid: true},
+ {name: "", valid: false},
+ {name: "my instance", valid: false},
+ {name: "my-instance", valid: false},
+ {name: "实例", valid: false},
+ {name: "instância", valid: false},
+ {name: "instance!", valid: false},
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ if err := validateInstanceName(tt.name); (err == nil) != tt.valid {
+ t.Fatalf("validateInstanceName(%q) error = %v, valid = %v", tt.name, err, tt.valid)
+ }
+ })
+ }
+}
+
+func TestProviderHandlerCreateProviderInstanceRejectsInvalidInstanceName(t *testing.T) {
+ ctx, recorder := newProviderHandlerRequest(
+ t,
+ map[string]interface{}{"instance_name": "my instance!"},
+ gin.Param{Key: "provider_id_or_name", Value: "OpenAI"},
+ )
+
+ NewProviderHandler(nil, service.NewModelProviderService()).CreateProviderInstance(ctx)
+
+ body := decodeProviderHandlerResponse(t, recorder)
+ if common.ErrorCode(body["code"].(float64)) != common.CodeBadRequest {
+ t.Fatalf("code = %v, want %v", body["code"], common.CodeBadRequest)
+ }
+}
+
func TestProviderHandlerAlterModelRejectsMissingModelSelector(t *testing.T) {
ctx, recorder := newProviderHandlerRequest(
t,