mentat package

Mentat is a distributed modular SIEM (Security Information and Event Management System) designed to monitor networks of all sizes. Its architecture enables reception, storage, analysis, processing and response to a great volume of security incidents originating from various sources, such as honeypots, network probes, log analysers, third party detection services, etc. The Mentat system has been developed as an open-source project.

Subpackages

• mentat.daemon package
  • Subpackages
    • mentat.daemon.component package
      • Submodules
        • mentat.daemon.component.commiter module
        • mentat.daemon.component.enricher module
          • Component setup configuration
          • Plugin configuration
          • Current plugin list
        • mentat.daemon.component.filer module
        • mentat.daemon.component.filter module
        • mentat.daemon.component.inspector module
          • Setup configuration
          • Inspection rules
          • Inspection actions
        • mentat.daemon.component.mailer module
        • mentat.daemon.component.parser module
        • mentat.daemon.component.printer module
        • mentat.daemon.component.sampler module
        • mentat.daemon.component.storage module
        • mentat.daemon.component.test_commiter module
        • mentat.daemon.component.test_enricher module
        • mentat.daemon.component.test_filer module
        • mentat.daemon.component.test_filter module
        • mentat.daemon.component.test_inspector module
        • mentat.daemon.component.test_mailer module
        • mentat.daemon.component.test_parser module
        • mentat.daemon.component.test_printer module
        • mentat.daemon.component.test_sampler module
        • mentat.daemon.component.test_storage module
        • mentat.daemon.component.testsuite module
  • Submodules
    • mentat.daemon.base module
    • mentat.daemon.piper module
      • Filer daemon component
      • Custom configuration
        • Custom command line options
    • mentat.daemon.test_piper module
• mentat.datatype package
  • Submodules
    • mentat.datatype.internal module
      • Library contents
    • mentat.datatype.sqldb module
      • Overview
    • mentat.datatype.test_internal module
    • mentat.datatype.test_sqldb module
• mentat.emails package
  • Submodules
    • mentat.emails.base module
    • mentat.emails.event module
    • mentat.emails.informant module
    • mentat.emails.test_event module
    • mentat.emails.test_informant module
• mentat.idea package
  • Submodules
    • mentat.idea.internal module
    • mentat.idea.jsondict module
    • mentat.idea.sqldb module
    • mentat.idea.test_internal module
    • mentat.idea.test_jsondict module
    • mentat.idea.test_sqldb module
• mentat.module package
  • Submodules
    • mentat.module.backup module
      • Usage examples
      • Available script commands
      • Custom configuration
        • Custom command line options
      • Backup script requirements
      • Backup structure
    • mentat.module.cleanup module
      • Usage examples
      • Available script commands
      • Custom configuration
        • Custom command line options
      • Available cleanup thresholds
    • mentat.module.controller module
      • Usage examples
      • Available script commands
      • Custom configuration
        • Custom command line options
        • Custom configuration file options
    • mentat.module.dbmngr module
      • Usage examples
      • Available script commands
      • Custom configuration
        • Custom command line options
    • mentat.module.enricher module
      • Usage examples
    • mentat.module.ideagen module
      • Message templates
      • Usage examples
      • Available script commands
      • Custom configuration
        • Custom command line options
    • mentat.module.informant module
      • Usage examples
      • Available script commands
    • mentat.module.inspector module
      • Usage examples
    • mentat.module.netmngr module
      • Usage examples
      • Available script commands
      • Custom configuration
        • Custom command line options
        • Custom config file options
      • Exception file format
      • Whois file format
    • mentat.module.precache module
      • Usage examples
      • Available script commands
      • Custom configuration
        • Custom command line options
        • Custom config file options
    • mentat.module.reporter module
      • Usage examples
      • Available script commands
      • Brief overview of reporting algorithm
    • mentat.module.sampler module
      • Usage examples
    • mentat.module.statistician module
      • Usage examples
      • Available script commands
    • mentat.module.storage module
      • Usage examples
• mentat.plugin package
  • Subpackages
    • mentat.plugin.app package
      • Submodules
        • mentat.plugin.app.eventstorage module
          • Example usage
        • mentat.plugin.app.mailer module
          • Example usage
        • mentat.plugin.app.sqlstorage module
          • Example usage
        • mentat.plugin.app.test_eventstorage module
        • mentat.plugin.app.test_sqlstorage module
        • mentat.plugin.app.testsuite module
    • mentat.plugin.enricher package
      • Submodules
        • mentat.plugin.enricher.geoip module
        • mentat.plugin.enricher.logger module
        • mentat.plugin.enricher.passivedns module
        • mentat.plugin.enricher.test_geoip module
        • mentat.plugin.enricher.test_logger module
        • mentat.plugin.enricher.test_whois module
        • mentat.plugin.enricher.testsuite module
        • mentat.plugin.enricher.whois module
    • mentat.plugin.test package
      • Submodules
        • mentat.plugin.test.test module
• mentat.reports package
  • Submodules
    • mentat.reports.base module
    • mentat.reports.event module
    • mentat.reports.overview module
    • mentat.reports.test_base module
    • mentat.reports.test_event module
    • mentat.reports.test_overview module
    • mentat.reports.test_utils module
    • mentat.reports.utils module
• mentat.script package
  • Submodules
    • mentat.script.base module
    • mentat.script.fetcher module
    • mentat.script.test_fetcher module
• mentat.services package
  • Submodules
    • mentat.services.bench_eventstorage module
    • mentat.services.bench_whois module
    • mentat.services.cache module
    • mentat.services.dnsr module
    • mentat.services.eventstorage module
      • References
    • mentat.services.geoip module
      • Prerequisites
    • mentat.services.nerd module
    • mentat.services.pdnsr module
    • mentat.services.sqlstorage module
    • mentat.services.test_dnsr module
    • mentat.services.test_eventstorage module
    • mentat.services.test_geoip module
    • mentat.services.test_pdnsr module
    • mentat.services.test_sqlstorage module
    • mentat.services.test_whois module
    • mentat.services.whois module
      • Module contents
• mentat.stats package
  • Submodules
    • mentat.stats.bench_idea module
    • mentat.stats.idea module
    • mentat.stats.rrd module
      • Overview
      • RRD database identifier naming convention
      • Example usage
    • mentat.stats.test_idea module
    • mentat.stats.test_rrd module

Submodules

• mentat.const module
• mentat.dirq module
• mentat.fixtures module
• mentat.system module
• mentat.test_dirq module
• mentat.test_idea module
• mentat.test_system module