Expand description
§MalwareDB
API
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§
- GetAPI
KeyRequest - User logs in with username and password
- GetAPI
KeyResponse - Response includes the key, if the credentials were correct, and possibly show a message related to errors or warnings.
- GetUser
Info Response - 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
- Server
Info - Information about the server
- Similar
Sample - Relation between a similar sample and the hashes by which the sample is similar
- Similar
Samples Request - Requesting a sample from
MalwareDB
by similarity hash - Similar
Samples Response - Response indicating samples which are similar
- Source
Info - Source record
- Sources
- Sources response for request for sources
- Supported
File Type - One record of supported file types
- Supported
File Types - Server’s supported types, the response
- Virus
Total Summary - Virus Total hits summary
Enums§
- Similarity
Hash Type - 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 aCaRT
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.