Class: Msf::MCP::Security::InputValidator

Inherits:
Object
  • Object
show all
Defined in:
lib/msf/core/mcp/security/input_validator.rb

Constant Summary collapse

LIMIT_DEFAULT = 
100
LIMIT_MIN = 
1
LIMIT_MAX = 
1000

Class Method Summary collapse

Class Method Details

.validate_ip_address!(addr) ⇒ true

Validate IP address or CIDR range

Parameters:

  • addr (String) —

    IP address or CIDR (e.g., “192.168.1.1” or “192.168.1.0/24”)

Returns:

  • (true) —

    If valid

Raises:



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/msf/core/mcp/security/input_validator.rb', line 85

def self.validate_ip_address!(addr)
  return true if addr.nil? || addr.empty?

  begin
    IPAddr.new(addr)
    true
  rescue IPAddr::InvalidAddressError
    raise ValidationError, "Invalid IP address or CIDR: #{addr}"
  end
end

.validate_limit!(limit) ⇒ true

Validate limit parameter for pagination

Parameters:

  • limit (Integer) —

    Limit value

Returns:

  • (true) —

    If valid

Raises:



135
136
137
 
# File 'lib/msf/core/mcp/security/input_validator.rb', line 135

def self.validate_limit!(limit)
  validate_parameter!('Limit', limit, LIMIT_MIN..LIMIT_MAX, allow_nil: true)
end

.validate_module_name!(module_name) ⇒ true

Validate module name

Parameters:

  • module_name (String) —

    Module name/path

Returns:

  • (true) —

    If valid

Raises:



173
174
175
176
 
# File 'lib/msf/core/mcp/security/input_validator.rb', line 173

def self.validate_module_name!(module_name)
  # Basic path validation (alphanumeric, slashes, underscores, hyphens)
  validate_parameter!('Module name', module_name, %r{\A[\w/\-]+\z}, max_size: 500)
end

.validate_module_type!(module_type) ⇒ true

Validate module type

Parameters:

  • module_type (String) —

    Module type

Returns:

  • (true) —

    If valid

Raises:



164
165
166
 
# File 'lib/msf/core/mcp/security/input_validator.rb', line 164

def self.validate_module_type!(module_type)
  validate_parameter!('Module type', module_type, %w[exploit auxiliary post payload encoder evasion nop])
end

.validate_offset!(offset) ⇒ true

Validate offset parameter for pagination

Parameters:

  • offset (Integer) —

    Offset value

Returns:

  • (true) —

    If valid

Raises:



144
145
146
 
# File 'lib/msf/core/mcp/security/input_validator.rb', line 144

def self.validate_offset!(offset)
  validate_parameter!('Offset', offset, 0..LIMIT_MAX, allow_nil: true)
end

.validate_only_up!(only_up) ⇒ true

Validate only_up boolean parameter

Parameters:

  • only_up (Boolean) —

    Only up parameter

Returns:

  • (true) —

    If valid

Raises:



183
184
185
 
# File 'lib/msf/core/mcp/security/input_validator.rb', line 183

def self.validate_only_up!(only_up)
  validate_parameter!('only_up', only_up, [true, false])
end

.validate_pagination!(limit, offset) ⇒ true

Validate pagination parameters

Parameters:

  • limit (Integer) —

    Limit value

  • offset (Integer) —

    Offset value

Returns:

  • (true) —

    If valid

Raises:



154
155
156
157
 
# File 'lib/msf/core/mcp/security/input_validator.rb', line 154

def self.validate_pagination!(limit, offset)
  validate_limit!(limit)
  validate_offset!(offset)
end

.validate_parameter!(name, value, constraint, allow_nil: false, max_size: nil) ⇒ true

Generic parameter validation against a constraint

Dispatches based on the constraint type:

  • Array → value must be included in the list (enum)

  • Range → value must be an integer within the range, or a Range whose

    bounds are within the constraint (range must be integer-bounded)

  • Regexp → value (via .to_s) must match the pattern

