idx int64 0 63k | question stringlengths 53 5.28k | target stringlengths 5 805 |
|---|---|---|
16,800 | def getThirdPartyLibLinkerFlags ( self , libs ) : fmt = PrintingFormat . singleLine ( ) if libs [ 0 ] == '--multiline' : fmt = PrintingFormat . multiLine ( ) libs = libs [ 1 : ] includeLibs = True if ( libs [ 0 ] == '--flagsonly' ) : includeLibs = False libs = libs [ 1 : ] platformDefaults = True if libs [ 0 ] == '--nodefaults' : platformDefaults = False libs = libs [ 1 : ] details = self . getThirdpartyLibs ( libs , includePlatformDefaults = platformDefaults ) return details . getLinkerFlags ( self . getEngineRoot ( ) , fmt , includeLibs ) | Retrieves the linker flags for building against the Unreal - bundled versions of the specified third - party libraries |
16,801 | def getThirdPartyLibCmakeFlags ( self , libs ) : fmt = PrintingFormat . singleLine ( ) if libs [ 0 ] == '--multiline' : fmt = PrintingFormat . multiLine ( ) libs = libs [ 1 : ] platformDefaults = True if libs [ 0 ] == '--nodefaults' : platformDefaults = False libs = libs [ 1 : ] details = self . getThirdpartyLibs ( libs , includePlatformDefaults = platformDefaults ) CMakeCustomFlags . processLibraryDetails ( details ) return details . getCMakeFlags ( self . getEngineRoot ( ) , fmt ) | Retrieves the CMake invocation flags for building against the Unreal - bundled versions of the specified third - party libraries |
16,802 | def getThirdPartyLibIncludeDirs ( self , libs ) : platformDefaults = True if libs [ 0 ] == '--nodefaults' : platformDefaults = False libs = libs [ 1 : ] details = self . getThirdpartyLibs ( libs , includePlatformDefaults = platformDefaults ) return details . getIncludeDirectories ( self . getEngineRoot ( ) , delimiter = '\n' ) | Retrieves the list of include directories for building against the Unreal - bundled versions of the specified third - party libraries |
16,803 | def getThirdPartyLibFiles ( self , libs ) : platformDefaults = True if libs [ 0 ] == '--nodefaults' : platformDefaults = False libs = libs [ 1 : ] details = self . getThirdpartyLibs ( libs , includePlatformDefaults = platformDefaults ) return details . getLibraryFiles ( self . getEngineRoot ( ) , delimiter = '\n' ) | Retrieves the list of library files for building against the Unreal - bundled versions of the specified third - party libraries |
16,804 | def getThirdPartyLibDefinitions ( self , libs ) : platformDefaults = True if libs [ 0 ] == '--nodefaults' : platformDefaults = False libs = libs [ 1 : ] details = self . getThirdpartyLibs ( libs , includePlatformDefaults = platformDefaults ) return details . getPreprocessorDefinitions ( self . getEngineRoot ( ) , delimiter = '\n' ) | Retrieves the list of preprocessor definitions for building against the Unreal - bundled versions of the specified third - party libraries |
16,805 | def generateProjectFiles ( self , dir = os . getcwd ( ) , args = [ ] ) : if os . path . exists ( os . path . join ( dir , 'Source' ) ) == False : Utility . printStderr ( 'Pure Blueprint project, nothing to generate project files for.' ) return genScript = self . getGenerateScript ( ) projectFile = self . getProjectDescriptor ( dir ) Utility . run ( [ genScript , '-project=' + projectFile , '-game' , '-engine' ] + args , cwd = os . path . dirname ( genScript ) , raiseOnError = True ) | Generates IDE project files for the Unreal project in the specified directory |
16,806 | def cleanDescriptor ( self , dir = os . getcwd ( ) ) : descriptor = self . getDescriptor ( dir ) shutil . rmtree ( os . path . join ( dir , 'Binaries' ) , ignore_errors = True ) shutil . rmtree ( os . path . join ( dir , 'Intermediate' ) , ignore_errors = True ) if self . isProject ( descriptor ) : projectPlugins = glob . glob ( os . path . join ( dir , 'Plugins' , '*' ) ) for pluginDir in projectPlugins : self . cleanDescriptor ( pluginDir ) | Cleans the build artifacts for the Unreal project or plugin in the specified directory |
16,807 | def buildDescriptor ( self , dir = os . getcwd ( ) , configuration = 'Development' , args = [ ] , suppressOutput = False ) : descriptor = self . getDescriptor ( dir ) descriptorType = 'project' if self . isProject ( descriptor ) else 'plugin' if os . path . exists ( os . path . join ( dir , 'Source' ) ) == False : Utility . printStderr ( 'Pure Blueprint {}, nothing to build.' . format ( descriptorType ) ) return if configuration not in self . validBuildConfigurations ( ) : raise UnrealManagerException ( 'invalid build configuration "' + configuration + '"' ) target = self . getDescriptorName ( descriptor ) + 'Editor' if self . isProject ( descriptor ) else 'UE4Editor' baseArgs = [ '-{}=' . format ( descriptorType ) + descriptor ] self . _runUnrealBuildTool ( target , self . getPlatformIdentifier ( ) , configuration , baseArgs + args , capture = suppressOutput ) | Builds the editor modules for the Unreal project or plugin in the specified directory using the specified build configuration |
16,808 | def runUAT ( self , args ) : Utility . run ( [ self . getRunUATScript ( ) ] + args , cwd = self . getEngineRoot ( ) , raiseOnError = True ) | Runs the Unreal Automation Tool with the supplied arguments |
16,809 | def packageProject ( self , dir = os . getcwd ( ) , configuration = 'Shipping' , extraArgs = [ ] ) : if configuration not in self . validBuildConfigurations ( ) : raise UnrealManagerException ( 'invalid build configuration "' + configuration + '"' ) extraArgs = Utility . stripArgs ( extraArgs , [ '-nocompileeditor' ] ) platformArgs = Utility . findArgs ( extraArgs , [ '-platform=' , '-targetplatform=' ] ) platform = Utility . getArgValue ( platformArgs [ 0 ] ) if len ( platformArgs ) > 0 else self . getPlatformIdentifier ( ) extraArgs = Utility . stripArgs ( extraArgs , platformArgs ) + [ '-platform={}' . format ( platform ) ] if configuration == 'Shipping' : extraArgs . append ( '-nodebuginfo' ) pakArg = '-package' if platform . upper ( ) == 'HTML5' else '-pak' distDir = os . path . join ( os . path . abspath ( dir ) , 'dist' ) self . runUAT ( [ 'BuildCookRun' , '-utf8output' , '-clientconfig=' + configuration , '-serverconfig=' + configuration , '-project=' + self . getProjectDescriptor ( dir ) , '-noP4' , '-cook' , '-allmaps' , '-build' , '-stage' , '-prereqs' , pakArg , '-archive' , '-archivedirectory=' + distDir ] + extraArgs ) | Packages a build of the Unreal project in the specified directory using common packaging options |
16,810 | def packagePlugin ( self , dir = os . getcwd ( ) , extraArgs = [ ] ) : distDir = os . path . join ( os . path . abspath ( dir ) , 'dist' ) self . runUAT ( [ 'BuildPlugin' , '-Plugin=' + self . getPluginDescriptor ( dir ) , '-Package=' + distDir ] + extraArgs ) | Packages a build of the Unreal plugin in the specified directory suitable for use as a prebuilt Engine module |
16,811 | def packageDescriptor ( self , dir = os . getcwd ( ) , args = [ ] ) : descriptor = self . getDescriptor ( dir ) if self . isProject ( descriptor ) : self . packageProject ( dir , args [ 0 ] if len ( args ) > 0 else 'Shipping' , args [ 1 : ] ) else : self . packagePlugin ( dir , args ) | Packages a build of the Unreal project or plugin in the specified directory |
16,812 | def runAutomationCommands ( self , projectFile , commands , capture = False ) : command = '{} {}' . format ( Utility . escapePathForShell ( self . getEditorBinary ( True ) ) , Utility . escapePathForShell ( projectFile ) ) command += ' -game -buildmachine -stdout -fullstdoutlogoutput -forcelogflush -unattended -nopause -nullrhi -nosplash' command += ' -ExecCmds="automation {};quit"' . format ( ';' . join ( commands ) ) if capture == True : return Utility . capture ( command , shell = True ) else : Utility . run ( command , shell = True ) | Invokes the Automation Test commandlet for the specified project with the supplied automation test commands |
16,813 | def _getEngineVersionDetails ( self ) : versionFile = os . path . join ( self . getEngineRoot ( ) , 'Engine' , 'Build' , 'Build.version' ) return json . loads ( Utility . readFile ( versionFile ) ) | Parses the JSON version details for the latest installed version of UE4 |
16,814 | def _getEngineVersionHash ( self ) : versionDetails = self . _getEngineVersionDetails ( ) hash = hashlib . sha256 ( ) hash . update ( json . dumps ( versionDetails , sort_keys = True , indent = 0 ) . encode ( 'utf-8' ) ) return hash . hexdigest ( ) | Computes the SHA - 256 hash of the JSON version details for the latest installed version of UE4 |
16,815 | def _runUnrealBuildTool ( self , target , platform , configuration , args , capture = False ) : platform = self . _transformBuildToolPlatform ( platform ) arguments = [ self . getBuildScript ( ) , target , platform , configuration ] + args if capture == True : return Utility . capture ( arguments , cwd = self . getEngineRoot ( ) , raiseOnError = True ) else : Utility . run ( arguments , cwd = self . getEngineRoot ( ) , raiseOnError = True ) | Invokes UnrealBuildTool with the specified parameters |
16,816 | def _getUE4BuildInterrogator ( self ) : ubtLambda = lambda target , platform , config , args : self . _runUnrealBuildTool ( target , platform , config , args , True ) interrogator = UE4BuildInterrogator ( self . getEngineRoot ( ) , self . _getEngineVersionDetails ( ) , self . _getEngineVersionHash ( ) , ubtLambda ) return interrogator | Uses UE4BuildInterrogator to interrogate UnrealBuildTool about third - party library details |
16,817 | def getKey ( self , key ) : data = self . getDictionary ( ) if key in data : return data [ key ] else : return None | Retrieves the value for the specified dictionary key |
16,818 | def getDictionary ( self ) : if os . path . exists ( self . jsonFile ) : return json . loads ( Utility . readFile ( self . jsonFile ) ) else : return { } | Retrieves the entire data dictionary |
16,819 | def setKey ( self , key , value ) : data = self . getDictionary ( ) data [ key ] = value self . setDictionary ( data ) | Sets the value for the specified dictionary key |
16,820 | def setDictionary ( self , data ) : jsonDir = os . path . dirname ( self . jsonFile ) if os . path . exists ( jsonDir ) == False : os . makedirs ( jsonDir ) Utility . writeFile ( self . jsonFile , json . dumps ( data ) ) | Overwrites the entire dictionary |
16,821 | def list ( self , platformIdentifier , configuration , libOverrides = { } ) : modules = self . _getThirdPartyLibs ( platformIdentifier , configuration ) return sorted ( [ m [ 'Name' ] for m in modules ] + [ key for key in libOverrides ] ) | Returns the list of supported UE4 - bundled third - party libraries |
16,822 | def interrogate ( self , platformIdentifier , configuration , libraries , libOverrides = { } ) : libModules = list ( [ lib for lib in libraries if lib not in libOverrides ] ) details = ThirdPartyLibraryDetails ( ) if len ( libModules ) > 0 : modules = self . _getThirdPartyLibs ( platformIdentifier , configuration ) modules = [ m for m in modules if m [ 'Name' ] in libModules ] names = [ m [ 'Name' ] for m in modules ] unsupported = [ '"' + m + '"' for m in libModules if m not in names ] if len ( unsupported ) > 0 : Utility . printStderr ( 'Warning: unsupported libraries ' + ',' . join ( unsupported ) ) for module in modules : if len ( module [ 'PublicAdditionalLibraries' ] ) > 0 and len ( module [ 'PublicLibraryPaths' ] ) > 0 : libPath = ( self . _absolutePaths ( module [ 'PublicLibraryPaths' ] ) ) [ 0 ] libs = list ( [ lib . replace ( '\\' , '/' ) for lib in module [ 'PublicAdditionalLibraries' ] ] ) libs = list ( [ os . path . join ( libPath , lib ) if '/' not in lib else lib for lib in libs ] ) module [ 'PublicAdditionalLibraries' ] = libs fields = [ 'Directory' , 'PublicAdditionalLibraries' , 'PublicLibraryPaths' , 'PublicSystemIncludePaths' , 'PublicIncludePaths' , 'PrivateIncludePaths' , 'PublicDefinitions' ] flattened = { } for field in fields : transform = ( lambda l : self . _absolutePaths ( l ) ) if field != 'Definitions' else None flattened [ field ] = self . _flatten ( field , modules , transform ) libraryDirectories = flattened [ 'PublicLibraryPaths' ] headerDirectories = flattened [ 'PublicSystemIncludePaths' ] + flattened [ 'PublicIncludePaths' ] + flattened [ 'PrivateIncludePaths' ] modulePaths = flattened [ 'Directory' ] prefixDirectories = list ( set ( flattened [ 'Directory' ] + headerDirectories + libraryDirectories + [ os . path . dirname ( p ) for p in headerDirectories + libraryDirectories ] ) ) details = ThirdPartyLibraryDetails ( prefixDirs = prefixDirectories , includeDirs = headerDirectories , linkDirs = libraryDirectories , definitions = flattened [ 'PublicDefinitions' ] , libs = flattened [ 'PublicAdditionalLibraries' ] ) overridesToApply = list ( [ libOverrides [ lib ] for lib in libraries if lib in libOverrides ] ) for override in overridesToApply : details . merge ( override ) return details | Interrogates UnrealBuildTool about the build flags for the specified third - party libraries |
16,823 | def _flatten ( self , field , items , transform = None ) : values = [ item [ field ] for item in items ] flattened = [ ] for value in values : flattened . extend ( [ value ] if isinstance ( value , str ) else value ) return transform ( flattened ) if transform != None else flattened | Extracts the entry field from each item in the supplied iterable flattening any nested lists |
16,824 | def _getThirdPartyLibs ( self , platformIdentifier , configuration ) : cachedList = CachedDataManager . getCachedDataKey ( self . engineVersionHash , 'ThirdPartyLibraries' ) if cachedList != None : return cachedList tempDir = tempfile . mkdtemp ( ) jsonFile = os . path . join ( tempDir , 'ubt_output.json' ) sentinelFile = os . path . join ( self . engineRoot , 'Engine' , 'Build' , 'InstalledBuild.txt' ) sentinelBackup = sentinelFile + '.bak' renameSentinel = os . path . exists ( sentinelFile ) and os . environ . get ( 'UE4CLI_SENTINEL_RENAME' , '0' ) == '1' if renameSentinel == True : shutil . move ( sentinelFile , sentinelBackup ) try : args = [ '-Mode=JsonExport' , '-OutputFile=' + jsonFile ] if self . engineVersion [ 'MinorVersion' ] >= 22 else [ '-gather' , '-jsonexport=' + jsonFile , '-SkipBuild' ] self . runUBTFunc ( 'UE4Editor' , platformIdentifier , configuration , args ) finally : if renameSentinel == True : shutil . move ( sentinelBackup , sentinelFile ) result = json . loads ( Utility . readFile ( jsonFile ) ) modules = [ result [ 'Modules' ] [ key ] for key in result [ 'Modules' ] ] thirdPartyRoot = os . path . join ( self . engineRoot , 'Engine' , 'Source' , 'ThirdParty' ) thirdparty = list ( [ m for m in modules if thirdPartyRoot in m [ 'Directory' ] ] ) try : shutil . rmtree ( tempDir ) except : pass CachedDataManager . setCachedDataKey ( self . engineVersionHash , 'ThirdPartyLibraries' , thirdparty ) return thirdparty | Runs UnrealBuildTool in JSON export mode and extracts the list of third - party libraries |
16,825 | def processLibraryDetails ( details ) : for includeDir in details . includeDirs : for pattern in CUSTOM_FLAGS_FOR_INCLUDE_DIRS : if pattern in includeDir : flag = '-D' + CUSTOM_FLAGS_FOR_INCLUDE_DIRS [ pattern ] + '=' + includeDir details . cmakeFlags . append ( flag ) for lib in details . libs : filename = os . path . basename ( lib ) ( name , ext ) = os . path . splitext ( filename ) libName = name . replace ( 'lib' , '' ) if name . startswith ( 'lib' ) else name libName = libName . rstrip ( '_-1234567890' ) if libName in CUSTOM_FLAGS_FOR_LIBS : flag = '-D' + CUSTOM_FLAGS_FOR_LIBS [ libName ] + '=' + lib details . cmakeFlags . append ( flag ) | Processes the supplied ThirdPartyLibraryDetails instance and sets any custom CMake flags |
16,826 | def getPlugins ( ) : plugins = { entry_point . name : entry_point . load ( ) for entry_point in pkg_resources . iter_entry_points ( 'ue4cli.plugins' ) } plugins = { name : plugins [ name ] for name in plugins if 'action' in plugins [ name ] and 'description' in plugins [ name ] and 'args' in plugins [ name ] and callable ( plugins [ name ] [ 'action' ] ) == True and len ( signature ( plugins [ name ] [ 'action' ] ) . parameters ) == 2 } return plugins | Returns the list of valid ue4cli plugins |
16,827 | 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 . cxxFlags , engineRoot ) , fmt . quotes ) | Constructs the compiler flags string for building against this library |
16,828 | 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 . resolveRoot ( self . libs , engineRoot ) ) return Utility . join ( fmt . delim , components , fmt . quotes ) | Constructs the linker flags string for building against this library |
16,829 | def getPrefixDirectories ( self , engineRoot , delimiter = ' ' ) : return delimiter . join ( self . resolveRoot ( self . prefixDirs , engineRoot ) ) | Returns the list of prefix directories for this library joined using the specified delimiter |
16,830 | def getIncludeDirectories ( self , engineRoot , delimiter = ' ' ) : return delimiter . join ( self . resolveRoot ( self . includeDirs , engineRoot ) ) | Returns the list of include directories for this library joined using the specified delimiter |
16,831 | def getLinkerDirectories ( self , engineRoot , delimiter = ' ' ) : return delimiter . join ( self . resolveRoot ( self . linkDirs , engineRoot ) ) | Returns the list of linker directories for this library joined using the specified delimiter |
16,832 | def getLibraryFiles ( self , engineRoot , delimiter = ' ' ) : return delimiter . join ( self . resolveRoot ( self . libs , engineRoot ) ) | Returns the list of library files for this library joined using the specified delimiter |
16,833 | def getPreprocessorDefinitions ( self , engineRoot , delimiter = ' ' ) : return delimiter . join ( self . resolveRoot ( self . definitions , engineRoot ) ) | Returns the list of preprocessor definitions for this library joined using the specified delimiter |
16,834 | 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 . getLinkerDirectories ( engineRoot , ';' ) , ] + self . resolveRoot ( self . cmakeFlags , engineRoot ) , fmt . quotes ) | Constructs the CMake invocation flags string for building against this library |
16,835 | 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 . |
16,836 | 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 : pass return "{} edx-rest-api-client/{} {}" . format ( requests . utils . default_user_agent ( ) , __version__ , client_name ) | Return a User - Agent that identifies this client . |
16,837 | 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_id , 'client_secret' : client_secret , 'token_type' : token_type , } if refresh_token : data [ 'refresh_token' ] = refresh_token else : assert grant_type != 'refresh_token' , "refresh_token parameter required" response = requests . post ( url , data = data , headers = { 'User-Agent' : USER_AGENT , } , ) data = response . json ( ) try : access_token = data [ 'access_token' ] expires_in = data [ 'expires_in' ] except KeyError : raise requests . RequestException ( response = response ) expires_at = now + datetime . timedelta ( seconds = expires_in ) return access_token , expires_at | Retrieves OAuth 2 . 0 access token using the given grant type . |
16,838 | def request ( self , method , url , ** kwargs ) : self . _check_auth ( ) return super ( OAuthAPIClient , self ) . request ( method , url , ** kwargs ) | Overrides Session . request to ensure that the session is authenticated |
16,839 | 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_timeout' ] ) credentials = self . get_scan_credentials ( scan_id , host ) if ( 'username_password' in options and ':' in options [ 'username_password' ] ) : username , password = options [ 'username_password' ] . split ( ':' , 1 ) elif 'username' in options and options [ 'username' ] : username = options [ 'username' ] password = options [ 'password' ] elif credentials : cred_params = credentials . get ( 'ssh' ) username = cred_params . get ( 'username' , '' ) password = cred_params . get ( 'password' , '' ) else : self . add_scan_error ( scan_id , host = host , value = 'Erroneous username_password value' ) raise ValueError ( 'Erroneous username_password value' ) try : ssh . connect ( hostname = host , username = username , password = password , timeout = timeout , port = port ) except ( paramiko . ssh_exception . AuthenticationException , socket . error ) as err : self . add_scan_error ( scan_id , host = host , value = str ( err ) ) return None _ , stdout , _ = ssh . exec_command ( cmd ) result = stdout . readlines ( ) ssh . close ( ) return result | Run a single command via SSH and return the content of stdout or None in case of an Error . A scan error is issued in the latter case . |
16,840 | 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' ] ) , ( 'host' , result [ 'host' ] ) , ( 'test_id' , result [ 'test_id' ] ) , ( 'port' , result [ 'port' ] ) , ( 'qod' , result [ 'qod' ] ) ] : result_xml . set ( name , str ( value ) ) result_xml . text = result [ 'value' ] return result_xml | Formats a scan result to XML format . |
16,841 | 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 ) : for elem in content : response . append ( elem ) elif isinstance ( content , Element ) : response . append ( content ) else : response . text = content return tostring ( response ) | Creates an OSP response XML string . |
16,842 | 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 ( ) logger . debug ( '%s:%s: Connection closed' , peer [ 0 ] , peer [ 1 ] ) except ( socket . error , OSError ) as exception : logger . debug ( 'Connection closing error: %s' , exception ) client_stream . close ( ) | Closes provided client stream |
16,843 | 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 . |
16,844 | 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' : { k : v [ 'name' ] for k , v in self . scanner_params . items ( ) } } | Add a scanner parameter . |
16,845 | 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_t = None , detection = None , qod_t = None , qod_v = None , severities = None ) : if not vt_id : return - 2 if self . vt_id_pattern . fullmatch ( vt_id ) is None : return - 2 if vt_id in self . vts : return - 1 if name is None : name = '' self . vts [ vt_id ] = { 'name' : name } if custom is not None : self . vts [ vt_id ] [ "custom" ] = custom if vt_params is not None : self . vts [ vt_id ] [ "vt_params" ] = vt_params if vt_refs is not None : self . vts [ vt_id ] [ "vt_refs" ] = vt_refs if vt_dependencies is not None : self . vts [ vt_id ] [ "vt_dependencies" ] = vt_dependencies if vt_creation_time is not None : self . vts [ vt_id ] [ "creation_time" ] = vt_creation_time if vt_modification_time is not None : self . vts [ vt_id ] [ "modification_time" ] = vt_modification_time if summary is not None : self . vts [ vt_id ] [ "summary" ] = summary if impact is not None : self . vts [ vt_id ] [ "impact" ] = impact if affected is not None : self . vts [ vt_id ] [ "affected" ] = affected if insight is not None : self . vts [ vt_id ] [ "insight" ] = insight if solution is not None : self . vts [ vt_id ] [ "solution" ] = solution if solution_t is not None : self . vts [ vt_id ] [ "solution_type" ] = solution_t if detection is not None : self . vts [ vt_id ] [ "detection" ] = detection if qod_t is not None : self . vts [ vt_id ] [ "qod_type" ] = qod_t elif qod_v is not None : self . vts [ vt_id ] [ "qod" ] = qod_v if severities is not None : self . vts [ vt_id ] [ "severities" ] = severities return len ( self . vts ) | Add a vulnerability test information . |
16,846 | def _preprocess_scan_params ( self , xml_params ) : params = { } for param in xml_params : params [ param . tag ] = param . text or '' for key in self . scanner_params : if key not in params : params [ key ] = self . get_scanner_param_default ( key ) if self . get_scanner_param_type ( key ) == 'selection' : params [ key ] = params [ key ] . split ( '|' ) [ 0 ] for key in params : param_type = self . get_scanner_param_type ( key ) if not param_type : continue if param_type in [ 'integer' , 'boolean' ] : try : params [ key ] = int ( params [ key ] ) except ValueError : raise OSPDError ( 'Invalid %s value' % key , 'start_scan' ) if param_type == 'boolean' : if params [ key ] not in [ 0 , 1 ] : raise OSPDError ( 'Invalid %s value' % key , 'start_scan' ) elif param_type == 'selection' : selection = self . get_scanner_param_default ( key ) . split ( '|' ) if params [ key ] not in selection : raise OSPDError ( 'Invalid %s value' % key , 'start_scan' ) if self . get_scanner_param_mandatory ( key ) and params [ key ] == '' : raise OSPDError ( 'Mandatory %s value is missing' % key , 'start_scan' ) return params | Processes the scan parameters . |
16,847 | 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 ] = { } for vt_value in vt : if not vt_value . attrib . get ( 'id' ) : raise OSPDError ( 'Invalid VT preference. No attribute id' , 'start_scan' ) vt_value_id = vt_value . attrib . get ( 'id' ) vt_value_value = vt_value . text if vt_value . text else '' vt_selection [ vt_id ] [ vt_value_id ] = vt_value_value if vt . tag == 'vt_group' : vts_filter = vt . attrib . get ( 'filter' , None ) if vts_filter is None : raise OSPDError ( 'Invalid VT group. No filter given.' , 'start_scan' ) filters . append ( vts_filter ) vt_selection [ 'vt_groups' ] = filters return vt_selection | Receive an XML object with the Vulnerability Tests an their parameters to be use in a scan and return a dictionary . |
16,848 | 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 ( 'type' ) if service == 'ssh' : credentials [ service ] [ 'port' ] = credential . attrib . get ( 'port' ) for param in credential : credentials [ service ] [ param . tag ] = param . text return credentials | Receive an XML object with the credentials to run a scan against a given target . |
16,849 | 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 = child . text if child . tag == 'ports' : ports = child . text if child . tag == 'credentials' : credentials = cls . process_credentials_elements ( child ) if hosts : target_list . append ( [ hosts , ports , credentials ] ) else : raise OSPDError ( 'No target to scan' , 'start_scan' ) return target_list | Receive an XML object with the target ports and credentials to run a scan against . |
16,850 | 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 . |
16,851 | 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 . |
16,852 | 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 . |
16,853 | 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 . |
16,854 | 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 ) , ( 'type' , param [ 'type' ] ) ] : param_xml . set ( name , value ) for name , value in [ ( 'name' , param [ 'name' ] ) , ( 'description' , param [ 'description' ] ) , ( 'default' , param [ 'default' ] ) , ( 'mandatory' , param [ 'mandatory' ] ) ] : elem = SubElement ( param_xml , name ) elem . text = str ( value ) return scanner_params | Returns the OSP Daemon s scanner params in xml format . |
16,855 | def new_client_stream ( self , sock ) : assert sock newsocket , fromaddr = sock . accept ( ) logger . debug ( "New connection from" " %s:%s" , fromaddr [ 0 ] , fromaddr [ 1 ] ) try : ssl_socket = ssl . wrap_socket ( newsocket , cert_reqs = ssl . CERT_REQUIRED , server_side = True , certfile = self . certs [ 'cert_file' ] , keyfile = self . certs [ 'key_file' ] , ca_certs = self . certs [ 'ca_file' ] , ssl_version = ssl . PROTOCOL_SSLv23 ) except ( ssl . SSLError , socket . error ) as message : logger . error ( message ) return None return ssl_socket | Returns a new ssl client stream from bind_socket . |
16,856 | 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 stream ( response [ i_start : i_end ] ) i_start = i_end i_end += block_len except ( socket . timeout , socket . error ) as exception : logger . debug ( 'Error sending response to the client: %s' , exception ) | Send the response in blocks of the given len using the passed method dependending on the socket type . |
16,857 | 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 : buf = stream . read ( 1024 ) if not buf : break data . append ( buf ) except ( AttributeError , ValueError ) as message : logger . error ( message ) return except ( ssl . SSLError ) as exception : logger . debug ( 'Error: %s' , exception [ 0 ] ) break except ( socket . timeout ) as exception : logger . debug ( 'Error: %s' , exception ) break data = b'' . join ( data ) if len ( data ) <= 0 : logger . debug ( "Empty client stream" ) return try : response = self . handle_command ( data ) except OSPDError as exception : response = exception . as_xml ( ) logger . debug ( 'Command error: %s' , exception . message ) except Exception : logger . exception ( 'While handling client command:' ) exception = OSPDError ( 'Fatal error' , 'error' ) response = exception . as_xml ( ) if is_unix : send_method = stream . send else : send_method = stream . write self . write_to_stream ( send_method , response ) | Handles stream of data received from client . |
16,858 | 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' ) elif ret == 1 : self . add_scan_host_detail ( scan_id , name = 'host_status' , host = target , value = '1' ) elif ret == 2 : self . add_scan_host_detail ( scan_id , name = 'host_status' , host = target , value = '2' ) else : logger . debug ( '%s: No host status returned' , target ) except Exception as e : self . add_scan_error ( scan_id , name = '' , host = target , value = 'Host process failure (%s).' % e ) logger . exception ( 'While scanning %s:' , target ) else : logger . info ( "%s: Host scan finished." , target ) | Starts the scan with scan_id . |
16,859 | 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 partial target progress . |
16,860 | 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 ( 'Erroneous targets list' , 'start_scan' ) for index , target in enumerate ( target_list ) : while len ( multiscan_proc ) >= parallel : progress = self . calculate_progress ( scan_id ) self . set_scan_progress ( scan_id , progress ) multiscan_proc = self . check_pending_target ( scan_id , multiscan_proc ) time . sleep ( 1 ) if self . get_scan_status ( scan_id ) == ScanStatus . STOPPED : return logger . info ( "%s: Host scan started on ports %s." , target [ 0 ] , target [ 1 ] ) scan_process = multiprocessing . Process ( target = self . parallel_scan , args = ( scan_id , target [ 0 ] ) ) multiscan_proc . append ( ( scan_process , target [ 0 ] ) ) scan_process . start ( ) self . set_scan_status ( scan_id , ScanStatus . RUNNING ) while multiscan_proc : multiscan_proc = self . check_pending_target ( scan_id , multiscan_proc ) if multiscan_proc : progress = self . calculate_progress ( scan_id ) self . set_scan_progress ( scan_id , progress ) time . sleep ( 1 ) if self . get_scan_status ( scan_id ) != ScanStatus . STOPPED : self . finish_scan ( scan_id ) | Handle N parallel scans if parallel is greater than 1 . |
16,861 | 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 ] ) continue port = self . get_scan_ports ( scan_id , target = target [ 0 ] ) logger . info ( "%s:%s: Dry run mode." , host , port ) self . add_scan_log ( scan_id , name = '' , host = host , value = 'Dry run result' ) self . finish_scan ( scan_id ) | Dry runs a scan . |
16,862 | 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 . |
16,863 | 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 . |
16,864 | 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 , "\t Attributes:\n" ] ) for attrname , attrdesc in info [ 'attributes' ] . items ( ) : attr_txt = "\t {0: <22} {1}\n" . format ( attrname , attrdesc ) command_txt = '' . join ( [ command_txt , attr_txt ] ) if info [ 'elements' ] : command_txt = '' . join ( [ command_txt , "\t Elements:\n" , self . elements_as_text ( info [ 'elements' ] ) ] ) txt = '' . join ( [ txt , command_txt ] ) return txt | Returns the help output in plain text format . |
16,865 | 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_txt = '' . join ( [ '\n' , desc_txt ] ) elif isinstance ( eledesc , str ) : desc_txt = '' . join ( [ eledesc , '\n' ] ) else : assert False , "Only string or dictionary" ele_txt = "\t{0}{1: <22} {2}" . format ( ' ' * indent , elename , desc_txt ) text = '' . join ( [ text , ele_txt ] ) return text | Returns the elems dictionary as formatted plain text . |
16,866 | 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 ) return self . scan_collection . delete_scan ( scan_id ) | Deletes scan_id scan from collection . |
16,867 | 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 ( results ) ) return results | Gets scan_id scan s results in XML format . |
16,868 | 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 ) elif isinstance ( value , list ) : value = ', ' . join ( [ m for m in value ] ) elem . text = value else : elem . text = value responses . append ( elem ) return responses | Creates a string in XML Format using the provided data structure . |
16,869 | 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_status ( scan_id ) start_time = self . get_scan_start_time ( scan_id ) end_time = self . get_scan_end_time ( scan_id ) response = Element ( 'scan' ) for name , value in [ ( 'id' , scan_id ) , ( 'target' , target ) , ( 'progress' , progress ) , ( 'status' , status . name . lower ( ) ) , ( 'start_time' , start_time ) , ( 'end_time' , end_time ) ] : response . set ( name , str ( value ) ) if detailed : response . append ( self . get_scan_results_xml ( scan_id , pop_res ) ) return response | Gets scan in XML format . |
16,870 | 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_xml ( vt_id ) ) else : for vt_id in self . vts : vts_xml . append ( self . get_vt_xml ( vt_id ) ) return vts_xml | Gets collection of vulnerability test information in XML format . If vt_id is specified the collection will contain only this vt if found . If no vt_id is specified the collection will contain all vts or those passed in filtered_vts . |
16,871 | 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_exists ( tree . tag ) and tree . tag != "authenticate" : raise OSPDError ( 'Bogus command name' ) if tree . tag == "get_version" : return self . handle_get_version_command ( ) elif tree . tag == "start_scan" : return self . handle_start_scan_command ( tree ) elif tree . tag == "stop_scan" : return self . handle_stop_scan_command ( tree ) elif tree . tag == "get_scans" : return self . handle_get_scans_command ( tree ) elif tree . tag == "get_vts" : return self . handle_get_vts_command ( tree ) elif tree . tag == "delete_scan" : return self . handle_delete_scan_command ( tree ) elif tree . tag == "help" : return self . handle_help_command ( tree ) elif tree . tag == "get_scanner_details" : return self . handle_get_scanner_details ( ) else : assert False , "Unhandled command: {0}" . format ( tree . tag ) | Handles an osp command in a string . |
16,872 | 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 sock . setblocking ( False ) inputs = [ sock ] outputs = [ ] try : while True : readable , _ , _ = select . select ( inputs , outputs , inputs , SCHEDULER_CHECK_PERIOD ) for r_socket in readable : if unix_path and r_socket is sock : client_stream , _ = sock . accept ( ) logger . debug ( "New connection from %s" , unix_path ) self . handle_client_stream ( client_stream , True ) else : client_stream = self . new_client_stream ( sock ) if client_stream is None : continue self . handle_client_stream ( client_stream , False ) close_client_stream ( client_stream , unix_path ) self . scheduler ( ) except KeyboardInterrupt : logger . info ( "Received Ctrl-C shutting-down ..." ) finally : sock . shutdown ( socket . SHUT_RDWR ) sock . close ( ) | Starts the Daemon handling commands until interrupted . |
16,873 | 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 . |
16,874 | 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 . |
16,875 | 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 ) self . add_scan_error ( scan_id , name = "" , host = "" , value = "Scan process failure." ) logger . info ( "%s: Scan stopped with errors." , scan_id ) elif progress == 100 : scan_process . join ( ) | Check the scan s process and terminate the scan if not alive . |
16,876 | 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 . |
16,877 | 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 . |
16,878 | 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 . |
16,879 | 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_id , severity , qod ) | Adds an alarm result to scan_id scan . |
16,880 | 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 OSPDError ( "Invalid number of argument in the filter" , "get_vts" ) _element , _oper , _val = filter_aux if _element not in self . allowed_filter : raise OSPDError ( "Invalid filter element" , "get_vts" ) if _oper not in self . filter_operator : raise OSPDError ( "Invalid filter operator" , "get_vts" ) filters . append ( filter_aux ) return filters | Parse a string containing one or more filters and return a list of filters |
16,881 | 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 depending on the given element . |
16,882 | 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 = vts . copy ( ) for _element , _oper , _filter_val in filters : for vt_id in _vts_aux . copy ( ) : if not _vts_aux [ vt_id ] . get ( _element ) : _vts_aux . pop ( vt_id ) continue _elem_val = _vts_aux [ vt_id ] . get ( _element ) _val = self . format_filter_value ( _element , _elem_val ) if self . filter_operator [ _oper ] ( _val , _filter_val ) : continue else : _vts_aux . pop ( vt_id ) return _vts_aux | Gets a collection of vulnerability test from the vts dictionary which match the filter . |
16,883 | 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 . inet_pton return __inet_pton ( address_family , ip_string ) | A platform independent version of inet_pton |
16,884 | 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 . inet_ntop return __inet_ntop ( address_family , packed_ip ) | A platform independent version of inet_ntop |
16,885 | 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 ) ) new_list . append ( new_ip ) return new_list | Return a list of IPv4 entries from start_packed to end_packed . |
16,886 | 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 ) : return None start_value = int ( binascii . hexlify ( bytes ( start_packed [ 3 ] ) ) , 16 ) if end_value < 0 or end_value > 255 or end_value < start_value : return None end_packed = start_packed [ 0 : 3 ] + struct . pack ( 'B' , end_value ) return ipv4_range_to_list ( start_packed , end_packed ) | Attempt to return a IPv4 short range list from a target string . |
16,887 | 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 ) : return None if block <= 0 or block > 30 : return None start_value = int ( binascii . hexlify ( start_packed ) , 16 ) >> ( 32 - block ) start_value = ( start_value << ( 32 - block ) ) + 1 end_value = ( start_value | ( 0xffffffff >> block ) ) - 1 start_packed = struct . pack ( '!I' , start_value ) end_packed = struct . pack ( '!I' , end_value ) return ipv4_range_to_list ( start_packed , end_packed ) | Attempt to return a IPv4 CIDR list from a target string . |
16,888 | 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 ) : return None if block <= 0 or block > 126 : return None start_value = int ( binascii . hexlify ( start_packed ) , 16 ) >> ( 128 - block ) start_value = ( start_value << ( 128 - block ) ) + 1 end_value = ( start_value | ( int ( 'ff' * 16 , 16 ) >> block ) ) - 1 high = start_value >> 64 low = start_value & ( ( 1 << 64 ) - 1 ) start_packed = struct . pack ( '!QQ' , high , low ) high = end_value >> 64 low = end_value & ( ( 1 << 64 ) - 1 ) end_packed = struct . pack ( '!QQ' , high , low ) return ipv6_range_to_list ( start_packed , end_packed ) | Attempt to return a IPv6 CIDR list from a target string . |
16,889 | 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 : return None if end_packed < start_packed : return None return ipv4_range_to_list ( start_packed , end_packed ) | Attempt to return a IPv4 long - range list from a target string . |
16,890 | 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 << 64 ) - 1 ) new_ip = inet_ntop ( socket . AF_INET6 , struct . pack ( '!2Q' , high , low ) ) new_list . append ( new_ip ) return new_list | Return a list of IPv6 entries from start_packed to end_packed . |
16,891 | 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 ) : return None start_value = int ( binascii . hexlify ( start_packed [ 14 : ] ) , 16 ) if end_value < 0 or end_value > 0xffff or end_value < start_value : return None end_packed = start_packed [ : 14 ] + struct . pack ( '!H' , end_value ) return ipv6_range_to_list ( start_packed , end_packed ) | Attempt to return a IPv6 short - range list from a target string . |
16,892 | 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 : return None if end_packed < start_packed : return None return ipv6_range_to_list ( start_packed , end_packed ) | Attempt to return a IPv6 long - range list from a target string . |
16,893 | 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 . |
16,894 | def target_to_list ( target ) : new_list = target_to_ipv4 ( target ) if not new_list : new_list = target_to_ipv6 ( target ) if not new_list : new_list = target_to_ipv4_cidr ( target ) if not new_list : new_list = target_to_ipv6_cidr ( target ) if not new_list : new_list = target_to_ipv4_short ( target ) if not new_list : new_list = target_to_ipv4_long ( target ) if not new_list : new_list = target_to_ipv6_short ( target ) if not new_list : new_list = target_to_ipv6_long ( target ) if not new_list : new_list = target_to_hostname ( target ) return new_list | Attempt to return a list of single hosts from a target string . |
16,895 | 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 : LOGGER . info ( "{0}: Invalid target value" . format ( target ) ) return None return list ( collections . OrderedDict . fromkeys ( new_list ) ) | Parses a targets string into a list of individual targets . |
16,896 | 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 ( '-' ) ] ) , int ( portrange [ portrange . index ( '-' ) + 1 : ] ) + 1 ) : port_list . append ( single_port ) return port_list | Receive a port range and expands it in individual ports . |
16,897 | 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' ) ) ) : return True return False | Check if the port string is well formed . Return True if fail False other case . |
16,898 | 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_list = list ( ) ports = port_str . replace ( ' ' , '' ) b_tcp = ports . find ( "T" ) b_udp = ports . find ( "U" ) if ports [ b_tcp - 1 ] == ',' : ports = ports [ : b_tcp - 1 ] + ports [ b_tcp : ] if ports [ b_udp - 1 ] == ',' : ports = ports [ : b_udp - 1 ] + ports [ b_udp : ] ports = port_str_arrange ( ports ) tports = '' uports = '' if b_udp != - 1 and b_tcp != - 1 : tports = ports [ ports . index ( 'T:' ) + 2 : ports . index ( 'U:' ) ] uports = ports [ ports . index ( 'U:' ) + 2 : ] elif b_tcp == - 1 and b_udp != - 1 : uports = ports [ ports . index ( 'U:' ) + 2 : ] elif b_udp == - 1 and b_tcp != - 1 : tports = ports [ ports . index ( 'T:' ) + 2 : ] else : tports = ports if tports : for port in tports . split ( ',' ) : if '-' in port : tcp_list . extend ( port_range_expand ( port ) ) else : tcp_list . append ( int ( port ) ) tcp_list . sort ( ) if uports : for port in uports . split ( ',' ) : if '-' in port : udp_list . extend ( port_range_expand ( port ) ) else : udp_list . append ( int ( port ) ) udp_list . sort ( ) return ( tcp_list , udp_list ) | Parses a ports string into two list of individual tcp and udp ports . |
16,899 | 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_list ) , lambda t : t [ 1 ] - t [ 0 ] ) : group = list ( group ) if group [ 0 ] [ 1 ] == group [ - 1 ] [ 1 ] : compressed_list . append ( str ( group [ 0 ] [ 1 ] ) ) else : compressed_list . append ( str ( group [ 0 ] [ 1 ] ) + '-' + str ( group [ - 1 ] [ 1 ] ) ) return ',' . join ( compressed_list ) | Compress a port list and return a string . |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.