flowstrider package

Subpackages

• flowstrider.converters package
  • Submodules
  • flowstrider.converters.dfd_to_dot_converter module
    • cluster_to_dot()
    • dataflow_to_dot()
    • deserialized_dfd_to_dot()
    • format_attributes()
    • node_to_dot()
    • render_dfd()
    • text_length_warning()
    • wrap_text()
  • flowstrider.converters.metadata_xlsx_converter module
    • determine_type()
    • metadata_check()
    • parse_value()
    • update_dfd_json_from_xlsx()
  • flowstrider.converters.threats_formatter module
    • ThreatGroup
      • ThreatGroup.name
      • ThreatGroup.threats_by_source_and_severity
      • ThreatGroup.name
      • ThreatGroup.threats_by_source_and_severity
    • ThreatsInfoContainer
      • ThreatsInfoContainer.info_strings
      • ThreatsInfoContainer.threat_groups
      • ThreatsInfoContainer.sources_occurences
      • ThreatsInfoContainer.info_strings
      • ThreatsInfoContainer.sources_occurences
      • ThreatsInfoContainer.threat_groups
    • format_threats()
    • threats_apply_filters()
    • threats_group()
    • threats_sort()
  • flowstrider.converters.threats_to_file_converter module
    • PDF
      • PDF.add_row()
      • PDF.add_table_h_line()
      • PDF.footer()
      • PDF.get_string_line_count()
      • PDF.page
    • create_threats_pdf()
  • Module contents
• flowstrider.helpers package
  • Submodules
  • flowstrider.helpers.rules_checker module
    • check_rule_name_duplicates()
  • flowstrider.helpers.warnings module
    • WarningsCounter
      • WarningsCounter.add_warning()
      • WarningsCounter.count
  • Module contents
• flowstrider.localization namespace
  • Submodules
  • flowstrider.localization.pre-commit_localization_check module
  • flowstrider.localization.pre-commit_localization_generate module
• flowstrider.models package
  • Submodules
  • flowstrider.models.common_models module
    • Cluster
      • Cluster.id
      • Cluster.node_ids
      • Cluster.name
      • Cluster.tags
      • Cluster.attributes
      • Cluster.severity_multiplier
      • Cluster.attributes
      • Cluster.id
      • Cluster.name
      • Cluster.node_ids
      • Cluster.severity_multiplier
      • Cluster.tags
    • Edge
      • Edge.id
      • Edge.source_id
      • Edge.sink_id
      • Edge.name
      • Edge.tags
      • Edge.attributes
      • Edge.attributes
      • Edge.id
      • Edge.name
      • Edge.sink_id
      • Edge.source_id
      • Edge.tags
    • Node
      • Node.id
      • Node.name
      • Node.tags
      • Node.attributes
      • Node.severity_multiplier
      • Node.attributes
      • Node.id
      • Node.name
      • Node.severity_multiplier
      • Node.tags
  • flowstrider.models.dataflowdiagram module
    • DataflowDiagram
      • DataflowDiagram.id
      • DataflowDiagram.nodes
      • DataflowDiagram.edges
      • DataflowDiagram.clusters
      • DataflowDiagram.name
      • DataflowDiagram.tags
      • DataflowDiagram.attributes
      • DataflowDiagram.attributes
      • DataflowDiagram.clusters
      • DataflowDiagram.edges
      • DataflowDiagram.get_cluster_by_id()
      • DataflowDiagram.get_clusters_for_node_id()
      • DataflowDiagram.get_edge_by_id()
      • DataflowDiagram.get_element_by_id()
      • DataflowDiagram.get_node_by_id()
      • DataflowDiagram.id
      • DataflowDiagram.name
      • DataflowDiagram.nodes
      • DataflowDiagram.tags
  • flowstrider.models.threat module
    • Threat
      • Threat.display_id()
      • Threat.location
      • Threat.location_str()
      • Threat.long_description
      • Threat.mitigation_options
      • Threat.req_status
      • Threat.requirement
      • Threat.rule_set_name
      • Threat.rule_set_tag
      • Threat.severity
      • Threat.short_description
      • Threat.source
      • Threat.source_internal
      • Threat.uid()
    • location_str()
  • flowstrider.models.threat_management module
    • ThreatManagementDatabase
      • ThreatManagementDatabase.get()
      • ThreatManagementDatabase.per_threat_information
      • ThreatManagementDatabase.should_fail()
      • ThreatManagementDatabase.update()
    • ThreatManagementItem
      • ThreatManagementItem.explanation
      • ThreatManagementItem.management_state
      • ThreatManagementItem.uid
    • ThreatManagementState
      • ThreatManagementState.Accept
      • ThreatManagementState.Avoid
      • ThreatManagementState.Delegate
      • ThreatManagementState.Delegated
      • ThreatManagementState.Mitigate
      • ThreatManagementState.Mitigated
      • ThreatManagementState.Undecided
  • Module contents
