cloudposse / terraform-aws-key-pair

Terraform Module to Automatically Generate SSH Key Pairs (Public/Private Keys)

terraform-aws-key-pair

Terraform module for generating or importing an SSH public key file into AWS.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

module "ssh_key_pair" {
  source = "cloudposse/key-pair/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  namespace             = "eg"
  stage                 = "prod"
  name                  = "app"
  ssh_public_key_path   = "/secrets"
  generate_ssh_key      = "true"
  private_key_extension = ".pem"
  public_key_extension  = ".pub"
}

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 1.0
aws	>= 3.0
local	>= 2.2.1
null	>= 2.1
tls	>= 2.0

Providers

Name	Version
aws	>= 3.0
local	>= 2.2.1
tls	>= 2.0

Modules

Name	Source	Version
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_key_pair.generated	resource
aws_key_pair.imported	resource
aws_ssm_parameter.private_key	resource
local_file.public_key_openssh	resource
local_sensitive_file.private_key_pem	resource
tls_private_key.default	resource

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	map(string)	{}	no
attributes	ID element. Additional attributes (e.g. workers or cluster) to add to id, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element.	list(string)	[]	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	Describe additional descriptors to be output in the descriptors output map. Map of maps. Keys are names of descriptors. Values are maps of the form {<br> format = string<br> labels = list(string)<br>} (Type is any so the map values can later be enhanced to provide additional options.) format is a Terraform format string to be passed to the format() function. labels is a list of labels, in order, to pass to format() function. Label values will be normalized before being passed to format() so they will be identical to how they appear in id. Default is {} (descriptors output will be empty).	any	{}	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
generate_ssh_key	If set to true, new SSH key pair will be created and ssh_public_key_file will be ignored	bool	false	no
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for keep the existing setting, which defaults to 0. Does not affect id_full.	number	null	no
label_key_case	Controls the letter case of the tags keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the tags input. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The order in which the labels (ID elements) appear in the id. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	list(string)	null	no
label_value_case	Controls the letter case of ID elements (labels) as included in id, set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input. Possible values: lower, title, upper and none (no transformation). Set this to title and set delimiter to "" to yield Pascal Case IDs. Default value: lower.	string	null	no
labels_as_tags	Set of labels (ID elements) to include as tags in the tags output. Default is to include all labels. Tags with empty values will not be included in the tags output. Set to [] to suppress all generated tags. Notes: The value of the name tag, if included, will be the id, not the name. Unlike other null-label inputs, the initial setting of labels_as_tags cannot be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag. The "name" tag is set to the full id string. There is no tag with the value of the name input.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
private_key_extension	Private key extension	string	""	no
public_key_extension	Public key extension	string	".pub"	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
ssh_key_algorithm	SSH key algorithm	string	"RSA"	no
ssh_public_key_file	Name of existing SSH public key file (e.g. id_rsa.pub)	string	null	no
ssh_public_key_path	Path to SSH public key directory (e.g. /secrets)	string	n/a	yes
ssm_parameter_enabled	Whether an SSM parameter store value is created to store the key's private key pem.	bool	false	no
ssm_parameter_path_prefix	The path prefix for the created SSM parameter e.g. '/ec2/key-pairs/acme-ue1-dev-bastion'. ssm_parameter_enabled must be set to true for this to take affect.	string	"/ec2/key-pairs/"	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no

Outputs

Name	Description
key_name	Name of SSH key
private_key	Content of the generated private key
private_key_filename	Private Key Filename
public_key	Content of the generated public key
public_key_filename	Public Key Filename

Related Projects

Check out these related projects.

• github-authorized-keys - Use GitHub teams to manage system user accounts and authorized_keys
• sudosh - Shell wrapper to run a login shell with sudo as the current user for the purpose of audit logging
• terraform-tls-ssh-key-pair - Terraform module for generating an SSH public/private key file.

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it with you.
✅ You own everything.
✅ Your team wins.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

• Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
• Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
• Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
• Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
• GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

• Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
• Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
• Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
• Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
• Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
• Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
• Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

---

Copyright © 2017-2024 Cloud Posse, LLC

terraform-aws-key-pair's Issues

Dependabot can't parse your main.tf

Dependabot couldn't parse the main.tf found at /main.tf.

You can mention @dependabot in the comments below to contact the Dependabot team.

Feature request: Automatically pathexpand ssh_public_key_path

Currently I have to do this:

"ssh_public_key_path" = "${pathexpand(~/.ssh)}"

It would be nice if the module called pathexpand on this variable automatically. I think most people who put ~ in this field want it to be interpolated as $HOME

Support for tf 0.13

Have a question? Please checkout our Slack Community or visit our Slack Archive.

Describe the Feature

Would love to see terraform 0.13 support. Currently I receive an error:

Error: Unsupported Terraform Core version

  on .terraform/modules/admin_ssh_key_pair/versions.tf line 2, in terraform:
   2:   required_version = "~> 0.12.0"

Module module.admin_ssh_key_pair (from
git::https://github.com/cloudposse/terraform-aws-key-pair.git?ref=master) does
not support Terraform version 0.13.0. To proceed, either choose another
supported Terraform version or update this version constraint. Version
constraints are normally set for good reason, so updating the constraint may
lead to other errors or unexpected behavior.

Expected Behavior

Desired behavior is successful execution when using 0.13.0.

Hold for file creation before releasing output variables

Issue Description

Hello - I love this module; it's made it much easier for me to create full pipelines for connecting to EC2 instances. However, I do have one major issue - the output variables "public_key_filename" and "private_key_filename" are released to downstream modules/resources too early, aka they are released immediately (during plan) before the files are actually created. This creates problems as other modules will try to parse those files and will fail because the file does not exist.

Workaround

My workaround is to hide the input of these variables behind a "fake" if-then block, as below:

module "tableau_server_on_aws" {
  ...
  # The if-then clause gives the same result regardless of length(public_key); the real purpose is to force a wait on file creation.
  ssh_public_key_filepath  = length(module.ssh_key_pair2.public_key) > 0 ? module.ssh_key_pair2.public_key_filename : module.ssh_key_pair2.public_key_filename
  ssh_private_key_filepath = length(module.ssh_key_pair2.public_key) > 0 ? module.ssh_key_pair2.private_key_filename : module.ssh_key_pair2.private_key_filename
  ...
}

module "ssh_key_pair" {
  source                = "git::https://github.com/cloudposse/terraform-aws-key-pair.git?ref=master"
  namespace             = lower(local.name_prefix)
  ssh_public_key_path   = abspath(local.secrets_folder)
  name                  = "aws-ssh-key"
  ...
}

Because the public_key output variable is not known until after the files are created, this workaround forces the downstream consumer to wait until the files exist before evaluating downstream conditions.

Requested Change

My ask would be to create a similar hold on the module's filename outputs, until those files have been created and can be consumed.

Dependabot can't parse your context.tf

Dependabot couldn't parse the context.tf found at /context.tf.

The error Dependabot encountered was:

unable to parse HCL: At 24:25: Unknown token: 24:25 IDENT var.enabled

View the update logs.

Downloaded key should have ".pem" extension

The downloaded key file should have the ".pem" extension.

Add Example Usage

what

• Add example invocation

why

• We need this so we can soon enable automated continuous integration testing of module

Should Use `local_file` Provisioner Instead of `local-exec`

https://www.terraform.io/docs/providers/local/r/file.html

resource "local_file" "foo" {
    content     = "foo!"
    filename = "${path.module}/foo.bar"
}

Parsing issue

 Getting source "git::https://github.com/cloudposse/terraform-aws-key-pair.git?ref=master"
Error downloading modules: Error loading modules: module ssh_key_pair: Error parsing .terraform/modules/dd391732868cc6224bc782f7858abb22/main.tf: At 3:16: Unknown token: 3:16 IDENT var.namespace

I'm seeing this since the update. I'm using Terraform 0.11.13

Add Example Usage

what

• Add example invocation

why

• We need this so we can soon enable automated continuous integration testing of module

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

terraform

main.tf

versions.tf

• aws >= 3.0
• local >= 2.2.1
• null >= 2.1
• tls >= 2.0
• hashicorp/terraform >= 0.13.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Usage

HI,

I tried to use the module this way but the problem is the resource will fail because the module hasn't generated the key yet. Do you have an inbuilt way to create the resource below through the module so I can refer to it in AWS launch configuration via terraform

module "ssh_key_pair" {
source = "git::https://github.com/cloudposse/terraform-aws-key-pair.git?ref=master"
namespace = "default"
stage = "${var.name}"
name = "${var.name}"
ssh_public_key_path = "${path.root}"
generate_ssh_key = "true"
private_key_extension = "_private_key.pem"
public_key_extension = "_public_key.pub"
chmod_command = "chmod 600 %v"
}

resource "aws_key_pair" "keys" {
key_name = "default-${var.name}-${var.name}_public_key.pub"
key_name = "${module.ssh_key_pair.id}"
public_key = "${file("${path.root}/default-${var.name}-${var.name}_public_key.pub")}"

depends_on = [
"local_file.default-eks_nodes_martini-eks_nodes_martini_public_key.pub",
]
}

Option to not save key

Have a question? Please checkout our Slack Community or visit our Slack Archive.

Describe the Feature

When creating a new key, I am currently forced to save it to a local file. I don't want/need to do that. It would be good to have that as an option.

Expected Behavior

module "key" {
    ...
    no_save = true
}

Use Case

I have a use case where the key is ephemeral. It doesn't create any huge bugs, but I'd like to ignore the creation of the keys, if possible.

don't pin aws provider to 2.0 version as need 3.05.

Dependabot can't parse your main.tf

Dependabot couldn't parse the main.tf found at /main.tf.

The error Dependabot encountered was:

unable to parse HCL: At 3:17: Unknown token: 3:17 IDENT var.namespace

View the update logs.

Wrong syntax in some parts of this module

Hi,

I was trying to make use of your module but I found out some issues in it. I'm not sure if it's related because I'm using Terraform 0.12 or not, but this is what it prints out:

Error: Missing resource instance key

  on .terraform/modules/jira.ssh_key_pair/cloudposse-terraform-aws-key-pair-ab1926c/main.tf line 31, in resource "aws_key_pair" "generated":
  31:   public_key = "${tls_private_key.default.public_key_openssh}"

Because tls_private_key.default has "count" set, its attributes must be
accessed on specific instances.

For example, to correlate with indices of a referring resource, use:
    tls_private_key.default[count.index]


Error: Missing resource instance key

  on .terraform/modules/jira.ssh_key_pair/cloudposse-terraform-aws-key-pair-ab1926c/main.tf line 37, in resource "local_file" "public_key_openssh":
  37:   content    = "${tls_private_key.default.public_key_openssh}"

Because tls_private_key.default has "count" set, its attributes must be
accessed on specific instances.

For example, to correlate with indices of a referring resource, use:
    tls_private_key.default[count.index]


Error: Missing resource instance key

  on .terraform/modules/jira.ssh_key_pair/cloudposse-terraform-aws-key-pair-ab1926c/main.tf line 44, in resource "local_file" "private_key_pem":
  44:   content    = "${tls_private_key.default.private_key_pem}"

Because tls_private_key.default has "count" set, its attributes must be
accessed on specific instances.

For example, to correlate with indices of a referring resource, use:
    tls_private_key.default[count.index]

Before creating a PR I wanted to align with you if the fixes proposed by Terraform CLI made sense or you see a better way to accomplish the goal.

Thank you in advance for this module, looking forward to get this fixed :)

Best regards,
Julian