Class: Aspisec::Modules::Amass — Documentation by YARD 0.9.36

# Class: Aspisec::Modules::Amass

Inherits:
  Aspisec::Module
  - Object
  - Aspisec::Module
  - Aspisec::Modules::Amass
  show all

Defined in:
  lib-ruby/aspisec/modules/amass.rb

## Overview

Amass module.
Inherits Aspisec::Module.
For more examples of methods, see Sqlmap.

Examples:

    # Get the global config
    conf = Aspisec::Config.new.conf
    # Create a Amass module instance
    ama = Aspisec::Modules::Amass.new(conf)
    # Locations available
    ama.locations_list # => ["logs", "database"]

See Also:

- https://github.com/OWASP/Amass

## Instance Attribute Summary collapse

- #database ⇒ Location readonly

  see Config::DEFAULT_CONFIG or call Aspisec::Module::Location#description.

- #logs ⇒ Location readonly

  see Config::DEFAULT_CONFIG or call Aspisec::Module::Location#description.

### Attributes inherited from Aspisec::Module

#base, #conf, #locations_list, #name

## Instance Method Summary collapse

- #initialize(conf, logger: nil) ⇒ Amass constructor

  Inherits from Aspisec::Module but has only the `conf` argument, `tool_name` is hardcoded for each module.

### Methods inherited from Aspisec::Module

#check_config, #enabled?, #locations

## Constructor Details

### #initialize(conf, logger: nil) ⇒ `Amass`

Inherits from Aspisec::Module but has only the `conf` argument,
`tool_name` is hardcoded for each module.

Parameters:

- conf (`Aspisec::Config`) —

  an instance of the global configuration

    30
    31
    32
    33
    34
    35
    # File 'lib-ruby/aspisec/modules/amass.rb', line 30

    def initialize(conf, logger: nil)
      super(conf, 'amass', logger:)
      @logs = Location.new(@conf, 'logs')
      @database = Location.new(@conf, 'database')
      @locations_list = %w[logs database]
    end

## Instance Attribute Details

### #database ⇒ `Location` (readonly)

see Config::DEFAULT_CONFIG or call Aspisec::Module::Location#description.

Returns:

- (`Location`)

    25
    26
    27
    # File 'lib-ruby/aspisec/modules/amass.rb', line 25

    def database
      @database
    end

### #logs ⇒ `Location` (readonly)

see Config::DEFAULT_CONFIG or call Aspisec::Module::Location#description.

Returns:

- (`Location`)

    21
    22
    23
    # File 'lib-ruby/aspisec/modules/amass.rb', line 21

    def logs
      @logs
    end