This project creates full-stack platform-specific packages for
metasploit-framework. This is not the same as the Metasploit Community
edition. It only contains the framework command-line interface and the
associated tools and modules.
If you just want to install this package, we provide a number of pre-built binaries for Metasploit that are rebuilt every night. See https://github.com/rapid7/metasploit-framework/wiki/Nightly-Installers for installation information.
This project has a package cache that should be pulled in before building. Run 'git submodule update -i' to download the git submodule that contains these packages. We cache these both for performance, and because occasionally upstream locations go away, and this allows the build to continue without broken dependencies.
The Dockerfiles for metasploit-omnibus are located within the docker directory of this repository.
You can build images yourself:
git clone https://github.com/rapid7/metasploit-omnibus.git
cd metasploit-omnibus
docker build --tag metasploit-omnibus-builder - < ./docker/ubuntu1204-x86/DockerfileOr on OSX you can use the following script to build all images following the latest Docker image naming convention:
export BUILD_DATE=$(date "+%Y_%m"); ls ./docker | xargs -I IMAGE_NAME /bin/bash -x -c "docker build --tag rapid7/msf-IMAGE_NAME-omnibus:$BUILD_DATE -f ./docker/IMAGE_NAME/Dockerfile ./docker/IMAGE_NAME"Pushing
export BUILD_DATE=$(date "+%Y_%m"); ls ./docker | xargs -I IMAGE_NAME /bin/bash -x -c "docker push rapid7/msf-IMAGE_NAME-omnibus:$BUILD_DATE"You can then run a new container using the above tagged image, whilst mounting the current directory as a volume:
docker run -it --rm --volume $(pwd):$(pwd) --workdir $(pwd) --user jenkins metasploit-omnibus-builder /bin/bash --loginOr you can run a new container using pre-built images from Rapid7's Docker Hub account:
docker run -it --rm --volume $(pwd):$(pwd) --workdir $(pwd) --user jenkins rapid7/msf-ubuntu1204-x86-omnibus:2021_11 /bin/bash --loginBy default, metasploit-omnibus will download the latest version of Metasploit framework from Github, but also supports building with local copies from /metasploit-framework - full details.
To build omnibus with a local version of Metasploit framework, you can mount your framework repository as a volume to /metasploit-framework within the container. The following command assumes that the repository exists within the parent directory:
docker run -it --rm --volume $(pwd):$(pwd) --volume=$(pwd)/../metasploit-framework:/metasploit-framework --workdir $(pwd) --user jenkins rapid7/msf-ubuntu1204-x86-omnibus:2021_11 /bin/bash --loginWhen running inside the container, you can perform a normal ommibus build:
# Download the git submodule that contains cached packages
git submodule update -i
# install omnibus' dependencies
bundle install
bundle binstubs --all
# build the metasploit-framework package
bin/omnibus build metasploit-framework
When complete, there will be a new installable .deb file under the 'pkg' directory. Note that the use of Docker volumes may cause builds to run slower.
To test the .deb file, install it - and then open msfconsole:
# install
sudo dpkg -i pkg/metasploit-framework_6.3.39~20231017232715.git.3.47e0cd3~1rapid7-1_amd64.deb
# Run to verify
msfconsole
In general, a build environment needs a working C/C++ compiler, Ruby 1.9 or higher and the ruby development headers, bundler, git, bison and flex. A quad-core CPU and 4GB of ram are recommended.
The following steps should produce a successful build with Ubuntu and other Debian derivatives, starting from a fresh installation:
# install required packages to build on Ubuntu / Debian systems
sudo apt-get -y install build-essential git ruby bundler ruby-dev bison flex autoconf automakeConfigure the omnibus cache and target directories if you want to build as non-root user (recommended).
# setup build directories you can write to
sudo mkdir -p /var/cache/omnibus
sudo mkdir -p /opt/metasploit-framework
sudo chown `whoami` /var/cache/omnibus
sudo chown `whoami` /opt/metasploit-frameworkNext setup git if you need to.
# setup git (ignore if you already have it configured)
git config --global user.name "Nobody"
git config --global user.email "[email protected]"Checkout the metasploit-framework installer builder and install omnibus' dependencies.
# checkout the builder repository
git clone https://github.com/rapid7/metasploit-omnibus.git
cd metasploit-omnibus
# install omnibus' dependencies
bundle install && bundle binstubs --allFinally, build the installer itself:
# build the metasploit-framework package
bin/omnibus build metasploit-frameworkwhen complete, there will be a new installable .deb file under the 'pkg' directory.
From Windows 10, install ruby, msys2, ruby-devkit, wixtoolset, git. Add the following command to the the preparation steps before executing the build command.
xz -d local/cache/*.xz
From OS X, first install XCode and the command line development tools. I use ruby, bundler, git, bison and flex from the Mac Homebrew project. The rest of the steps are identical to building on Ubuntu. A .pkg file will be under the pkg directory instead.
You can clean up all temporary files generated during the build process with
the clean command:
$ bin/omnibus clean metasploit-frameworkAdding the --purge purge option removes ALL files generated during the
build including the project install directory (/opt/metasploit-framework) and
the package cache directory (/var/cache/omnibus/pkg) as well as ALL files
in the local package cache directory (./local/cache):
$ bin/omnibus clean metasploit-framework --purgeRestore the git submodule that contains the local package cache:
$ git submodule update -iOmnibus has a built-in mechanism for releasing to a variety of "backends", such
as Amazon S3. You must set the proper credentials in your omnibus.rb config
file or specify them via the command line.
$ bin/omnibus publish path/to/*.deb --backend s3Full help for the Omnibus command line interface can be accessed with the
help command:
$ bin/omnibus help
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent