Skip to content

Commit b53987a

Browse files
committed
Added security monitoring
1 parent b7d33e4 commit b53987a

4 files changed

Lines changed: 65 additions & 8 deletions

File tree

‎.github/dependabot.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: /
5+
schedule:
6+
interval: monthly
7+
groups:
8+
actions:
9+
patterns: ["*"]
10+
- package-ecosystem: pip
11+
directory: /
12+
schedule:
13+
interval: monthly
14+
# dependencies are minimum versions (>=) ; only open security updates, not routine upgrades
15+
open-pull-requests-limit: 0

‎.github/workflows/security.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# This workflow audits the package dependencies for known vulnerabilities
2+
# It is separate from python-package.yml so that a new advisory never blocks a release
3+
4+
name: security
5+
6+
on:
7+
push:
8+
branches: [ "main" ]
9+
pull_request:
10+
branches: [ "main" ]
11+
schedule:
12+
- cron: "0 6 * * 1" # weekly, catches new advisories between pushes
13+
workflow_dispatch:
14+
15+
permissions:
16+
contents: read
17+
18+
jobs:
19+
pip-audit:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v7
23+
- name: Set up Python
24+
uses: actions/setup-python@v7
25+
with:
26+
python-version: "3.13"
27+
- name: Install pip-audit
28+
run: python -m pip install --upgrade pip pip-audit
29+
- name: Audit dependencies
30+
# resolves the dependencies of pyproject.toml in an isolated environment, so only these are audited
31+
run: pip-audit .

‎README.md‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<p align="center" id="top"><img src="https://github.com/packing-box/python-exeplot/raw/main/docs/pages/img/logo.png"></p>
22
<h1 align="center">ExePlot <a href="https://twitter.com/intent/tweet?text=ExePlot%20-%20Plot%20executable%20samples%20easy.%0D%0ALibrary%20for%20plotting%20executable%20samples%20supporting%20multiple%20formats.%0D%0Ahttps%3a%2f%2fgithub%2ecom%2fpacking-box%2fpython-exeplot%0D%0A&hashtags=python,programming,executable-samples,plot"><img src="https://img.shields.io/badge/Tweet--lightgrey?logo=twitter&style=social" alt="Tweet" height="20"/></a></h1>
3-
<h3 align="center">Search for samples from various malware databases.</h3>
3+
<h3 align="center">Plot executable samples easy.</h3>
44

55
[![PyPi](https://img.shields.io/pypi/v/exeplot.svg)](https://pypi.python.org/pypi/exeplot/)
66
[![Read The Docs](https://readthedocs.org/projects/python-exeplot/badge/?version=latest)](https://python-exeplot.readthedocs.io/en/latest/?badge=latest)
77
[![Build Status](https://github.com/packing-box/python-exeplot/actions/workflows/python-package.yml/badge.svg)](https://github.com/packing-box/python-exeplot/actions/workflows/python-package.yml)
8+
[![Security](https://github.com/packing-box/python-exeplot/actions/workflows/security.yml/badge.svg)](https://github.com/packing-box/python-exeplot/actions/workflows/security.yml)
89
[![Coverage Status](https://raw.githubusercontent.com/packing-box/python-exeplot/coverage-badge/docs/coverage.svg)](#)
910
[![Python Versions](https://img.shields.io/pypi/pyversions/exeplot.svg)](https://pypi.python.org/pypi/exeplot/)
10-
[![Known Vulnerabilities](https://snyk.io/test/github/packing-box/python-exeplot/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/packing-box/python-exeplot?targetFile=requirements.txt)
1111
[![License](https://img.shields.io/pypi/l/exeplot.svg)](https://pypi.python.org/pypi/exeplot/)
1212

1313
This library implements multiple plot types for illustrating executable samples. It currently supports the PE, ELF and Mach-O formats, relying on [`lief`](https://github.com/lief-project/LIEF) for abstracting them.
@@ -67,10 +67,4 @@ $ exeplot entropy calc_packed.exe --no-title --no-legend --no-label --no-entrypo
6767
![Simplified entropy plot of `calc_packed.exe`](https://github.com/packing-box/python-exeplot/blob/main/docs/pages/img/calc_packed_entropy.png?raw=true)
6868

6969

70-
## :clap: Supporters
71-
72-
[![Stargazers repo roster for @packing-box/python-exeplot](https://reporoster.com/stars/dark/packing-box/python-exeplot)](https://github.com/packing-box/python-exeplot/stargazers)
73-
74-
[![Forkers repo roster for @packing-box/python-exeplot](https://reporoster.com/forks/dark/packing-box/python-exeplot)](https://github.com/packing-box/python-exeplot/network/members)
75-
7670
<p align="center"><a href="#top"><img src="https://img.shields.io/badge/Back%20to%20top--lightgrey?style=social" alt="Back to top" height="20"/></a></p>

‎SECURITY.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Only the latest release of ExePlot (`exeplot` on [PyPI](https://pypi.org/project/exeplot/)) receives security fixes.
6+
7+
## Reporting a Vulnerability
8+
9+
Please do **not** report security vulnerabilities through public GitHub issues.
10+
11+
Instead, report them privately through [GitHub's private vulnerability reporting](https://github.com/packing-box/python-exeplot/security/advisories/new) (the repository's *Security* tab, then *Report a vulnerability*). Please include:
12+
13+
- the ExePlot version (`exeplot --help` prints it);
14+
- the steps to reproduce the issue, and a sample (or its hash) if relevant;
15+
- the impact you expect.
16+
17+
You will get an answer as soon as possible. Once the issue is confirmed, a fix is released and the advisory is published.

0 commit comments

Comments
 (0)