いつも通りにコンパイルしたところエラーが発生

Nginxをインストールする際、リバースプロキシのキャッシュを削除するためにngx_cache_purgeモジュールを組み込んでソースからコンパイルする方も多いと思います。

今回CentOS6でいつも通りにコンパイルしたところエラーが出てハマったので、導入方法と合わせて原因と解決方法を解説します。

---

各種ファイルのダウンロードとspecファイルの変種

CentOS6用のソースファイルをダウンロード

まずはエンタープライズLinux用の拡張パッケージ(EPEL)からソースファイルをダウンロードします。

http://dl.fedoraproject.org/pub/epel/6/SRPMS/から当該ファイルを調べることができます。今回は最新版が「nginx-1.0.15-11.el6.src.rpm」だったので以下の通り。

# su - hoge ← hogeユーザーで実行する場合
$ wget http://dl.fedoraproject.org/pub/epel/6/SRPMS/nginx-1.0.15-11.el6.src.rpm

ちなみにビルド作業用のユーザーを「mockbuild」とする例が多いですが、一般ユーザーで既にhomeディレクトリのあるユーザーであればユーザー名は何でも構いません。

ソースファイルのインストール

$ rpm -ivh nginx-1.0.15-11.el6.src.rpm

ngx_cache_purgeをダウンロード

ダウンロードするファイルはhttp://labs.frickle.com/files/から調べることができる。

$ cd ~/rpmbuild/SOURCES/ ← ソースを展開するディレクトリに移動
$ wget http://labs.frickle.com/files/ngx_cache_purge-2.3.tar.gz

Nginxをダウンロード

ダウンロードするファイルはhttp://nginx.org/en/download.htmlで調べられる。

Stable versionとMainline versionについて

Stable versionが安定版、Mainline versionが通常版となっている。
Stable versionはAPIとの互換性を重視したり、こなれたものを好む環境向け。
Mainline versionは開発版という扱いではなく、名前の通りこちらが通常版で特別な理由が無い限りこちらを使う。バグの修正もMainlineが先で、その後に重大なエラーの場合はStableにも反映されるという流れらしい。

参考：どのバージョンのnginxを使うべきか？ - 考える人、コードを書く人より

今回はさくっと作業を終えたいのでStable versionの1.6.2を選択。

$ wget http://nginx.org/download/nginx-1.6.2.tar.gz

specファイルの編集

specファイルはRPMファイルを作るための手順書のようなものです。
一応初めて触れる方にもわかるように解説を加えながら進めます。

さらに詳しく知りたい方は英語版ですがFedoraのwikiで詳しく解説されています。
https://fedoraproject.org/wiki/How_to_create_an_RPM_package

もしくはこちら。
http://vinelinux.org/docs/vine6/making-rpm/make-spec.html

$ cd ~/rpmbuild/SPECS  ← specファイルのディレクトリに移動
$ cp nginx.spec nginx.spec.org  ← バックアップ
$ vi nginx.spec

1.マクロの定義を追加

「%define」はマクロの定義で、「%define マクロの名前 内容」という書式で書きます。
使いたい場合は「%{マクロの名前}」とすれば表示できます。
下の例で言えば「%{ngx_cache_purge_version}」と書けば「2.3」が返ります。

「_unpackaged_files_terminate_build 0」はファイルの定義をするものです。
RPMは%filesセクションに記載されていないファイルをパッケージのリストに見つけた場合に強制終了します。

この仕組みによってspecファイルが正確に記述されているか判定できるものの、今回のように自分でモジュールなどを追加した場合はオフにしておいたほうが良いようです。ちなみに今回は無くても問題なくコンパイルできましたが、書式のようなものとして追加しておいてください。

ドキュメントエラーの場合は「%define _missing_doc_files_terminate_build 0」を使います。

%define _unpackaged_files_terminate_build 0
%define ngx_cache_purge_version 2.3

2.バージョンの指定

11行目あたり、Nginxのバージョンとリリース番号、ディストリビューションを指定します。再度モジュール等を追加してコンパイルし直す場合はリリース番号を更新してください。

Version:           1.0.15
Release:           11%{?dist}
↓
Version:           1.6.2
Release:           1%{?dist}

3.ngx_cache_purgeのソースを追加

28行目あたり、ソースの後の番号は空いてるものならなんでもいいですが、切り良く「10」にしときます。上で解説したように%{ngx_cache_purge_version}は2.3が渡されます。

Source7:           nginx.sysconfig
↓
Source7:           nginx.sysconfig
Source10: ngx_cache_purge-%{ngx_cache_purge_version}.tar.gz

