talisman icon indicating copy to clipboard operation
talisman copied to clipboard

Talisman fails silently if parts of the .talismanrc are not valid yaml

Open karlbrown-va opened this issue 1 year ago • 2 comments

Describe the bug .talismanrc is supposed to be a yaml file. However, the filename does not end in .yaml, certain editors may not detect it and use yaml settings, and additionally, yaml linters will not detect it by default to find errors.

This can lead to silent failures - for example if a tab is added to one of the lines. Further lines in the file (such as custom_patterns) could be ignored, leading to password leakage.

To Reproduce Steps to reproduce the behavior:

  1. Create a new git repository and add a test file
  2. Add a custom pattern to .talismanrc:
custom_patterns:
  - 'pwd_[a-z]{8,20}'
  1. Add a string matching this pattern to the file
  2. git add . and then talisman -l debug --githook pre-commit and confirm the secret is detected and the custom pattern was used
  3. Replace the spaces in .talismanrc with tabs
  4. git add . and then talisman -l debug --githook pre-commit and confirm the secret no longer detected

Expected behavior

  • Talisman should fail on a malformed .talismanrc.yaml file and perform some basic sanity checks on the file
  • .talismanrc should be renamed as .talismanrc.yaml so it is detected by yamllinters and editors.
  • The samples of .talismanrc.yaml should be updated to be proper yaml (with correct indenting)
  • The output of the checksum tool should be properly indented (currently it is not indented, missing --- prefix, - e.g.
fileignoreconfig:
- filename: readme.md
  checksum: xxx
version: ""

should be

---
fileignoreconfig:
  - filename: readme.md
    checksum: xxx
version: ''

Desktop (please complete the following information):

  • OS: OSX

karlbrown-va avatar Apr 20 '24 14:04 karlbrown-va