Welcome to the Documentation of CogniCryptSAST
CogniCryptSAST is the static analysis component for CogniCrypt. It takes a set of rules written in the specification language CrySL as input, performs a static analysis based on these specifications and creates a report with all violations.
CogniCryptSAST provides the following features:
- A context-sensitive, field-sensitive and flow-sensitive typestate analysis using IDEal
- A context-sensitive, field-sensitive and flow-sensitive pointer analysis using Boomerang
- A CLI and API to analyze Java and Android applications
- Support for the static analysis frameworks Soot, SootUp and Opal
- A wide range of different error types that explain the violations of CrySL specifications
- An API to configure your own analysis
This documentation covers the following aspects:
- The installation and setup for the project
- A tutorial on how to use CongiCryptSAST for Java and Android applications
- A list with examples for all reported error types
- Examples of running CogniCryptSAST with a Java application
- A description of the API that allows the extension of CogniCryptSAST
- Information about contributing to this project