Rename bearer and method fields for consistency

Author: boxofrad

cmd/consul-dataplane/main.go

@@ -32,15 +32,15 @@ var (
 	namespace string
 	partition string
 
-	credentialType  string
-	token           string
-	loginMethod     string
-	loginNamespace  string
-	loginPartition  string
-	loginDatacenter string
-	loginBearer     string
-	loginBearerPath string
-	loginMeta       map[string]string
+	credentialType       string
+	token                string
+	loginAuthMethod      string
+	loginNamespace       string
+	loginPartition       string
+	loginDatacenter      string
+	loginBearerToken     string
+	loginBearerTokenPath string
+	loginMeta            map[string]string
 
 	useCentralTelemetryConfig bool
 
@@ -78,12 +78,12 @@ func init() {
 
 	flag.StringVar(&credentialType, "credential-type", "", "The type of credentials that will be used to authenticate with Consul servers (static or login).")
 	flag.StringVar(&token, "static-token", "", "The ACL token used to authenticate requests to Consul servers (when -credential-type is set to static).")
-	flag.StringVar(&loginMethod, "login-method", "", "The auth method that will be used to log in.")
+	flag.StringVar(&loginAuthMethod, "login-auth-method", "", "The auth method that will be used to log in.")
 	flag.StringVar(&loginNamespace, "login-namespace", "", "The Consul Enterprise namespace containing the auth method.")
 	flag.StringVar(&loginPartition, "login-partition", "", "The Consul Enterprise partition containing the auth method.")
 	flag.StringVar(&loginDatacenter, "login-datacenter", "", "The datacenter containing the auth method.")
-	flag.StringVar(&loginBearer, "login-bearer", "", "The bearer token that will be presented to the auth method.")
-	flag.StringVar(&loginBearerPath, "login-bearer-path", "", "The path to a file containing the bearer token that will be presented to the auth method.")
+	flag.StringVar(&loginBearerToken, "login-bearer-token", "", "The bearer token that will be presented to the auth method.")
+	flag.StringVar(&loginBearerTokenPath, "login-bearer-token-path", "", "The path to a file containing the bearer token that will be presented to the auth method.")
 	flag.Var((*FlagMapValue)(&loginMeta), "login-meta", "An arbitrary set of key/value pairs that will be attached to the ACL token (formatted as key=value, may be given multiple times).")
 
 	flag.BoolVar(&useCentralTelemetryConfig, "telemetry-use-central-config", true, "Controls whether the proxy will apply the central telemetry configuration.")
@@ -129,13 +129,13 @@ func main() {
 					Token: token,
 				},
 				Login: consuldp.LoginCredentialsConfig{
-					Method:     loginMethod,
-					Namespace:  loginNamespace,
-					Partition:  loginPartition,
-					Datacenter: loginDatacenter,
-					Bearer:     loginBearer,
-					BearerPath: loginBearerPath,
-					Meta:       loginMeta,
+					AuthMethod:      loginAuthMethod,
+					Namespace:       loginNamespace,
+					Partition:       loginPartition,
+					Datacenter:      loginDatacenter,
+					BearerToken:     loginBearerToken,
+					BearerTokenPath: loginBearerTokenPath,
+					Meta:            loginMeta,
 				},
 			},
 			ServerWatchDisabled: serverWatchDisabled,

pkg/consuldp/config.go

@@ -132,18 +132,18 @@ type StaticCredentialsConfig struct {
 
 // LoginCredentialsConfig contains credentials for logging in with an auth method.
 type LoginCredentialsConfig struct {
-	// Method is the name of the Consul auth method.
-	Method string
+	// AuthMethod is the name of the Consul auth method.
+	AuthMethod string
 	// Namespace is the namespace containing the auth method.
 	Namespace string
 	// Partition is the partition containing the auth method.
 	Partition string
 	// Datacenter is the datacenter containing the auth method.
 	Datacenter string
-	// Bearer is the bearer token presented to the auth method.
-	Bearer string
-	// BearerPath is the path to a file containing a bearer token.
-	BearerPath string
+	// BearerToken is the bearer token presented to the auth method.
+	BearerToken string
+	// BearerTokenPath is the path to a file containing a bearer token.
+	BearerTokenPath string
 	// Meta is the arbitrary set of key-value pairs to attach to the
 	// token. These are included in the Description field of the token.
 	Meta map[string]string
@@ -165,16 +165,16 @@ func (cc *CredentialsConfig) ToDiscoveryCredentials() (discovery.Credentials, er
 	case CredentialsTypeLogin:
 		creds.Type = discovery.CredentialsTypeLogin
 		creds.Login = discovery.LoginCredential{
-			AuthMethod:  cc.Login.Method,
+			AuthMethod:  cc.Login.AuthMethod,
 			Namespace:   cc.Login.Namespace,
 			Partition:   cc.Login.Partition,
 			Datacenter:  cc.Login.Datacenter,
-			BearerToken: cc.Login.Bearer,
+			BearerToken: cc.Login.BearerToken,
 			Meta:        cc.Login.Meta,
 		}
 
-		if creds.Login.BearerToken == "" && cc.Login.BearerPath != "" {
-			bearer, err := os.ReadFile(cc.Login.BearerPath)
+		if creds.Login.BearerToken == "" && cc.Login.BearerTokenPath != "" {
+			bearer, err := os.ReadFile(cc.Login.BearerTokenPath)
 			if err != nil {
 				return creds, fmt.Errorf("failed to read bearer token from file: %w", err)
 			}

pkg/consuldp/config_test.go

@@ -105,12 +105,12 @@ func TestConfig_Credentials(t *testing.T) {
 			in: CredentialsConfig{
 				Type: CredentialsTypeLogin,
 				Login: LoginCredentialsConfig{
-					Method:     "jwt",
-					Namespace:  "namespace-1",
-					Partition:  "partition-a",
-					Datacenter: "primary-dc",
-					Bearer:     "bearer-token",
-					Meta:       map[string]string{"foo": "bar"},
+					AuthMethod:  "jwt",
+					Namespace:   "namespace-1",
+					Partition:   "partition-a",
+					Datacenter:  "primary-dc",
+					BearerToken: "bearer-token",
+					Meta:        map[string]string{"foo": "bar"},
 				},
 			},
 			out: discovery.Credentials{
@@ -129,12 +129,12 @@ func TestConfig_Credentials(t *testing.T) {
 			in: CredentialsConfig{
 				Type: CredentialsTypeLogin,
 				Login: LoginCredentialsConfig{
-					Method:     "jwt",
-					Namespace:  "namespace-1",
-					Partition:  "partition-a",
-					Datacenter: "primary-dc",
-					BearerPath: tokFile.Name(),
-					Meta:       map[string]string{"foo": "bar"},
+					AuthMethod:      "jwt",
+					Namespace:       "namespace-1",
+					Partition:       "partition-a",
+					Datacenter:      "primary-dc",
+					BearerTokenPath: tokFile.Name(),
+					Meta:            map[string]string{"foo": "bar"},
 				},
 			},
 			out: discovery.Credentials{

pkg/consuldp/consul_dataplane.go

@@ -82,7 +82,7 @@ func validateConfig(cfg *Config) error {
 	}
 
 	creds := cfg.Consul.Credentials
-	if creds.Type == CredentialsTypeLogin && creds.Login.Bearer == "" && creds.Login.BearerPath == "" {
+	if creds.Type == CredentialsTypeLogin && creds.Login.BearerToken == "" && creds.Login.BearerTokenPath == "" {
 		return errors.New("bearer token (or path to a file containing a bearer token) is required for login")
 	}