Commit Graph

211 Commits

Author SHA1 Message Date
David A. Wheeler e97254a5f3 Document in README that we accept Python 3 as well as Python 2.7
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 16:18:33 -04:00
David A. Wheeler 339763c644 Add test for saving/loading hitlist, add Python3 fixes for it
Test the saving and loading of hitlists.
This detected a Python3 problem, which was easily corrected by
saving and loading in binary "b" format instead of text format.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 16:15:17 -04:00
David A. Wheeler b2556b7348 Add some warnings about -P to help users use it properly
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 15:52:04 -04:00
David A. Wheeler 608bc45b6d Add test for -P (patch) option, which tests diff handling
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 15:42:35 -04:00
David A. Wheeler 203115edc3 Update book title
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 15:28:22 -04:00
David A. Wheeler a19a2bb694 Don't output "saving hitlist..." if quiet
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 15:13:35 -04:00
David A. Wheeler 58e56cad03 Minor update of man page
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 14:55:09 -04:00
David A. Wheeler b5c17e2969 Add "All tests pass!" if they do at completion of test suite
This message makes it clear that the test suite passed (if it did).

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 11:21:03 -04:00
David A. Wheeler 64c8f8dcbb Add test_004 integration test (ensure single-line and minimum are working)
Add test_004. This tests options that are often used when sending
flawfinder output to other tools.  In this case,
we test -m, -S, -D, -C, and --quiet.

This also begins a convention change, to name tests e.g., "test_001".
This ensures that the tests sort reasonably without special options.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 11:15:51 -04:00
David A. Wheeler 62c1db1141 Rename "input" to avoid redefining built-in
We formerly used a variable named "input".  This is legal in Python,
but potentially confusing since there's a built-in named "input"
that this shadows in that scope.  Rename the variable, to
avoid that confusion.  This fixes the following pylint warning:
W:1440, 8: Redefining built-in 'input' (redefined-builtin)

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 11:00:04 -04:00
David A. Wheeler ad0d06cced Remove unnecessary import of os.path
We import os, so there's no need to import os.path.
This fixes the following pylint warning:
C: 53, 0: Imports from package os are not grouped (ungrouped-imports)

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 10:55:02 -04:00
David A. Wheeler 57929a1c60 Fix some Python3 stragglers, so flawfinder runs on Python 2 or 3
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-23 22:01:34 -04:00
David A. Wheeler cdea1a214a Update comments
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-23 21:55:35 -04:00
David A. Wheeler 48a6b3982b Modify flawfinder to work in Python 2 *and* Python 3 - this passes tests
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-23 21:45:22 -04:00
David A. Wheeler 90777b6980 Split up tests in makefile
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-23 21:12:23 -04:00
David A. Wheeler a59ca71bc2 Add PYTHON macro to the makefile
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-23 21:02:08 -04:00
David A. Wheeler 596b63164f Update setup.py for PyPI
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-13 17:45:32 -04:00
David A. Wheeler 0a1761b10b Replace some string.find/rfind for Python 2/3 compatibility
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-13 10:11:58 -04:00
David A. Wheeler 94164014da Change string.join => "".join for simultaneous Python 2/3 support
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-12 21:18:11 -04:00
David A. Wheeler 05c238acc6 Modify find/split operations to work on Python 2 and 3
Python 3 only accepts certain syntaxes for find & split.
Thankfully, it's possible to use them in Python 2, so rework
it so we can use the same syntax for both.
This is not detected or fixed by futurize, sadly
(a problem true for many other situations).

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-12 21:12:54 -04:00
David A. Wheeler 8fee8a34bd Remove another use of range (Python 2/3 difference)
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-12 21:01:11 -04:00
David A. Wheeler c2ecdcf89b Remove many uses of range(), a Python 2/3 difference
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-12 20:58:19 -04:00
David A. Wheeler 0f4deebe00 Remove some Python 2/3 inconsistencies
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-12 20:45:05 -04:00
David A. Wheeler 6bb9c5d3c7 Tweak code to eliminate pylint warning
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-12 20:34:04 -04:00
David A. Wheeler eb3631d839 Remove use of Python 2-only __cmp__
Remove use of __cmp__, which is in Python 2 but not in Python 3.
Instead, use sort keys, which work in Python 2 and 3.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-12 20:31:41 -04:00
David A. Wheeler ea67f5dbca Switch all print statements to print() functions
Switch all print statements to print() functions per PEP 3105.
Python 3 *only* supports print() functions, so this begins to
move the code towards simultaneously supporting python 2 and 3.

