Skip to content

rapid7/rex-socket

Repository files navigation

Rex::Socket

The Ruby Exploitation (Rex) Socket Abstraction Library. This library includes all of the code needed to turn sockets into Rex::Sockets. Rex::Sockets are used to provide L3 pivoting and proxy support in Metasploit.

Installation

Add this line to your application's Gemfile:

gem 'rex-socket'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rex-socket

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rapid7/rex-socket. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.