CapacitorSet/yara-java

Java bindings for Yara

★ 1Forks 0JavaGitHub ↗Compare

README

This module is for internal usage in elasticsearch-yara. For other scenarios, use at your own risk.

The original repository is licensed Apache 2.0. Refer to the commit history for the list of changes.

The original README follows with small fixes.


Highlights

  • Does not require yara to be deployed (embeds all needed native dependencies)
  • Supports two modes of operation:
    • External: yara binary extracted and executed as a child process
    • Embedded: yara jnilib runs embedded in the java process
  • Rules can be loaded as strings, files or archives; for archives will recursively look for and load all yara rule files
  • Matches are returned with identifier, metadata and tags
  • Negate, timeout and limit supported

How to build

Get and build yara source code

Example (building from 3.5.0 version)

git clone https://github.com/virustotal/yara.git
cd yara
git checkout tags/v3.5.0
./bootstrap.sh
./configure
make

Get and build yara-java

my-project
 |
 +-- yara
 |
 +-- yara-java

Example (in the same folder as "yara"):

git clone https://github.com/p8a/yara-java.git
cd yara-java
git checkout tags/v3.5.0
mvn clean install

Usage and examples

See the unit tests

Contributors

p8aCapacitorSetcbladesm91snik

Issues