Command line utility to mask sensitive output from a transform plan or terraform apply.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
Example of masking output from a terraform plan execution
Example of masking output from a terraform apply execution
If you answer "yes" to any of these questions, then look no further!
- Have you ever wished you could easily filter sensitive output from a
terraform planorterraform apply? - Do you use terraform providers that leak sensitive data to
stdout(e.g.terraform-github-provider)?
Yes? Great! Then this utility is for you.
The tfmask utility will replace the "old value" and the "new value" with the masking character (e.g. *).
NOTE: tfmask will preserve the name of the nodes in the graph
NOTE: The utility supports a number of configuration settings which can be passed via environment variables.
| Environment Variable | Description | Default |
|---|---|---|
TFMASK_CHAR |
Character used to mask all output | * |
TFMASK_VALUES_REGEX |
Regular expression used to match values | [see code] |
TFMASK_RESOURCES_REGEX |
Regular expression used to match resources | [see code] |
IMPORTANT: Pass -no-color to terraform plan and terraform apply for proper parsing
The basic usage looks like this. We're going to run terraform plan and filter it through tfmask:
terraform plan | tfmaskYou can use tfmask with direnv to set the defaults.
Example .envrc:
# Export terraform environment
export TFMASK_CHAR="#"
export TFMASK_VALUES_REGEX="(?i)^.*(secret|password|oauth|token|key).*$"Example of Masked Output
Terraform will perform the following actions:
~ module.atlantis.module.web_app.module.ecs_codepipeline.aws_codepipeline.source_build_deploy
stage.0.action.0.configuration.%: "4" => "5"
stage.0.action.0.configuration.OAuthToken: "" => "*******************************************"
Plan: 0 to add, 1 to change, 0 to destroy.make go/buildMany terraform providers unintentionally leak sensitive information when running terraform plan. This is very bad.
Example of a Leaked Secret from a Terraform Plan
An execution plan has been generated and is shown below.
Resource actions are indicated with the following symbols:
~ update in-place
Terraform will perform the following actions:
~ module.example.aws_codepipeline.source_build_deploy
stage.0.action.0.configuration.%: "4" => "5"
stage.0.action.0.configuration.OAuthToken: "" => "efba05dbe9b94ba18ae3737a6d6de16eefba05dbe9b9"
Plan: 0 to add, 1 to change, 0 to destroy.NOTE: This OAuthToken is just an example and not a valid token.
Using tfmask, the output from terraform plan will be masked like this:
terraform plan | tfmaskExample of Masked Terraform Plan Output
An execution plan has been generated and is shown below.
Resource actions are indicated with the following symbols:
~ update in-place
Terraform will perform the following actions:
~ module.example.aws_codepipeline.source_build_deploy
stage.0.action.0.configuration.%: "4" => "5"
stage.0.action.0.configuration.OAuthToken: "" => ********************************************"
Plan: 0 to add, 1 to change, 0 to destroy.
Many terraform providers unintentionally leak sensitive information when running terraform apply. This is very bad.
Example of a Leaked Secret from a Terraform Apply
terraform apply
module.example.aws_codepipeline.source_build_deploy: Modifying... (ID: example-codepipeline)
stage.0.action.0.configuration.%: "4" => "5"
stage.0.action.0.configuration.OAuthToken: "" => "efba05dbe9b94ba18ae3737a6d6de16eefba05dbe9b9"
module.example.aws_codepipeline.source_build_deploy: Modifications complete after 1s (ID: example-codepipeline)
Apply complete! Resources: 0 added, 1 changed, 0 destroyed.NOTE: This OAuthToken is just an example and not a valid token.
Using tfmask, the output from terraform apply will be masked like this:
terraform apply | tfmaskExample of Masked Terraform Apply Output
module.example.aws_codepipeline.source_build_deploy: Modifying... (ID: example-codepipeline)
stage.0.action.0.configuration.%: "4" => "5"
stage.0.action.0.configuration.OAuthToken: "" => "********************************************"
module.example.aws_codepipeline.source_build_deploy: Modifications complete after 1s (ID: example-codepipeline)
Apply complete! Resources: 0 added, 1 changed, 0 destroyed.Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
Check out these related projects.
- Packages - Cloud Posse installer and distribution of native apps
- build-harness - Collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more
- geodesic - Geodesic is the fastest way to get up and running with a rock solid, production grade cloud platform built on strictly Open Source tools.
- direnv - Unclutter your .profile with an environment switcher for the shell
- tfenv - Transform environment variables for use with Terraform (e.g.
HOSTNAME⇨TF_VAR_hostname)
Got a question?
File a GitHub issue, send us an email or join our Slack Community.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.
- Questions. We'll use a Shared Slack channel between your team and ours.
- Troubleshooting. We'll help you triage why things aren't working.
- Code Reviews. We'll review your Pull Requests and provide constructive feedback.
- Bug Fixes. We'll rapidly work to fix any bugs in our projects.
- Build New Terraform Modules. We'll develop original modules to provision infrastructure.
- Cloud Architecture. We'll assist with your cloud strategy and design.
- Implementation. We'll provide hands-on support to implement our reference architectures.
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.
Signup for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- 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!
Copyright © 2017-2019 Cloud Posse, LLC
See LICENSE for full details.
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
 Erik Osterman |
|---|