Code stringlengths 103 85.9k | Summary listlengths 0 94 |
|---|---|
Please provide a description of the function:def _absolutePaths(self, paths):
slashes = [p.replace('\\', '/') for p in paths]
stripped = [p.replace('../', '') if p.startswith('../') else p for p in slashes]
return list([p if (os.path.isabs(p) or '/' not in p) else os.path.join(self.engineRoot, self.engineSourc... | [
"\n\t\tConverts the supplied list of paths to absolute pathnames (except for pure filenames without leading relative directories)\n\t\t"
] |
Please provide a description of the function:def _flatten(self, field, items, transform = None):
# Retrieve the value for each item in the iterable
values = [item[field] for item in items]
# Flatten any nested lists
flattened = []
for value in values:
flattened.extend([value] if isinstance(value, ... | [
"\n\t\tExtracts the entry `field` from each item in the supplied iterable, flattening any nested lists\n\t\t"
] |
Please provide a description of the function:def _getThirdPartyLibs(self, platformIdentifier, configuration):
# If we have previously cached the library list for the current engine version, use the cached data
cachedList = CachedDataManager.getCachedDataKey(self.engineVersionHash, 'ThirdPartyLibraries')
if ... | [
"\n\t\tRuns UnrealBuildTool in JSON export mode and extracts the list of third-party libraries\n\t\t"
] |
Please provide a description of the function:def processLibraryDetails(details):
# If the header include directories list contains any directories we have flags for, add them
for includeDir in details.includeDirs:
# If the directory path matches any of the substrings in our list, generate the relevant ... | [
"\n\t\tProcesses the supplied ThirdPartyLibraryDetails instance and sets any custom CMake flags\n\t\t"
] |
Please provide a description of the function:def getPlugins():
# Retrieve the list of detected entry points in the ue4cli.plugins group
plugins = {
entry_point.name: entry_point.load()
for entry_point
in pkg_resources.iter_entry_points('ue4cli.plugins')
}
# Filter out any invalid plugins
plu... | [
"\n\t\tReturns the list of valid ue4cli plugins\n\t\t"
] |
Please provide a description of the function:def getCompilerFlags(self, engineRoot, fmt):
return Utility.join(
fmt.delim,
self.prefixedStrings(self.definitionPrefix, self.definitions, engineRoot) +
self.prefixedStrings(self.includeDirPrefix, self.includeDirs, engineRoot) +
self.resolveRoot(self.cxx... | [
"\n\t\tConstructs the compiler flags string for building against this library\n\t\t"
] |
Please provide a description of the function:def getLinkerFlags(self, engineRoot, fmt, includeLibs=True):
components = self.resolveRoot(self.ldFlags, engineRoot)
if includeLibs == True:
components.extend(self.prefixedStrings(self.linkerDirPrefix, self.linkDirs, engineRoot))
components.extend(self.resolveRo... | [
"\n\t\tConstructs the linker flags string for building against this library\n\t\t"
] |
Please provide a description of the function:def getPrefixDirectories(self, engineRoot, delimiter=' '):
return delimiter.join(self.resolveRoot(self.prefixDirs, engineRoot)) | [
"\n\t\tReturns the list of prefix directories for this library, joined using the specified delimiter\n\t\t"
] |
Please provide a description of the function:def getIncludeDirectories(self, engineRoot, delimiter=' '):
return delimiter.join(self.resolveRoot(self.includeDirs, engineRoot)) | [
"\n\t\tReturns the list of include directories for this library, joined using the specified delimiter\n\t\t"
] |
Please provide a description of the function:def getLinkerDirectories(self, engineRoot, delimiter=' '):
return delimiter.join(self.resolveRoot(self.linkDirs, engineRoot)) | [
"\n\t\tReturns the list of linker directories for this library, joined using the specified delimiter\n\t\t"
] |
Please provide a description of the function:def getLibraryFiles(self, engineRoot, delimiter=' '):
return delimiter.join(self.resolveRoot(self.libs, engineRoot)) | [
"\n\t\tReturns the list of library files for this library, joined using the specified delimiter\n\t\t"
] |
Please provide a description of the function:def getPreprocessorDefinitions(self, engineRoot, delimiter=' '):
return delimiter.join(self.resolveRoot(self.definitions, engineRoot)) | [
"\n\t\tReturns the list of preprocessor definitions for this library, joined using the specified delimiter\n\t\t"
] |
Please provide a description of the function:def getCMakeFlags(self, engineRoot, fmt):
return Utility.join(
fmt.delim,
[
'-DCMAKE_PREFIX_PATH=' + self.getPrefixDirectories(engineRoot, ';'),
'-DCMAKE_INCLUDE_PATH=' + self.getIncludeDirectories(engineRoot, ';'),
'-DCMAKE_LIBRARY_PATH=' + self.getLi... | [
"\n\t\tConstructs the CMake invocation flags string for building against this library\n\t\t"
] |
Please provide a description of the function:def is_changed():
executed, changed_lines = execute_git('status --porcelain', output=False)
merge_not_finished = mod_path.exists('.git/MERGE_HEAD')
return changed_lines.strip() or merge_not_finished | [
" Checks if current project has any noncommited changes. "
] |
Please provide a description of the function:def user_agent():
client_name = 'unknown_client_name'
try:
client_name = os.environ.get("EDX_REST_API_CLIENT_NAME") or socket.gethostbyname(socket.gethostname())
except: # pylint: disable=bare-except
pass # using 'unknown_client_name' is go... | [
"\n Return a User-Agent that identifies this client.\n\n Example:\n python-requests/2.9.1 edx-rest-api-client/1.7.2 ecommerce\n\n The last item in the list will be the application name, taken from the\n OS environment variable EDX_REST_API_CLIENT_NAME. If that environment\n variable is not set... |
Please provide a description of the function:def get_oauth_access_token(url, client_id, client_secret, token_type='jwt', grant_type='client_credentials',
refresh_token=None):
now = datetime.datetime.utcnow()
data = {
'grant_type': grant_type,
'client_id': client_i... | [
" Retrieves OAuth 2.0 access token using the given grant type.\n\n Args:\n url (str): Oauth2 access token endpoint\n client_id (str): client ID\n client_secret (str): client secret\n Kwargs:\n token_type (str): Type of token to return. Options include bearer and jwt.\n grant... |
Please provide a description of the function:def request(self, method, url, **kwargs): # pylint: disable=arguments-differ
self._check_auth()
return super(OAuthAPIClient, self).request(method, url, **kwargs) | [
"\n Overrides Session.request to ensure that the session is authenticated\n "
] |
Please provide a description of the function:def run_command(self, scan_id, host, cmd):
ssh = paramiko.SSHClient()
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
options = self.get_scan_options(scan_id)
port = int(options['port'])
timeout = int(options['ssh... | [
"\n Run a single command via SSH and return the content of stdout or\n None in case of an Error. A scan error is issued in the latter\n case.\n\n For logging into 'host', the scan options 'port', 'username',\n 'password' and 'ssh_timeout' are used.\n "
] |
Please provide a description of the function:def get_result_xml(result):
result_xml = Element('result')
for name, value in [('name', result['name']),
('type', ResultType.get_str(result['type'])),
('severity', result['severity']),
('hos... | [
" Formats a scan result to XML format.\n\n Arguments:\n result (dict): Dictionary with a scan result.\n\n Return:\n Result as xml element object.\n "
] |
Please provide a description of the function:def simple_response_str(command, status, status_text, content=""):
response = Element('%s_response' % command)
for name, value in [('status', str(status)), ('status_text', status_text)]:
response.set(name, str(value))
if isinstance(content, list):
... | [
" Creates an OSP response XML string.\n\n Arguments:\n command (str): OSP Command to respond to.\n status (int): Status of the response.\n status_text (str): Status text of the response.\n content (str): Text part of the response XML element.\n\n Return:\n String of response... |
Please provide a description of the function:def bind_socket(address, port):
assert address
assert port
bindsocket = socket.socket()
try:
bindsocket.bind((address, port))
except socket.error:
logger.error("Couldn't bind socket on %s:%s", address, port)
return None
... | [
" Returns a socket bound on (address:port). "
] |
Please provide a description of the function:def bind_unix_socket(path):
assert path
bindsocket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
try:
os.unlink(path)
except OSError:
if os.path.exists(path):
raise
try:
bindsocket.bind(path)
except sock... | [
" Returns a unix file socket bound on (path). "
] |
Please provide a description of the function:def close_client_stream(client_stream, unix_path):
try:
client_stream.shutdown(socket.SHUT_RDWR)
if unix_path:
logger.debug('%s: Connection closed', unix_path)
else:
peer = client_stream.getpeername()
logge... | [
" Closes provided client stream "
] |
Please provide a description of the function:def set_command_attributes(self, name, attributes):
if self.command_exists(name):
command = self.commands.get(name)
command['attributes'] = attributes | [
" Sets the xml attributes of a specified command. "
] |
Please provide a description of the function:def add_scanner_param(self, name, scanner_param):
assert name
assert scanner_param
self.scanner_params[name] = scanner_param
command = self.commands.get('start_scan')
command['elements'] = {
'scanner_params':
... | [
" Add a scanner parameter. "
] |
Please provide a description of the function:def add_vt(self, vt_id, name=None, vt_params=None, vt_refs=None,
custom=None, vt_creation_time=None, vt_modification_time=None,
vt_dependencies=None, summary=None, impact=None, affected=None,
insight=None, solution=None, solution_... | [
" Add a vulnerability test information.\n\n Returns: The new number of stored VTs.\n -1 in case the VT ID was already present and thus the\n new VT was not considered.\n -2 in case the vt_id was invalid.\n "
] |
Please provide a description of the function:def _preprocess_scan_params(self, xml_params):
params = {}
for param in xml_params:
params[param.tag] = param.text or ''
# Set default values.
for key in self.scanner_params:
if key not in params:
... | [
" Processes the scan parameters. "
] |
Please provide a description of the function:def process_vts_params(self, scanner_vts):
vt_selection = {}
filters = list()
for vt in scanner_vts:
if vt.tag == 'vt_single':
vt_id = vt.attrib.get('id')
vt_selection[vt_id] = {}
fo... | [
" Receive an XML object with the Vulnerability Tests an their\n parameters to be use in a scan and return a dictionary.\n\n @param: XML element with vt subelements. Each vt has an\n id attribute. Optional parameters can be included\n as vt child.\n Example ... |
Please provide a description of the function:def process_credentials_elements(cred_tree):
credentials = {}
for credential in cred_tree:
service = credential.attrib.get('service')
credentials[service] = {}
credentials[service]['type'] = credential.attrib.get('... | [
" Receive an XML object with the credentials to run\n a scan against a given target.\n\n @param:\n <credentials>\n <credential type=\"up\" service=\"ssh\" port=\"22\">\n <username>scanuser</username>\n <password>mypass</password>\n </credential>\n ... |
Please provide a description of the function:def process_targets_element(cls, scanner_target):
target_list = []
for target in scanner_target:
ports = ''
credentials = {}
for child in target:
if child.tag == 'hosts':
hosts ... | [
" Receive an XML object with the target, ports and credentials to run\n a scan against.\n\n @param: XML element with target subelements. Each target has <hosts>\n and <ports> subelements. Hosts can be a single host, a host range,\n a comma-separated host list or a network address.\n ... |
Please provide a description of the function:def handle_start_scan_command(self, scan_et):
target_str = scan_et.attrib.get('target')
ports_str = scan_et.attrib.get('ports')
# For backward compatibility, if target and ports attributes are set,
# <targets> element is ignored.
... | [
" Handles <start_scan> command.\n\n @return: Response string for <start_scan> command.\n "
] |
Please provide a description of the function:def handle_stop_scan_command(self, scan_et):
scan_id = scan_et.attrib.get('scan_id')
if scan_id is None or scan_id == '':
raise OSPDError('No scan_id attribute', 'stop_scan')
self.stop_scan(scan_id)
return simple_respons... | [
" Handles <stop_scan> command.\n\n @return: Response string for <stop_scan> command.\n "
] |
Please provide a description of the function:def finish_scan(self, scan_id):
self.set_scan_progress(scan_id, 100)
self.set_scan_status(scan_id, ScanStatus.FINISHED)
logger.info("%s: Scan finished.", scan_id) | [
" Sets a scan as finished. "
] |
Please provide a description of the function:def get_scanner_param_type(self, param):
assert isinstance(param, str)
entry = self.scanner_params.get(param)
if not entry:
return None
return entry.get('type') | [
" Returns type of a scanner parameter. "
] |
Please provide a description of the function:def get_scanner_param_mandatory(self, param):
assert isinstance(param, str)
entry = self.scanner_params.get(param)
if not entry:
return False
return entry.get('mandatory') | [
" Returns if a scanner parameter is mandatory. "
] |
Please provide a description of the function:def get_scanner_param_default(self, param):
assert isinstance(param, str)
entry = self.scanner_params.get(param)
if not entry:
return None
return entry.get('default') | [
" Returns default value of a scanner parameter. "
] |
Please provide a description of the function:def get_scanner_params_xml(self):
scanner_params = Element('scanner_params')
for param_id, param in self.scanner_params.items():
param_xml = SubElement(scanner_params, 'scanner_param')
for name, value in [('id', param_id),
... | [
" Returns the OSP Daemon's scanner params in xml format. "
] |
Please provide a description of the function:def new_client_stream(self, sock):
assert sock
newsocket, fromaddr = sock.accept()
logger.debug("New connection from"
" %s:%s", fromaddr[0], fromaddr[1])
# NB: Despite the name, ssl.PROTOCOL_SSLv23 selects the hi... | [
" Returns a new ssl client stream from bind_socket. "
] |
Please provide a description of the function:def write_to_stream(stream, response, block_len=1024):
try:
i_start = 0
i_end = block_len
while True:
if i_end > len(response):
stream(response[i_start:])
break
... | [
"\n Send the response in blocks of the given len using the\n passed method dependending on the socket type.\n "
] |
Please provide a description of the function:def handle_client_stream(self, stream, is_unix=False):
assert stream
data = []
stream.settimeout(2)
while True:
try:
if is_unix:
buf = stream.recv(1024)
else:
... | [
" Handles stream of data received from client. "
] |
Please provide a description of the function:def parallel_scan(self, scan_id, target):
try:
ret = self.exec_scan(scan_id, target)
if ret == 0:
self.add_scan_host_detail(scan_id, name='host_status',
host=target, value='0')... | [
" Starts the scan with scan_id. "
] |
Please provide a description of the function:def check_pending_target(self, scan_id, multiscan_proc):
for running_target_proc, running_target_id in multiscan_proc:
if not running_target_proc.is_alive():
target_prog = self.get_scan_target_progress(
scan_id... | [
" Check if a scan process is still alive. In case the process\n finished or is stopped, removes the process from the multiscan\n _process list.\n Processes dead and with progress < 100% are considered stopped\n or with failures. Then will try to stop the other runnings (target)\n ... |
Please provide a description of the function:def calculate_progress(self, scan_id):
t_prog = dict()
for target in self.get_scan_target(scan_id):
t_prog[target] = self.get_scan_target_progress(scan_id, target)
return sum(t_prog.values())/len(t_prog) | [
" Calculate the total scan progress from the\n partial target progress. "
] |
Please provide a description of the function:def start_scan(self, scan_id, targets, parallel=1):
os.setsid()
multiscan_proc = []
logger.info("%s: Scan started.", scan_id)
target_list = targets
if target_list is None or not target_list:
raise OSPDError('Erron... | [
" Handle N parallel scans if 'parallel' is greater than 1. "
] |
Please provide a description of the function:def dry_run_scan(self, scan_id, targets):
os.setsid()
for _, target in enumerate(targets):
host = resolve_hostname(target[0])
if host is None:
logger.info("Couldn't resolve %s.", target[0])
con... | [
" Dry runs a scan. "
] |
Please provide a description of the function:def handle_timeout(self, scan_id, host):
self.add_scan_error(scan_id, host=host, name="Timeout",
value="{0} exec timeout."
.format(self.get_scanner_name())) | [
" Handles scanner reaching timeout error. "
] |
Please provide a description of the function:def set_scan_host_finished(self, scan_id, target, host):
self.scan_collection.set_host_finished(scan_id, target, host) | [
" Add the host in a list of finished hosts "
] |
Please provide a description of the function:def set_scan_target_progress(
self, scan_id, target, host, progress):
self.scan_collection.set_target_progress(
scan_id, target, host, progress) | [
" Sets host's progress which is part of target. "
] |
Please provide a description of the function:def handle_get_scans_command(self, scan_et):
scan_id = scan_et.attrib.get('scan_id')
details = scan_et.attrib.get('details')
pop_res = scan_et.attrib.get('pop_results')
if details and details == '0':
details = False
... | [
" Handles <get_scans> command.\n\n @return: Response string for <get_scans> command.\n "
] |
Please provide a description of the function:def handle_get_vts_command(self, vt_et):
vt_id = vt_et.attrib.get('vt_id')
vt_filter = vt_et.attrib.get('filter')
if vt_id and vt_id not in self.vts:
text = "Failed to find vulnerability test '{0}'".format(vt_id)
ret... | [
" Handles <get_vts> command.\n\n @return: Response string for <get_vts> command.\n "
] |
Please provide a description of the function:def handle_help_command(self, scan_et):
help_format = scan_et.attrib.get('format')
if help_format is None or help_format == "text":
# Default help format is text.
return simple_response_str('help', 200, 'OK',
... | [
" Handles <help> command.\n\n @return: Response string for <help> command.\n "
] |
Please provide a description of the function:def get_help_text(self):
txt = str('\n')
for name, info in self.commands.items():
command_txt = "\t{0: <22} {1}\n".format(name, info['description'])
if info['attributes']:
command_txt = ''.join([command_txt, "... | [
" Returns the help output in plain text format."
] |
Please provide a description of the function:def elements_as_text(self, elems, indent=2):
assert elems
text = ""
for elename, eledesc in elems.items():
if isinstance(eledesc, dict):
desc_txt = self.elements_as_text(eledesc, indent + 2)
desc_tx... | [
" Returns the elems dictionary as formatted plain text. "
] |
Please provide a description of the function:def handle_delete_scan_command(self, scan_et):
scan_id = scan_et.attrib.get('scan_id')
if scan_id is None:
return simple_response_str('delete_scan', 404,
'No scan_id attribute')
if not self.... | [
" Handles <delete_scan> command.\n\n @return: Response string for <delete_scan> command.\n "
] |
Please provide a description of the function:def delete_scan(self, scan_id):
if self.get_scan_status(scan_id) == ScanStatus.RUNNING:
return 0
try:
del self.scan_processes[scan_id]
except KeyError:
logger.debug('Scan process for %s not found', scan_id... | [
" Deletes scan_id scan from collection.\n\n @return: 1 if scan deleted, 0 otherwise.\n "
] |
Please provide a description of the function:def get_scan_results_xml(self, scan_id, pop_res):
results = Element('results')
for result in self.scan_collection.results_iterator(scan_id, pop_res):
results.append(get_result_xml(result))
logger.info('Returning %d results', len(... | [
" Gets scan_id scan's results in XML format.\n\n @return: String of scan results in xml.\n "
] |
Please provide a description of the function:def get_xml_str(self, data):
responses = []
for tag, value in data.items():
elem = Element(tag)
if isinstance(value, dict):
for value in self.get_xml_str(value):
elem.append(value)
... | [
" Creates a string in XML Format using the provided data structure.\n\n @param: Dictionary of xml tags and their elements.\n\n @return: String of data in xml format.\n "
] |
Please provide a description of the function:def get_scan_xml(self, scan_id, detailed=True, pop_res=False):
if not scan_id:
return Element('scan')
target = ','.join(self.get_scan_target(scan_id))
progress = self.get_scan_progress(scan_id)
status = self.get_scan_stat... | [
" Gets scan in XML format.\n\n @return: String of scan in XML format.\n "
] |
Please provide a description of the function:def get_vt_xml(self, vt_id):
if not vt_id:
return Element('vt')
vt = self.vts.get(vt_id)
name = vt.get('name')
vt_xml = Element('vt')
vt_xml.set('id', vt_id)
for name, value in [('name', name)]:
... | [
" Gets a single vulnerability test information in XML format.\n\n @return: String of single vulnerability test information in XML format.\n "
] |
Please provide a description of the function:def get_vts_xml(self, vt_id=None, filtered_vts=None):
vts_xml = Element('vts')
if vt_id:
vts_xml.append(self.get_vt_xml(vt_id))
elif filtered_vts:
for vt_id in filtered_vts:
vts_xml.append(self.get_vt... | [
" Gets collection of vulnerability test information in XML format.\n If vt_id is specified, the collection will contain only this vt, if\n found.\n If no vt_id is specified, the collection will contain all vts or those\n passed in filtered_vts.\n\n Arguments:\n vt_id (v... |
Please provide a description of the function:def handle_get_scanner_details(self):
desc_xml = Element('description')
desc_xml.text = self.get_scanner_description()
details = [
desc_xml,
self.get_scanner_params_xml()
]
return simple_response_str('g... | [
" Handles <get_scanner_details> command.\n\n @return: Response string for <get_scanner_details> command.\n "
] |
Please provide a description of the function:def handle_get_version_command(self):
protocol = Element('protocol')
for name, value in [('name', 'OSP'), ('version', self.get_protocol_version())]:
elem = SubElement(protocol, name)
elem.text = value
daemon = Element... | [
" Handles <get_version> command.\n\n @return: Response string for <get_version> command.\n "
] |
Please provide a description of the function:def handle_command(self, command):
try:
tree = secET.fromstring(command)
except secET.ParseError:
logger.debug("Erroneous client input: %s", command)
raise OSPDError('Invalid data')
if not self.command_exi... | [
" Handles an osp command in a string.\n\n @return: OSP Response to command.\n "
] |
Please provide a description of the function:def run(self, address, port, unix_path):
assert address or unix_path
if unix_path:
sock = bind_unix_socket(unix_path)
else:
sock = bind_socket(address, port)
if sock is None:
return False
s... | [
" Starts the Daemon, handling commands until interrupted.\n\n @return False if error. Runs indefinitely otherwise.\n "
] |
Please provide a description of the function:def create_scan(self, scan_id, targets, options, vts):
if self.scan_exists(scan_id):
logger.info("Scan %s exists. Resuming scan.", scan_id)
return self.scan_collection.create_scan(scan_id, targets, options, vts) | [
" Creates a new scan.\n\n @target: Target to scan.\n @options: Miscellaneous scan options.\n\n @return: New scan's ID.\n "
] |
Please provide a description of the function:def set_scan_option(self, scan_id, name, value):
return self.scan_collection.set_option(scan_id, name, value) | [
" Sets a scan's option to a provided value. "
] |
Please provide a description of the function:def check_scan_process(self, scan_id):
scan_process = self.scan_processes[scan_id]
progress = self.get_scan_progress(scan_id)
if progress < 100 and not scan_process.is_alive():
self.set_scan_status(scan_id, ScanStatus.STOPPED)
... | [
" Check the scan's process, and terminate the scan if not alive. "
] |
Please provide a description of the function:def add_scan_log(self, scan_id, host='', name='', value='', port='',
test_id='', qod=''):
self.scan_collection.add_result(scan_id, ResultType.LOG, host, name,
value, port, test_id, 0.0, qod) | [
" Adds a log result to scan_id scan. "
] |
Please provide a description of the function:def add_scan_error(self, scan_id, host='', name='', value='', port=''):
self.scan_collection.add_result(scan_id, ResultType.ERROR, host, name,
value, port) | [
" Adds an error result to scan_id scan. "
] |
Please provide a description of the function:def add_scan_host_detail(self, scan_id, host='', name='', value=''):
self.scan_collection.add_result(scan_id, ResultType.HOST_DETAIL, host,
name, value) | [
" Adds a host detail result to scan_id scan. "
] |
Please provide a description of the function:def add_scan_alarm(self, scan_id, host='', name='', value='', port='',
test_id='', severity='', qod=''):
self.scan_collection.add_result(scan_id, ResultType.ALARM, host, name,
value, port, test_i... | [
" Adds an alarm result to scan_id scan. "
] |
Please provide a description of the function:def parse_filters(self, vt_filter):
filter_list = vt_filter.split(';')
filters = list()
for single_filter in filter_list:
filter_aux = re.split('(\W)', single_filter, 1)
if len(filter_aux) < 3:
raise O... | [
" Parse a string containing one or more filters\n and return a list of filters\n\n Arguments:\n vt_filter (string): String containing filters separated with\n semicolon.\n Return:\n List with filters. Each filters is a list with 3 elements\n e.g. ... |
Please provide a description of the function:def format_filter_value(self, element, value):
format_func = self.allowed_filter.get(element)
return format_func(value) | [
" Calls the specific function to format value,\n depending on the given element.\n\n Arguments:\n element (string): The element of the VT to be formatted.\n value (dictionary): The element value.\n\n Returns:\n Returns a formatted value.\n\n "
] |
Please provide a description of the function:def get_filtered_vts_list(self, vts, vt_filter):
if not vt_filter:
raise RequiredArgument('vt_filter: A valid filter is required.')
filters = self.parse_filters(vt_filter)
if not filters:
return None
_vts_aux... | [
" Gets a collection of vulnerability test from the vts dictionary,\n which match the filter.\n\n Arguments:\n vt_filter (string): Filter to apply to the vts collection.\n vts (dictionary): The complete vts collection.\n\n Returns:\n Dictionary with filtered vuln... |
Please provide a description of the function:def cvss_base_v2_value(cls, cvss_base_vector):
if not cvss_base_vector:
return None
_av, _ac, _au, _c, _i, _a = cls._parse_cvss_base_vector(
cvss_base_vector)
_impact = 10.41 * (1 - (1 - cvss_v2_metrics['C'].get(_c))... | [
" Calculate the cvss base score from a cvss base vector\n for cvss version 2.\n Arguments:\n cvss_base_vector (str) Cvss base vector v2.\n\n Return the calculated score\n "
] |
Please provide a description of the function:def cvss_base_v3_value(cls, cvss_base_vector):
if not cvss_base_vector:
return None
_ver, _av, _ac, _pr, _ui, _s, _c, _i, _a = cls._parse_cvss_base_vector(
cvss_base_vector)
scope_changed = cvss_v3_metrics['S'].get(_s... | [
" Calculate the cvss base score from a cvss base vector\n for cvss version 3.\n Arguments:\n cvss_base_vector (str) Cvss base vector v3.\n\n Return the calculated score, None on fail.\n "
] |
Please provide a description of the function:def inet_pton(address_family, ip_string):
global __inet_pton
if __inet_pton is None:
if hasattr(socket, 'inet_pton'):
__inet_pton = socket.inet_pton
else:
from ospd import win_socket
__inet_pton = win_socket.in... | [
" A platform independent version of inet_pton "
] |
Please provide a description of the function:def inet_ntop(address_family, packed_ip):
global __inet_ntop
if __inet_ntop is None:
if hasattr(socket, 'inet_ntop'):
__inet_ntop = socket.inet_ntop
else:
from ospd import win_socket
__inet_ntop = win_socket.in... | [
" A platform independent version of inet_ntop "
] |
Please provide a description of the function:def ipv4_range_to_list(start_packed, end_packed):
new_list = list()
start = struct.unpack('!L', start_packed)[0]
end = struct.unpack('!L', end_packed)[0]
for value in range(start, end + 1):
new_ip = socket.inet_ntoa(struct.pack('!L', value))
... | [
" Return a list of IPv4 entries from start_packed to end_packed. "
] |
Please provide a description of the function:def target_to_ipv4_short(target):
splitted = target.split('-')
if len(splitted) != 2:
return None
try:
start_packed = inet_pton(socket.AF_INET, splitted[0])
end_value = int(splitted[1])
except (socket.error, ValueError):
... | [
" Attempt to return a IPv4 short range list from a target string. "
] |
Please provide a description of the function:def target_to_ipv4_cidr(target):
splitted = target.split('/')
if len(splitted) != 2:
return None
try:
start_packed = inet_pton(socket.AF_INET, splitted[0])
block = int(splitted[1])
except (socket.error, ValueError):
retur... | [
" Attempt to return a IPv4 CIDR list from a target string. "
] |
Please provide a description of the function:def target_to_ipv6_cidr(target):
splitted = target.split('/')
if len(splitted) != 2:
return None
try:
start_packed = inet_pton(socket.AF_INET6, splitted[0])
block = int(splitted[1])
except (socket.error, ValueError):
retu... | [
" Attempt to return a IPv6 CIDR list from a target string. "
] |
Please provide a description of the function:def target_to_ipv4_long(target):
splitted = target.split('-')
if len(splitted) != 2:
return None
try:
start_packed = inet_pton(socket.AF_INET, splitted[0])
end_packed = inet_pton(socket.AF_INET, splitted[1])
except socket.error:
... | [
" Attempt to return a IPv4 long-range list from a target string. "
] |
Please provide a description of the function:def ipv6_range_to_list(start_packed, end_packed):
new_list = list()
start = int(binascii.hexlify(start_packed), 16)
end = int(binascii.hexlify(end_packed), 16)
for value in range(start, end + 1):
high = value >> 64
low = value & ((1 << 6... | [
" Return a list of IPv6 entries from start_packed to end_packed. "
] |
Please provide a description of the function:def target_to_ipv6_short(target):
splitted = target.split('-')
if len(splitted) != 2:
return None
try:
start_packed = inet_pton(socket.AF_INET6, splitted[0])
end_value = int(splitted[1], 16)
except (socket.error, ValueError):
... | [
" Attempt to return a IPv6 short-range list from a target string. "
] |
Please provide a description of the function:def target_to_ipv6_long(target):
splitted = target.split('-')
if len(splitted) != 2:
return None
try:
start_packed = inet_pton(socket.AF_INET6, splitted[0])
end_packed = inet_pton(socket.AF_INET6, splitted[1])
except socket.error... | [
" Attempt to return a IPv6 long-range list from a target string. "
] |
Please provide a description of the function:def target_to_hostname(target):
if len(target) == 0 or len(target) > 255:
return None
if not re.match(r'^[\w.-]+$', target):
return None
return [target] | [
" Attempt to return a single hostname list from a target string. "
] |
Please provide a description of the function:def target_to_list(target):
# Is it an IPv4 address ?
new_list = target_to_ipv4(target)
# Is it an IPv6 address ?
if not new_list:
new_list = target_to_ipv6(target)
# Is it an IPv4 CIDR ?
if not new_list:
new_list = target_to_ipv... | [
" Attempt to return a list of single hosts from a target string. "
] |
Please provide a description of the function:def target_str_to_list(target_str):
new_list = list()
for target in target_str.split(','):
target = target.strip()
target_list = target_to_list(target)
if target_list:
new_list.extend(target_list)
else:
LOG... | [
" Parses a targets string into a list of individual targets. "
] |
Please provide a description of the function:def port_range_expand(portrange):
if not portrange or '-' not in portrange:
LOGGER.info("Invalid port range format")
return None
port_list = list()
for single_port in range(int(portrange[:portrange.index('-')]),
i... | [
"\n Receive a port range and expands it in individual ports.\n\n @input Port range.\n e.g. \"4-8\"\n\n @return List of integers.\n e.g. [4, 5, 6, 7, 8]\n "
] |
Please provide a description of the function:def port_str_arrange(ports):
b_tcp = ports.find("T")
b_udp = ports.find("U")
if (b_udp != -1 and b_tcp != -1) and b_udp < b_tcp:
return ports[b_tcp:] + ports[b_udp:b_tcp]
return ports | [
" Gives a str in the format (always tcp listed first).\n T:<tcp ports/portrange comma separated>U:<udp ports comma separated>\n "
] |
Please provide a description of the function:def ports_str_check_failed(port_str):
pattern = r'[^TU:0-9, \-]'
if (
re.search(pattern, port_str)
or port_str.count('T') > 1
or port_str.count('U') > 1
or port_str.count(':') < (port_str.count('T') + port_str.count('U'))
):
... | [
"\n Check if the port string is well formed.\n Return True if fail, False other case.\n "
] |
Please provide a description of the function:def ports_as_list(port_str):
if not port_str:
LOGGER.info("Invalid port value")
return [None, None]
if ports_str_check_failed(port_str):
LOGGER.info("{0}: Port list malformed.")
return [None, None]
tcp_list = list()
udp_... | [
"\n Parses a ports string into two list of individual tcp and udp ports.\n\n @input string containing a port list\n e.g. T:1,2,3,5-8 U:22,80,600-1024\n\n @return two list of sorted integers, for tcp and udp ports respectively.\n "
] |
Please provide a description of the function:def port_list_compress(port_list):
if not port_list or len(port_list) == 0:
LOGGER.info("Invalid or empty port list.")
return ''
port_list = sorted(set(port_list))
compressed_list = []
for key, group in itertools.groupby(enumerate(port_... | [
" Compress a port list and return a string. "
] |
Please provide a description of the function:def valid_uuid(value):
try:
uuid.UUID(value, version=4)
return True
except (TypeError, ValueError, AttributeError):
return False | [
" Check if value is a valid UUID. "
] |
Please provide a description of the function:def create_args_parser(description):
parser = argparse.ArgumentParser(description=description)
def network_port(string):
value = int(string)
if not 0 < value <= 65535:
raise argparse.ArgumentTypeError(
'por... | [
" Create a command-line arguments parser for OSPD. ",
" Check if provided string is a valid network port. ",
" Check if provided file is a valid CA Certificate ",
" Check if provided string is a valid log level. ",
" Check if provided string is a valid file path. "
] |
Please provide a description of the function:def go_to_background():
try:
if os.fork():
sys.exit()
except OSError as errmsg:
LOGGER.error('Fork failed: {0}'.format(errmsg))
sys.exit('Fork failed') | [
" Daemonize the running process. "
] |
Please provide a description of the function:def get_common_args(parser, args=None):
options = parser.parse_args(args)
# TCP Port to listen on.
port = options.port
# Network address to bind listener to
address = options.bind_address
# Unix file socket to listen on
unix_socket = optio... | [
" Return list of OSPD common command-line arguments from parser, after\n validating provided values or setting default ones.\n\n "
] |
Please provide a description of the function:def print_version(wrapper):
scanner_name = wrapper.get_scanner_name()
server_version = wrapper.get_server_version()
print("OSP Server for {0} version {1}".format(scanner_name, server_version))
protocol_version = wrapper.get_protocol_version()
print(... | [
" Prints the server version and license information."
] |
Please provide a description of the function:def main(name, klass):
# Common args parser.
parser = create_args_parser(name)
# Common args
cargs = get_common_args(parser)
logging.getLogger().setLevel(cargs['log_level'])
wrapper = klass(certfile=cargs['certfile'], keyfile=cargs['keyfile'],
... | [
" OSPD Main function. "
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.