Skip to main content

Finds Cipher in lua scripts.

Project description

FivemCipherFinder (v2.4.0)

Visitors

Pylint and Flake8 PyTest Code style: black

This is a Fivem Cipher finder for those that don't want Ciphers in their scripts :D

The idea behind these scripts is to find one or more Cipher in your script files. Currently, there is only the Python version available, but I will soon add the C++ variant.

Desc: The script will walk through your Server's directories and scan, for example, \x41\x42\x43. When it found something it will write the line and trigger it into a Log file.

Installation

Py-Version: 3.8 and above Newest python version

Please make sure, that when you're on Windows based system, that you've added Python to your environment variables. You can test that with simply typing python --version into your CMD or Terminal run pip install FivemCipherFinder or download the latest release and unpack it.

Also please consider using the pip way to install except you know what you're doing

Make sure to read the Troubleshooting page first before you add me on Discord.

For manual installation

I just put the commands here

  • git clone https://github.com/exersalza/FivemCipherFinder.git && cd FivemCipherFinder
  • pip install -r req
  • python3 -m build . && pip install . Then you can just type find-cipher in your server resources directory.

Usage

Syntax: find-cipher [-h] [-p [PATH]] [-x [EXCLUDE_PATH ...]] [-n] [-v] [--v2] Options are:

  • -p|--path -> Redirect the search from the current path . to another one.
  • -x|--exclude -> Exclude paths that you dont want to scan.
  • -n|--no-log -> Prevents that an logfile is being written. Works hand in hand with -v
  • -v|--verbose -> To show the found ciphers inside the Console as soon as they were found.
  • --v2 -> For the gibberish search. Like local fjdlsajfdsancu = ...

It's a console tool so you can use find-cipher just like that in your Resources folder or you can specifiy you folder with find-cipher ~/FiveM/server-data/resources as example.

Should you struggle with returning ciphers in your script, try using the --v2 flag behind the command like find-cipher . --v2 cars,mlos.

As you can see in the last example, you can exclude Directories so can prevent false-positives like \[cars\],\[mlos\],easy-admin but make sure you add \ before curly and square brackets, otherwise your terminal will throw an error.

The script logs found Cipher in a file names CipherLog-HH-MM-SS.txt so can easily find your log files.

Troubleshooting

First things first, read the error/warning message

Should the installation with pip fail with the error code externally-managed-environment, add --break-system-packages. Pip changed something in their internals in the newer versions.

Also make sure (on Windows) that you have your python scripts folder inside your path variable. Should the folder be missing, it shows at the pip installation as a warning. how to add something to the path variable

Known-false-positives

  • EasyAdmin
  • encrypted/obfuscated scripts

Contributing

Feel free to open a PR with your changes, as every PR the checks should run without a fail to run workflows localy please consider using act

Use the manual installation guide for getting the project. Installation

ToDo

  • Detect cipher spreader
  • Add de obfuscator for detectet cipher
  • Find random generated character variable names

Contact

Discord: exersalza / exersalza[>'-']>#1337 | [DE/EN]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

FiveMCipherFinder-2.4.0.tar.gz (9.8 kB view hashes)

Uploaded Source

Built Distribution

FiveMCipherFinder-2.4.0-py3-none-any.whl (10.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page