Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janislley/lsverifier
LSVerifier - Large Systems Verifier
https://github.com/janislley/lsverifier
bounded-model-checking c-language formal-verification model-checking open-source-software security-vulnerabilities software-verification
Last synced: 5 days ago
JSON representation
LSVerifier - Large Systems Verifier
- Host: GitHub
- URL: https://github.com/janislley/lsverifier
- Owner: janislley
- License: apache-2.0
- Created: 2020-10-09T23:51:57.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T12:52:44.000Z (6 months ago)
- Last Synced: 2024-09-29T01:05:49.334Z (5 days ago)
- Topics: bounded-model-checking, c-language, formal-verification, model-checking, open-source-software, security-vulnerabilities, software-verification
- Language: Python
- Homepage:
- Size: 22.4 MB
- Stars: 10
- Watchers: 7
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## LSVerifier
LSVerifier is a command-line tool for formal verification of large ANSI-C projects in a single run.
It leverages the [ESBMC](https://github.com/esbmc/esbmc) model checker as its core verification engine.
Demo [video](https://www.youtube.com/watch?v=LrGwp00pSLc).
## Version
| Version | Improviments |
|---------|--------------|
| v0.3.0 | Support specific class of property verification; Support for large software; Prioritized functions verification, Disable invalid pointer verification. |
| v0.2.0 | Support for libraries dependencies; Recursive verification. |
## Requirements
[Ctags](https://github.com/universal-ctags/ctags) is required to use LSVerifier.
## Installation
#### Install LSVerifier
##### From repository
1. Clone the repository:
```
$ git clone https://github.com/janislley/lsverifier.git
```
2. Install using pip:
```
$ cd LSVerifier
$ pip3 install .
```
##### From Pypi
```
$ pip3 install lsverifier
```
## Usage
#### 1. Verify a project
```
$ cd
$ lsverifier -r -f
```
For projects with third-party library dependencies, use ```-l``` option to specify header paths:
```
$ lsverifier -r -f -l dep.txt
```
See an example of ```dep.txt``` below:
```
/usr/include/glib-2.0/
/usr/lib/x86_64-linux-gnu/glib-2.0/include/extcap/
extcap/
plugins/epan/ethercat/
plugins/epan/falco_bridge/
plugins/epan/wimaxmacphy/
epan/crypt/
...
```
#### 2. Verify a single C file
```
$ lsverifier -f -fl file.c
```
#### 3. Verify C files using a priorization algorithm
If you want to verify a project using a prioritization scheme, run:
```
$ cd
$ lsverifier -r -fp
```
#### 4. Verify an entire project by providing the folder path as an argument
To set the folder path parameter, you should use ```-d```:
```
lsverifier -r -f -l dep.txt -d project-root/
```
#### 5. Verify C files using a predefined class of properties
In the project that you want to verify, run:
```
$ lsverifier -r -f -p memory-leak-check,overflow-check,deadlock-check,data-races-check
```
See more properties on tool help.
#### 6. LSVerifier help
For more details, check the help:
```
$ lsverifier -h
usage: lsverifier [-h] [-l LIBRARIES] [-p PROPERTIES] [-f] [-fp] [-fl FILE] [-v] [-r] [-d DIRECTORY] [-dp] [-e ESBMC_PARAMETER]
Input Options
optional arguments:
-h, --help show this help message and exit
-l,--libraries LIBRARIES
Path to the file that describes the libraries' dependencies
-p,--properties PROPERTIES
Properties to be verified (comma separated):
multi-property
nan-check
memory-leak-check
floatbv
overflow-check
unsigned-overflow-check
ub-shift-check
struct-fields-check
deadlock-check
data-races-check
lock-order-check
-f, --functions Enable Functions Verification
-fp, --function-prioritized
Enable Prioritized Functions Verification
-fl,--file FILE File to be verified
-v, --verbose Enable Verbose Output
-r, --recursive Enable Recursive Verification
-d,--directory DIRECTORY
Set the directory to be verified
-dp, --disable-pointer-check
Disable invalid pointer property verification
-e,--esbmc-parameter ESBMC_PARAMETER
Use ESBMC parameter
```
## Verification report
The verification results will be saved in ```output``` folder, automatically created in the current verification path. Each verification run generates two files:
- lsverifier-**DATE**.log: Contains the verification output log.
- lsverifier-**DATE**.csv: Contains the verification results in CSV format.