- 原文地址:https://github.com/rapid7/metasploit-framework/wiki/Setting-Up-a-Metasploit-Development-Environment
- 作者:Metasploit Community
- 譯者:王一航 & Google 2018-06-15
- 校對(duì):王一航 2018-06-15
譯者注:
在國內(nèi)建議使用 Gem 的 國內(nèi)鏡像源
gem sources --add https://gems.ruby-china.org/ --remove https://rubygems.org/
bundle config mirror.https://rubygems.org https://gems.ruby-china.org
本文將著重講述如何搭建 Metasploit Framework 的開發(fā)環(huán)境以便于貢獻(xiàn)者可以高效迅速地進(jìn)行貢獻(xiàn)。
如果你只是想對(duì) Metasploit Framework 進(jìn)行授權(quán)的合法的滲透測(cè)試,我們建議直接下載商業(yè)版本安裝包或者 開源版本安裝包,因?yàn)槲覀円呀?jīng)在這些包中為您解決了所有的依賴問題。商業(yè)版本安裝包還包括可選的可以更新到 Metasploit Pro 的部分并且會(huì)每周更新兩次,而開源版本則會(huì)在每天晚上進(jìn)行更新。
如果你正在使用 Kali Linux,Metasploit 已經(jīng)預(yù)先安裝好了。可以參考這個(gè)指南,該指南提供了如何使用提供好的 Metasploit-Framework 軟件包以及配置數(shù)據(jù)庫。
如果你想?yún)⑴c開發(fā)或者對(duì) Metasploit 進(jìn)行貢獻(xiàn),那么本文很適合你,繼續(xù)讀下去吧!本文應(yīng)該可以讓你使用任何基于 Debian 的 Linux 操作系統(tǒng)進(jìn)行工作。
那么廢話少說,開始吧!
前提
- 你已經(jīng)有了一個(gè)基于 Debian 的 Linux 環(huán)境
- 你有一個(gè)非 Root 的用戶,本文中我們使用
msfdev
這個(gè)用戶 - 你有一個(gè) GitHub 賬號(hào),并且關(guān)聯(lián)了一個(gè) SSH 密鑰 到你的 GitHub 賬號(hào)。
安裝基礎(chǔ)開發(fā)軟件包
sudo apt-get -y install \
autoconf \
bison \
build-essential \
curl \
git-core \
libapr1 \
libaprutil1 \
libcurl4-openssl-dev \
libgmp3-dev \
libpcap-dev \
libpq-dev \
libreadline6-dev \
libsqlite3-dev \
libssl-dev \
libsvn1 \
libtool \
libxml2 \
libxml2-dev \
libxslt-dev \
libyaml-dev \
locate \
ncurses-dev \
openssl \
postgresql \
postgresql-contrib \
wget \
xsel \
zlib1g \
zlib1g-dev
請(qǐng)注意:目前我們還沒有安裝 Ruby,但是我們將會(huì)在后續(xù)步驟中進(jìn)行安裝。
Fork 并克隆 Metasploit-Framework 倉庫
你可以參考這篇 GitHub 提供的關(guān)于 forking 的指南,但是其實(shí)你只需要點(diǎn)擊倉庫主頁右上角的 “Fork” 按鈕就可以完成 Fork 操作了。
克隆
一旦你已經(jīng)在 GitHub 上 Fork 了該倉庫,現(xiàn)在就可以將該倉庫拉取到本地的開發(fā)機(jī)了。
同樣,你也可以參考 GitHub 提供的這篇關(guān)于 cloning 的指南
mkdir -p $HOME/git
cd $HOME/git
git clone git@github.com:YOUR_USERNAME_FOR_GITHUB/metasploit-framework
cd metasploit-framework
設(shè)置 Git 倉庫的 Upstream
首先,如果你打算使用最新的上游(upstream)來更新您的本地克隆,那么您需要跟蹤(track)它
在 metasploit-framework
Checkout 的目錄中,運(yùn)行如下命令:
git remote add upstream git@github.com:rapid7/metasploit-framework.git
git fetch upstream
git checkout -b upstream-master --track upstream/master
現(xiàn)在你已經(jīng)有了一個(gè)指向了 upstream 的分支(也就是 GitHub 上的 rapid7/Metasploit-Framework
這個(gè)倉庫),與你自己 Fork 得到的倉庫不同(指向 origin/master
的源 master
分支) 。
你或許會(huì)發(fā)現(xiàn),擁有 upstream-master
和 master
兩個(gè)不同的分支是非常方便的(尤其是當(dāng)你是一個(gè) Metasploit committer 的時(shí)候,因?yàn)檫@會(huì)將避免你意外地將代碼直接推送到 rapid7/master
分支上)
安裝 RVM(譯者注:Ruby Version Manager)
大部分的 Linux 發(fā)行版并不會(huì)提供可預(yù)測(cè)頻率的最新版本的 Ruby,因此我們使用 RVM (Ruby Version Manager)進(jìn)行 Ruby 版本的管理,你可以參考官網(wǎng)獲取相關(guān)信息,看起來很不錯(cuò)。當(dāng)然也有些人比較青睞 rbenv,你也可以參考 rbenv 教程。
但是你就得自己保證你有合適版本的 Ruby。因?yàn)榇蟛糠趾?Commiters 使用 RVM,所有本篇教程中,我們也會(huì)就 RVM 進(jìn)行接下來的操作。
首先,你需要為獲取 RVM 發(fā)行版的簽名文件
curl -sSL https://rvm.io/mpapis.asc | gpg --import -
然后,安裝 RVM:
curl -L https://get.rvm.io | bash -s stable
上面的命令是直接使用管道將所有的命令定向到了 Bash 中,但是這可能會(huì)引起一些比較敏感的問題。因此有一個(gè)更安全的方法如下:
curl -o rvm.sh -L https://get.rvm.io
less rvm.sh # Read it and see it's all good
cat rvm.sh | bash -s stable
當(dāng)上面的操作都成功完成后,就可以修復(fù)你的終端(Terminal)來使用 RVM 版的 Ruby 了
source ~/.rvm/scripts/rvm
cd ~/git/metasploit-framework
rvm --install $(cat .ruby-version)
最后,安裝 bundler
這個(gè) gem 包來獲取其他所有需要的的 gem 包:
gem install bundler
為 Gnome Terminal 配置使用 RVM
Gnome Terminal 真是個(gè)混蛋,默認(rèn)情況下它并沒有將你的 Shell 作為 Login shell,所以沒有對(duì) tweak 進(jìn)行配置的話, RVM 將無法正常工作。如下:
Navigate to Edit > Profiles > Highlight Default > Edit > Title and Command
選中如下復(fù)選框:
[√] Run command as a login shell.
看起來應(yīng)該像下圖這樣,具體可能根據(jù)不同的 Gnome 版本有微小差異:
最后,你就可以運(yùn)行在 .ruby-version 這個(gè)文件中指定的特定的 Ruby 版本了。
ruby -v
如果你發(fā)現(xiàn)當(dāng)前正在運(yùn)行的 Ruby 版本仍然不是在 .ruby-version
這個(gè)文件里面定義的版本的話,你或許需要重啟你的終端。如果你初始安裝的 RVM 不具備如下功能的話,那么請(qǐng)確保你已經(jīng)將 rvm 添加到了你的 Termianl 的啟動(dòng)腳本中。
echo '[[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm"' >> .bashrc
安裝打包組件 Gems
Metasploit 依賴許多 gems(Ruby 庫)。因?yàn)槟阏谑褂?RVM,因此你可以直接在本地安裝它們而不用考慮與 Debian 打包好的 Gems 產(chǎn)生沖突,感謝 Bundler 的黑科技。
先進(jìn)入你的 Checkout 的根目錄,然后運(yùn)行:
cd ~/git/metasploit-framework/
bundle install
一兩分鐘后,你就可以開始你的 Metasploit 之旅了,在你的 Checkout 目錄,輸入:
./msfconsole
沐浴在 Metasploit 啟動(dòng)帶來的光輝中吧?。ㄗg者注:原文 And bask in the glory that is a functioning source checkout)
第一次運(yùn)行的時(shí)候,將會(huì)順便創(chuàng)建一個(gè) ~/.msf4
的目錄
msfdev@lys:~/git/metasploit-framework$ ./msfconsole
[*] Starting the Metasploit Framework console.../
_---------.
.' ####### ;."
.---,. ;@ @@`; .---,..
." @@@@@'.,'@@ @@@@@',.'@@@@ ".
'-.@@@@@@@@@@@@@ @@@@@@@@@@@@@ @;
`.@@@@@@@@@@@@ @@@@@@@@@@@@@@ .'
"--'.@@@ -.@ @ ,'- .'--"
".@' ; @ @ `. ;'
|@@@@ @@@ @ .
' @@@ @@ @@ ,
`.@@@@ @@ .
',@@ @ ; _____________
( 3 C ) /|___ / Metasploit! \
;@'. __*__,." \|--- \_____________/
'(.,...."/
=[ metasploit v5.0.0-dev-26bf96b ]
+ -- --=[ 1744 exploits - 1001 auxiliary - 302 post ]
+ -- --=[ 536 payloads - 40 encoders - 10 nops ]
+ -- --=[ ** This is Metasploit 5 development branch ** ]
msf > ls ~/.msf4
[*] exec: ls ~/.msf4
history
local
logos
logs
loot
modules
plugins
msf > exit
唉,我們似乎還沒有成功配置數(shù)據(jù)庫來使用這些狂暴的 Hacking,要解決?簡單!
配置 PostgreSQL
Kali Linux 已經(jīng)自帶了 PostgreSQL,所以我們可以直接使用。在 Ubuntu 和其他基于 Debian 的發(fā)行版上,所有的配置應(yīng)該都是類似的,并且可以很好的工作。我們假設(shè)使用別的發(fā)行版的人已經(jīng)安裝好了 PostgreSQL
,TLDR 也確保數(shù)據(jù)庫能在系統(tǒng)啟動(dòng)時(shí)啟動(dòng)。
啟動(dòng)數(shù)據(jù)庫
TLDR(以 msfdev 用戶的身份運(yùn)行)
echo 'YOUR_PASSWORD_FOR_KALI' | sudo -kS update-rc.d postgresql enable &&
echo 'YOUR_PASSWORD_FOR_KALI' | sudo -S service postgresql start &&
cat <<EOF> $HOME/pg-utf8.sql
update pg_database set datallowconn = TRUE where datname = 'template0';
\c template0
update pg_database set datistemplate = FALSE where datname = 'template1';
drop database template1;
create database template1 with template = template0 encoding = 'UTF8';
update pg_database set datistemplate = TRUE where datname = 'template1';
\c template1
update pg_database set datallowconn = FALSE where datname = 'template0';
\q
EOF
sudo -u postgres psql -f $HOME/pg-utf8.sql &&
sudo -u postgres createuser msfdev -dRS &&
sudo -u postgres psql -c \
"ALTER USER msfdev with ENCRYPTED PASSWORD 'YOUR_PASSWORD_FOR_PGSQL';" &&
sudo -u postgres createdb --owner msfdev msf_dev_db &&
sudo -u postgres createdb --owner msfdev msf_test_db &&
cat <<EOF> $HOME/.msf4/database.yml
# Development Database
development: &pgsql
adapter: postgresql
database: msf_dev_db
username: msfdev
password: YOUR_PASSWORD_FOR_PGSQL
host: localhost
port: 5432
pool: 5
timeout: 5
# Production database -- same as dev
production: &production
<<: *pgsql
# Test database -- not the same, since it gets dropped all the time
test:
<<: *pgsql
database: msf_test_db
EOF
在 Kali Linux 上,PostgreSQL(或者其他需要監(jiān)聽端口的服務(wù))默認(rèn)情況下不會(huì)開啟。這是一個(gè)很好的安全資源防御措施,但是如果你想要讓他們隨時(shí)運(yùn)行的話(譯者注:開機(jī)啟動(dòng)),你也可以運(yùn)行以下命令:
update-rc.d postgresql enable
然后,切換到 Postgres 用戶來執(zhí)行一些小型數(shù)據(jù)庫的運(yùn)維工作來修復(fù)默認(rèn)編碼錯(cuò)誤(該有用的信息由 @ffmike's gist 提供)
sudo -sE su postgres
psql
update pg_database set datallowconn = TRUE where datname = 'template0';
\c template0
update pg_database set datistemplate = FALSE where datname = 'template1';
drop database template1;
create database template1 with template = template0 encoding = 'UTF8';
update pg_database set datistemplate = TRUE where datname = 'template1';
\c template1
update pg_database set datallowconn = FALSE where datname = 'template0';
\q
創(chuàng)建一個(gè)數(shù)據(jù)庫用戶 msfdev
還是在 postgres 這個(gè)用戶的權(quán)限下:
createuser msfdev -dPRS # Come up with another great password
createdb --owner msfdev msf_dev_db # Create the development database
createdb --owner msfdev msf_test_db # Create the test database
exit # Become msfdev again
創(chuàng)建 database.yml
現(xiàn)在切換到你自己的用戶,按照如下模板創(chuàng)建文件 $HOME/.msf4/database.yml
:
# Development Database
development: &pgsql
adapter: postgresql
database: msf_dev_db
username: msfdev
password: YOUR_PASSWORD_FOR_PGSQL
host: localhost
port: 5432
pool: 5
timeout: 5
# Production database -- same as dev
production: &production
<<: *pgsql
# Test database -- not the same, since it gets dropped all the time
test:
<<: *pgsql
database: msf_test_db
當(dāng)你下次啟動(dòng) ./msfconsole
,一個(gè)用于開發(fā)的數(shù)據(jù)庫將會(huì)被創(chuàng)建,可以使用以下命令檢查:
./msfconsole -qx "db_status; exit"
運(yùn)行規(guī)格說明
我們使用 rspec 來進(jìn)行大部分的框架測(cè)試。首先要確保下面的命令可以正常工作:
rake spec
上述命令運(yùn)行完成后,你應(yīng)該會(huì)看到總共運(yùn)行了超過 9000 個(gè)測(cè)試用例,其中大部分被標(biāo)記為綠色,很少一部分為黃色,不會(huì)出現(xiàn)紅色的錯(cuò)誤結(jié)果。
配置 Git
TLDR(以 msfdev 用戶的身份運(yùn)行)
cd $HOME/git/metasploit-framework &&
git remote add upstream git@github.com:rapid7/metasploit-framework.git &&
git fetch upstream &&
git checkout -b upstream-master --track upstream/master &&
ruby tools/dev/add_pr_fetch.rb &&
ln -sf ../../tools/dev/pre-commit-hook.rb .git/hooks/pre-commit &&
ln -sf ../../tools/dev/pre-commit-hook.rb .git/hooks/post-merge &&
git config --global user.name "YOUR_USERNAME_FOR_REAL_LIFE" &&
git config --global user.email "YOUR_USERNAME_FOR_EMAIL" &&
git config --global github.user "YOUR_USERNAME_FOR_GITHUB"
配置 Pull Ref
如果你想要在命令行上輕松訪問上游(upstream)的 Pull Requests,那么您需要添加相關(guān)的 fetch reference 到.git/config
中??梢酝ㄟ^以下方式輕松完成:
tools/dev/add_pr_fetch.rb
這將會(huì)添加所有相關(guān)的引用到你所有的 Git Remotes 中,包括你自己的。
現(xiàn)在你就可以按照如下命令來進(jìn)行操作了:
git checkout fixes-to-pr-1234 upstream/pr/1234
git push origin
- GitHub 提供了一種 更簡單的方法
上面所做的一切可以讓你查看別人的 Pull Request(PR),并進(jìn)行修改,然后發(fā)布到你自己的 Fork 的某一個(gè)分支上。這反過來會(huì)讓你幫助其他人的PR進(jìn)行修復(fù)或補(bǔ)充。
保持同步
請(qǐng)絕對(duì) 不要 直接直接提交代碼到 Master 分支。請(qǐng)將你所有的改動(dòng)放置在一個(gè)新的分支,然后對(duì)分支進(jìn)行合并。這樣的做法可以很容易就能保持代碼同步,并且你的本地修改永遠(yuǎn)也不會(huì)丟失。
同步到 upstream/master
再簡單不過了。
git checkout master
git fetch upstream
git push origin
這可以讓 Pull Requests 與 Master 分支保持同步。除非你遇到合并沖突,否則不需要經(jīng)常這樣做。
而且當(dāng)你最終解決合并沖突之后,你可能會(huì)想使用 --force
參數(shù)來將本地修改重新同步到分支,因?yàn)槟愕奶峤粴v史將會(huì)在 rebase 之后變得不同。
對(duì) rapid7/master 進(jìn)行強(qiáng)制 Push 是絕對(duì)不可以的。但是可以在別的正在開發(fā)的分支,重寫一些歷史并不會(huì)構(gòu)成聯(lián)邦犯罪。
Msftidy 工具
為了對(duì)任何你正在編寫的新模塊進(jìn)行檢查,你需要在 Commit 之前,以及 Merge 之后進(jìn)行 HOOK 以使用我們的代碼檢查工具 msftity.rb
進(jìn)行檢查,所以按照如下命令配置 Git HOOK:
cd $HOME/git/metasploit-framework
ln -sf ../../tools/dev/pre-commit-hook.rb .git/hooks/pre-commit
ln -sf ../../tools/dev/pre-commit-hook.rb .git/hooks/post-merge
配置你的身份
最后,如果你想為 Metasploit 做貢獻(xiàn)的話(譯者注:事實(shí)上所有開源項(xiàng)目都應(yīng)該這樣做),你至少需要按照如下命令配置你的名字與郵箱:
git config --global user.name "YOUR_USERNAME_FOR_REAL_LIFE"
git config --global user.email "YOUR_USERNAME_FOR_EMAIL"
git config --global github.user "YOUR_USERNAME_FOR_GITHUB"
注意你的郵箱地址必須和你的 GitHub 注冊(cè)的郵箱相互匹配。
對(duì) Commits 簽名
我們熱愛對(duì) Commits 進(jìn)行簽名,主要是因?yàn)槲覀?害怕另一種選擇(譯者注:原文 we're terrified of the alternative)。關(guān)于如何簽名的詳細(xì)信息可以在此獲取。請(qǐng)注意姓名和郵件地址必須完全匹配上簽名密鑰上的信息。我們鼓勵(lì)貢獻(xiàn)者簽名自己的 Commits,因?yàn)?Metasploit 的 Committers 在 合并 Pull Request(譯者注:Land Pull Request) 的時(shí)候也需要進(jìn)行簽名。
有用的別名
如果不再配置一些有用的讓生活變得更美好的別名的話,那么配置開發(fā)環(huán)境就不能算完成。
覆蓋已經(jīng)安裝過的 msfconsole
作為一個(gè)開發(fā)者,你可能會(huì)一不小心使用到已經(jīng)安裝過的 Metasploit msfconsole
,由于 RVM 會(huì)處理不同的 Ruby 版本和 gemsets 包的原因,可能會(huì)出現(xiàn)一些非預(yù)期的問題,所以你可以配置一下 Shell 的別名:
echo 'alias msfconsole="pushd $HOME/git/metasploit-framework && ./msfconsole && popd"' >> ~/.bash_aliases
如果你既想使用開發(fā)版的 Metasploit 也想使用安裝包,那么使用兩個(gè)不同的用戶可能是一個(gè)更好的選擇(譯者注:感覺這樣很麻煩,還不如使用 ./msfconsole
和 msfconsole
來的方便)
修改命令提示符使其支持顯示 Ruby/Gemset/Branch
下面的腳本可以很容易讓你知道你目前所在的位置/環(huán)境(譯者注:例如 Ruby 版本,Git 倉庫的分支等),你可以將如下腳本放在 ~/.bash_aliases
function git-current-branch {
git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/(\1) /'
}
export PS1="[ruby-\$(~/.rvm/bin/rvm-prompt v p g)]\$(git-current-branch)\n$PS1"
Git 命令別名
與傳統(tǒng) Shell 別名很相似,Git 自己本身也有別名功能,既可以在 $HOME/.gitconfig
中被配置,也可以在 repo-name/.git/config
中被配置。
如下為一些很有用的別名配置:
[alias]
# 一個(gè)簡單,帶顏色的單行日志格式化命令,并且會(huì)顯示當(dāng)前是否簽名的狀態(tài)。
nicelog = log --pretty=format:'%Cred%h%Creset -%Creset %s %Cgreen(%cr) %C(bold blue)<%aE>%Creset [%G?]'
# 快捷方式:
# 在 merge 和 commit 的時(shí)候自動(dòng)簽名,并且編輯 commit message
m = merge -S --no-ff --edit
c = commit -S --edit
# 為快速運(yùn)行 Git Blame 設(shè)置快捷方式,并且忽略空白字符的修改
#(譯者注:git blame 命令本身是在開發(fā)中出現(xiàn)問題的時(shí)候,用來定位某一個(gè)文件被誰修改了,這也是為啥叫 blame,當(dāng)然也可以查看誰修復(fù)了 BUG 進(jìn)行表揚(yáng)。)
b= blame -w
# 快速創(chuàng)建一個(gè)臨時(shí)分支,因?yàn)?Git Stash 命令太嚇人了(譯者注:估計(jì)是大部分人不太會(huì)用)
temp = !"git branch -D temp; git checkout -b temp"
# 在命令行中打開瀏覽器并創(chuàng)建一個(gè) Pull Request,其中第一個(gè)參數(shù)為用戶名,第二個(gè)參數(shù)為分支名。
# 感謝 @kernelsmith 對(duì)命令的修正!
pr-url =!"xdg-open https://github.com/$(git config github.user)/$(basename $(git rev-parse --show-toplevel))/pull/new/$1:$2...$(git branch-current) #"
以上就是全部內(nèi)容啦!如果你比較關(guān)心 Pull Request 的話,那么你看還需要配置 Aliases 和 PGP key 來 簽名你的 Commits。
但是除此之外,你已經(jīng)準(zhǔn)備好啦!
如果您在操作的時(shí)候遇到任何錯(cuò)誤,遺漏,或者發(fā)現(xiàn)了更好的方法,無論如何,請(qǐng)開啟一個(gè) GitHub Issue,我們將會(huì)看到您的反饋并更新 HOWTO 文檔。
特別鳴謝 @kernelsmith 與 @corelanc0d3r ,感謝他們對(duì)此開發(fā)環(huán)境文檔指南的寶貴幫助和反饋!