Automatically Handle Shared Credentials Filename Home Directory Expansion

[bflad]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Currently there is a discrepancy between the Terraform AWS Provider and Terraform S3 Backend with respects to Config.CredsFilename. The AWS Provider automatically expands the home directory configuration provided:

https://github.com/terraform-providers/terraform-provider-aws/blob/934b07ac2dc27a97e041e5f8558d2dd3bf369ae1/aws/provider.go#L1172-L1177

While the S3 Backend does not. Let's move this handling into this library so its consistent and should be considered a bug fix for there due to the potentially confusing behavior.

Potential Library Implementation

import (
  homedir "github.com/mitchellh/go-homedir"
)

// GetCredentials()
sharedCredentialsFile, err := homedir.Expand(c.CredsFilename)

if err != nil {
  return nil, err
}

Potential Terraform Backend/Provider Configuration

(Already existing)

terraform {
  backend "s3" {
    shared_credentials_file = "..."
  }
}

provider "aws" {
  shared_credentials_file = "..."
}

References

• Error loading state: AccessDenied: Access Denied (AWS S3 backend) terraform#18801 (likely original cause)
• Bad path for shared credentials file is ignored #18 (related request for verification of configured shared credentials file)