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

# Class: Aspisec::Modules::Recaf

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

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

## Overview

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

Examples:

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

See Also:

- https://github.com/Col-E/Recaf

## Instance Attribute Summary collapse

- #classpath ⇒ 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) ⇒ Recaf 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) ⇒ `Recaf`

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/recaf.rb', line 30

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

## Instance Attribute Details

### #classpath ⇒ `Location` (readonly)

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

Returns:

- (`Location`)

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

    def classpath
      @classpath
    end

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

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

Returns:

- (`Location`)

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

    def logs
      @logs
    end