Struct MalwareDBClient 

pub struct MalwareDBClient { /* private fields */ }

Malware DB client

Implementations

impl MalwareDBClient

pub fn new() -> PyResult<Self>

Load a configuration from a file if it can be found

Errors

Returns an error if the configuration file can’t be found or isn’t valid.

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

Login with a username and password

Errors

Returns an error if the server URL, username, or password were incorrect, or if a network issue occurred.

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

Connect if an API key is already known

Errors

Returns an error if a list of certificates was passed and any were not in the expected DER or PEM format or could not be parsed.

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

Connect using a specific configuration file

Errors

Returns an error if the configuration file cannot be read, possibly because it doesn’t exist or due to a permission error or a parsing error.

pub fn url(&self) -> String

Get the server’s URL

pub fn get_file_bytes(&self, hash: &str) -> Result<Vec<u8>>

Get the bytes of a sample from the database

Errors

This may return an error if there’s a network situation or if the user is not logged in or not properly authorized to connect.

pub fn submit_file( &self, contents: Vec<u8>, file_name: String, source_id: u32, ) -> Result<bool>

Submit a file to the database, which requires the file name and source ID. Returns true if stored.

Errors

This may return an error if there’s a network situation or if the user is not logged in or not properly authorized to connect.

pub fn partial_search( &self, hash: Option<String>, hash_type: &str, file_name: Option<String>, limit: u32, response_hash: &str, ) -> Result<Vec<String>>

Search by partial hash and/or partial file name, returning a list of hashes by specified hash type

Errors

• Invalid hash types will result in an error
• This may return an error if there’s a network situation or if the user is not logged in or the request isn’t valid

pub fn get_sources(&self) -> Result<Vec<Source>>

Get sources available to the user

Errors

This may return an error if there’s a network situation or if the user is not logged in or not properly authorized to connect.

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

Get information about the server

Errors

This may return an error if there’s a network problem or the server is down.

pub fn get_supported_file_types(&self) -> Result<Vec<SupportedFileType>>

Get supported file types; Malware DB only accepts file types it knows about

Errors

This may return an error if there’s a network problem or the server is down.

pub fn whoami(&self) -> Result<UserInfo>

Get information about the user

Errors

This may return an error if there’s a network problem or if the user is not logged in or not properly authorized to connect.

pub fn labels(&self) -> Result<Vec<Label>>

Get labels

Errors

This may return an error if there’s a network problem or if the user is not logged in or not properly authorized to connect.

Trait Implementations

impl<'py> IntoPyObject<'py> for MalwareDBClient

type Target = MalwareDBClient

The Python output type

type Output = Bound<'py, <MalwareDBClient as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for MalwareDBClient

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for MalwareDBClient

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Malware DB client

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<MalwareDBClient>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for MalwareDBClient

const TEXT_SIGNATURE: &'static str = "()"

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder MalwareDBClient

type Holder = Option<PyClassGuard<'a, MalwareDBClient>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<MalwareDBClient> for PyClassImplCollector<MalwareDBClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for MalwareDBClient

const NAME: &'static str = "MalwareDBClient"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for MalwareDBClient