Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cloudposse-archives/tfmask

Terraform utility to mask select output from `terraform plan` and `terraform apply`
https://github.com/cloudposse-archives/tfmask

mask masking regex security terraform terraform-plans terrahelp

Last synced: 27 days ago
JSON representation

Terraform utility to mask select output from `terraform plan` and `terraform apply`

Awesome Lists containing this project

README 

        
# tfmask [![Build Status](https://travis-ci.org/cloudposse/tfmask.svg?branch=master)](https://travis-ci.org/cloudposse/tfmask) [![Latest Release](https://img.shields.io/github/release/cloudposse/tfmask.svg)](https://github.com/cloudposse/tfmask/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)



[![README Header][readme_header_img]][readme_header_link]



[![Cloud Posse][logo]](https://cpco.io/homepage)



Command line utility to mask sensitive output from a `transform plan` or `terraform apply`.



---



This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.

[][share_email]

[][share_googleplus]

[][share_facebook]

[][share_reddit]

[][share_linkedin]

[][share_twitter]



It's 100% Open Source and licensed under the [APACHE2](LICENSE).



## Screenshots



![terraform plan](https://user-images.githubusercontent.com/52489/51474936-c1003800-1d35-11e9-9e25-11245388a372.png)

*Example of masking output from a `terraform plan` execution*

![terraform apply](https://user-images.githubusercontent.com/52489/51475052-248a6580-1d36-11e9-9f55-5ad46bf77bcb.png)

*Example of masking output from a `terraform apply` execution*



## Introduction



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 plan` or `terraform 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



## Usage



__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`:



```sh

terraform plan -no-color | tfmask

```



### Direnv



You can use `tfmask` with [`direnv`](https://direnv.net/) to set the defaults.



Example `.envrc`:



```sh

# Export terraform environment

export TFMASK_CHAR="#"

export TFMASK_VALUES_REGEX="(?i)^.*[^a-zA-Z](oauth|secret|token|password|key|result|id).*$"

```



  Example of Masked Output



  ```sh

  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.

  ```



## Examples



### Compiling the Binary



```sh

make go/build

```



 ### Use with Terraform Plan



 Many terraform providers unintentionally leak sensitive information when running `terraform plan`. **This is very bad.**



  Example of a Leaked Secret from a Terraform Plan



  ```sh

  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:



```sh

terraform plan -no-color | tfmask

```



  Example 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.

  ```



### Use with Terraform Apply



Many terraform providers unintentionally leak sensitive information when running `terraform apply`. **This is very bad.**



  Example of a Leaked Secret from a Terraform Apply



  ```sh

  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:



```sh

terraform apply -no-color | tfmask

```



  Example of Masked Terraform Apply Output



  ```sh

  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.

  ```



## Share the Love



Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/tfmask)! (it helps us **a lot**)



Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)



## Related Projects



Check out these related projects.



- [Packages](https://github.com/cloudposse/packages) - Cloud Posse installer and distribution of native apps

- [build-harness](https://github.com/cloudposse/build-harness) - Collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more

- [geodesic](https://github.com/cloudposse/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](https://direnv.net/) - Unclutter your .profile with an environment switcher for the shell

- [tfenv](https://github.com/cloudposse/tfenv) - Transform environment variables for use with Terraform (e.g.  `HOSTNAME` ⇨ `TF_VAR_hostname`)



## Help



**Got a question?** We got answers.



File a GitHub [issue](https://github.com/cloudposse/tfmask/issues), send us an [email][email] or join our [Slack Community][slack].



[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]



## DevOps Accelerator for Startups



We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.



[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]



Work directly with our team of DevOps experts via email, slack, and video conferencing.



We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.



- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.

- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.

- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.

- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.

- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.

- **Training.** You'll receive hands-on training so your team can operate what we build.

- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.

- **Troubleshooting.** You'll get help to triage when things aren't working.

- **Code Reviews.** You'll receive constructive feedback on Pull Requests.

- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.



## Slack Community



Join our [Open Source Community][slack] 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.



## Discourse Forums



Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.



## Newsletter



Sign up for [our newsletter][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.



## Office Hours



[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!



[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]



## Contributing



### Bug Reports & Feature Requests



Please use the [issue tracker](https://github.com/cloudposse/tfmask/issues) to report any bugs or file feature requests.



### Developing



If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].



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



 1. **Fork** the repo on GitHub

 2. **Clone** the project to your own machine

 3. **Commit** changes to your own branch

 4. **Push** your work back up to your fork

 5. 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



Copyright © 2017-2020 [Cloud Posse, LLC](https://cpco.io/copyright)



## License



[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)



See [LICENSE](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.



## Trademarks



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



## About



This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!



[![Cloud Posse][logo]][website]



We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️  [Open Source Software][we_love_open_source].



We offer [paid support][commercial_support] on all of our projects.



Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.



### Contributors



|  [![Erik Osterman][osterman_avatar]][osterman_homepage]
[Erik Osterman][osterman_homepage] |

|---|



  [osterman_homepage]: https://github.com/osterman

  [osterman_avatar]: https://img.cloudposse.com/150x150/https://github.com/osterman.png



[![README Footer][readme_footer_img]][readme_footer_link]

[![Beacon][beacon]][website]



  [logo]: https://cloudposse.com/logo-300x69.svg

  [docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=docs

  [website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=website

  [github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=github

  [jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=jobs

  [hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=hire

  [slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=slack

  [linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=linkedin

  [twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=twitter

  [testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=testimonial

  [office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=office_hours

  [newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=newsletter

  [discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=discourse

  [email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=email

  [commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=commercial_support

  [we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=we_love_open_source

  [terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=terraform_modules

  [readme_header_img]: https://cloudposse.com/readme/header/img

  [readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=readme_header_link

  [readme_footer_img]: https://cloudposse.com/readme/footer/img

  [readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=readme_footer_link

  [readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img

  [readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/tfmask&utm_content=readme_commercial_support_link

  [share_twitter]: https://twitter.com/intent/tweet/?text=tfmask&url=https://github.com/cloudposse/tfmask

  [share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=tfmask&url=https://github.com/cloudposse/tfmask

  [share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/tfmask

  [share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/tfmask

  [share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/tfmask

  [share_email]: mailto:?subject=tfmask&body=https://github.com/cloudposse/tfmask

  [beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/tfmask?pixel&cs=github&cm=readme&an=tfmask