tailscale: use a custom User-Agent header while making API requests (#…

…270) This passes a custom user-agent header value to the API client for making HTTP requests. It uses an existing UserAgent helper provided by the plugin SDK: https://github.com/hashicorp/terraform-plugin-sdk/blob/8bde488a9529d281bc6858ca2b0a3708c2f93658/helper/schema/provider.go#L489 Signed-off-by: Anton Tolchanov <[email protected]>
tailscale · Aug 17, 2023 · e2961ac · e2961ac
1 parent ce39573
commit e2961ac
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/docs/index.md b/docs/index.md
@@ -39,3 +39,4 @@ provider "tailscale" {
 - `oauth_client_secret` (String, Sensitive) The OAuth application's secret when using OAuth client credentials. Can be set via the OAUTH_CLIENT_SECRET environment variable. Both 'oauth_client_id' and 'oauth_client_secret' must be set. Conflicts with 'api_key'.
 - `scopes` (List of String) The OAuth 2.0 scopes to request when for the access token generated using the supplied OAuth client credentials. See https://tailscale.com/kb/1215/oauth-clients/#scopes for available scopes. Only valid when both 'oauth_client_id' and 'oauth_client_secret' are set.
 - `tailnet` (String) The organization name of the Tailnet in which to perform actions. Can be set via the TAILSCALE_TAILNET environment variable.
+- `user_agent` (String) User-Agent header for API requests.
diff --git a/main.go b/main.go
@@ -8,10 +8,24 @@ import (
 	"github.com/tailscale/terraform-provider-tailscale/tailscale"
 )
 
+// version is filled by goreleaser at build time.
+var version = "dev"
+
 func main() {
 	plugin.Serve(&plugin.ServeOpts{
 		ProviderFunc: func() *schema.Provider {
-			return tailscale.Provider()
+			return tailscale.Provider(addUserAgent)
 		},
 	})
 }
+
+// addUserAgent adds a `user_agent` configuration key to the provider with a
+// default value based on provider version.
+func addUserAgent(p *schema.Provider) {
+	p.Schema["user_agent"] = &schema.Schema{
+		Type:        schema.TypeString,
+		Default:     p.UserAgent("terraform-provider-tailscale", version),
+		Optional:    true,
+		Description: "User-Agent header for API requests.",
+	}
+}
diff --git a/tailscale/provider.go b/tailscale/provider.go
@@ -107,6 +107,8 @@ func providerConfigure(_ context.Context, d *schema.ResourceData) (interface{},
 		return nil, diag.Errorf("tailscale provider argument 'oauth_client_secret' is empty")
 	}
 
+	userAgent := d.Get("user_agent").(string)
+
 	if oauthClientID != "" && oauthClientSecret != "" {
 		var oauthScopes []string
 		oauthScopesFromConfig := d.Get("scopes").([]interface{})
@@ -121,6 +123,7 @@ func providerConfigure(_ context.Context, d *schema.ResourceData) (interface{},
 			"",
 			tailnet,
 			tailscale.WithBaseURL(baseURL),
+			tailscale.WithUserAgent(userAgent),
 			tailscale.WithOAuthClientCredentials(oauthClientID, oauthClientSecret, oauthScopes),
 		)
 		if err != nil {
@@ -134,6 +137,7 @@ func providerConfigure(_ context.Context, d *schema.ResourceData) (interface{},
 		apiKey,
 		tailnet,
 		tailscale.WithBaseURL(baseURL),
+		tailscale.WithUserAgent(userAgent),
 	)
 	if err != nil {
 		return nil, diagnosticsError(err, "failed to initialise client")