This implements "stage1" of futurize.  In theory, "stage1" is
supposed to be "low risk", but in fact a *large* number of
manual fixes had to be made to make the program work again.

Python 2's traditional print statement includes the "softspace"
feature. This is "a semi-secret attribute on files currently used to tell
print whether to insert a space before the first item".  The print()
function does not have the "softspace" feature, so there is no direct
translation for any situation that depended on softspaces.
Flawfinder used softspaces extensively, as they were convenient,
so it took a little work to make print() functions work.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-12 19:33:49 -04:00
David A. Wheeler f9d6e11cdf Document CSV format further, including the fingerprint
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 23:56:09 -04:00
David A. Wheeler d5c4af4be1 Add "fingerprint" to CSV output
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 23:50:52 -04:00
David A. Wheeler 41ccb9c0ef Add CSV option as a documented example
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 23:39:04 -04:00
David A. Wheeler 5ad5a17034 Make minor improvements to flawfinder man page
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 23:29:36 -04:00
David A. Wheeler 51208ff35b Document the --csv option in the man page and pdf
The CSV option is noted in the ChangeLog, and is explained in --help,
but I forgot to add it to the man page.  This fixes the man page
and its corresponding generated PDF file.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 23:23:18 -04:00
David A. Wheeler fa9e1b0d42 Save CSV file on "make test-is-correct"
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 23:16:40 -04:00
David A. Wheeler 310f850d5b Update version number to 2.0.1
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 23:15:56 -04:00
David A. Wheeler aae3976bcf Note CONTRIBUTING.md in README and ChangeLog
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 20:52:42 -04:00
David A. Wheeler 7a0a1f38a6 Improve documentation about the use of pylint
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 20:47:28 -04:00
David A. Wheeler a19714aa30 Modify some names per pylint recommendations
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 20:29:10 -04:00
David A. Wheeler c4b28d916f Remove/merge duplicate hash entries found by pylint
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 20:22:11 -04:00
David A. Wheeler 6c49d39c61 Fix error (use of undefined variable) found by pylint
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 20:13:37 -04:00
David A. Wheeler 48bad06778 Change old-style class to "new"-style class
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 20:07:58 -04:00
David A. Wheeler 1de04d3dca Mass reformat of flawfinder source code to better comply with PEP 8
This reformats the source code's style to better comply with
Python PEP 8.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 20:06:39 -04:00
David A. Wheeler d06466bd2a Fix minor style issues identified by pylint
Pylint is a static analyzer of Python code.  It seems appropriate
to use a static analyzer to analyze a static analyzer :-).
None of the changes here fix a flaw in flawfinder.
The goal here is to follow PEP 008 more closely in the hope that
the changes make it easier for other developers to improve it further.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 16:49:11 -04:00
David A. Wheeler 595f45ad13 Add information about pylint
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 16:35:45 -04:00
David A. Wheeler 9309aa9c63 Add CONTRIBUTING.md documentation
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-29 17:46:15 -04:00
David A. Wheeler 02029816d4 Add rules to detect g_*rand* functions
Thanks to Michael McConville for this suggestion!

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-29 16:35:06 -04:00
David A. Wheeler 6f399a0a25 Add support for generating CSV files
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-29 16:21:00 -04:00
David A. Wheeler 872109f230 Change version number to 2.0.0 - use Semantic Versioning
This switches flawfinder's version naming conventions to comply with
Semantic Versioning.  We change the first digit to "2" because
there's a subtle change in how CWEs are reported - see the
ChangeLog or documentation for more information.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-29 13:24:25 -04:00
David A. Wheeler 8f62d4290b flawfinder: remove some trailing whitespace 2014-09-07 14:14:55 -04:00
David A. Wheeler dc04172c52 flawfinder.1: Note that .makepp is also skipped by default 2014-09-07 14:14:34 -04:00
David A. Wheeler 94a20df2ee flawfinder.1: Tweak documentation about flag syntax 2014-09-07 14:05:52 -04:00
David A. Wheeler f6814c97c1 Reduce risk level to 0 of snprintf with constant format string
- snprintf is a useful *countermeasure* for buffer overflows,
    and unlike some alternatives it is standard and *widely* available.
    (strlcpy/strlcat are useful but not standard and not widely available;
    snprintf_s is standard but not widely available).
    Historically we warned about snprintf because old systems didn't
    implement it correctly, but at this point these old systems are
    more historical than anything else.
    Instead, let's specifically *mention* snprintf as a recommended
    potential solution for buffer overflows.
2014-09-01 15:14:55 -04:00