Vulnerability¶
This documentation provides details about the data that can be faked for Vulnerabilities.
To retrieve generated/fake data for Vulnerabilities see the following capabilities:
from socfaker import SocFaker
sc = SocFaker()
print(sc.vulnerability().host)
print(sc.vulnerability().scan)
print(sc.vulnerability().data)
print(sc.vulnerability().critical)
print(sc.vulnerability().high)
print(sc.vulnerability().medium)
print(sc.vulnerability().low)
print(sc.vulnerability().informational)
Vulnerability Class¶
-
class
socfaker.vulnerability.Vulnerability(host_count=1, critical=1, high=1, medium=1, low=1, informational=1)¶ The Vulnerabiltiy class contains properties to access data related to vulnerabilities
- Returns:
- Vulnerability: An object containing properties about vulnerabilities
-
critical¶ Returns a list of critical vulnerabilities based on counts provided when instantiating the class
- Returns:
- list: Returns a list of critical vulnerabilities
-
data¶ Returns all vulnerability data
- Returns:
- json: Returns json of all vulnerability data
-
high¶ Returns a list of high vulnerabilities based on counts provided when instantiating the class
- Returns:
- list: Returns a list of high vulnerabilities
-
host¶ Retrieve information about hosts found in a vulnerability scan
- Returns:
- VulnerabilityHost: Returns an object with properties for a vulnerable host
-
informational¶ Returns a list of informational vulnerabilities based on counts provided when instantiating the class
- Returns:
- list: Returns a list of informational vulnerabilities
-
low¶ Returns a list of low vulnerabilities based on counts provided when instantiating the class
- Returns:
- list: Returns a list of low vulnerabilities
-
medium¶ Returns a list of medium vulnerabilities based on counts provided when instantiating the class
- Returns:
- list: Returns a list of medium vulnerabilities
-
scan¶ A vulnerability scan
- Returns:
- VulnerabilityScan: Returns a vulnerability scan object with properties related a vulnerability scan
Vulnerability Host Class¶
-
class
socfaker.vulnerabilityhost.VulnerabilityHost(critical=0, high=0, medium=0, low=0, informational=0)¶ A VulnerabilityHost object contains properties related a single vulnerabile host
-
checks_considered¶ A count of how many vulnerability checks were considered for a host
- Returns:
- int: Returns a randomly integer for checks considered during a vulnerability scan
-
fqdn¶ A host FQDN
- Returns:
- str: Returns a randomly generated DNS name
-
host_id¶ Returns a random host ID
- Returns:
- int: Returns a random host ID
-
mac_address¶ A host MAC Address
- Returns:
- str: Returns a randomly generated MAC Address
-
name¶ Returns a computer name
- Returns:
- str: Returns a randomly generated computer name
-
percentage¶ Returns a percentage of vulnerabilities found on a host
- Returns:
- dict: Returns a percentage of vulnerabilities found on a host
-
total_score¶ The total score of a host during a vulnerability scan
- Returns:
- int: The total score for a host during a vulnerability scan
-
Vulnerability Scan Class¶
-
class
socfaker.vulnerabilityscan.VulnerabilityScan(host_count=1)¶ A VulnerabilityScan object contains properties about a vulnerability scan
-
end_time¶ End time of a vulnerability scan
- Returns:
- str: The end time of a vulnerability scan in the future
-
host_count¶ A vulnerability scan host count
- Returns:
- int: The provided vulnerability scan host count
-
id¶ A vulnerability scan ID
- Returns:
- int: Returns a random vulnerability scan ID
-
ip_list¶ A list of host IPs during a Vulnerability scan
- Returns:
- list: A randomly generated list of host IPs during a vulnerability scan
-
name¶ A vulnerability scan name
- Returns:
- str: A randomly selected vulnerability scan name
-
scan_uuid¶ A vulnerability scan UUID
- Returns:
- str: A random UUID for a vulnerability scan
-
scanner_name¶ A vulnerability scaner name
- Returns:
- str: Returns a random vulnerability scanner name
-
scanner_uuid¶ A vulnerability scanner UUID
- Returns:
- str: A random UUID for a scanner
-
start_time¶ Start time of a vulnerability scan
- Returns:
- str: The start time of a vulnerability scan in the past
-
status¶ Vulnerability scan status
- Returns:
- str: A randomly selected scan status
-
type¶ The vulnerability scan type
- Returns:
- str: A randomly selected vulnerability scan type
-