Parameters:

  • name (String) —

    Parameter name (used in error messages)

  • value (Object) —

    Value to validate

  • constraint (Array, Range, Regexp) —

    Allowed values, range, or pattern

  • allow_nil (Boolean) (defaults to: false) —

    Whether nil/empty values are allowed (default: false)

  • max_size (Integer) (defaults to: nil) —

    (optional) Maximum length for string values (only applies to Regexp constraints)

Returns:

  • (true) —

    If valid

Raises:



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/msf/core/mcp/security/input_validator.rb', line 27

def self.validate_parameter!(name, value, constraint, allow_nil: false, max_size: nil)
  if allow_nil
    return true if value.nil?
    return true if value.respond_to?(:empty?) && value.empty?
  else
    raise ValidationError, "#{name} cannot be nil" if value.nil?
    raise ValidationError, "#{name} cannot be empty" if value.respond_to?(:empty?) && value.empty?
  end

  case constraint
  when Array
    unless constraint.include?(value)
      raise ValidationError, "Invalid #{name}: #{value.inspect}. Must be one of: #{constraint.join(', ')}"
    end
  when Range
    unless constraint.first.is_a?(Integer) && constraint.last.is_a?(Integer)
      raise ArgumentError, "Range constraint must be a range of integers, got #{constraint.first.class}..#{constraint.last.class}"
    end
    if value.is_a?(Range)
      begin
        int_first = Integer(value.first)
        int_last = Integer(value.last)
      rescue TypeError, ArgumentError
        raise ValidationError, "#{name} must have integer bounds: #{value.inspect}"
      end
      unless constraint.cover?(int_first..int_last)
        raise ValidationError, "#{name} must be between #{constraint.min} and #{constraint.max}: #{int_first}..#{int_last}"
      end
    else
      begin
        int_value = Integer(value)
      rescue TypeError, ArgumentError
        raise ValidationError, "#{name} must be an integer: #{value.inspect}"
      end
      unless constraint.cover?(int_value)
        raise ValidationError, "#{name} must be between #{constraint.min} and #{constraint.max}: #{value}"
      end
    end
  when Regexp
    string_value = value.to_s
    if max_size && string_value.length > max_size
      raise ValidationError, "#{name} too long (max #{max_size} characters)"
    end
    unless string_value.match?(constraint)
      raise ValidationError, "Invalid #{name} format: #{value}"
    end
  else
    raise ArgumentError, "Unsupported constraint type: #{constraint.class}"
  end

  true
end

.validate_port_range!(range) ⇒ true

Validate port or port range

Parameters:

  • range (String, Integer) —

    Port number or range (e.g., “80” or “80-443”)

Returns:

  • (true) —

    If valid

Raises:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/msf/core/mcp/security/input_validator.rb', line 101

def self.validate_port_range!(range)
  return true if range.nil? || range.to_s.empty?

  range_str = range.to_s

  # Match a port range like "80-443" — requires digits on both sides of the dash
  if range_str.match?(/\A\s*[[:alnum:]]+-[[:alnum:]]+\s*\z/)
    begin
      start_port, end_port = range_str.split('-', 2).map { |p| Integer(p.strip) }
    rescue TypeError, ArgumentError
      raise ValidationError, "Port range must have integer bounds: #{range_str}"
    end
    validate_parameter!('Port range', start_port..end_port, 1..65535)
  else
    validate_parameter!('Port', range_str, 1..65535)
  end

  true
end

.validate_protocol!(protocol) ⇒ true

Validate protocol parameter

Parameters:

  • protocol (String) —

    Protocol (‘tcp’ or ‘udp’)

Returns:

  • (true) —

    If valid

Raises:



192
193
194
 
# File 'lib/msf/core/mcp/security/input_validator.rb', line 192

def self.validate_protocol!(protocol)
  validate_parameter!('Protocol', protocol.to_s.downcase, %w[tcp udp], allow_nil: true)
end

.validate_search_query!(query) ⇒ true

Validate query string for module search

Parameters:

  • query (String) —

    Search query

Returns:

  • (true) —

    If valid

Raises:



126
127
128
 
# File 'lib/msf/core/mcp/security/input_validator.rb', line 126

def self.validate_search_query!(query)
  validate_parameter!('Search query', query, /\A[[:print:]]+\z/, allow_nil: false, max_size: 500)
end