Skip to content

Commit fb43ef4

Browse files
author
Brent Cook
committed
realign msfvenom help text
1 parent a82168d commit fb43ef4

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

msfvenom

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -58,94 +58,95 @@ require 'msf/core/payload_generator'
5858
opt.separator('')
5959
opt.separator('Options:')
6060

61-
opt.on('-p', '--payload <payload>', String, 'Payload to use. Specify a \'-\' or stdin to use custom payloads') do |p|
61+
opt.on('-p', '--payload <payload>', String,
62+
'Payload to use. Specify a \'-\' or stdin to use custom payloads') do |p|
6263
if p == '-'
6364
opts[:payload] = 'stdin'
6465
else
6566
opts[:payload] = p
6667
end
6768
end
6869

69-
opt.on('-l', '--list [module_type]', Array, 'List a module type. Options are: payloads, encoders, nops, all') do |l|
70+
opt.on('--payload-options', "List the payload's standard options") do
71+
opts[:list_options] = true
72+
end
73+
74+
opt.on('-l', '--list [type]', Array, 'List a module type. Options are: payloads, encoders, nops, all') do |l|
7075
if l.nil? or l.empty?
7176
l = ["all"]
7277
end
7378
opts[:list] = l
7479
end
7580

76-
opt.on('-n', '--nopsled <length>', Integer, 'Prepend a nopsled of [length] size on to the payload') do |n|
81+
opt.on('-n', '--nopsled <length>', Integer, 'Prepend a nopsled of [length] size on to the payload') do |n|
7782
opts[:nops] = n.to_i
7883
end
7984

80-
opt.on('-f', '--format <format>', String, "Output format (use --help-formats for a list)") do |f|
85+
opt.on('-f', '--format <format>', String, "Output format (use --help-formats for a list)") do |f|
8186
opts[:format] = f
8287
end
8388

84-
opt.on('-e', '--encoder [encoder]', String, 'The encoder to use') do |e|
89+
opt.on('--help-formats', String, "List available formats") do
90+
init_framework(:module_types => [])
91+
msg = "Executable formats\n" +
92+
"\t" + ::Msf::Util::EXE.to_executable_fmt_formats.join(", ") + "\n" +
93+
"Transform formats\n" +
94+
"\t" + ::Msf::Simple::Buffer.transform_formats.join(", ")
95+
raise UsageError, msg
96+
end
97+
98+
opt.on('-e', '--encoder <encoder>', String, 'The encoder to use') do |e|
8599
opts[:encoder] = e
86100
end
87101

88-
opt.on('-a', '--arch <architecture>', String, 'The architecture to use') do |a|
102+
opt.on('-a', '--arch <arch>', String, 'The architecture to use') do |a|
89103
opts[:arch] = a
90104
end
91105

92-
opt.on('--platform <platform>', String, 'The platform of the payload') do |l|
106+
opt.on('--platform <platform>', String, 'The platform of the payload') do |l|
93107
opts[:platform] = l
94108
end
95109

96-
opt.on('-s', '--space <length>', Integer, 'The maximum size of the resulting payload') do |s|
110+
opt.on('-s', '--space <length>', Integer, 'The maximum size of the resulting payload') do |s|
97111
opts[:space] = s
98112
end
99113

100-
opt.on('--encoder-space <length>', Integer, 'The maximum size of the encoded payload (defaults to the -s value)') do |s|
114+
opt.on('--encoder-space <length>', Integer, 'The maximum size of the encoded payload (defaults to the -s value)') do |s|
101115
opts[:encoder_space] = s
102116
end
103117

104-
opt.on('-b', '--bad-chars <list>', String, 'The list of characters to avoid example: \'\x00\xff\'') do |b|
118+
opt.on('-b', '--bad-chars <list>', String, 'The list of characters to avoid example: \'\x00\xff\'') do |b|
105119
opts[:badchars] = Rex::Text.hex_to_raw(b)
106120
end
107121

108-
opt.on('-i', '--iterations <count>', Integer, 'The number of times to encode the payload') do |i|
122+
opt.on('-i', '--iterations <count>', Integer, 'The number of times to encode the payload') do |i|
109123
opts[:iterations] = i
110124
end
111125

112-
opt.on('-c', '--add-code <path>', String, 'Specify an additional win32 shellcode file to include') do |x|
126+
opt.on('-c', '--add-code <path>', String, 'Specify an additional win32 shellcode file to include') do |x|
113127
opts[:add_code] = x
114128
end
115129

116-
opt.on('-x', '--template <path>', String, 'Specify a custom executable file to use as a template') do |x|
130+
opt.on('-x', '--template <path>', String, 'Specify a custom executable file to use as a template') do |x|
117131
opts[:template] = x
118132
end
119133

120134
opt.on('-k', '--keep', 'Preserve the template behavior and inject the payload as a new thread') do
121135
opts[:keep] = true
122136
end
123137

124-
opt.on('--payload-options', "List the payload's standard options") do
125-
opts[:list_options] = true
126-
end
127-
128-
opt.on('-o', '--out <path>', 'Save the payload') do |x|
138+
opt.on('-o', '--out <path>', 'Save the payload') do |x|
129139
opts[:out] = x
130140
end
131141

132-
opt.on('-v', '--var-name <name>', String, 'Specify a custom variable name to use for certain output formats') do |x|
142+
opt.on('-v', '--var-name <name>', String, 'Specify a custom variable name to use for certain output formats') do |x|
133143
opts[:var_name] = x
134144
end
135145

136146
opt.on_tail('-h', '--help', 'Show this message') do
137147
raise UsageError, "#{opt}"
138148
end
139149

140-
opt.on_tail('--help-formats', String, "List available formats") do
141-
init_framework(:module_types => [])
142-
msg = "Executable formats\n" +
143-
"\t" + ::Msf::Util::EXE.to_executable_fmt_formats.join(", ") + "\n" +
144-
"Transform formats\n" +
145-
"\t" + ::Msf::Simple::Buffer.transform_formats.join(", ")
146-
raise UsageError, msg
147-
end
148-
149150
begin
150151
opt.parse!(args)
151152
rescue OptionParser::InvalidOption => e

0 commit comments

Comments
 (0)