Struct MdbClient

pub struct MdbClient {
    pub url: String,
    /* private fields */
}

MalwareDB Client Configuration and connection

Fields

url: String

URL of MalwareDB, including http and port number, ending without a slash

Implementations

impl MdbClient

pub fn new( url: String, api_key: String, cert_path: Option<PathBuf>, ) -> Result<Self>

MDB Client from components, doesn’t test connectivity

pub async fn login( url: String, username: String, password: String, save: bool, cert_path: Option<PathBuf>, ) -> Result<Self>

Login to a server, optionally save the config file, and return a client object

pub async fn reset_key(&self) -> Result<()>

Reset one’s own API key to effectively logout & disable all clients who are using the key

pub fn from_file(path: &PathBuf) -> Result<Self>

MDB Client loaded from a specified path

pub fn load() -> Result<Self>

MDB Client from user’s home directory

pub fn save(&self) -> Result<()>

Save MDB Client to the user’s home directory

pub fn delete(&self) -> Result<()>

Delete the MalwareDB client config file

pub async fn server_info(&self) -> Result<ServerInfo>

Get information about the server, unauthenticated

pub async fn supported_types(&self) -> Result<SupportedFileTypes>

Get file types supported by the server, unauthenticated

pub async fn whoami(&self) -> Result<GetUserInfoResponse>

Get information about the user

pub async fn labels(&self) -> Result<Labels>

Get the sample labels known to the server

pub async fn sources(&self) -> Result<Sources>

Get the sources available to the current user

pub async fn submit( &self, contents: impl AsRef<[u8]>, file_name: &str, source_id: u32, ) -> Result<bool>

Submit one file to MalwareDB: provide the contents, file name, and source ID

pub async fn retrieve(&self, hash: &str, cart: bool) -> Result<Vec<u8>>

Retrieve sample by hash, optionally in the CaRT format

pub async fn report(&self, hash: &str) -> Result<Report>

Fetch a report for a sample

pub async fn similar(&self, contents: &[u8]) -> Result<SimilarSamplesResponse>

Find similar samples in MalwareDB based on the contents of a given file. This does not submit the sample to MalwareDB.

Trait Implementations

impl Debug for MdbClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MdbClient

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for MdbClient

fn drop(&mut self)

Executes the destructor for this type.

impl Serialize for MdbClient

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Zeroize for MdbClient

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.