4.nginx-auto-cc-gccパッチをコメントアウト

90行目あたり、パッチの適用をコメントアウト。
patch0は設定ファイルで定義したように「nginx-auto-cc-gcc.patch」というパッチで、バッファが溢れるのを防ぐFORTIFY_SOURCE=2がFedora系ではコンパイルエラーになるため無効にするためのパッチです。
CentOS6ではこのパッチを当てずともコンパイルできるのでコメントアウトして無効にします。

%patch0 -p0
↓
#%patch0 -p0

続いて今回コンパイルエラーの原因になった「patch1」もコメントアウトします。

こちらは「nginx-1.0.15-fix-CVE-2014-3616.patch」というパッチ。バーチャルドメインで複数のサイトを運営している場合、SSLのキーやキャッシュを共通して利用してしまうバグを修正するもの。クッキーの盗難やセッションハイジャックに悪用されることがあるようです。

詳しくはBug 1142573 – CVE-2014-3616 nginx: virtual host confusion。

上記のサイトに解説されているようにStable versionなら1.6.2以上、Mainline versionなら1.7.5 以上で解決されているとのこと。
つまり今回インストールする1.6.2ならパッチは必要ないのでコメントアウトします。

%patch1 -p1
↓
#%patch1 -p1

ちなみにコメントアウトせずにコンパイルしようとすると以下のエラーが出ます。

+ echo 'Patch #1 (nginx-1.0.15-fix-CVE-2014-3616.patch):'
Patch #1 (nginx-1.0.15-fix-CVE-2014-3616.patch):
+ /bin/cat /home/www/rpmbuild/SOURCES/nginx-1.0.15-fix-CVE-2014-3616.patch
+ /usr/bin/patch -p1 --fuzz=0
patching file src/event/ngx_event_openssl.c
Hunk #1 FAILED at 1498.
1 out of 1 hunk FAILED -- saving rejects to file src/event/ngx_event_openssl.c.rej
error: Bad exit status from /var/tmp/rpm-tmp.OTT0Zs (%prep)

試しにNginx 1.6.2で「~/rpmbuild/BUILD」に展開された「src/event/ngx_event_openssl.c」を見てみてもパッチの当該箇所がありません。
さらに1.6.1を見てみるとパッチの当該箇所はあるものの、パッチのミスなのか、そもそも対象となるバージョンが異なっているのか不明ですが行数の指定が間違っており、やはりエラーになります。
何らかの理由で1.6.1以下を使う場合は上記パッチを手動で当てる必要がありそうです。

5.ngx_cache_purgeのソースファイル用の設定を追加

93行目あたり、ソースファイルの展開方法を指定します。ざっくり解説するとnginx.sysconfigを展開した場所にファイルを展開して削除をしないという設定です。

セットアップマクロについては「%setupマクロの詳細」で詳しく解説されています。
必要な方は参照してください。

%patch2 -p0
↓
%patch2 -p0
%setup -T -D -a 10

6.言語設定を追加

export DESTDIR=%{buildroot}
↓
export LANG='ja_JP.UTF-8'
export DESTDIR=%{buildroot}

7.オプションにngx_cache_purgeを追加

--with-cc-opt="%{optflags} $(pcre-config --cflags)" \
↓
--with-cc-opt="%{optflags} $(pcre-config --cflags)" \
--add-module=%{_builddir}/nginx-%{version}/ngx_cache_purge-%{ngx_cache_purge_version} \

8.ngx_cache_purgeのリードミーと更新ログをリネーム

make %{?_smp_mflags} 
↓
make %{?_smp_mflags} 

mv ngx_cache_purge-%{ngx_cache_purge_version}/CHANGES ngx_cache_purge-%{ngx_cache_purge_version}/CHANGES.ngx_cache_purge
mv ngx_cache_purge-%{ngx_cache_purge_version}/README.md ngx_cache_purge-%{ngx_cache_purge_version}/README.ngx_cache_purge

9.ngx_cache_purgeのドキュメントファイルの指定

%doc LICENSE CHANGES README
↓
%doc LICENSE CHANGES README
%doc ngx_cache_purge-%{ngx_cache_purge_version}/CHANGES.ngx_cache_purge ngx_cache_purge-%{ngx_cache_purge_version}/README.ngx_cache_purge

以上で全ての設定は完了です。
バージョンごとに細かく異なるので、設定を理解して自分で修正したほうがいいですが、一応今回の修正したspecファイルを掲載します。

