Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(token): add support for eks pod identity cred provider #500

Merged
merged 3 commits into from
Mar 7, 2025
Merged

feat(token): add support for eks pod identity cred provider #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d62a86c
feat(token): add support for eks pod identity cred provider
ssttehrani Jan 29, 2025
00f37d6
doc(readme): introduce the new cred provider
ssttehrani Jan 29, 2025
9d80305
Merge branch 'main' into add-eks-pod-identity-support
Mongey Mar 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,16 @@ provider "kafka" {
sasl_aws_region = "us-east-1"
}
```

Example provider with aws-iam(Container Creds) client authentication. You have to export `AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE` and `AWS_CONTAINER_CREDENTIALS_FULL_URI`
```hcl
provider "kafka" {
bootstrap_servers = ["localhost:9098"]
tls_enabled = true
sasl_mechanism = "aws-iam"
sasl_aws_region = "us-east-1"
}
```
#### Compatibility with Redpanda

```hcl
Expand All @@ -151,6 +161,8 @@ Due to Redpanda not implementing some Metadata APIs, we need to force the Kafka
| `sasl_password` | Password for SASL authentication. | `""` |
| `sasl_mechanism` | Mechanism for SASL authentication. Allowed values are `plain`, `aws-iam`, `scram-sha256`, `scram-sha512` or `oauthbearer` | `plain` |
| `sasl_aws_region` | AWS region for IAM authentication. | `""` |
| `sasl_aws_container_authorization_token_file` | Path to a file containing the AWS pod identity authorization token. | `""` |
| `sasl_aws_container_credentials_full_uri` | URI to retrieve AWS credentials from. | `""` |
| `sasl_aws_role_arn` | Arn of AWS IAM role to assume for IAM authentication. | `""` |
| `sasl_aws_profile` | AWS profile to use for IAM authentication. | `""` |
| `sasl_aws_access_key` | AWS access key. | `""` |
Expand Down
60 changes: 39 additions & 21 deletions kafka/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,35 @@ import (
"github.com/IBM/sarama"
"github.com/aws/aws-msk-iam-sasl-signer-go/signer"
"github.com/aws/aws-sdk-go-v2/credentials"
"github.com/aws/aws-sdk-go-v2/credentials/endpointcreds"
"golang.org/x/net/proxy"
"golang.org/x/oauth2"
"golang.org/x/oauth2/clientcredentials"
)

type Config struct {
BootstrapServers *[]string
Timeout int
CACert string
ClientCert string
ClientCertKey string
ClientCertKeyPassphrase string
KafkaVersion string
TLSEnabled bool
SkipTLSVerify bool
SASLUsername string
SASLPassword string
SASLMechanism string
SASLAWSRegion string
SASLAWSRoleArn string
SASLAWSProfile string
SASLAWSAccessKey string
SASLAWSSecretKey string
SASLAWSToken string
SASLAWSCredsDebug bool
SASLTokenUrl string
BootstrapServers *[]string
Timeout int
CACert string
ClientCert string
ClientCertKey string
ClientCertKeyPassphrase string
KafkaVersion string
TLSEnabled bool
SkipTLSVerify bool
SASLUsername string
SASLPassword string
SASLMechanism string
SASLAWSContainerAuthorizationTokenFile string
SASLAWSContainerCredentialsFullUri string
SASLAWSRegion string
SASLAWSRoleArn string
SASLAWSProfile string
SASLAWSAccessKey string
SASLAWSSecretKey string
SASLAWSToken string
SASLAWSCredsDebug bool
SASLTokenUrl string
}

