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!
terraform plan
or terraform apply
?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 -no-color | tfmask
You can use tfmask
with direnv
to set the defaults.
Example .envrc
:
# Export terraform environment
export TFMASK_CHAR="#"
export TFMASK_VALUES_REGEX="(?i)^.*[^a-zA-Z](oauth|secret|token|password|key|result|id).*$"
make go/build
Many terraform providers unintentionally leak sensitive information when running terraform plan
. This is very bad.
Using tfmask
, the output from terraform plan
will be masked like this:
terraform plan -no-color | tfmask
Many terraform providers unintentionally leak sensitive information when running terraform apply
. This is very bad.
Using tfmask
, the output from terraform apply
will be masked like this:
terraform apply -no-color | tfmask
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.
HOSTNAME
⇨ TF_VAR_hostname
)Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. 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.
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.
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.
Participate in our Discourse Forums. 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.
Sign up 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.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
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.
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Copyright © 2017-2020 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 |
---|