mirror of https://github.com/tailscale/tailscale/
cmd,feature: add workload idenity auto discovery
Adds the ability to auto detect what provider the client is running on and tries fetch the JWT to use with Workload Identity. Updates https://github.com/tailscale/corp/issues/33316pull/18371/head
Danni Popova
3 days ago
parent
4c37141ab7
commit
b6b7929f19
@ -0,0 +1,13 @@
|
||||
package identityfederation
|
||||
|
||||
type TokenSourceKind string
|
||||
|
||||
const (
|
||||
SourceUnknown TokenSourceKind = "unknown"
|
||||
SourceGitHub TokenSourceKind = "github"
|
||||
SourceAWS TokenSourceKind = "aws"
|
||||
SourceGCP TokenSourceKind = "gcp"
|
||||
SourceAzure TokenSourceKind = "azure"
|
||||
)
|
||||
|
||||
func detectIdp() {}
|
||||
@ -0,0 +1,334 @@
|
||||
// Copyright (c) Tailscale Inc & AUTHORS
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
package wif
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"os"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/aws/aws-sdk-go-v2/aws"
|
||||
"github.com/aws/aws-sdk-go-v2/config"
|
||||
"github.com/aws/aws-sdk-go-v2/service/sts"
|
||||
"github.com/aws/smithy-go"
|
||||
)
|
||||
|
||||
type Environment string
|
||||
|
||||
const (
|
||||
EnvGitHub Environment = "github"
|
||||
EnvAWS Environment = "aws"
|
||||
EnvGCP Environment = "gcp"
|
||||
EnvNone Environment = "none"
|
||||
)
|
||||
|
||||
const (
|
||||
metadataDialTimeout = 200 * time.Millisecond
|
||||
metadataResponseTimeout = 200 * time.Millisecond
|
||||
metadataClientTimeout = 400 * time.Millisecond
|
||||
metadataIdleConnTimeout = 10 * time.Second
|
||||
providerDialTimeout = 500 * time.Millisecond
|
||||
providerResponseTimeout = 500 * time.Millisecond
|
||||
providerClientTimeout = 2 * time.Second
|
||||
githubClientTimeout = 10 * time.Second
|
||||
)
|
||||
|
||||
// ObtainProviderToken tries to detect what provider the client is running in
|
||||
// and then tries to obtain an ID token for the audience that is passed as an argument
|
||||
// To detect the environment, we do it in the following intentional order:
|
||||
// 1. GitHub Actions (strongest env signals; may run atop any cloud)
|
||||
// 2. AWS via IMDSv2 token endpoint (does not require env vars)
|
||||
// 3. GCP via metadata header semantics
|
||||
func ObtainProviderToken(ctx context.Context, audience string) (token string, err error) {
|
||||
env := detectEnvironment(ctx)
|
||||
|
||||
switch env {
|
||||
case EnvGitHub:
|
||||
return acquireGitHubActionsIDToken(ctx, audience)
|
||||
case EnvAWS:
|
||||
return acquireAWSWebIdentityToken(ctx, audience)
|
||||
case EnvGCP:
|
||||
return acquireGCPMetadataIDToken(ctx, audience)
|
||||
default:
|
||||
return "", errors.New("could not detect environment; provide --id-token explicitly")
|
||||
}
|
||||
}
|
||||
|
||||
func detectEnvironment(ctx context.Context) Environment {
|
||||
if os.Getenv("ACTIONS_ID_TOKEN_REQUEST_URL") != "" &&
|
||||
os.Getenv("ACTIONS_ID_TOKEN_REQUEST_TOKEN") != "" {
|
||||
return EnvGitHub
|
||||
}
|
||||
|
||||
client := metadataHTTPClient()
|
||||
|
||||
if detectAWSIMDSv2(ctx, client) {
|
||||
return EnvAWS
|
||||
}
|
||||
|
||||
if detectGCPMetadata(ctx, client) {
|
||||
return EnvGCP
|
||||
}
|
||||
|
||||
return EnvNone
|
||||
}
|
||||
|
||||
func metadataHTTPClient() *http.Client {
|
||||
return &http.Client{
|
||||
Transport: &http.Transport{
|
||||
Proxy: nil,
|
||||
DialContext: (&net.Dialer{
|
||||
Timeout: metadataDialTimeout,
|
||||
}).DialContext,
|
||||
ResponseHeaderTimeout: metadataResponseTimeout,
|
||||
IdleConnTimeout: metadataIdleConnTimeout,
|
||||
},
|
||||
Timeout: metadataClientTimeout,
|
||||
}
|
||||
}
|
||||
|
||||
func providerHTTPClient() *http.Client {
|
||||
return &http.Client{
|
||||
Transport: &http.Transport{
|
||||
Proxy: nil,
|
||||
DialContext: (&net.Dialer{
|
||||
Timeout: providerDialTimeout,
|
||||
}).DialContext,
|
||||
ResponseHeaderTimeout: providerResponseTimeout,
|
||||
},
|
||||
Timeout: providerClientTimeout,
|
||||
}
|
||||
}
|
||||
|
||||
func detectAWSIMDSv2(ctx context.Context, client *http.Client) bool {
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodPut, "http://169.254.169.254/latest/api/token", nil)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
req.Header.Set("X-aws-ec2-metadata-token-ttl-seconds", "60")
|
||||
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
return resp.StatusCode == http.StatusOK
|
||||
}
|
||||
|
||||
func detectGCPMetadata(ctx context.Context, client *http.Client) bool {
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, "http://metadata.google.internal", nil)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
req.Header.Set("Metadata-Flavor", "Google")
|
||||
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
return resp.Header.Get("Metadata-Flavor") == "Google"
|
||||
}
|
||||
|
||||
type githubOIDCResponse struct {
|
||||
Value string `json:"value"`
|
||||
}
|
||||
|
||||
func acquireGitHubActionsIDToken(ctx context.Context, audience string) (jwt string, err error) {
|
||||
reqURL := os.Getenv("ACTIONS_ID_TOKEN_REQUEST_URL")
|
||||
reqTok := os.Getenv("ACTIONS_ID_TOKEN_REQUEST_TOKEN")
|
||||
if reqURL == "" || reqTok == "" {
|
||||
return "", errors.New("missing ACTIONS_ID_TOKEN_REQUEST_URL/TOKEN (ensure workflow has permissions: id-token: write)")
|
||||
}
|
||||
|
||||
u, err := url.Parse(reqURL)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("parse ACTIONS_ID_TOKEN_REQUEST_URL: %w", err)
|
||||
}
|
||||
if strings.TrimSpace(audience) != "" {
|
||||
q := u.Query()
|
||||
q.Set("audience", strings.TrimSpace(audience))
|
||||
u.RawQuery = q.Encode()
|
||||
}
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, u.String(), nil)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("build request: %w", err)
|
||||
}
|
||||
req.Header.Set("Authorization", "Bearer "+reqTok)
|
||||
req.Header.Set("Accept", "application/json")
|
||||
|
||||
client := &http.Client{Timeout: githubClientTimeout}
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("request github oidc token: %w", err)
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
if resp.StatusCode/100 != 2 {
|
||||
b, _ := io.ReadAll(io.LimitReader(resp.Body, 2048))
|
||||
return "", fmt.Errorf("github oidc token endpoint returned %s: %s", resp.Status, strings.TrimSpace(string(b)))
|
||||
}
|
||||
|
||||
var tr githubOIDCResponse
|
||||
if err := json.NewDecoder(resp.Body).Decode(&tr); err != nil {
|
||||
return "", fmt.Errorf("decode github oidc response: %w", err)
|
||||
}
|
||||
if strings.TrimSpace(tr.Value) == "" {
|
||||
return "", errors.New("github oidc response contained empty token")
|
||||
}
|
||||
|
||||
// GitHub response doesn't provide exp directly; caller can parse JWT if needed.
|
||||
return tr.Value, nil
|
||||
}
|
||||
|
||||
func acquireAWSWebIdentityToken(ctx context.Context, audience string) (jwt string, err error) {
|
||||
duration := 5 * time.Minute
|
||||
|
||||
region, err := detectAWSRegion(ctx)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
// LoadDefaultConfig wires up the default credential chain (incl. IMDS).
|
||||
cfg, err := config.LoadDefaultConfig(ctx, config.WithRegion(region))
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("load aws config: %w", err)
|
||||
}
|
||||
|
||||
// Verify credentials are available before proceeding.
|
||||
if _, err := cfg.Credentials.Retrieve(ctx); err != nil {
|
||||
return "", fmt.Errorf("AWS credentials unavailable (instance profile/IMDS?): %w", err)
|
||||
}
|
||||
|
||||
stsClient := sts.NewFromConfig(cfg)
|
||||
|
||||
in := &sts.GetWebIdentityTokenInput{
|
||||
Audience: []string{strings.TrimSpace(audience)},
|
||||
SigningAlgorithm: aws.String("RS256"),
|
||||
DurationSeconds: aws.Int32(int32(duration / time.Second)),
|
||||
}
|
||||
|
||||
out, err := stsClient.GetWebIdentityToken(ctx, in)
|
||||
if err != nil {
|
||||
var apiErr smithy.APIError
|
||||
if errors.As(err, &apiErr) {
|
||||
return "", fmt.Errorf("aws sts:GetWebIdentityToken failed (%s): %w", apiErr.ErrorCode(), err)
|
||||
}
|
||||
return "", fmt.Errorf("aws sts:GetWebIdentityToken failed: %w", err)
|
||||
}
|
||||
|
||||
if out.WebIdentityToken == nil || strings.TrimSpace(*out.WebIdentityToken) == "" {
|
||||
return "", fmt.Errorf("aws sts:GetWebIdentityToken returned empty token")
|
||||
}
|
||||
|
||||
return *out.WebIdentityToken, nil
|
||||
}
|
||||
|
||||
func acquireGCPMetadataIDToken(ctx context.Context, audience string) (jwt string, err error) {
|
||||
u := "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity"
|
||||
v := url.Values{}
|
||||
v.Set("audience", strings.TrimSpace(audience))
|
||||
v.Set("format", "full")
|
||||
fullURL := u + "?" + v.Encode()
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, fullURL, nil)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("build request: %w", err)
|
||||
}
|
||||
req.Header.Set("Metadata-Flavor", "Google")
|
||||
|
||||
client := providerHTTPClient()
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("call gcp metadata identity endpoint: %w", err)
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
if resp.StatusCode/100 != 2 {
|
||||
b, _ := io.ReadAll(io.LimitReader(resp.Body, 2048))
|
||||
return "", fmt.Errorf("gcp metadata identity endpoint returned %s: %s", resp.Status, strings.TrimSpace(string(b)))
|
||||
}
|
||||
|
||||
b, err := io.ReadAll(io.LimitReader(resp.Body, 1024*1024))
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("read gcp id token: %w", err)
|
||||
}
|
||||
jwt = strings.TrimSpace(string(b))
|
||||
if jwt == "" {
|
||||
return "", fmt.Errorf("gcp metadata returned empty token")
|
||||
}
|
||||
|
||||
return jwt, nil
|
||||
}
|
||||
|
||||
func detectAWSRegion(ctx context.Context) (string, error) {
|
||||
client := providerHTTPClient()
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodPut, "http://169.254.169.254/latest/api/token", nil)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("build imds token request: %w", err)
|
||||
}
|
||||
req.Header.Set("X-aws-ec2-metadata-token-ttl-seconds", "60")
|
||||
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("call imds token endpoint: %w", err)
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
b, _ := io.ReadAll(io.LimitReader(resp.Body, 512))
|
||||
return "", fmt.Errorf("imds token endpoint returned %s: %s", resp.Status, strings.TrimSpace(string(b)))
|
||||
}
|
||||
|
||||
tokenBytes, err := io.ReadAll(io.LimitReader(resp.Body, 1024))
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("read imds token: %w", err)
|
||||
}
|
||||
token := strings.TrimSpace(string(tokenBytes))
|
||||
if token == "" {
|
||||
return "", fmt.Errorf("imds token endpoint returned empty token")
|
||||
}
|
||||
|
||||
// Get instance identity document
|
||||
req2, err := http.NewRequestWithContext(ctx, http.MethodGet, "http://169.254.169.254/latest/dynamic/instance-identity/document", nil)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("build identity document request: %w", err)
|
||||
}
|
||||
req2.Header.Set("X-aws-ec2-metadata-token", token)
|
||||
|
||||
resp2, err := client.Do(req2)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("call identity document endpoint: %w", err)
|
||||
}
|
||||
defer resp2.Body.Close()
|
||||
|
||||
if resp2.StatusCode != http.StatusOK {
|
||||
b, _ := io.ReadAll(io.LimitReader(resp2.Body, 512))
|
||||
return "", fmt.Errorf("identity document endpoint returned %s: %s", resp2.Status, strings.TrimSpace(string(b)))
|
||||
}
|
||||
|
||||
var doc struct {
|
||||
Region string `json:"region"`
|
||||
}
|
||||
if err := json.NewDecoder(resp2.Body).Decode(&doc); err != nil {
|
||||
return "", fmt.Errorf("decode identity document: %w", err)
|
||||
}
|
||||
if doc.Region == "" {
|
||||
return "", fmt.Errorf("region not found in instance identity document")
|
||||
}
|
||||
|
||||
return doc.Region, nil
|
||||
}
|
||||
Loading…
Reference in New Issue