稼働済みNGINXへの受付制限の追加¶
既にHTTPSサイトと問い合わせAPIの転送が動いている環境へ、今回の設定差分を追加する。サイトのHTML・CSS・JavaScriptはCI/CDで配置するため、この作業では公開ファイルを手動コピーしない。既存のroot、証明書、HTTPからHTTPSへの301転送、APIのproxy_passは維持する。
静的サイトのCSP・HSTS等も追加する場合は、セキュリティヘッダーの反映手順へ進む。受付制限の共有定義はhttp内、ヘッダーのincludeはHTTPS用serverまたは対象location内と、追加先が異なる。
設定を書く場所¶
NGINXのhttp { ... }は、HTTP通信だけを扱う場所という意味ではない。HTTP用・HTTPS用の両方のserverを含む設定ブロックである。今回の共有定義は、このhttp内で、各serverの外側へ置く。
| 設定 | 書く場所 |
|---|---|
limit_req_zone |
http内、serverの外 |
limit_conn_zone |
http内、serverの外 |
log_format contact_safe |
http内、serverの外 |
limit_req・limit_connなどの受付制限 |
HTTPS用server内の既存location = /api/contact |
proxy_set_header X-Real-IP・専用ログ |
同じlocation = /api/contact |
| HTTPからHTTPSへの301転送 | 既存設定を維持。今回の追加先には使わない |
次は配置関係だけを示す模式図であり、設定ファイル全体の置き換えには使わない。
http {
# 共有定義の追加先:limit_req_zone / limit_conn_zone / log_format
server {
listen 80;
# 既存のHTTPSへの301転送を維持
}
server {
listen 443 ssl;
# 既存の証明書、rootなどを維持
location = /api/contact {
# 頻度制限、同時処理制限、実IP転送、ログの追加先
# 既存のproxy_passなどを維持
}
}
}
サイト別ファイルにhttpブロックがない場合は、nginx.confのhttp内からそのファイルがincludeされているかを確認する。この構成なら、サイト別ファイルのserverより前もhttpの設定範囲となる。ただし、そのファイルがserver内から読み込まれる構成なら共有定義は書けない。新しいhttpブロックをサイト別ファイルに作らず、読み込み元の位置で判断する。
1. 現在の設定ファイルを確認・保存する¶
ここからはNGINXサーバーのBashで実行する。
sudo nginx -T 2>&1 | less
# configuration file ...の表示とincludeを確認し、httpを定義するファイル、対象HTTPSサイト、既存のlocation = /api/contactを特定する。ファイル名や配置は環境により異なる。
編集前に対象ファイルをバックアップする。次のcontact_siteは実際に編集するファイルへ置き換える。シンボリックリンクならreadlink -fで確認したリンク先を使う。
contact_site=/etc/nginx/sites-available/実際のサイト設定ファイル
contact_nginx_backup="/root/nginx-contact-before-$(date -u +%Y%m%dT%H%M%SZ)"
sudo install -d -m 700 "$contact_nginx_backup"
sudo cp -a /etc/nginx/nginx.conf "$contact_nginx_backup/nginx.conf"
sudo cp -a "$contact_site" "$contact_nginx_backup/site.conf"
バックアップはNGINXがincludeするディレクトリの外へ置く。sites-enabled/*などがバックアップも読み込み、同じサイトを二重定義する事故を避ける。
2. 共有定義を一度だけ追加する¶
ここでは/etc/nginx/nginx.confの既存のhttp { ... }内に書く方法を使う。
sudoedit /etc/nginx/nginx.conf
対象サイトの設定を読み込むincludeより前に、次を追加する。同名の共有領域やログ形式が既にある場合は重複追加せず、内容を確認する。
limit_req_zone $binary_remote_addr zone=contact_rate:10m rate=6r/m;
limit_conn_zone $binary_remote_addr zone=contact_connections:10m;
log_format contact_safe '$time_iso8601 status=$status method=$request_method '
'duration=$request_time rate=$limit_req_status';
これらをHTTPS用のserver内へ書くと構文エラーになる。共有定義だけでは制限は有効にならず、次のlocationへの適用が必要である。
3. 既存のHTTPS用locationを差分更新する¶
sudoedit "$contact_site"
既存のlocation = /api/contact { ... }の内側へ次を追加する。同じディレクティブがある場合は、二重に追加せずその行を更新する。
limit_req zone=contact_rate burst=2 nodelay;
limit_req_status 429;
limit_conn contact_connections 1;
limit_conn_status 429;
proxy_set_header X-Real-IP $remote_addr;
同じlocationにあるaccess_log off;を次へ置き換える。既に専用のアクセスログ・エラーログ設定がある場合も、重複させず更新する。
access_log /var/log/nginx/contact-access.log contact_safe;
error_log /var/log/nginx/contact-error.log crit;
proxy_pass、proxy_set_header Origin、タイムアウトなどの既存設定は維持する。location = /api/contact全体の参照例はnginx.conf.exampleにあるが、既存サイト全体をこの断片で置き換えない。
4. API側の信頼するプロキシIPを合わせる¶
NGINXサーバーで、APIへの接続元IPを確認する。以下のAPI接続先は今回の作業環境の例である。
ip route get 192.168.200.10
出力のsrcが192.168.200.1なら、アプリサーバー側の/etc/tectas-contact/contact.envに次を設定する。NAT等がある場合は、APIから実際に見える接続元IPを確認する。
TRUSTED_PROXY_IPS=192.168.200.1
アプリサーバーで設定変更後に再起動する。
sudo systemctl restart tectas-contact
以前の例の192.168.15.20をそのまま使わない。同一ホスト構成なら通常は127.0.0.1,::1を指定する。APIのTCP 3001番への接続はNGINXからだけ許可する。CDN等を挟む場合は、信頼する接続元からだけNGINXの実IPを復元する設定も別途確認する。
5. 構文検査後にreloadする¶
NGINXサーバーで実行する。
sudo nginx -t && sudo systemctl reload nginx
構文検査が失敗した場合はreloadされない。表示されたファイル・行を修正し、再度検査する。
| エラーの例 | 確認する箇所 |
|---|---|
directive is not allowed here |
共有定義をserverやlocation内へ書いていないか |
unknown log format "contact_safe" |
log_formatを追加したか、参照するサイトより前に読み込まれるか |
duplicate ... |
同じ共有定義・ディレクティブ・locationを二重に追加していないか |
6. NGINX経由の疎通とログを確認する¶
APIがSENDING_ENABLED=falseなら、Origin照合を通過した要求は503・dependency_errorになる。NGINX自体の503や502とは、JSONのcodeとログで区別する。
次はNGINXが192.168.200.1で、本番ドメイン用のHTTPS設定・有効な証明書を持つ場合の例である。既存サイトのホスト名・IPが異なる場合は置き換える。--resolveはDNSの公開先を変更せず、今回の確認だけ接続先を指定する。
curl --noproxy '*' \
--resolve www.tectas.co.jp:443:192.168.200.1 \
-i https://www.tectas.co.jp/api/contact \
-H 'Origin: https://www.tectas.co.jp' \
-H 'Content-Type: application/json' \
--data '{}'
OriginはAPIのALLOWED_ORIGINと一致させる。現在の本番用設定はhttps://www.tectas.co.jpであり、接続先の内部IPと同じ値とは限らない。証明書エラーの場合は検証を省略せず、既存のホスト名と証明書を確認する。
sudo tail -n 5 /var/log/nginx/contact-access.log
時刻、status=503、メソッド、処理時間、頻度制限結果が記録されれば、送信停止状態の疎通確認は完了となる。短時間に繰り返すと429になるため、再試行時は時間を置く。空のJSONによる確認ではSMTP・Turnstile・IP別送信カウンターの正常動作までは確認できない。
この段階ではAPIの送信停止を維持する。フロントの修正はCI/CDで配置し、両方の設定がそろってから送信を再開して実Turnstile・メール受信・別IPの受付を確認する。専用ログの権限・ローテーションとSlack通知の配置はSlack監視手順へ進む。
設定を戻す場合¶
変更前へ戻す場合は、上記で保存したバックアップから編集対象の設定を復元し、nginx -tの成功後にreloadする。API側のTRUSTED_PROXY_IPSも、戻したNGINX設定との組み合わせを確認する。NGINXがX-Real-IPを送らなくなった状態でAPIだけがその値を信頼すると、新規投稿を処理できなくなる。