Module: Aspisec::Modules — Documentation by YARD 0.9.36

# Module: Aspisec::Modules

Defined in:
  lib-ruby/aspisec/modules.rb,
  lib-ruby/aspisec/modules/ffuf.rb,
  lib-ruby/aspisec/modules/john.rb,
  lib-ruby/aspisec/modules/amass.rb,
  lib-ruby/aspisec/modules/mobsf.rb,
  lib-ruby/aspisec/modules/recaf.rb,
  lib-ruby/aspisec/modules/dbgate.rb,
  lib-ruby/aspisec/modules/lsassy.rb,
  lib-ruby/aspisec/modules/ncrack.rb,
  lib-ruby/aspisec/modules/sqlmap.rb,
  lib-ruby/aspisec/modules/hashcat.rb,
  lib-ruby/aspisec/modules/netexec.rb,
  lib-ruby/aspisec/modules/remmina.rb,
  lib-ruby/aspisec/modules/semgrep.rb,
  lib-ruby/aspisec/modules/weevely.rb,
  lib-ruby/aspisec/modules/whatwaf.rb,
  lib-ruby/aspisec/modules/jwt_tool.rb,
  lib-ruby/aspisec/modules/filezilla.rb,
  lib-ruby/aspisec/modules/manspider.rb,
  lib-ruby/aspisec/modules/bloodhound.rb,
  lib-ruby/aspisec/modules/metasploit.rb,
  lib-ruby/aspisec/modules/spiderfoot.rb,
  lib-ruby/aspisec/modules/crackmapexec.rb,
  lib-ruby/aspisec/modules/theharvester.rb,
  lib-ruby/aspisec/modules/mongodb_compass.rb,
  lib-ruby/aspisec/modules/mongodb_mongosh.rb,
  lib-ruby/aspisec/modules/home_history_files.rb

## Overview

This Ruby module contains all Aspisec modules.
Each Aspisec module is a Ruby class inherinting the Aspisec::Module base class.
The "Modules" module also contains methods to manage all Aspisec modules.

## Defined Under Namespace

Classes: Amass, Bloodhound, Crackmapexec, Dbgate, Ffuf, Filezilla, Hashcat, HomeHistoryFiles, John, JwtTool, Lsassy, Manspider, Metasploit, Mobsf, MongodbCompass, MongodbMongosh, Ncrack, Netexec, Recaf, Remmina, Semgrep, Spiderfoot, Sqlmap, Theharvester, Weevely, Whatwaf

## Class Method Summary collapse

- .list_modules ⇒ Array<Symbol>

  List all available Aspisec modules.

- .modules(conf: nil, logger: nil) ⇒ Array<Aspisec::Module>

  Intanciates all Aspisec modules.

## Class Method Details

### .list_modules ⇒ `Array<Symbol>`

List all available Aspisec modules

Examples:

    Aspisec::Modules.list_modules
    # => [:Netexec, :Sqlmap, :Hashcat, :Theharvester, :Crackmapexec, :John, :Metasploit]

Returns:

- (`Array<Symbol>`) —

  list of symbolized module names

    16
    17
    18
    # File 'lib-ruby/aspisec/modules.rb', line 16

    def self.list_modules
      Aspisec::Modules.constants.select { |c| Aspisec::Modules.const_get(c) <= Aspisec::Module }
    end

### .modules(conf: nil, logger: nil) ⇒ `Array<Aspisec::Module>`

Intanciates all Aspisec modules

Parameters:

- conf (`Aspisec::Config`) (defaults to: `nil`) —

  an instance of the global configuration
  If none is provided, the default config is loaded.

- logger (`TTY::Logger`) (defaults to: `nil`) —

  logger instance. See Logger.
  If none is provided, a default logger with log level 2 is created.
  See Logger::LOG_LEVEL.

Returns:

- (`Array<Aspisec::Module>`)

    27
    28
    29
    30
    # File 'lib-ruby/aspisec/modules.rb', line 27

    def self.modules(conf: nil, logger: nil)
      cnf = conf || Aspisec::Config.new(logger).conf
      list_modules.map { |c| Aspisec::Modules.const_get(c).new(cnf, logger:) }
    end