CWE-200 Web App Tool Repo

Quick summary

This tool is designed to detect and identify vulnerabilities related to CWE-200 (Exposure of Sensitive Information to an Unauthorized Actor) within Java projects. Sensitive information may be inadvertently exposed through various methods, including logging activities, revealing underlying program logic, displaying directory information, or printing usernames and passwords, among others. Given the complexity and subtlety of these exposures, our tool offers a comprehensive scanning solution. Users can upload their Java projects for a thorough analysis, ensuring all instances of such vulnerabilities are identified.

Current Coverage

• CWE-200: Exposure of Sensitive Information to an Unauthorized Actor
• CWE-201: Insertion of Sensitive Information Into Sent Data
• CWE-204: Observable Response Discrepancy
• CWE-208: Observable Timing Discrepancy
• CWE-209: Generation of Error Message Containing Sensitive Information
• CWE-214: Invocation of Process Using Visible Sensitive Information
• CWE-215: Insertion of Sensitive Information Into Debugging Code
• CWE-531: Inclusion of Sensitive Information in Test Code
• CWE-532: Insertion of Sensitive Information into Log File
• CWE-535: Exposure of Information Through Shell Error Message
• CWE-536: Servlet Runtime Error Message Containing Sensitive Information
• CWE-537: Java Runtime Error Message Containing Sensitive Information
• CWE-540: Inclusion of Sensitive Information in Source Code
• CWE-548: Exposure of Information Through Directory Listing
• CWE-550: Server-generated Error Message Containing Sensitive Information
• CWE-598: Use of GET Request Method With Sensitive Query Strings
• CWE-615: Inclusion of Sensitive Information in Source Code Comments

How do I get set up?

Using Docker

docker build -t cwe-200 --build-arg JAVA_VERSION=<VERSION> . 

docker run -p 4200:4200 -p 5400:5400 cwe-200

3. http://localhost:4200/

Manual Install

Dependencies

1. Node.js 20+ You will need to add Node as a system env variable
2. CodeQL CLI You will need to add CodeQL as a system env variable

Your project's build tool (Ensure that your project builds before using our tool) Maven, Gradle

In the Root Directory

1. Install dependencies

npm install

2. Build backend and frontend

npm run build

3. Setup Codeql dependencies

npm run codeql-setup

4. Run the Front-end and Back-end Servers

npm run start

Navigate to http://localhost:4200/

Query Testing

There is a labeled toy dataset located in backend/Files/CWEToyDataset that includes 333 test cases. To test the results of the queries run this command codeql database analyze backend/Files/CWEToyDataset/CWEToyDatasetdb --format=sarifv2.1.0 --output=out.sarif --rerun codeql/codeql-custom-queries-java from the project root. After this is complete, navigate to testing/toy-dataset-results.py and run this file. You should see the accuracies printed out in the terminal. If you want to know exactly how each query classified their corresponding test cases. Look in the codeql_results.json file located in the same directory.

Making your queries work with the testing script

If you make a new query or modify one, make sure you add the @id CWE- and @cwe CWE- tags to the meta data at the top of the query.

Contribution guidelines

• Writing tests
• Code review
• Other guidelines

Who do I talk to?

• Repo owner or admin
• Other community or team contact