feat: enhance authentication plugin configurations with username and password fields

Author: zhu327

api/adc/plugin_types.go

@@ -127,9 +127,14 @@ type ForwardAuthConfig struct {
 // BasicAuthConfig is the rule config for basic-auth plugin.
 // +k8s:deepcopy-gen=true
 type BasicAuthConfig struct {
+	Username string `json:"username,omitempty"`
+	Password string `json:"password,omitempty"`
 }
 
 // KeyAuthConfig is the rule config for key-auth plugin.
 // +k8s:deepcopy-gen=true
 type KeyAuthConfig struct {
+	Header string `json:"header,omitempty"`
+	Query  string `json:"query,omitempty"`
+	Key    string `json:"key,omitempty"`
 }

internal/adc/translator/annotations/plugins/authorization.go

@@ -36,7 +36,10 @@ func (b *basicAuth) Handle(e annotations.Extractor) (any, error) {
 	if e.GetStringAnnotation(annotations.AnnotationsAuthType) != "basicAuth" {
 		return nil, nil
 	}
-	plugin := adctypes.BasicAuthConfig{}
+	plugin := adctypes.BasicAuthConfig{
+		Username: e.GetStringAnnotation(annotations.AnnotationsBasicAuthUsername),
+		Password: e.GetStringAnnotation(annotations.AnnotationsBasicAuthPassword),
+	}
 	return &plugin, nil
 }
 
@@ -56,6 +59,10 @@ func (k *keyAuth) Handle(e annotations.Extractor) (any, error) {
 	if e.GetStringAnnotation(annotations.AnnotationsAuthType) != "keyAuth" {
 		return nil, nil
 	}
-	plugin := adctypes.KeyAuthConfig{}
+	plugin := adctypes.KeyAuthConfig{
+		Header: e.GetStringAnnotation(annotations.AnnotationsKeyAuthHeader),
+		Query:  e.GetStringAnnotation(annotations.AnnotationsKeyAuthQuery),
+		Key:    e.GetStringAnnotation(annotations.AnnotationsKeyAuthKey),
+	}
 	return &plugin, nil
 }

internal/adc/translator/annotations/types.go

@@ -46,7 +46,7 @@ const (
 	AnnotationsCorsAllowMethods = AnnotationsPrefix + "cors-allow-methods"
 
 	// csrf plugin
-	AnnotationsEnableCsrf = AnnotationsPrefix + "enable-csrf" // pingsix not support
+	AnnotationsEnableCsrf = AnnotationsPrefix + "enable-csrf"
 	AnnotationsCsrfKey    = AnnotationsPrefix + "csrf-key"
 
 	// redirect plugin
@@ -60,10 +60,10 @@ const (
 	AnnotationsRewriteTargetRegexTemplate = AnnotationsPrefix + "rewrite-target-regex-template"
 
 	// response-rewrite plugin
-	AnnotationsEnableResponseRewrite       = AnnotationsPrefix + "enable-response-rewrite" // pingsix not support
+	AnnotationsEnableResponseRewrite       = AnnotationsPrefix + "enable-response-rewrite"
 	AnnotationsResponseRewriteStatusCode   = AnnotationsPrefix + "response-rewrite-status-code"
-	AnnotationsResponseRewriteBody         = AnnotationsPrefix + "response-rewrite-body"
-	AnnotationsResponseRewriteBodyBase64   = AnnotationsPrefix + "response-rewrite-body-base64"
+	AnnotationsResponseRewriteBody         = AnnotationsPrefix + "response-rewrite-body"        // pingsix not support
+	AnnotationsResponseRewriteBodyBase64   = AnnotationsPrefix + "response-rewrite-body-base64" // pingsix not support
 	AnnotationsResponseRewriteHeaderAdd    = AnnotationsPrefix + "response-rewrite-add-header"
 	AnnotationsResponseRewriteHeaderSet    = AnnotationsPrefix + "response-rewrite-set-header"
 	AnnotationsResponseRewriteHeaderRemove = AnnotationsPrefix + "response-rewrite-remove-header"
@@ -85,13 +85,15 @@ const (
 
 	// key-auth plugin and basic-auth plugin
 	// auth-type: keyAuth | basicAuth
-	AnnotationsAuthType = AnnotationsPrefix + "auth-type" // need modify config with pingsix
+	AnnotationsAuthType          = AnnotationsPrefix + "auth-type"
+	AnnotationsKeyAuthHeader     = AnnotationsPrefix + "key-auth-header"
+	AnnotationsKeyAuthQuery      = AnnotationsPrefix + "key-auth-query"
+	AnnotationsKeyAuthKey        = AnnotationsPrefix + "key-auth-key"
+	AnnotationsBasicAuthUsername = AnnotationsPrefix + "basic-auth-username"
+	AnnotationsBasicAuthPassword = AnnotationsPrefix + "basic-auth-password"
 
 	// support backend service cross namespace
 	AnnotationsSvcNamespace = AnnotationsPrefix + "svc-namespace"
-
-	// NOTE: PingSIX may support CSRF and Basic Authentication in the future.
-	// NOTE: key-auth and basic-auth need to read configuration directly from annotations.
 )
 
 const (