Module Expr Str ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias identifier ImportFrom alias ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults body Expr Str Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr ListLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad AttributeLoad NameLoad attr attr decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str For NameStore AttributeLoad NameLoad attr body Assign NameStore Call NameLoad AttributeLoad NameLoad attr Str Str If CompareEq NameLoad NameLoad body Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If BoolOpAnd UnaryOpNot AttributeLoad NameLoad attr UnaryOpNot AttributeLoad NameLoad attr body Return NameLoad For NameStore AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr If NameLoad body Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Call AttributeLoad AttributeLoad NameLoad attr attr decorator_list decorator_list ClassDef bases NameLoad body Expr Str Assign NameStore AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr FunctionDef arguments args NameParam defaults body Expr Str Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr Assign AttributeStore NameLoad attr Dict Assign AttributeStore NameLoad attr Dict Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr Dict Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Call NameLoad Call AttributeLoad AttributeLoad NameLoad attr attr decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad If NameLoad body Raise Call NameLoad Str Assign NameStore Call NameLoad NameLoad If NameLoad body If CompareNotIn AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Raise Call NameLoad Str Assign AttributeStore NameLoad attr NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad If UnaryOpNot AttributeLoad NameLoad attr body Assign AttributeStore NameLoad attr NameLoad Assign SubscriptStore AttributeLoad NameLoad attr Index NameLoad NameLoad If CompareIn AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Assign SubscriptStore AttributeLoad NameLoad attr Index NameLoad NameLoad Assign AttributeStore NameLoad attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return CompareNotEq AttributeLoad NameLoad attr Dict decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return CompareNotEq AttributeLoad NameLoad attr Dict decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Return CompareIsNot Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr NameLoad If UnaryOpNot AttributeLoad NameLoad attr body Return NameLoad Return Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Return CompareIn NameLoad AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str If AttributeLoad NameLoad attr body Return CompareEq AttributeLoad NameLoad attr AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str If AttributeLoad NameLoad attr body Return CompareEq AttributeLoad NameLoad attr AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad If UnaryOpNot NameLoad body Raise Call NameLoad Str Assign SubscriptStore AttributeLoad NameLoad attr Index NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr keyword NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad If UnaryOpNot NameLoad body Return If AttributeLoad NameLoad attr body Raise Call NameLoad Str Assign NameStore AttributeLoad NameLoad attr If NameLoad body Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad If CompareEq NameLoad AttributeLoad NameLoad attr body Assign AttributeStore NameLoad attr NameLoad Delete SubscriptDel AttributeLoad NameLoad attr Index NameLoad If CompareIn AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Delete SubscriptDel AttributeLoad NameLoad attr Index NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If CompareIs AttributeLoad NameLoad attr NameLoad body Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If UnaryOpNot Call AttributeLoad NameLoad attr NameLoad body Raise Call NameLoad Str Delete SubscriptDel AttributeLoad NameLoad attr Index NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad body Expr Str If UnaryOpNot NameLoad body Raise Call NameLoad Str If UnaryOpNot NameLoad body Raise Call NameLoad Str Assign NameStore AttributeLoad NameLoad attr If UnaryOpNot Call AttributeLoad NameLoad attr body Assign NameStore NameLoad orelse Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr If CompareIs NameLoad NameLoad body Raise Call AttributeLoad NameLoad attr Str If Call AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Return Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr If NameLoad body Assign AttributeStore NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad If Call AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr orelse Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr If UnaryOpNot NameLoad body Return Assign NameStore NameLoad While NameLoad body If CompareIn AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Break If Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Break Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr If UnaryOpNot NameLoad body Break If UnaryOpNot Call AttributeLoad NameLoad attr NameLoad body Assign AttributeStore NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad If BoolOpAnd NameLoad Call AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr orelse Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr If CompareIn AttributeLoad NameLoad attr AttributeLoad NameLoad attr body If CompareEq AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad AttributeLoad NameLoad attr attr If NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr For NameStore AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr NameLoad If CompareNotEq AttributeLoad NameLoad attr AttributeLoad NameLoad attr body If BoolOpOr NameLoad UnaryOpNot AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad NameLoad keyword NameLoad Return orelse If CompareIn AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr Assign NameStore BoolOpOr UnaryOpNot NameLoad AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr If NameLoad body Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr If CompareEq AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad AttributeLoad NameLoad attr attr If NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad AttributeLoad NameLoad attr If BoolOpAnd UnaryOpNot NameLoad AttributeLoad NameLoad attr body Return If UnaryOpNot AttributeLoad NameLoad attr body Break If BoolOpAnd CompareIn AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr CompareEq Call NameLoad AttributeLoad NameLoad attr Str NameLoad Str body Pass orelse If Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Pass orelse If BoolOpAnd CompareEq AttributeLoad NameLoad attr AttributeLoad NameLoad attr NameLoad CompareNotEq AttributeLoad NameLoad attr NameLoad body Pass orelse If CompareNotIn AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr If UnaryOpNot NameLoad body If CompareEq AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr AttributeLoad NameLoad attr orelse Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr orelse If UnaryOpNot Call AttributeLoad NameLoad attr NameLoad body Assign AttributeStore NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad If BoolOpAnd NameLoad Call AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr orelse Expr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr If UnaryOpNot AttributeLoad NameLoad attr body Assign AttributeStore NameLoad attr NameLoad Return decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore ListLoad For NameStore AttributeLoad NameLoad attr body Assign NameStore Call NameLoad NameLoad Str NameLoad If NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad Return Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str If UnaryOpNot NameLoad body Raise Call NameLoad Str Assign AttributeStore NameLoad attr NameLoad If NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad orelse Assign NameStore Call AttributeLoad NameLoad attr If NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str TryExcept body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword AttributeLoad NameLoad attr handlers ExceptHandler type NameLoad name NameStore body Raise Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad If UnaryOpNot NameLoad body Return Assign NameStore SubscriptLoad NameLoad Index Num If CompareGt Call NameLoad NameLoad Num body If CompareNotIn AttributeLoad NameLoad attr NameLoad body Raise Call AttributeLoad NameLoad attr Str Assign NameStore AttributeLoad NameLoad attr If CompareEq NameLoad AttributeLoad NameLoad attr body Return Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword Str keyword NameLoad Return Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword Str keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str TryExcept body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword AttributeLoad NameLoad attr handlers ExceptHandler type NameLoad name NameStore body Raise Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad If UnaryOpNot NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr keyword NameLoad TryExcept body Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad handlers ExceptHandler type AttributeLoad NameLoad attr body Assign NameStore NameLoad If UnaryOpNot NameLoad body Return Return NameLoad If CompareGt Call NameLoad NameLoad Num body Raise Call AttributeLoad NameLoad attr Str Return Call AttributeLoad AttributeLoad NameLoad attr attr SubscriptLoad NameLoad Index Num keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If CompareEq AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Return If CompareIn AttributeLoad NameLoad attr AttributeLoad NameLoad attr body If CompareEq Call NameLoad NameLoad Str NameLoad Str body Return NameLoad TryExcept body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword AttributeLoad NameLoad attr handlers ExceptHandler type TupleLoad NameLoad NameLoad name NameStore body Raise Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad If UnaryOpNot NameLoad body Return If CompareGt Call NameLoad NameLoad Num body Raise Call AttributeLoad NameLoad attr Str If BoolOpAnd CompareEq SubscriptLoad NameLoad Index Num AttributeLoad NameLoad attr CompareIn AttributeLoad NameLoad attr ListLoad AttributeLoad NameLoad attr body Return If CompareIn SubscriptLoad NameLoad Index Num AttributeLoad NameLoad attr body Return Call AttributeLoad AttributeLoad NameLoad attr attr SubscriptLoad NameLoad Index Num keyword Str keyword NameLoad Return Call AttributeLoad AttributeLoad NameLoad attr attr SubscriptLoad NameLoad Index Num keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults body Expr Str If UnaryOpNot Call AttributeLoad NameLoad attr NameLoad body Raise Call NameLoad Str If UnaryOpNot Call AttributeLoad NameLoad attr NameLoad body Raise Call NameLoad Str Expr Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr NameLoad NameLoad NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword AttributeLoad NameLoad attr Assign NameStore BoolOpOr UnaryOpNot NameLoad AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr If NameLoad body Return NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list decorator_list
N/A N/A Scanner for source files, directories and devices.

