Crate malwaredb_api

Source
Expand description

§MalwareDB API

TestLintCrossDocumentationCrates.io Version

This crate stores the API endpoints and data types expected for each endpoint. This could be used to build a custom client.

Modules§

digest
Wrapper for fixed-size hash digests from hex strings

Structs§

GetAPIKeyRequest
User logs in with username and password
GetAPIKeyResponse
Response includes the key, if the credentials were correct, and possibly show a message related to errors or warnings.
GetUserInfoResponse
User gets information about their account
Label
A label, used for sources and samples
Labels
One or more labels
NewSample
New file sample being sent to MalwareDB
Report
All the data for a sample known to MalwareDB
ServerInfo
Information about the server
SimilarSample
Relation between a similar sample and the hashes by which the sample is similar
SimilarSamplesRequest
Requesting a sample from MalwareDB by similarity hash
SimilarSamplesResponse
Response indicating samples which are similar
SourceInfo
Source record
Sources
Sources response for request for sources
SupportedFileType
One record of supported file types
SupportedFileTypes
Server’s supported types, the response
VirusTotalSummary
Virus Total hits summary

Enums§

SimilarityHashType
The hash by which a sample is identified

Constants§

DOWNLOAD_SAMPLE
API endpoint for downloading a sample, GET. The hash value goes at the end of the URL. For example: /v1/samples/download/aabbccddeeff0011223344556677889900 Response is raw bytes of the file, or HTTP 404 if not found
DOWNLOAD_SAMPLE_CART
API endpoint for downloading a sample as a CaRT container file, GET Example: /v1/samples/download/cart/aabbccddeeff0011223344556677889900 Response is the file encoded in a CaRT container file, or HTTP 404 if not found
LIST_LABELS
API endpoint for finding samples which are similar to a specific file, POST
LIST_SOURCES
Endpoint for the sources, per-user, GET, authenticated
MDB_API_HEADER
Header key used to present the API key to the server
MDB_VERSION
MDB version
SAMPLE_REPORT
API endpoint to get a report for a given sample Example: /v1/samples/report/aabbccddeeff0011223344556677889900
SERVER_INFO
Server information, request is empty, GET, Unauthenticated.
SIMILAR_SAMPLES
API endpoint for finding samples which are similar to specific file, POST, Authenticated.
SUPPORTED_FILE_TYPES
File types supported by MalwareDB, request is empty, GET, Unauthenticated.
UPLOAD_SAMPLE
API endpoint for uploading a sample, POST, Authenticated
USER_INFO_URL
User’s get self information API endpoint, GET, authenticated User EmptyAuthenticatingPost to authenticate
USER_LOGIN_URL
Login API endpoint, POST
USER_LOGOUT_URL
Logout API endpoint, GET, authenticated.