• flowstrider.rules package
  • Subpackages
    • flowstrider.rules.builtin package
      • Subpackages
      • Module contents
  • Submodules
  • flowstrider.rules.attributes_dict module
    • Attribute
      • Attribute.accepted_values
      • Attribute.applicable_entities
      • Attribute.corresponding_rule_sets
      • Attribute.display_name
      • Attribute.explanation
    • init_attributes()
    • init_bsi_attributes()
    • init_linddun_attributes()
  • flowstrider.rules.collections module
  • flowstrider.rules.common_rules module
    • DataflowDiagramRule
      • DataflowDiagramRule.evaluate()
      • DataflowDiagramRule.init_texts()
    • DataflowDiagramRuleCollection
      • DataflowDiagramRuleCollection.dfd_rules
      • DataflowDiagramRuleCollection.edge_rules
      • DataflowDiagramRuleCollection.evaluate()
      • DataflowDiagramRuleCollection.graph_rules
      • DataflowDiagramRuleCollection.init_texts()
      • DataflowDiagramRuleCollection.name
      • DataflowDiagramRuleCollection.node_rules
      • DataflowDiagramRuleCollection.references
      • DataflowDiagramRuleCollection.set_rules_ruleset_name()
      • DataflowDiagramRuleCollection.tag
    • EdgeRule
      • EdgeRule.evaluate()
      • EdgeRule.init_texts()
    • EdgeTagRule
      • EdgeTagRule.edge_tags_all
      • EdgeTagRule.edge_tags_any
      • EdgeTagRule.init_texts()
    • GraphRule
      • GraphRule.evaluate()
      • GraphRule.init_texts()
    • NodeRule
      • NodeRule.evaluate()
      • NodeRule.init_texts()
    • NodeTagRule
      • NodeTagRule.init_texts()
      • NodeTagRule.node_tags_all
      • NodeTagRule.node_tags_any
  • flowstrider.rules.elicit module
    • elicit()
  • Module contents
    • elicit()

Submodules

flowstrider.settings module

flowstrider.settings.get_localedir() → str

flowstrider.settings.init_localization(language: str, position: str)

Manages the localization

Parameters:

• language – the language string e.g.(‘en’, ‘de’)

• position – whether to set the system language (‘sys’) or the output language (‘out’)

flowstrider.storage module

flowstrider.storage.deserialize_dfd(serialized_dfd: str) → DataflowDiagram

Convert a dfd given as string to a DataflowDiagram class

flowstrider.storage.deserialize_threat_management_database(serialized_threat_management_database: str) → ThreatManagementDatabase

flowstrider.storage.dictify_dfd(dfd: DataflowDiagram) → dict

flowstrider.storage.dictify_threat_management_database(threat_management_database: ThreatManagementDatabase) → dict

flowstrider.storage.serialize_dfd(dfd: DataflowDiagram) → str

flowstrider.storage.serialize_threat_management_database(threat_management_database: ThreatManagementDatabase) → str

flowstrider.storage.undictify_dfd(dictified_dfd: dict) → DataflowDiagram

flowstrider.storage.undictify_threat_management_database(dictified_threat_management_database: dict) → ThreatManagementDatabase

flowstrider.tool module

flowstrider.tool.elicit_cmd(dfd_path: Path, management_path: Path | None, output_path: Path | None, fail_on_threat: str, out_lang: str, filters: List[str], sort: str, group: str, quiet: bool)

flowstrider.tool.main()

flowstrider.tool.metadata_cmd(dfd_path: Path, output_path: Path, out_lang: str)

flowstrider.tool.print_threats(dfd: DataflowDiagram, threat_management_database: ThreatManagementDatabase, threats_info_holder: ThreatsInfoContainer, quiet: bool)

flowstrider.tool.update_cmd(dfd_path: Path, metadata_path: Path)

Module contents