Package entropy :: Module security :: Class SecurityInterface

Class SecurityInterface

source code

~~ GIVES YOU WINGS ~~

Instance Methods

__init__(self, entropy_client_instance)
SecurityInterface constructor.

source code

clear(self, xcache=False)
Clear SecurityInterface cache (RAM and on-disk).

source code

get_advisories_cache(self)
Return cached advisories information metadata.

source code

set_advisories_cache(self, adv_metadata)
Set advisories information metadata cache.

source code

dict

get_advisories_metadata(self)
Get security advisories metadata.

source code

dict

filter_advisories(self, adv_metadata)
This function filters advisories metadata dict removing non-applicable ones.

source code

bool

is_affected(self, adv_key, adv_data=None)
Determine whether the system is affected by vulnerabilities listed in the provided security advisory identifier.

source code

dict

get_vulnerabilities(self)
Return advisories metadata for installed packages containing vulnerabilities.

source code

dict

get_fixed_vulnerabilities(self)
Return advisories metadata for installed packages not affected by any vulnerability.

source code

set

get_affected_atoms(self)
Return a list of package atoms affected by vulnerabilities.

source code

bool

check_advisories_availability(self)
Return whether security advisories are available.

source code

int

fetch_advisories(self, do_cache=True)
This is the service method for remotely fetch advisories metadata.

source code

Method Details

init(self, entropy_client_instance)
(Constructor)

source code

SecurityInterface constructor.

Parameters:

entropy_client_instance (entropy.client.interfaces.Client instance) - a valid entropy.client.interfaces.Client instance

clear(self, xcache=False)

source code

Clear SecurityInterface cache (RAM and on-disk).

Parameters:

xcache (bool) - also remove Entropy on-disk cache if True

get_advisories_cache(self)

source code

Return cached advisories information metadata. It first tries to load them from RAM and, in case of failure, it tries to gather the info from disk, using EntropyCacher.

set_advisories_cache(self, adv_metadata)

source code

Set advisories information metadata cache.

Parameters:

adv_metadata (dict) - advisories metadata to store

get_advisories_metadata(self)

source code

Get security advisories metadata.

Returns: dict: advisories metadata

filter_advisories(self, adv_metadata)

source code

This function filters advisories metadata dict removing non-applicable ones.

Parameters:

adv_metadata (dict) - security advisories metadata dict

Returns: dict

filtered security advisories metadata

is_affected(self, adv_key, adv_data=None)

source code

Determine whether the system is affected by vulnerabilities listed in the provided security advisory identifier.

Parameters:

adv_key (string) - security advisories identifier
adv_data (dict) - use the provided security advisories instead of the stored one.

Returns: bool

True, if system is affected by vulnerabilities listed in the provided security advisory.

get_vulnerabilities(self)

source code

Return advisories metadata for installed packages containing vulnerabilities.

Returns: dict: advisories metadata for vulnerable packages.

get_fixed_vulnerabilities(self)

source code

Return advisories metadata for installed packages not affected by any vulnerability.

Returns: dict: advisories metadata for NON-vulnerable packages.

get_affected_atoms(self)

source code

Return a list of package atoms affected by vulnerabilities.

Returns: set: list (set) of package atoms affected by vulnerabilities

check_advisories_availability(self)

source code

Return whether security advisories are available.

Returns: bool: availability

fetch_advisories(self, do_cache=True)

source code

This is the service method for remotely fetch advisories metadata.

Parameters:

do_cache (bool) - generates advisories cache

Returns: int

execution status (0 means all file)

Class SecurityInterface

__init__(self, entropy_client_instance) (Constructor)

clear(self, xcache=False)

get_advisories_cache(self)

set_advisories_cache(self, adv_metadata)

get_advisories_metadata(self)

filter_advisories(self, adv_metadata)

is_affected(self, adv_key, adv_data=None)

get_vulnerabilities(self)

get_fixed_vulnerabilities(self)

get_affected_atoms(self)

check_advisories_availability(self)

fetch_advisories(self, do_cache=True)

init(self, entropy_client_instance)
(Constructor)