Skip to content

Commit b64d881

Browse files
committed
Make OptionContainer docs a little more useful
1 parent 3a5af39 commit b64d881

File tree

2 files changed

+19
-27
lines changed

2 files changed

+19
-27
lines changed

lib/msf/core/opt.rb

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,6 @@
22

33
module Msf
44

5-
###
6-
#
7-
# The core supported option types are:
8-
#
9-
# OptString - Multi-byte character string
10-
# OptRaw - Multi-byte raw string
11-
# OptBool - Boolean true or false indication
12-
# OptPort - TCP/UDP service port
13-
# OptAddress - IP address or hostname
14-
# OptPath - Path name on disk or an Object ID
15-
# OptInt - An integer value
16-
# OptEnum - Select from a set of valid values
17-
# OptAddressRange - A subnet or range of addresses
18-
# OptSession - A session identifier
19-
# OptRegexp - Valid Ruby regular expression
20-
#
21-
###
22-
235
#
246
# Builtin framework options with shortcut methods
257
#

lib/msf/core/option_container.rb

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,27 @@
33
module Msf
44
require 'msf/core/opt_base'
55

6-
###
76
#
8-
# The options purpose in life is to associate named options
9-
# with arbitrary values at the most simplistic level. Each
10-
# module contains a OptionContainer that is used to hold the
11-
# various options that the module depends on. Example of options
12-
# that are stored in the OptionContainer are rhost and rport for
13-
# payloads or exploits that need to connect to a host and
14-
# port, for instance.
7+
# The options purpose in life is to associate named options with arbitrary
8+
# values at the most simplistic level. Each {Msf::Module} contains an
9+
# OptionContainer that is used to hold the various options that the module
10+
# depends on. Example of options that are stored in the OptionContainer are
11+
# rhost and rport for payloads or exploits that need to connect to a host
12+
# and port, for instance.
13+
#
14+
# The core supported option types are:
15+
#
16+
# * {OptString} - Multi-byte character string
17+
# * {OptRaw} - Multi-byte raw string
18+
# * {OptBool} - Boolean true or false indication
19+
# * {OptPort} - TCP/UDP service port
20+
# * {OptAddress} - IP address or hostname
21+
# * {OptPath} - Path name on disk or an Object ID
22+
# * {OptInt} - An integer value
23+
# * {OptEnum} - Select from a set of valid values
24+
# * {OptAddressRange} - A subnet or range of addresses
25+
# * {OptRegexp} - Valid Ruby regular expression
1526
#
16-
###
1727
class OptionContainer < Hash
1828

1929
#

0 commit comments

Comments
 (0)