https://github.com/chris-anley/cq

CQ, a code security scanner
https://github.com/chris-anley/cq

Last synced: 3 months ago
JSON representation

CQ, a code security scanner

• Host: GitHub
• URL: https://github.com/chris-anley/cq
• Owner: chris-anley
• License: bsd-2-clause
• Created: 2022-06-20T11:07:53.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-14T13:09:46.000Z (6 months ago)
• Last Synced: 2024-06-06T20:02:41.647Z (5 months ago)
• Language: Python
• Size: 110 KB
• Stars: 97
• Watchers: 4
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - chris-anley/cq - CQ, a code security scanner (Python)

README

        
# cq

Code Query, a universal code security scanning tool.

CQ scans code for security vulnerabilities and other items of interest to security-focussed code reviewers.

It outputs text files containing references to issues found, into an output directory. These output files can then be reviewed, 

filtered by unix command line tools such as grep, or used as a means to 'jump' into the codebase at the specified file:line reference.

One popular mode of use is to consider the output files as a 'todo' list, deleting references as they are reviewed and either considered false positives, 

or copying the references into some report file to either review in detail or provide the basis for a bug report.

The tool is extremely basic, largely manual, and assumes deep knowledge of application security vulnerabilities and code review. 

It does, however, have the advantages of being relatively fast and reliable, and working even when only partial code is available.

CQ is Code Query, or Sécurité, or CQD, or "Seek You".

## Intended Purpose

CQ is intended to be used in a security code review context by human experts. It is not intended for use in automated scenarios, 

although it might be applied in that context. 

CQ outputs plain text files, with typically one finding per line, using the convention full path:line number to 

represent locations in the codebase. This format is used to allow for ease of manipulation using the standard unix 

command line utilities, such as grep, wc, sed and similar, and the line-based facilities of many editors 

such as vi, Sublime Text, Atom and Visual Studio Code.

The focus on reporting all items of interest results in a tool that will find many points of interest in 

almost any codebase, but which will also report a large number of 'false positives'. These false positives can be 

removed from the results either by inspection or in an automated fashion, due to the line-based reporting method.  

Little to no explanation of issues is provided; it's assumed that you are aware of the context, impact and 

characteristics of the issues reported.