Skip to content

Metasploit Loginpalooza

Jump to bottom Edit New page
Tod Beardsley edited this page Aug 4, 2014 · 16 revisions

Just looking for the list or the scorecard? If so, feel free to skip ahead.

This wiki describes how to set up an environment and participate in the Metasploit Loginpalooza contest by creating Metasploit Framework LoginScanners, running from now until September 1, 2014. Read this, and start knocking out modules that use the new Metasploit Credential gem, now available for all and sundry users who care to track the new branch.

Step One: Get a development environment

If you've never set up a Metasploit Framework development environment, bop on over to http://r-7.co/MSF-DEV and do that -- the docs assume an Ubuntu Linux OS, vim, and ssh private key authentication.

Clean up any old references to staging

If you didn't just set up your environment, you'll need to probably prune your remote refs to avoid the "unable to resolve reference refs/remotes/upstream/staging/electro-release" error. There used to be a staging branch, now it's a directory. So, to clean that up:

git checkout master                 # Switch to your master branch
git branch -D staging               # Deletes your local staging branch if you have one
git push origin :staging            # Deletes your remote staging branch if you have one
git remote prune upstream origin && # Clears out refs to staging branches
git gc &&                           # Garbage collect
git fetch upstream &&               # Fetch the current repo info for usptream
git fetch origin                    # Fetch the current repo info for usptream

This may take a minute or two.

Check out the electro-release branch

Now, just treat the electro-release branch just like you would any other.

git checkout -b staging/electro-release --track upstream/staging/electro-release
bundle install

Performing the above will get you a copy of the target branch and install all the new gems you'll need to use the new Credential hotness.

Step Two: Pick a module and edit it

There are lots of helpful docs written by Dave Maloney, aka @dmaloney-r7, aka @TheLightCosine, on how to get rid of the old report_auth_info() method in your chosen module and replace it with a fancy new create_credential_login() method. Read up on that at Creating Metasploit Framework Login Scanners. It's really quite thrilling.

Now that you have some idea of what you're doing, pick a module from the list, and edit away!

Step Three: Open a Pull Request

This works pretty much just like a regular Metasploit module update, but for one important detail: You will want to open a pull request against the staging/electro-release branch.

To make the Pull Request process a little easier, I have an alias in my .gitconfig of pr-url (thanks kernelsmith!)

pr-url =!"xdg-open https://github.com/$(git config github.user)/$(basename $(git rev-parse --show-toplevel))/pull/new/$1:$2...$(git branch-current) #"

Using this is easy and fun:

git push origin
git pr-url rapid7 staging/electro-release

Step Four: Winning!

We will keep a simple Gist score card with links to Merged PRs, here, and the way to win is simple: Have the most Loginpalooza pull requests landed between right now and September 1st. That "landed" bit is important. If your module is broken, it won't be landed, and if it's a duplicate, it will be rejected.

Of course, there will be lots of discretion from the Metasploit Committers on who gets credit if/when people collaborate. GitHub is all about collaboration, of course. Generally speaking, anyone who is legitimately helpful on the code review and implementing changes will get credit. If it becomes obvious that people are cheating or just leeching off the work of others without doing anything usefully original, then credit for "merely" helping will drop off.

First place

The prize for first place is a really sweet Hak5 WiFi Pineapple kit.

Second place

The second place prize is a Onion Pi from Adafruit. These little buggers are adorable.

Runners up

Hey, I'm sure you'll get public praise and thank you's, and you'll get some training on how to credential-snarf the new and exciting way. You can't put a price tag on that!

Example module refactor

Check out the example FTP module over at Creating Metasploit Framework LoginScanners.

Scorecard

Nobody's started yet! This space will list users and their landed/contributed to pull requests.

Modules to Refactor

Special attention needed

Add a custom footer

Metasploit Wiki Pages

Clone this wiki locally