mirror of https://github.com/Ciphey/Ciphey.git
Page:
The Settings File
Pages
Adding your own checker
Adding your own ciphers
Checkers, explained
Ciphey's Repos, explained
Common Issues & Their Solutions
Common things you may want to do
Contributing.md
Discord
Extending Ciphey
Features
Home
Importing Ciphey
Installation
Running Ciphey for Contributors
Searchers, explained
Supported Ciphers
Tagging System
Testing your cracker decoder
The Settings File
Things to check before submitting a PR
What to check before a pull request
_Contributing
_Installation
Table of Contents
This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
The settings file contains settings for Ciphey. Specifically, some of these you may want:
- Regex list. Have a list of Regex’s for the Regex checker? Use the settings file.
- Default language. Hate how Ciphey always loads in English? Use the settings file to change the default language to whatever you want.
- Is the language checker not working how you want it to work? Fine-tune the details in the settings file.
Default Settings File
Save this as settings.yml in the appdirs location, which can be found by running ciphey -where or –where.
➜ python3 ciphey -where
settings.yml should be placed in /home/bee/.config/ciphey
From this example, we can see that using the argument we need to place the settings file at /home/bee.config/ciphey/settings.yml
The settings file follows a specific format. Copy and paste this below!
---
params:
regex:
regex:
- FLAG{*.}
- CTF{*.}
- HTB{*.}
- THM{*.}
brandon:
top1000: cipheydists::list::english1000
wordlist: cipheydists::list::english
stopwords: cipheydists::list::englishStopWords
threshold: 0.45
Join our Discord
List of Supported Ciphers/Encodings/Hashes
https://github.com/Ciphey/Ciphey/wiki/Supported-Ciphers