a static analysis tool for finding vulnerabilities in C/C++ source code
Go to file
David A. Wheeler 54039e0bd5 Fix flawfinder man page (e.g., fix the title of my book)
This fixes bug #11, see:
https://sourceforge.net/p/flawfinder/bugs/11/

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2018-04-04 11:31:07 -04:00
.gitignore Add simple .gitignore file 2017-09-02 18:06:28 -04:00
CONTRIBUTING.md "make check" tests against both python2 AND python3 2017-11-16 20:08:30 -05:00
COPYING Initial import 2007-01-16 02:44:45 +00:00
ChangeLog Add some material to ChangeLog 2018-01-26 00:28:52 -05:00
INSTALL.txt Update INSTALL.txt and README to note pip install 2017-09-02 21:03:02 -04:00
MANIFEST.in Initial import 2007-01-16 02:44:45 +00:00
README Fix typo in README 2018-01-26 00:07:36 -05:00
announcement Initial import 2007-01-16 02:44:45 +00:00
correct-results-004.txt Add test_004 integration test (ensure single-line and minimum are working) 2017-08-26 11:15:51 -04:00
correct-results-005.txt Add test for saving/loading hitlist, add Python3 fixes for it 2017-08-26 16:15:17 -04:00
correct-results-006.txt Add test for saving/loading hitlist, add Python3 fixes for it 2017-08-26 16:15:17 -04:00
correct-results.csv Add "fingerprint" to CSV output 2017-07-30 23:50:52 -04:00
correct-results.html Update version numbers 2018-01-26 00:24:39 -05:00
correct-results.txt Update version numbers 2018-01-26 00:24:39 -05:00
cwe.l Add ability to list CWEs in source code 2014-07-13 09:44:34 -04:00
flawfinder Add "--error-level" option for continuous integration systems 2018-01-27 18:11:52 -05:00
flawfinder.1 Fix flawfinder man page (e.g., fix the title of my book) 2018-04-04 11:31:07 -04:00
flawfinder.spec Update version numbers 2018-01-26 00:24:39 -05:00
flawtest.c Initial import 2007-01-16 02:44:45 +00:00
junk.c Add support for git diff (as well as svn diff and GNU diff) 2014-07-12 21:36:54 -04:00
makefile Add release_process.md documentation and tweak makefile 2018-01-26 00:26:36 -05:00
no-ending-newline.c Version number now 1.28, add test for filenames without trailing newline 2014-07-12 07:01:23 -04:00
pylintrc Mass reformat of flawfinder source code to better comply with PEP 8 2017-07-30 20:06:39 -04:00
release_process.md Add release_process.md documentation and tweak makefile 2018-01-26 00:26:36 -05:00
setup.cfg Update version to 2.0.4 2017-09-02 20:46:45 -04:00
setup.py Update version numbers 2018-01-26 00:24:39 -05:00
sloctest.c Initial import 2007-01-16 02:44:45 +00:00
test-diff-005.patch Rename test-diff-0005 to follow other filename conventions 2017-09-02 15:45:08 -04:00
test-patched.c Add test for -P (patch) option, which tests diff handling 2017-08-26 15:42:35 -04:00
test.c Initial import 2007-01-16 02:44:45 +00:00
test2.c Initial import 2007-01-16 02:44:45 +00:00

README

This is "flawfinder" by David A. Wheeler, <dwheeler@dwheeler.com>.

Flawfinder is a simple program that scans C/C++ source code and reports
potential security flaws.  It can be a useful tool for examining software
for vulnerabilities, and it can also serve as a simple introduction to
static source code analysis tools more generally.  It is designed to
be easy to install and use.  Flawfinder supports the Common Weakness
Enumeration (CWE) and is officially CWE-Compatible.

For more information, see:
 http://www.dwheeler.com/flawfinder

Flawfinder is designed for use on Unix/Linux/POSIX systems
(including Cygwin, Linux-based systems, MacOS, and *BSDs) as a
command line tool.  It requires Python 2.7 or Python 3.

If you just want to *use* it, you can install flawfinder with
Python's "pip" or with your system's package manager (flawfinder has
packages for many systems).  It also supports easy installation
following usual "make install" source installation conventions.
The file INSTALL.txt has more detailed installation instructions.
You don't HAVE to install it to run it, but it's easiest that way.

To run flawfinder, just give it a list of source files or directories to
example.  For example, to examine all files in "src/" and down recursively:

  flawfinder src/

The manual page (flawfinder.1 or flawfinder.pdf) describes how to use
flawfinder (including its various options) and related information
(such as how it supports CWE).  For example, the "--html" option generates
output in HTML format. The "--help" option gives a brief list of options.

More technically, flawfinder uses lexical scanning to find tokens
(such as function names) that suggest likely vulnerabilities, estimates their
level of risk (e.g., by the text of function calls), and reports the results.
Flawfinder does not use or have access to information about control flow,
data flow, or data types.  Thus, flawfinder will necessarily
produce many false positives for vulnerabilities and fail to report
many vulnerabilities.  On the other hand, flawfinder can find
vulnerabilities in programs that cannot be built or cannot be linked.
Flawfinder also doesn't get as confused by macro definitions
and other oddities that more sophisticated tools have trouble with.

We love contributions!  For more information on contributing, see
the file CONTRIBUTING.md.

Flawfinder is released under the GNU GPL license version 2 or later (GPL-2.0+).
See the COPYING file for license information.