---

Nginxをコンパイルしてインストールする

コンパイルに必要なパッケージのインストール

まずはコンパイルに必要なパッケージをインストールします。
specファイルのBuildRequiresに記載されていたものが必要なパッケージです。

# yum install GeoIP-devel gd-devel libxslt-devel openssl-devel pcre-devel perl-devel perl zlib-devel

コンパイル

コンパイルするユーザーに戻してrpmbuildでコンパイルします。

# su - hoge
$ cd ~/rpmbuild/SPECS/
$ rpmbuild -bb nginx.spec

ズラーっと表示されるが、以下のように出力されれば成功。

+ cd /home/www/rpmbuild/BUILD
+ cd nginx-1.6.2
+ /bin/rm -rf /home/www/rpmbuild/BUILDROOT/nginx-1.6.2-1.el6.x86_64
+ exit 0

あとは普通のrpmファイルと同じようにインストールするだけです。
既にNginxがインストールしてある場合はアンインストールをしてからインストールしたほうが確実です。yumで削除すると依存関係にあるソフトも削除されて面倒なので、nodepsオプションを付けてNginxだけアンインストールします。
設定ファイルはrpmが自動でバックアップを取ってくれますが、無くなると面倒なので設定ファイルは自分でバックアップしてからアンインストールしてください。

# rpm -e --nodeps nginx ← Nginxだけ削除
warning: /etc/nginx/nginx.conf saved as /etc/nginx/nginx.conf.rpmsave ← rmpが自動で設定ファイルをバックアップ
warning: /etc/nginx/fastcgi_params saved as /etc/nginx/fastcgi_params.rpmsave
# rpm -ivh nginx-1.6.2-1.el6.x86_64.rpm

もし「error: Failed dependencies:」と表示されたら、依存関係を無視してインストールします。

# rpm -ivh --nodeps nginx-1.6.2-1.el6.x86_64.rpm

インストールが完了したら「ngx_cache_purgeモジュール」が正しく組み込まれているか調べます。

# nginx -V

built by gcc 4.4.7 20120313 (Red Hat 4.4.7-11) (GCC)
TLS SNI support enabled
configure arguments: --prefix=/usr/share/nginx --sbin-path=/usr/sbin/nginx --conf-path=/etc/nginx/nginx.conf --error-log-path=/var/log/nginx/error.log --http-log-path=/var/log/nginx/access.log --http-client-body-temp-path=/var/lib/nginx/tmp/client_body --http-proxy-temp-path=/var/lib/nginx/tmp/proxy --http-fastcgi-temp-path=/var/lib/nginx/tmp/fastcgi --http-uwsgi-temp-path=/var/lib/nginx/tmp/uwsgi --http-scgi-temp-path=/var/lib/nginx/tmp/scgi --pid-path=/var/run/nginx.pid --lock-path=/var/lock/subsys/nginx --user=nginx --group=nginx --with-file-aio --with-ipv6 --with-http_ssl_module --with-http_realip_module --with-http_addition_module --with-http_xslt_module --with-http_image_filter_module --with-http_geoip_module --with-http_sub_module --with-http_dav_module --with-http_flv_module --with-http_mp4_module --with-http_gzip_static_module --with-http_random_index_module --with-http_secure_link_module --with-http_degradation_module --with-http_stub_status_module --with-http_perl_module --with-mail --with-mail_ssl_module --with-debug --with-cc-opt='-O2 -g -pipe -Wall -Wp,-D_FORTIFY_SOURCE=2 -fexceptions -fstack-protector --param=ssp-buffer-size=4 -m64 -mtune=generic' --add-module=/home/hoge/rpmbuild/BUILD/nginx-1.6.2/ngx_cache_purge-2.3 --with-ld-opt=-Wl,-E

「--add-module=/home/hoge/rpmbuild/BUILD/nginx-1.6.2/ngx_cache_purge-2.3」となっており、正しくモジュールが追加されていることがわかります。（hogeはコンパイルしたユーザー名）
このモジュールを指定するために展開したファイルを削除しない設定を追加したというわけです。

インストールが完了したら、保存しておいた設定ファイルの復元と、実行ユーザーを変更している場合は「/var/lib/nginx」や「/var/log/nginx」の所有権の変更をして、再起動します。

---

以上Nginx 1.6.2にngx_cache_purge 2.3を組み込んでインストールする方法でした。

パッチのくだりなど、何のためのパッチなのかを理解せずに行っていると、思わぬエラーで躓くことがあるぞ、という例でした。