infosecn1nja
/
metasploit-framework
mirror of https://github.com/infosecn1nja/metasploit-framework.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Land #5026, #5027, #5028: Doc grammar 

This merge covers three PRs. It /should/ autoresolve #5026 and #5028, but
I will have to manually close #5027 with this comment.
bug/bundler_fix
Tod Beardsley 2015-03-30 12:53:13 -05:00
parent 613f4777ce f663f39e1f
commit b770f8dca4
No known key found for this signature in database
GPG Key ID: BD63D0A3EA19CAAC
3 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@ -4,8 +4,8 @@ Thanks for your interest in making Metasploit -- and therefore, the
world -- a better place! world -- a better place!
Are you about to report a bug? Sorry to hear it. Here's our [Issue tracker]. Are you about to report a bug? Sorry to hear it. Here's our [Issue tracker].
Please try to be as specific as you can about your problem, include steps Please try to be as specific as you can about your problem; include steps
to reproduce (cut and paste from your console output if it's helpful), and to reproduce (cut and paste from your console output if it's helpful) and
what you were expecting to happen. what you were expecting to happen.
Are you about to report a security vulnerability in Metasploit itself? Are you about to report a security vulnerability in Metasploit itself?
@ -18,7 +18,7 @@ Metasploit module? If so, read on...
# Contributing to Metasploit # Contributing to Metasploit
What you see here in CONTRIBUTING.md is a bullet-point list of the do's What you see here in CONTRIBUTING.md is a bullet point list of the do's
and don'ts of how to make sure *your* valuable contributions actually and don'ts of how to make sure *your* valuable contributions actually
make it into Metasploit's master branch. make it into Metasploit's master branch.
@ -27,7 +27,7 @@ closed. Sorry!
This is intended to be a **short** list. The [wiki] is much more This is intended to be a **short** list. The [wiki] is much more
exhaustive and reveals many mysteries. If you read nothing else, take a exhaustive and reveals many mysteries. If you read nothing else, take a
look at the standard [development environment setup] guide, look at the standard [development environment setup] guide
and Metasploit's [Common Coding Mistakes]. and Metasploit's [Common Coding Mistakes].
## Code Contributions ## Code Contributions
@ -52,7 +52,7 @@ Pull requests [PR#2940] and [PR#3043] are a couple good examples to follow.
#### New Modules #### New Modules
* **Do** run `tools/msftidy.rb` against your module and fix any errors or warnings that come up. * **Do** run `tools/msftidy.rb` against your module and fix any errors or warnings that come up.
- Even better would be to set up `msftidy.rb` as a [pre-commit hook]. - It would be even better to set up `msftidy.rb` as a [pre-commit hook].
* **Do** use the many module mixin [API]s. Wheel improvements are welcome; wheel reinventions, not so much. * **Do** use the many module mixin [API]s. Wheel improvements are welcome; wheel reinventions, not so much.
* **Don't** include more than one module per pull request. * **Don't** include more than one module per pull request.
@ -80,11 +80,11 @@ Pull requests [PR#2940] and [PR#3043] are a couple good examples to follow.
* **Do** report vulnerabilities in Rapid7 software directly to security@rapid7.com. * **Do** report vulnerabilities in Rapid7 software directly to security@rapid7.com.
* **Do** write a detailed description of your bug and use a descriptive title. * **Do** write a detailed description of your bug and use a descriptive title.
* **Do** include reproduction steps, stack traces, and anything else that might help us verify and fix your bug. * **Do** include reproduction steps, stack traces, and anything else that might help us verify and fix your bug.
* **Don't** file duplicate reports - search for your bug before filing a new report. * **Don't** file duplicate reports; search for your bug before filing a new report.
If you need some more guidance, talk to the main body of open If you need some more guidance, talk to the main body of open
source contributors over on the [Freenode IRC channel] source contributors over on the [Freenode IRC channel],
or e-mail us at [metasploit-hackers] mailing list. or e-mail us at the [metasploit-hackers] mailing list.
Also, **thank you** for taking the few moments to read this far! You're Also, **thank you** for taking the few moments to read this far! You're
already way ahead of the curve, so keep it up! already way ahead of the curve, so keep it up!
@ -92,7 +92,7 @@ already way ahead of the curve, so keep it up!
[Issue Tracker]:http://r-7.co/MSF-BUGv1 [Issue Tracker]:http://r-7.co/MSF-BUGv1
[PGP key]:http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=0x2380F85B8AD4DB8D [PGP key]:http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=0x2380F85B8AD4DB8D
[wiki]:https://github.com/rapid7/metasploit-framework/wiki [wiki]:https://github.com/rapid7/metasploit-framework/wiki
[scripts]: https://github.com/rapid7/metasploit-framework/tree/master/scripts [scripts]:https://github.com/rapid7/metasploit-framework/tree/master/scripts
[development environment setup]:http://r-7.co/MSF-DEV [development environment setup]:http://r-7.co/MSF-DEV
[Common Coding Mistakes]:https://github.com/rapid7/metasploit-framework/wiki/Common-Metasploit-Module-Coding-Mistakes [Common Coding Mistakes]:https://github.com/rapid7/metasploit-framework/wiki/Common-Metasploit-Module-Coding-Mistakes
[Ruby style guide]:https://github.com/bbatsov/ruby-style-guide [Ruby style guide]:https://github.com/bbatsov/ruby-style-guide
@ -104,10 +104,10 @@ already way ahead of the curve, so keep it up!
[PR#2940]:https://github.com/rapid7/metasploit-framework/pull/2940 [PR#2940]:https://github.com/rapid7/metasploit-framework/pull/2940
[PR#3043]:https://github.com/rapid7/metasploit-framework/pull/3043 [PR#3043]:https://github.com/rapid7/metasploit-framework/pull/3043
[pre-commit hook]:https://github.com/rapid7/metasploit-framework/blob/master/tools/dev/pre-commit-hook.rb [pre-commit hook]:https://github.com/rapid7/metasploit-framework/blob/master/tools/dev/pre-commit-hook.rb
[API]:https://rapid7.github.io/metasploit-framework/api/ [API]:https://rapid7.github.io/metasploit-framework/api
[RSpec]:http://rspec.info/ [RSpec]:http://rspec.info
[Better Specs]:http://betterspecs.org/ [Better Specs]:http://betterspecs.org
[YARD]:http://yardoc.org/ [YARD]:http://yardoc.org
[Issues]:https://github.com/rapid7/metasploit-framework/issues [Issues]:https://github.com/rapid7/metasploit-framework/issues
[Freenode IRC channel]:http://webchat.freenode.net/?channels=%23metasploit&uio=d4 [Freenode IRC channel]:http://webchat.freenode.net/?channels=%23metasploit&uio=d4
[metasploit-hackers]:https://lists.sourceforge.net/lists/listinfo/metasploit-hackers [metasploit-hackers]:https://lists.sourceforge.net/lists/listinfo/metasploit-hackers

12
README.md
View File

@ -3,7 +3,7 @@ Metasploit [![Build Status](https://travis-ci.org/rapid7/metasploit-framework.pn
The Metasploit Framework is released under a BSD-style license. See The Metasploit Framework is released under a BSD-style license. See
COPYING for more details. COPYING for more details.
The latest version of this software is available from https://metasploit.com/ The latest version of this software is available from: https://metasploit.com
Bug tracking and development information can be found at: Bug tracking and development information can be found at:
https://github.com/rapid7/metasploit-framework https://github.com/rapid7/metasploit-framework
@ -20,8 +20,8 @@ Questions and suggestions can be sent to:
Installing Installing
-- --
Generally, you should use [the free installer](https://www.metasploit.com/download) Generally, you should use [the free installer](https://www.metasploit.com/download),
which contains all dependencies and will get you up and running with a which contains all of the dependencies and will get you up and running with a
few clicks. See the [Dev Environment Setup](http://r-7.co/MSF-DEV) if few clicks. See the [Dev Environment Setup](http://r-7.co/MSF-DEV) if
you'd like to deal with dependencies on your own. you'd like to deal with dependencies on your own.
@ -34,10 +34,10 @@ resources](https://metasploit.github.io), or the [wiki].
Contributing Contributing
-- --
See the [Dev Environment Setup][wiki-devenv] guide on GitHub which will See the [Dev Environment Setup][wiki-devenv] guide on GitHub, which will
walk you through the whole process starting from installing all the walk you through the whole process from installing all the
dependencies, to cloning the repository, and finally to submitting a dependencies, to cloning the repository, and finally to submitting a
pull request. For slightly more info, see pull request. For slightly more information, see
[Contributing](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md). [Contributing](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md).

4
msfvenom
View File

@ -28,7 +28,7 @@ require 'msf/core/payload_generator'
# Creates a new framework object. # Creates a new framework object.
# #
# @note Ignores any previously cached value # @note Ignores any previously cached value.
# @param (see ::Msf::Simple::Framework.create) # @param (see ::Msf::Simple::Framework.create)
# @return [Msf::Framework] # @return [Msf::Framework]
def init_framework(create_opts={}) def init_framework(create_opts={})
@ -66,7 +66,7 @@ require 'msf/core/payload_generator'
end end
end end
opt.on('-l', '--list [module_type]', Array, 'List a module type example: payloads, encoders, nops, all') do |l| opt.on('-l', '--list [module_type]', Array, 'List a module type. Options are: payloads, encoders, nops, all') do |l|
if l.nil? or l.empty? if l.nil? or l.empty?
l = ["all"] l = ["all"]
end end