Samplescore client

The samplescore client is an example of a Python-based client for the samplescored service script that demonstrates how to analyze files or directories (recursively) and produce a comma-separated-value (CSV) report showing the confidence scores for each file.

Note: The scamplescore client works with the Aurora Engine Protocol only. It does not work with the RESTful API.

To use the samplescore client, the samplescored service script must be running.

Samplescore argument

Description

Valid values

-p PORT

This is an optional port number that the samplescored service is listening to.

1024 to 65535

-o PATH

This is an optional output path for the CSV report.

A valid file path

FILENAME

This is the file name, including the path if necessary, of the file to be scored.

A valid file name with read access
The following is an example of the samplescore command:
CODE 
samplescore -p 9002 -o outputfile badfile.exe

The samplescore client can score both files and archives with the same command.

The CSV report produced by samplescore provides the following details:

Output

Description

Name

The file name

Threat

How the threat is categorized if the file scores as a bad file

Score

The score returned for the file

Path

The path to the file

Type

The file type

SHA256

The SHA256 hash for the file