type OAuth2Config interface {
Expand Down Expand Up @@ -85,7 +88,20 @@ func (c *Config) Token() (*sarama.AccessToken, error) {
signer.AwsDebugCreds = c.SASLAWSCredsDebug
var token string
var err error
if c.SASLAWSRoleArn != "" {

if c.SASLAWSContainerAuthorizationTokenFile != "" && c.SASLAWSContainerCredentialsFullUri != "" {
log.Printf("[INFO] Generating auth token using container credentials in '%s'", c.SASLAWSRegion)
var containerAuthorizationToken []byte
containerAuthorizationToken, err = os.ReadFile(c.SASLAWSContainerAuthorizationTokenFile)
if err != nil {
return nil, fmt.Errorf("failed to read authorization token file: %w", err)
}
tokenOpt := func(o *endpointcreds.Options) {
o.AuthorizationToken = string(containerAuthorizationToken)
}
credProvider := endpointcreds.New(c.SASLAWSContainerCredentialsFullUri, tokenOpt)
token, _, err = signer.GenerateAuthTokenFromCredentialsProvider(context.TODO(), c.SASLAWSRegion, credProvider)
} else if c.SASLAWSRoleArn != "" {
log.Printf("[INFO] Generating auth token with a role '%s' in '%s'", c.SASLAWSRoleArn, c.SASLAWSRegion)
token, _, err = signer.GenerateAuthTokenFromRole(context.TODO(), c.SASLAWSRegion, c.SASLAWSRoleArn, "terraform-kafka-provider")
} else if c.SASLAWSProfile != "" {
Expand Down Expand Up @@ -303,6 +319,8 @@ func (config *Config) copyWithMaskedSensitiveValues() Config {
config.SASLUsername,
"*****",
config.SASLMechanism,
config.SASLAWSContainerAuthorizationTokenFile,
config.SASLAWSContainerCredentialsFullUri,
config.SASLAWSRegion,
config.SASLAWSRoleArn,
config.SASLAWSProfile,
Expand Down
54 changes: 34 additions & 20 deletions kafka/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,18 @@ func Provider() *schema.Provider {
DefaultFunc: schema.EnvDefaultFunc("KAFKA_VERSION", "2.7.0"),
Description: "The version of Kafka protocol to use in `$MAJOR.$MINOR.$PATCH` format. Some features may not be available on older versions. Default is 2.7.0.",
},
"sasl_aws_container_authorization_token_file": {
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE", nil),
Description: "Path to a file containing the AWS pod identity authorization token",
},
"sasl_aws_container_credentials_full_uri": {
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("AWS_CONTAINER_CREDENTIALS_FULL_URI", nil),
Description: "URI to retrieve AWS credentials from",
},
"sasl_aws_role_arn": {
Type: schema.TypeString,
Optional: true,
Expand Down Expand Up @@ -179,26 +191,28 @@ func providerConfigure(d *schema.ResourceData) (interface{}, error) {
}

config := &Config{
BootstrapServers: brokers,
CACert: d.Get("ca_cert").(string),
ClientCert: d.Get("client_cert").(string),
ClientCertKey: d.Get("client_key").(string),
ClientCertKeyPassphrase: d.Get("client_key_passphrase").(string),
KafkaVersion: d.Get("kafka_version").(string),
SkipTLSVerify: d.Get("skip_tls_verify").(bool),
SASLAWSRegion: d.Get("sasl_aws_region").(string),
SASLUsername: d.Get("sasl_username").(string),
SASLPassword: d.Get("sasl_password").(string),
SASLTokenUrl: d.Get("sasl_token_url").(string),
SASLAWSRoleArn: d.Get("sasl_aws_role_arn").(string),
SASLAWSProfile: d.Get("sasl_aws_profile").(string),
SASLAWSAccessKey: d.Get("sasl_aws_access_key").(string),
SASLAWSSecretKey: d.Get("sasl_aws_secret_key").(string),
SASLAWSToken: d.Get("sasl_aws_token").(string),
SASLAWSCredsDebug: d.Get("sasl_aws_creds_debug").(bool),
SASLMechanism: saslMechanism,
TLSEnabled: d.Get("tls_enabled").(bool),
Timeout: d.Get("timeout").(int),
BootstrapServers: brokers,
CACert: d.Get("ca_cert").(string),
ClientCert: d.Get("client_cert").(string),
ClientCertKey: d.Get("client_key").(string),
ClientCertKeyPassphrase: d.Get("client_key_passphrase").(string),
KafkaVersion: d.Get("kafka_version").(string),
SkipTLSVerify: d.Get("skip_tls_verify").(bool),
SASLAWSRegion: d.Get("sasl_aws_region").(string),
SASLAWSContainerAuthorizationTokenFile: d.Get("sasl_aws_container_authorization_token_file").(string),
SASLAWSContainerCredentialsFullUri: d.Get("sasl_aws_container_credentials_full_uri").(string),
SASLUsername: d.Get("sasl_username").(string),
SASLPassword: d.Get("sasl_password").(string),
SASLTokenUrl: d.Get("sasl_token_url").(string),
SASLAWSRoleArn: d.Get("sasl_aws_role_arn").(string),
SASLAWSProfile: d.Get("sasl_aws_profile").(string),
SASLAWSAccessKey: d.Get("sasl_aws_access_key").(string),
SASLAWSSecretKey: d.Get("sasl_aws_secret_key").(string),
SASLAWSToken: d.Get("sasl_aws_token").(string),
SASLAWSCredsDebug: d.Get("sasl_aws_creds_debug").(bool),
SASLMechanism: saslMechanism,
TLSEnabled: d.Get("tls_enabled").(bool),
Timeout: d.Get("timeout").(int),
}

if config.CACert == "" {
Expand Down
Loading