https://github.com/htrgouvea/zarn
A lightweight static security analysis tool for modern Perl Apps
https://github.com/htrgouvea/zarn
sast security static-analysis static-code-analysis
Last synced: 6 months ago
JSON representation
A lightweight static security analysis tool for modern Perl Apps
- Host: GitHub
- URL: https://github.com/htrgouvea/zarn
- Owner: htrgouvea
- License: other
- Created: 2022-11-23T13:42:38.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-16T12:28:43.000Z (over 1 year ago)
- Last Synced: 2024-05-02T02:39:31.796Z (over 1 year ago)
- Topics: sast, security, static-analysis, static-code-analysis
- Language: Perl
- Homepage: https://heitorgouvea.me/2023/03/19/static-security-analysis-tool-perl
- Size: 149 KB
- Stars: 37
- Watchers: 3
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.MD
- Security: SECURITY.md
Awesome Lists containing this project
README
ZARN
A lightweight static code security analysis for Modern Perl Applications
---
### Summary
Performing [static analysis](https://en.wikipedia.org/wiki/Static_program_analysis), Zarn is able to identify possible vulnerabilities: for this purpose, each file is parsed using [AST analysis](https://en.wikipedia.org/wiki/Abstract_syntax_tree) to recognize tokens that present risks and subsequently runs the [taint tracking](https://en.wikipedia.org/wiki/Taint_checking) process to confirm that it is a whether exploitable or not, to validate whether a malicious agent is able to target the method in question.
Currently, Zarn do single file context analysis, which means that it is not able to identify vulnerabilities that are not directly related to the file being analyzed. But in the future, we plan to implement a [call graph](https://en.wikipedia.org/wiki/Call_graph) analysis to identify vulnerabilities that are not directly related to the file being analyzed.
You can read the full publication about Zarn at: [a lightweight static security analysis tool for modern Perl Apps.](https://heitorgouvea.me/2023/03/19/static-security-analysis-tool-perl)
---
### Download and install
```bash
# Download
$ git clone https://github.com/htrgouvea/zarn && cd zarn
# Install libs dependencies
$ sudo cpanm --installdeps .
```
---
### Example of use
```bash
$ perl zarn.pl --rules rules/quick-wins.yml --source ../nozaki --sarif report.sarif
[warn] - FILE:../nozaki/lib/Functions/Helper.pm Potential: Timing Attack.
[vuln] - FILE:../nozaki/lib/Engine/Orchestrator.pm Potential: Path Traversal.
[vuln] - FILE:../nozaki/lib/Engine/Orchestrator.pm Potential: Path Traversal.
[warn] - FILE:../nozaki/lib/Engine/FuzzerThread.pm Potential: Timing Attack.
```
---
### Rules example
```yaml
rules:
- id: '0001'
type: presence
category: info
name: Debug module enabled
message: Debug modules can expose sensitive information and potentially create security vulnerabilities.
sample:
- Dumper
- id: '0002'
type: presence
category: vuln
name: Code Injection
message: Occur when untrusted data is executed as code, allowing attackers to run arbitrary commands on the server.
sample:
- system
- eval
- exec
- qx
- id: '0003'
type: presence
category: vuln
name: Path Traversal
message: Occur when user input is not properly sanitized, allowing attackers to access files and directories outside of the intended directory structure.
sample:
- open
- id: '0004'
type: presence
category: vuln
name: Weak Criptography Algorithm
message: Weak algorithms like MD5 are susceptible to various attacks and should be avoided in favor of stronger alternatives to ensure the security of sensitive data.
sample:
- md5
- id: '0005'
type: presence
category: vuln
name: Weak Random Value Generator
message: Weak random value generators can lead to predictable values, which can be exploited by attackers to bypass security controls.
sample:
- rand
- id: '0006'
type: absence
category: warning
name: Error Suppression
message: Suppressing errors can make it difficult to identify and troubleshoot issues, potentially leading to security vulnerabilities.
sample:
- strict
- warnings
```
---
### Github Actions
```yaml
name: ZARN SAST
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
schedule:
- cron: "28 23 * * 1"
jobs:
zarn:
name: Security Static Analysis with ZARN
runs-on: ubuntu-20.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Perform Static Analysis
uses: htrgouvea/zarn@0.0.9
- name: Send result to Github Security
uses: github/codeql-action/upload-sarif@v3
with:
sarif_file: result.sarif
```
---
### Contribution
Your contributions and suggestions are heartily ♥ welcome. [See here the contribution guidelines.](/.github/CONTRIBUTING.md) Please, report bugs via [issues page](https://github.com/htrgouvea/zarn/issues) and for security issues, see here the [security policy.](/SECURITY.md) (✿ ◕‿◕) This project follows this [style guide: (https://github.com/htrgouvea/perl-style-guide)](https://github.com/htrgouvea/perl-style-guide).
---
### License
This work is licensed under [MIT License.](/LICENSE.md)