Git Product home page Git Product logo

redact-secrets-fork-matt8707's Introduction

redact-secrets

Redacts Home Assistant secrets for public repositories.

But, why?

I'm sharing my configuration publicly and I want to include my commands but not actual secrets like tokens. It's a pain to have to redact secrets manually.

Usage

The secrets_template.yaml is read and writes two files:

  • secrets.yaml file read by hass
  • secrets_redacted.yaml file pushed to your repository

You also have to edit the paths in main.py

TEMPLATE = "/Users/matte/mount/hass-config/secrets_template.yaml"
write_redacted("/Users/matte/mount/hass-config/secrets_redacted.yaml")
write_secrets("/Users/matte/mount/hass-config/secrets.yaml")

Example

Note: If the secret starts with brackets you have to wrap it in quotes.

secrets_template.yaml

token: "[[[Gffk52sd5]]]"
command: my cool command but hide my [[[password]]]
remote: ssh [[[[email protected]]]] reboot

secrets_redacted.yaml

token: REDACTED
command: my cool command but hide my REDACTED
remote: ssh REDACTED reboot

secrets.yaml

token: Gffk52sd5
command: my cool command but hide my password
remote: ssh [email protected] reboot

.gitignore

secrets.yaml
secrets_template.yaml

Terminal

Edit ~/.zshrc and add the function

makes() {
   python3 "/Users/matte/GitHub/redact-secrets/main.py"
}

Now you can type makes into terminal to quickly generate the files.

Disclaimer

Please double-check secrets_redacted.yaml before you push it so you don't leak any sensitive information.

redact-secrets-fork-matt8707's People

Contributors

matt8707 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.