The source scanner tries to determine what input we are dealing with:
* a file that contains a storage media image;
* a device file of a storage media image device;
* a regular file or directory.

The source scanner scans for:
* supported types of storage media images;
* supported types of volume systems;
* supported types of file systems.

The source scanner uses the source scanner context to keep track of
previously scanned or user provided context information, e.g.
* which partition to default to;
* which VSS stores to default to.
 dfvfs.analyzer analyzer dfvfs.lib definitions dfvfs.lib errors dfvfs.lib raw dfvfs.path factory path_spec_factory dfvfs.resolver resolver SourceScanNode N/A object N/A N/A Class that defines a source scan node. __init__ N/A N/A self path_spec N/A N/A N/A Initializes the source scan node object.

    Args:
      path_spec: the path specification (instance of PathSpec).
     N/A N/A N/A N/A super SourceScanNode self __init__ N/A N/A self path_spec path_spec N/A N/A self parent_node None N/A N/A self scanned False N/A N/A self sub_nodes N/A N/A type_indicator N/A N/A self N/A N/A N/A The path specification type indicator. N/A N/A N/A self path_spec type_indicator N/A property GetSubNodeByLocation N/A N/A self location N/A N/A N/A Retrieves a sub scan node based on the location.

    Args:
      location: the location string in the sub scan node path specification,
                that should match.

    Return:
      The sub scan node object (instance of SourceScanNode) or None.
     N/A sub_node N/A self sub_nodes N/A N/A sub_node_location N/A getattr N/A sub_node path_spec location N/A N/A location sub_node_location N/A N/A sub_node N/A GetUnscannedSubNode N/A N/A self N/A N/A N/A Retrieves the first unscanned sub node.

    Returns:
      A scan node (instance of SourceScanNode) or None.
     N/A N/A N/A N/A self sub_nodes N/A N/A self scanned N/A N/A self N/A sub_node N/A self sub_nodes N/A N/A result N/A N/A sub_node GetUnscannedSubNode N/A result N/A N/A result N/A IsSystemLevel N/A N/A self N/A N/A N/A Determines if the path specification is at system-level. N/A N/A N/A N/A self path_spec IsSystemLevel N/A N/A SourceScannerContext N/A object N/A N/A Class that defines contextual information for the source scanner. N/A SOURCE_TYPE_DIRECTORY N/A definitions SOURCE_TYPE_DIRECTORY N/A SOURCE_TYPE_FILE N/A definitions SOURCE_TYPE_FILE N/A SOURCE_TYPE_STORAGE_MEDIA_DEVICE N/A definitions SOURCE_TYPE_STORAGE_MEDIA_DEVICE N/A SOURCE_TYPE_STORAGE_MEDIA_IMAGE N/A definitions SOURCE_TYPE_STORAGE_MEDIA_IMAGE __init__ N/A N/A self N/A N/A N/A Initializes the source scanner context object. N/A N/A N/A N/A super SourceScannerContext self __init__ N/A N/A self _file_system_scan_nodes N/A N/A N/A self _locked_scan_nodes N/A N/A N/A self _root_path_spec None N/A N/A self _scan_nodes N/A N/A N/A self source_type None N/A N/A self updated False N/A locked_scan_nodes N/A N/A self N/A N/A N/A The locked scan nodes. N/A N/A iter N/A N/A N/A self _locked_scan_nodes values N/A property AddScanNode N/A N/A self path_spec parent_scan_node N/A N/A N/A Adds a scan node for a certain path specifiation.

    Args:
      path_spec: the path specification (instance of PathSpec).
      parent_scan_node: the parent scan node (instance of SourceScanNode)
                        or None.

    Returns:
      The scan node (instance of SourceScanNode).

    Raises:
      KeyError: if the scan node already exists.
      RuntimeError: if the parent scan node is not present.
     N/A scan_node N/A N/A N/A self _scan_nodes get path_spec None N/A scan_node N/A N/A N/A KeyError Scan node already exists. N/A scan_node N/A SourceScanNode path_spec N/A parent_scan_node N/A N/A N/A N/A parent_scan_node path_spec N/A self _scan_nodes N/A N/A N/A RuntimeError Parent scan node not present. N/A N/A scan_node parent_node parent_scan_node N/A N/A N/A N/A parent_scan_node sub_nodes append scan_node N/A N/A N/A self _root_path_spec N/A N/A N/A self _root_path_spec path_spec N/A N/A N/A self _scan_nodes N/A path_spec scan_node N/A N/A N/A path_spec type_indicator N/A definitions FILE_SYSTEM_TYPE_INDICATORS N/A N/A N/A N/A self _file_system_scan_nodes N/A path_spec scan_node N/A N/A self updated True N/A scan_node N/A HasFileSystemScanNodes N/A N/A self N/A N/A N/A Determines if a file system was detected during the scan. N/A N/A N/A self _file_system_scan_nodes N/A N/A HasLockedScanNodes N/A N/A self N/A N/A N/A Determines if a locked scan node was detected during the scan.

    A locked scan node is e.g. an encrypted volume for which a credential,
    e.g. password, to unlock the volume is not available.
     N/A N/A N/A self _locked_scan_nodes N/A N/A HasScanNode N/A N/A self path_spec N/A N/A N/A Determines if there is a scan node for a certain path specifiation.

    Args:
      path_spec: the path specification (instance of PathSpec).

    Returns:
      A boolean value indicating if there is a scan node for
      the path specification.
     N/A N/A N/A N/A N/A self _scan_nodes get path_spec None None N/A GetRootScanNode N/A N/A self N/A N/A N/A Retrieves the root scan node.

    Returns:
      A scan node (instance of SourceScanNode) or None.
     N/A N/A N/A N/A self _scan_nodes get N/A self _root_path_spec None N/A GetScanNode N/A N/A self path_spec N/A N/A N/A Retrieves a scan node for a certain path specifiation.

    Args:
      path_spec: the path specification (instance of PathSpec).

    Returns:
      A scan node (instance of SourceScanNode) or None.
     N/A N/A N/A N/A self _scan_nodes get path_spec None N/A GetUnscannedScanNode N/A N/A self N/A N/A N/A Retrieves the first unscanned scan node.

    Returns:
      A scan node (instance of SourceScanNode) or None.
     N/A root_scan_node N/A N/A N/A self _scan_nodes get N/A self _root_path_spec None N/A N/A N/A root_scan_node scanned N/A N/A root_scan_node N/A N/A N/A root_scan_node GetUnscannedSubNode N/A IsLockedScanNode N/A N/A self path_spec N/A N/A N/A Determines if a scan node is locked.

    A locked scan node is e.g. an encrypted volume for which a credential,
    e.g. password, to unlock the volume is not available.

    Args:
      path_spec: the path specification (instance of PathSpec)
                 of the scan node.

    Returns:
      A boolean value indicating if the scan node is locked.
     N/A N/A path_spec N/A self _locked_scan_nodes N/A IsSourceTypeDirectory N/A N/A self N/A N/A N/A Determines if the source type is a directory.

    Returns:
      A boolean if the source type is or is not a directory or None if not set.
     N/A N/A self source_type N/A N/A N/A N/A self source_type N/A definitions SOURCE_TYPE_DIRECTORY N/A IsSourceTypeFile N/A N/A self N/A N/A N/A Determines if the source type is a file.

    Returns:
      A boolean if the source type is or is not a file or None if not set.
     N/A N/A self source_type N/A N/A N/A N/A self source_type N/A definitions SOURCE_TYPE_FILE N/A LockScanNode N/A N/A self path_spec N/A N/A N/A Marks a scan node as locked.

    Args:
      path_spec: the path specification (instance of PathSpec).

    Raises:
      KeyError: if the scan node does not exists.
     N/A scan_node N/A N/A N/A self _scan_nodes get path_spec None N/A N/A scan_node N/A N/A N/A KeyError Scan node does not exist. N/A N/A N/A self _locked_scan_nodes N/A path_spec scan_node N/A OpenSourcePath N/A N/A self source_path N/A N/A N/A Opens the source path.

    Args:
      source_path: Unicode string containing the source path.
     N/A source_path_spec N/A N/A N/A path_spec_factory Factory NewPathSpec N/A definitions TYPE_INDICATOR_OS location source_path N/A N/A N/A self AddScanNode source_path_spec None N/A RemoveScanNode N/A N/A self path_spec N/A N/A N/A Removes a scan node of a certain path specifiation.

    Args:
      path_spec: the path specification (instance of PathSpec).

    Returns:
      The parent scan node (instance of SourceScanNode) or
      None if not available.

    Raises:
      RuntimeError: if the scan node has sub nodes.
     N/A scan_node N/A N/A N/A self _scan_nodes get path_spec None N/A N/A scan_node N/A N/A N/A N/A scan_node sub_nodes N/A N/A N/A RuntimeError Scan node has sub nodes. N/A parent_scan_node N/A scan_node parent_node N/A parent_scan_node N/A N/A N/A N/A N/A parent_scan_node sub_nodes remove scan_node N/A N/A path_spec N/A self _root_path_spec N/A N/A N/A self _root_path_spec None N/A N/A N/A self _scan_nodes N/A path_spec N/A N/A N/A path_spec type_indicator N/A definitions FILE_SYSTEM_TYPE_INDICATORS N/A N/A N/A N/A self _file_system_scan_nodes N/A path_spec N/A parent_scan_node N/A SetSourceType N/A N/A self source_type N/A N/A N/A Sets the source type.

    Args:
      source_type: the source type.
     N/A N/A N/A self source_type None N/A N/A N/A self source_type source_type N/A UnlockScanNode N/A N/A self path_spec N/A N/A N/A Marks a scan node as unlocked.

    Args:
      path_spec: the path specification (instance of PathSpec).

    Raises:
      KeyError: if the scan node does not exists.
     N/A N/A N/A N/A self HasScanNode path_spec N/A N/A N/A KeyError Scan node does not exist. N/A N/A N/A self _locked_scan_nodes N/A path_spec N/A N/A SourceScanner N/A object N/A N/A Searcher object to find volumes within a volume system. __init__ N/A N/A self resolver_context N/A None N/A N/A Initializes the source scanner object.

    Args:
      resolver_context: the optional resolver context (instance of
                        resolver.Context). The default is None which will use
                        the built in context which is not multi process safe.
     N/A N/A N/A N/A super SourceScanner self __init__ N/A N/A self _resolver_context resolver_context N/A _ScanNode N/A N/A self scan_context scan_node auto_recurse N/A True N/A N/A Scans for supported formats using a scan node.

    Args:
      scan_context: the source scanner context (instance of
                    SourceScannerContext).
      scan_node: the scan node (instance of SourceScanNode).
      auto_recurse: optional boolean value to indicate if the scan should
                    automatically recurse as far as possible. The default
                    is False.

    Raises:
      BackEndError: if the source cannot be scanned.
      ValueError: if the scan context or scan node is invalid.
     N/A N/A scan_context N/A N/A N/A ValueError Invalid scan context. N/A N/A scan_node N/A N/A N/A ValueError Invalid scan node. N/A scan_path_spec N/A scan_node path_spec N/A N/A N/A N/A scan_node IsSystemLevel N/A N/A system_level_file_entry None N/A N/A system_level_file_entry N/A N/A N/A resolver Resolver OpenFileEntry N/A scan_node path_spec resolver_context N/A self _resolver_context N/A N/A system_level_file_entry None N/A N/A N/A N/A errors BackEndError Unable to open file entry. N/A N/A N/A system_level_file_entry IsDirectory N/A N/A N/A N/A scan_context SetSourceType N/A definitions SOURCE_TYPE_DIRECTORY N/A N/A source_path_spec N/A N/A self ScanForStorageMediaImage N/A scan_node path_spec N/A source_path_spec N/A N/A N/A scan_node scanned True N/A scan_node N/A N/A scan_context AddScanNode source_path_spec scan_node N/A N/A N/A system_level_file_entry IsDevice N/A N/A N/A N/A scan_context SetSourceType N/A definitions SOURCE_TYPE_STORAGE_MEDIA_DEVICE N/A N/A N/A N/A scan_context SetSourceType N/A definitions SOURCE_TYPE_STORAGE_MEDIA_IMAGE N/A N/A auto_recurse N/A N/A N/A source_path_spec None N/A True N/A N/A N/A N/A scan_node type_indicator N/A definitions FILE_SYSTEM_TYPE_INDICATORS N/A N/A N/A N/A N/A scan_context IsLockedScanNode N/A scan_node path_spec N/A N/A N/A source_path_spec N/A N/A self ScanForVolumeSystem N/A scan_node path_spec N/A N/A source_path_spec N/A N/A N/A N/A N/A N/A scan_context HasScanNode source_path_spec N/A N/A N/A scan_node scanned True N/A scan_node N/A N/A scan_context AddScanNode source_path_spec scan_node N/A N/A system_level_file_entry N/A N/A system_level_file_entry IsDevice N/A N/A N/A N/A scan_context SetSourceType N/A definitions SOURCE_TYPE_STORAGE_MEDIA_DEVICE N/A N/A N/A N/A scan_context SetSourceType N/A definitions SOURCE_TYPE_STORAGE_MEDIA_IMAGE N/A N/A N/A scan_node type_indicator N/A definitions VOLUME_SYSTEM_TYPE_INDICATORS N/A N/A N/A N/A scan_node type_indicator N/A definitions TYPE_INDICATOR_VSHADOW N/A N/A path_spec N/A N/A self ScanForFileSystem N/A N/A scan_node path_spec parent N/A path_spec N/A N/A N/A N/A scan_context AddScanNode path_spec N/A scan_node parent_node N/A file_entry N/A N/A N/A resolver Resolver OpenFileEntry N/A scan_node path_spec resolver_context N/A self _resolver_context N/A sub_file_entry N/A file_entry sub_file_entries N/A N/A sub_scan_node N/A N/A scan_context AddScanNode N/A sub_file_entry path_spec scan_node N/A N/A N/A scan_node type_indicator N/A definitions TYPE_INDICATOR_VSHADOW N/A N/A N/A auto_recurse N/A N/A scan_context updated N/A N/A N/A N/A self _ScanNode scan_context sub_scan_node auto_recurse auto_recurse N/A N/A N/A N/A N/A scan_node type_indicator N/A definitions ENCRYPTED_VOLUME_TYPE_INDICATORS N/A N/A file_object N/A N/A N/A resolver Resolver OpenFileObject N/A scan_node path_spec resolver_context N/A self _resolver_context N/A is_locked N/A N/A file_object N/A file_object is_locked N/A N/A N/A file_object close N/A is_locked N/A N/A N/A N/A scan_context LockScanNode N/A scan_node path_spec N/A N/A N/A scan_node type_indicator N/A definitions TYPE_INDICATOR_BDE N/A N/A path_spec N/A N/A self ScanForFileSystem N/A N/A scan_node path_spec parent N/A path_spec N/A N/A N/A N/A scan_context AddScanNode path_spec N/A scan_node parent_node N/A N/A N/A auto_recurse N/A scan_context updated N/A N/A N/A N/A N/A scan_context updated N/A N/A N/A N/A N/A N/A N/A scan_node path_spec type_indicator N/A definitions VOLUME_SYSTEM_TYPE_INDICATORS N/A N/A getattr N/A scan_node path_spec location None / N/A N/A N/A N/A N/A N/A scan_context IsLockedScanNode N/A scan_node path_spec N/A N/A N/A N/A N/A N/A N/A scan_node type_indicator N/A definitions TYPE_INDICATOR_VSHADOW auto_recurse N/A N/A scan_node path_spec scan_path_spec N/A N/A N/A N/A N/A N/A scan_node type_indicator N/A definitions FILE_SYSTEM_TYPE_INDICATORS N/A N/A source_path_spec N/A N/A self ScanForFileSystem N/A scan_node path_spec N/A N/A source_path_spec N/A N/A N/A N/A N/A scan_node path_spec type_indicator N/A definitions TYPE_INDICATOR_RAW N/A N/A scan_node N/A N/A scan_context RemoveScanNode N/A scan_node path_spec N/A N/A scan_context source_type N/A definitions SOURCE_TYPE_FILE N/A N/A N/A N/A scan_context SetSourceType N/A definitions SOURCE_TYPE_FILE N/A N/A N/A N/A N/A scan_context HasScanNode source_path_spec N/A N/A N/A scan_node scanned True N/A scan_node N/A N/A scan_context AddScanNode source_path_spec scan_node N/A N/A system_level_file_entry N/A N/A system_level_file_entry IsDevice N/A N/A N/A N/A scan_context SetSourceType N/A definitions SOURCE_TYPE_STORAGE_MEDIA_DEVICE N/A N/A N/A N/A scan_context SetSourceType N/A definitions SOURCE_TYPE_STORAGE_MEDIA_IMAGE N/A N/A N/A scan_node scanned N/A N/A N/A scan_node scanned True N/A N/A GetVolumeIdentifiers N/A N/A self volume_system N/A N/A N/A Retrieves the volume identifiers.

    Args:
      volume_system: The volume system (instance of dfvfs.VolumeSystem).

    Returns:
      A sorted list containing the volume identifiers.
     N/A volume_identifiers N/A N/A volume N/A volume_system volumes N/A N/A volume_identifier N/A getattr volume identifier None N/A volume_identifier N/A N/A N/A N/A volume_identifiers append volume_identifier N/A N/A sorted volume_identifiers N/A Scan N/A N/A self scan_context auto_recurse scan_path_spec N/A True None N/A N/A Scans for supported formats.

    Args:
      scan_context: the source scanner context (instance of
                    SourceScannerContext).
      auto_recurse: optional boolean value to indicate if the scan should
                    automatically recurse as far as possible. The default
                    is True.
      scan_path_spec: optional path specification (instance of PathSpec)
                      to indicate where the source scanner should continue
                      scanning. The default is None which indicates the
                      scanner will start with the sources.

    Raises:
      ValueError: if the scan context is invalid.
     N/A N/A scan_context N/A N/A N/A ValueError Invalid scan context. N/A N/A scan_context updated False N/A scan_path_spec N/A N/A scan_node N/A N/A scan_context GetScanNode scan_path_spec N/A N/A scan_node N/A N/A scan_context GetUnscannedScanNode N/A scan_node N/A N/A N/A N/A self _ScanNode scan_context scan_node auto_recurse auto_recurse N/A ScanForFileSystem N/A N/A self source_path_spec N/A N/A N/A Scans the path specification for a supported file system format.

    Args:
      source_path_spec: the source path specification (instance of
                        dfvfs.PathSpec).

    Returns:
      The file system path specification (instance of dfvfs.PathSpec) or None
      if no supported file system type was found.

    Raises:
      BackEndError: if the source cannot be scanned or more than one file
                    system type is found.
     N/A N/A N/A type_indicators N/A N/A N/A analyzer Analyzer GetFileSystemTypeIndicators source_path_spec resolver_context N/A self _resolver_context N/A N/A N/A RuntimeError N/A exception N/A N/A N/A N/A errors BackEndError N/A N/A Unable to process source path specification with error: {0:s} format exception N/A N/A type_indicators N/A N/A N/A type_indicator N/A type_indicators N/A 0 N/A N/A N/A len type_indicators 1 N/A N/A N/A N/A definitions PREFERRED_NTFS_BACK_END type_indicators N/A N/A N/A N/A errors BackEndError Unsupported source found more than one file system types. N/A type_indicator N/A definitions PREFERRED_NTFS_BACK_END N/A N/A type_indicator N/A definitions TYPE_INDICATOR_NTFS N/A N/A N/A N/A N/A path_spec_factory Factory NewPathSpec type_indicator location \ parent source_path_spec N/A N/A N/A N/A path_spec_factory Factory NewPathSpec type_indicator location / parent source_path_spec N/A ScanForStorageMediaImage N/A N/A self source_path_spec N/A N/A N/A Scans the path specification for a supported storage media image format.

    Args:
      source_path_spec: the source path specification (instance of
                        dfvfs.PathSpec).

    Returns:
      The storage media image path specification (instance of dfvfs.PathSpec)
      or None if no supported storage media image type was found.

    Raises:
      BackEndError: if the source cannot be scanned or more than one storage
                    media image type is found.
     N/A N/A N/A type_indicators N/A N/A N/A analyzer Analyzer GetStorageMediaImageTypeIndicators source_path_spec resolver_context N/A self _resolver_context N/A N/A N/A RuntimeError N/A exception N/A N/A N/A N/A errors BackEndError N/A N/A Unable to process source path specification with error: {0:s} format exception N/A N/A type_indicators N/A N/A file_system N/A N/A N/A resolver Resolver OpenFileSystem source_path_spec resolver_context N/A self _resolver_context N/A raw_path_spec N/A N/A N/A path_spec_factory Factory NewPathSpec N/A definitions TYPE_INDICATOR_RAW parent source_path_spec N/A N/A N/A glob_results N/A N/A raw RawGlobPathSpec file_system raw_path_spec N/A N/A N/A N/A errors PathSpecError N/A N/A glob_results None N/A N/A glob_results N/A N/A N/A raw_path_spec N/A N/A N/A len type_indicators 1 N/A N/A N/A N/A errors BackEndError Unsupported source found more than one storage media image types. N/A N/A N/A N/A path_spec_factory Factory NewPathSpec N/A type_indicators N/A 0 parent source_path_spec N/A ScanForVolumeSystem N/A N/A self source_path_spec N/A N/A N/A Scans the path specification for a supported volume system format.

    Args:
      source_path_spec: the source path specification (instance of
                        dfvfs.PathSpec).

    Returns:
      The volume system path specification (instance of dfvfs.PathSpec) or
      None if no supported volume system type was found.

    Raises:
      BackEndError: if the source cannot be scanned or more than one volume
                    system type is found.
     N/A N/A N/A source_path_spec type_indicator N/A definitions TYPE_INDICATOR_VSHADOW N/A N/A N/A N/A N/A source_path_spec type_indicator N/A definitions VOLUME_SYSTEM_TYPE_INDICATORS N/A N/A N/A N/A getattr source_path_spec location None / N/A N/A source_path_spec N/A N/A N/A type_indicators N/A N/A N/A analyzer Analyzer GetVolumeSystemTypeIndicators source_path_spec resolver_context N/A self _resolver_context N/A N/A N/A N/A IOError RuntimeError N/A exception N/A N/A N/A N/A errors BackEndError N/A N/A Unable to process source path specification with error: {0:s} format exception N/A N/A type_indicators N/A N/A N/A N/A N/A len type_indicators 1 N/A N/A N/A N/A errors BackEndError Unsupported source found more than one volume system types. N/A N/A N/A N/A type_indicators N/A 0 N/A definitions TYPE_INDICATOR_TSK_PARTITION N/A N/A source_path_spec type_indicator N/A N/A definitions TYPE_INDICATOR_TSK_PARTITION N/A N/A N/A N/A N/A type_indicators N/A 0 N/A definitions VOLUME_SYSTEM_TYPE_INDICATORS N/A N/A N/A N/A N/A path_spec_factory Factory NewPathSpec N/A type_indicators N/A 0 location / parent source_path_spec N/A N/A N/A N/A path_spec_factory Factory NewPathSpec N/A type_indicators N/A 0 parent source_path_spec N/A Unlock N/A N/A self scan_context path_spec credential_identifier credential_data N/A N/A N/A Unlocks a locked scan node e.g. the scan node of an encrypted volume.

    Args:
      scan_context: the source scanner context (instance of
                    SourceScannerContext).
      path_spec: the path specification (instance of PathSpec) of
                 the locked scan node.
      credential_identifier: string containing the credential identifier used
                             to unlock the scan node.
      credential_data: the credential data used to unlock the scan node.

    Returns:
      A boolean indicating if the scan node was successfully unlocked or not.

    Raises:
      KeyError: if the scan node does not exists or is not locked.
     N/A N/A N/A N/A scan_context HasScanNode path_spec N/A N/A N/A KeyError Scan node does not exist. N/A N/A N/A N/A scan_context IsLockedScanNode path_spec N/A N/A N/A KeyError Scan node is not locked. N/A N/A N/A N/A N/A resolver Resolver key_chain SetCredential path_spec credential_identifier credential_data N/A file_object N/A N/A N/A resolver Resolver OpenFileObject path_spec resolver_context N/A self _resolver_context N/A is_locked N/A N/A file_object N/A file_object is_locked N/A N/A N/A file_object close N/A is_locked N/A N/A False N/A N/A N/A scan_context UnlockScanNode path_spec N/A True N/A N/A