Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
Updated README
  • Loading branch information
coffeeandsecurity committed Nov 11, 2024
1 parent 7bb8264 commit f720d4e
Showing 1 changed file with 37 additions and 23 deletions.
60 changes: 37 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,44 +87,58 @@ Once the above step successfully installs all the required libraries, refer to t

## Tool Usage

$ python3 dakshscra.py -h // To view avaialble options and arguments
$ python3 dakshscra.py -h // To view available options and arguments

usage: dakshscra.py [-h] [-r RULE_FILE] [-f FILE_TYPES] [-v] [-t TARGET_DIR] [-l {R,RF}] [-recon] [-estimate]

options:
-h, --help show this help message and exit
-r RULE_FILE Specify platform specific rule name
-f FILE_TYPES Specify file types to scan
-v Specify verbosity level {'-v', '-vv', '-vvv'}
-t TARGET_DIR Specify target directory path
-l {R,RF}, --list {R,RF}
List rules [R] OR rules and filetypes [RF]
-recon Detects platform, framework and programming language used
-estimate Estimate efforts required for code review
-h, --help Show this help message and exit
-r RULE_FILE Specify platform-specific rule name or 'auto' for auto-detection of platforms
-f FILE_TYPES Specify file types to scan
-v Specify verbosity level {'-v', '-vv', '-vvv'}
-t TARGET_DIR Specify target directory path
-l {R,RF}, --list {R,RF} List rules [R] OR rules and filetypes [RF]
-recon Detects platform, framework, and programming language used
-estimate Estimate efforts required for code review

### Example Usage
$ python3 dakshscra.py // To view tool usage along with examples

Examples:
# '-f' is optional. If not specified, it will default to the corresponding filetypes of the selected rule.
dakshsca.py -r php -t /source_dir_path
dakshscra.py -r php -t /source_dir_path

# To override default settings, other filetypes can be specified with '-f' option.
dakshsca.py -r php -f dotnet -t /path_to_source_dir
dakshsca.py -r php -f custom -t /path_to_source_dir
# Specify platforms with '-r' (single or multiple) for platform-specific rules:
- Single platform: dakshscra.py -r php -t /source_dir_path
- Multiple platforms: dakshscra.py -r php,java,cpp -t /source_dir_path
- Auto-detect Platforms: dakshscra.py -r auto -t /source_dir_path

# Perform reconnaissance and rule based scanning if '-recon' used with '-r' option.
dakshsca.py -recon -r php -t /path_to_source_dir
# To override default settings, other filetypes can be specified with the '-f' option:
dakshscra.py -r php -f dotnet -t /path_to_source_dir
dakshscra.py -r php -f custom -t /path_to_source_dir

# Perform only reconnaissance if '-recon' used without the '-r' option.
dakshsca.py -recon -t /path_to_source_dir

# Verbosity: '-v' is default, '-vvv' will display all rules check within each rule category.
dakshsca.py -r php -vv -t /path_to_source_dir
# Perform reconnaissance and rule-based scanning if '-recon' used with '-r' option:
dakshscra.py -recon -r php -t /path_to_source_dir

# Perform only reconnaissance if '-recon' used without the '-r' option:
dakshscra.py -recon -t /path_to_source_dir

Supported RULE_FILE: dotnet, java, php, python, javascript
Supported FILE_TYPES: dotnet, java, php, python, javascript, custom, allfiles
# Verbosity: '-v' is default, '-vvv' will display all rules check within each rule category.
dakshscra.py -r php -vv -t /path_to_source_dir

### List of all available rules
$ python3 dakshscra.py -l R # View list of supported rules
dotnet
php
java
javascript
kotlin
python
go
c
cpp
android (beta - limited checks)
common


## Reports
Expand Down

0 comments on commit f720d4e

Please sign in to comment.