Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wireghoul/graudit

grep rough audit - source code auditing tool
https://github.com/wireghoul/graudit

security security-audit security-tools shell source-code vulnerability-detection

Last synced: 1 day ago
JSON representation

grep rough audit - source code auditing tool

Awesome Lists containing this project

README 

        
graudit

===============================================================================

graudit is a simple script and signature sets that allows you to find potential

security flaws in source code using the GNU utility grep. It's comparable to

other static analysis applications like RATS, SWAAT and flaw-finder while

keeping the technical requirements to a minimum and being very flexible.



Installation

===============================================================================

Installation can be done as a user or globally as root, simply run make with

the userinstall or install argument. It is however recommended to use graudit

directly by cloning the git repository as it includes additional database rules

not included on the distribution files. This also enables you to get updates

between releases. To do this run the following command:



```

git clone https://github.com/wireghoul/graudit

```



You can then add graudit to your path, using the appropriate values for

your preferred shell:

```

echo 'PATH="$HOME/graudit:${PATH:+:${PATH}}"; export PATH;' >> ~/.bashrc

```



If graudit is not in your home directory you may wish to set the GRDIR

environment variable to the signatures directory in your `.bashrc` file.

```

export GRDIR=/path/to/graudit/signatures

```



Usage

===============================================================================

graudit supports several options and tries to follow good shell practices. For

a list of the options you can run graudit -h or see below. The simplest way to

use graudit is;



```

graudit [opts] /path/to/scan



OPTIONS

  -d  database to use or /path/to/file.db (uses default if not specified)

  -A scan unwanted and difficult (ALL) files

  -x exclude these files (comma separated list: -x *.js,*.sql)

  -i case in-sensitive scan

  -c  number of lines of context to display before and after a match, default is 1



  -B suppress banner

  -L vim friendly lines

  -b colour blind friendly template

  -z suppress colors

  -Z high contrast colors

  

  -l lists databases available

  -v prints version number

  -h prints this help screen

```



You can set default commandline options via the GRARGS environment variable.

This may affect the use of graudit in scripts so it's only recommended to use

the B,L,b,z and Z options for this purpose.

```

echo 'GRARGS="-b -L"; export GRARGS' >> ~/.bashrc

```



Databases

===============================================================================

graudit uses extended regular expressions (POSIX) as it's signatures and comes

with several databases ready for use. You can extend the existing databases or

make your own if you require additional signatures.



Databases can be loaded from multiple locations, the order of precedence is as

follows:

  1. Custom location specified via the GRDIR environment variable

  2. /usr/share/graudit/

  3. $HOME/.graudit/

  4. A relative signatures/ directory from the graudit location

  5. A relative misc/ directory from the graudit location

  6. $HOME/graudit/signatures/

  7. Any file that is specified with a full path, i.e: /home/user/my.db

  8. Rules can be read from stdin by supplying - or /dev/stdin as the database



A list of the database files in order of precedence is shown with the -l switch:

`graudit -l`



The following databases are included:

  - actionscript

  - android

  - asp

  - c

  - cobol

  - default (used if -d argument is omitted)

  - dotnet

  - eiffel

  - exec

  - fruit

  - go

  - ios

  - java

  - js

  - nim

  - perl

  - php

  - python

  - ruby

  - scala

  - secrets

  - spsqli

  - sql

  - strings

  - typescript

  - xss



Tutorial

===============================================================================

A tutorial/introduction video can be found at: https://youtu.be/b8Xbzer1n94



Contributing

===============================================================================

If you would like to contribute to graudit, please fork the repository at

https://github.com/wireghoul/graudit and use that. In particular language rules,

additional scripts and documentation contributions are very welcome.

If you like graudit then please say thanks and share it around.



If you wish to get in contact with me, shoot me a line on github or twitter:

@wireghoul



Credits

===============================================================================

  * Wireghoul - http://www.justanotherhacker.com

  * Various others - see Changelog