Skip to main content

Quick Start

Pull the latest YaraHunter image, and use it to scan a node:latest container.

Pull the latest YaraHunter image​

docker pull quay.io/deepfenceio/deepfence_malware_scanner_ce:2.5.0

Generate License Key​

Run this command to generate a license key. Work/official email id has to be used.

curl https://license.deepfence.io/threatmapper/generate-license?first_name=<FIRST_NAME>&last_name=<LAST_NAME>&email=<EMAIL>&company=<ORGANIZATION_NAME>&resend_email=true

Scan a Container Image​

Pull an image to your local repository, then scan it

docker pull node:latest

docker run -i --rm --name=yara-hunter \
    -e DEEPFENCE_PRODUCT=<ThreatMapper or ThreatStryker> \
    -e DEEPFENCE_LICENSE=<ThreatMapper or ThreatStryker license key> \
    -v /var/run/docker.sock:/var/run/docker.sock \
    quay.io/deepfenceio/deepfence_malware_scanner_ce:2.5.0 \
    --image-name node:latest

docker rmi node:latest

Process the results with jq​

You can summarise the results by processing the JSON output, e.g. using jq:

docker run -i --rm --name=yara-hunter \
    -e DEEPFENCE_PRODUCT=<ThreatMapper or ThreatStryker> \
    -e DEEPFENCE_LICENSE=<ThreatMapper or ThreatStryker license key> \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -v /tmp:/home/deepfence/output \
    quay.io/deepfenceio/deepfence_malware_scanner_ce:2.5.0 \
    --image-name node:latest \
    --output=json > node-latest.json

cat /tmp/node-latest.json | jq '.IOC[] | ."Matched Rule Name"'