Skip to main content

No project description provided

Project description

SecML Malware plugin

GitHub code size in bytes GitHub issues PyPI - Python Version PyPI - Downloads

This is a plugin for the SecML Python library. There is a pre-trained MalConv model trained by EndGame, included in this project for testing.

Included Attacks

Installation

Navigate to the folder where you want to clone the project. I recommend creating a new environment (I use conda):

conda create -n secml_malware_env python=3.7
conda activate secml_malware_env
pip install secml_malware
pip install git+https://github.com/endgameinc/ember.git

You also need to install pytorch, find instructions here.

Troubleshooting possible errors

If you encouter problem due to libmagic, follow this instruction. If, for some reason, the installation through pip does not work, install ember and pytorch as described before, then:

git clone https://github.com/zangobot/secml_malware.git
cd secml_malware
pip install -r requirements.txt

How to use

Activate your environment import the secml_malware package inside your script:

import secml_malware
print(secml_malware.__version__)

The tests included in this project show how the library can be used for applying the manipulation to the input programs. There is also an example Jupyter notebook tutorial on how to build a simple attack (using a standard one).

Cite

If you use SecML Malware, please cite our latest work:

@article{demetrio2020adversarial,
    title={Adversarial EXEmples: A Survey and Experimental Evaluation of Practical Attacks on Machine Learning for Windows Malware Detection},
    author={Luca Demetrio and Scott E. Coull and Battista Biggio and Giovanni Lagorio and Alessandro Armando and Fabio Roli},
    year={2020},
    eprint={2008.07125},
    archivePrefix={arXiv},
    primaryClass={cs.CR}
}

Bug reports

If you encounter something strange, feel free to open an issue! I am working a lot, and bugs are present everytwhere. Let me know, and I'll try to fix them as soon as possible.

Testing

I provide a small test suite for the attacks I have developed inside the plugin. If you want to run them, ADD GOODWARE/MALWARE samples! There are two distinct folders:

secml_malware/data/goodware_samples
secml_malware/data/malware_samples/test_folder

Please, add samples to both folders (if and only if you want to run the internal tests).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

secml_malware-0.2.1.1.tar.gz (26.0 kB view hashes)

Uploaded Source

Built Distribution

secml_malware-0.2.1.1-py3-none-any.whl (54.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page