貴学にてIdPv5をインストールする場合の構築手順
貴学にて、貴学のサーバにOSを含めShibboleth IdPならびに必要なパッケージのインストール・設定を行う手順を説明します。
目次 maxLevel 2 minLevel 2 style none
...
アンカー idpInst1 idpInst1
1. Shibboleth IdP (version 5以降) の動作要件
以下は本技術ガイドで構築する前提となる環境です。
- メモリ3GB以上
Java実行環境への推奨割り当てメモリ量が1.5GBですので、その動作に支障がないようにしてください。 - Apache HTTP Server 2.4 以上 と mod_ssl
以下のパッケージはインストール方法も含めて以降の手順で説明します。
- Jetty 9.4
- 11
- jetty-
distribution - home-
9- 11.0.
4- 20.
32- tar.
v20200930を使った手順となっています。- gzを使った手順となっています。
※いずれも以下のShibbolethのサイト「Jetty94」が情報源です。- 以前の技術ガイドではサーブレットコンテナとしてTomcatを用いたものをご案内しておりました。その関係で継続してTomcat利用を強くご希望の方向けに、暫定的にShibboleth IdP V4をTomcat 9で構築する方法を別途ご案内しております:
⇒旧: 貴学にてIdPv4(Tomcat)をインストールする場合の構築手順- いずれにしろTomcat 10およびそれ以降はサポートできかねますのでご了承ください。
- あくまでも暫定版です。すでに運用中でTomcatをお使いの方は動作確認の上Jettyへの移行をご検討ください。
- Java 11
Java 11以降のバージョンのみ対応しています。
注意 文字列置換のためのJavaScriptメソッド
"abc".replace("a", "b")
について、Java 7では全置換されていたものがJava 8では先頭の一致した部分しか置換されなくなるという情報があります。
当該メソッドを使って全置換を行っている場合は正規表現replace(/a/g, "b")
を使うようにしてください。Oracle JDK / OpenJDK 11にてLDAPサーバへの接続にLDAPSを使う場合、以下のエラーになるという情報があります。
書式設定済み java.lang.NullPointerException: Thread local SslConfig has not been set
原因はJDKのバグであるとのことです。該当する場合、以下でUnboundIDを使う回避策が提示されています。
https://wiki.shibboleth.net/confluence/display/IDP30/LDAPonJava>8
詳細: https://issues.shibboleth.net/jira/browse/IDP-1357- エントロピー不足で起動が遅くなる場合があるという情報があります。jre/conf/security/java.securityやシステムプロパティ等で対処してください。
確認方法および手順例: IdPのサービス動作状況の確認の「よくあるエラー」の503エラーの項- この問題はCentOS 7を使っている場合に顕著です。
- VMで稼働させていてこの問題がある場合、ホストマシンでHavegedを導入しVMからこれを参照する等で十分なエントロピーを生成できる場合があるようですので、合わせてご検討ください。
- GNU Javaは利用できません。 OpenJDKもしくはOracleのJavaを利用してください。
...
- Java 17
Java 17以降のバージョンのみ対応しています。
最新の情報はShibbolethのサイトでご確認ください:
全体, Jetty11
...
2. OSをインストールする
1. OSでの設定
・OS(Rocky Linux 9)インストール
インストーラでインストールするもの。
Webサーバー (HTTPのみ)
OpenLDAP
その他のパッケージは必要に応じてインストールしてください。
ただし、Java開発とJettyは後の手順で別にインストールします。
運用フェデレーション参加後に、ホスト名を変更する場合はいくつか考慮・解決すべき点があります。
ホスト名は十分ご検討いただいた上で設定してください。詳しくは IdPのホスト名変更に関する注意点 をご参照ください。
※このテキストはSELinuxはPermissiveに設定されているものとして書かれております。下記コマンドでSELinux設定を確認してください。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
$ /usr/sbin/getenforce |
・ネットワーク設定
環境に合わせ、ホスト名・ネットワーク・セキュリティを設定して下さい。
2. DNSへ登録する
新しいホスト名とIPアドレスをDNSに登録してください。
3. 時刻同期を設定する
ntpサービスを用い、貴学環境のntpサーバと時刻同期をしてください。
※Shibbolethでは、通信するサーバ間の時刻のずれが約3分を越えるとエラーになります。
...
アンカー | ||||
---|---|---|---|---|
|
3. java17(OpenJDK)、jetty11をインストールする
1. tomcatの削除
tomcat が入っている場合は、削除してください。
2. java17 のインストール
Rocky LinuxにはOpenJDKのパッケージが用意されていますので、これをdnfにてインストールします。
...
2. OSをインストールする
1. OSでの設定
・OS(CentOS 7)インストール
インストーラでインストールするもの。
Webサーバー (HTTPのみ)
OpenLDAP
その他のパッケージは必要に応じてインストールしてください。
ただし、Java開発とJettyは後の手順で別にインストールします。
運用フェデレーション参加後に、ホスト名を変更する場合はいくつか考慮・解決すべき点があります。
ホスト名は十分ご検討いただいた上で設定してください。詳しくは IdPのホスト名変更に関する注意点 をご参照ください。
※このテキストはSELinuxはPermissiveに設定されているものとして書かれております。下記コマンドでSELinux設定を確認してください。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
$ /usr/sbin/getenforce |
・ネットワーク設定
...
2. DNSへ登録する
...
3. 時刻同期を設定する
ntpサービスを用い、貴学環境のntpサーバと時刻同期をしてください。
※Shibbolethでは、通信するサーバ間の時刻のずれが約3分を越えるとエラーになります。
...
|
3. jetty11 のインストール
Jetty11の配置
jetty11は、https://jetty.org/download.html より最新版のパッケージ
...
3. jdk 11、jetty 9.4をインストールする
1. tomcatの削除
...
2. jdk のインストール
CentOS 7にはOpenJDKのパッケージが用意されていますので、これをyumにてインストールします。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
|
3. jetty 9.4 のインストール
https://www.eclipse.org/jetty/download.html より最新版のパッケージ(.tgz)をダウンロードしてインストールします。
さらに、Shibboleth Projectが配布しているJetty向け設定ファイル群(jetty-base)を配置します。
...
borderColor | #cccccc |
---|---|
bgColor | #eeeeee |
borderStyle | solid |
...
「最新版のパッケージ(.tgz)」のURLは、https://jetty.org/download.htmlの「The latest releases of Eclipse Jetty」表の「11.0.22 (EOCS)」行の「.tgz」をマウス右クリックして「リンクをコピー」を選択することによって、クリップボードに得ることができます。
(下枠の青色「https://repo1.maven.org/maven2/org/eclipse/jetty/jetty-
...
home/
...
11.
...
0.
...
20/jetty-
...
home-
...
11.
...
0.
...
20.tar.gz」が得られたURLです)
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Jetty-baseの配置
さらに、Shibboleth Projectが配布しているJetty向け設定ファイル群(jetty-base)を配置します。
jetty-baseのURLは、ブラウザで
https://build.shibboleth.net/maven/snapshots/net/shibboleth/idp/idp-jetty-base/
...
...
...
...
にアクセスし、バージョン11.0の(ファイル名に含まれる日付けが)最新版であるファイル(idp-jetty-base-
...
11.
...
0.
...
0-
...
*.
...
*-
...
*.tar.
...
gzというファイル名)をマウス右クリックして現れる「リンクをコピー」メニューで、取得してください。(クリップボードにURLがコピーされます)
(下枠の青色「https://build.shibboleth.net/maven/snapshots/net/shibboleth/idp/idp-jetty-base
...
/11.0.0-SNAPSHOT/idp-jetty-base-11.0.0-20240620.102527-121.tar.gz」が得られたURLです)
パネル | |||
---|---|---|---|
|
...
サービス起動には、jetty起動用のユーザを使用することを推奨します。
ここでは、一般的な"jetty"ユーザを作成します。(以降、"jetty"ユーザを使用する事を前提として説明します。)なお、下記コマンドでユーザID・グループIDは /usr/share/doc/setup-2.8.71/uidgid
の値を利用していますが他の値でも問題ありません。既存のユーザ・グループと重複しない値を指定してください。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
# useradd -u 110 -g jetty -d /opt/jetty-base -s /sbin/nologin -c "Jetty daemon" jetty
|
Jetty起動用ユーザ
サービス起動には、jetty起動用のユーザを使用することを推奨します。
ここでは、一般的な"jetty"ユーザを作成します。(以降、"jetty"ユーザを使用する事を前提として説明します。)なお、下記コマンドでユーザID・グループIDは /usr/share/doc/setup/uidgid
の値を利用していますが他の値でも問題ありません。既存のユーザ・グループと重複しない値を指定してください。以下のコマンドでその他Jetty関連の設定ファイルやディレクトリの所有者、パーミッションを設定します。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
# chown -R root:root /opt/jetty-distribution-9.4.*.v????????groupadd -g 110
# chown jetty:jetty /opt/jetty-base/{logs, -s /sbin/nologin -c "Jetty daemon" jetty |
以下のコマンドでその他Jetty関連の設定ファイルやディレクトリの所有者、パーミッションを設定します。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
# chown -R root:root /opt/jetty-home-11.0.20 /opt/jetty-base # chmod -R g-w /opt/jetty-base # chown jetty:jetty /opt/jetty-base/{logs,tmp} |
Jettyサービス自動起動の設定
jetty11は、"systemctl enable jetty"コマンドで自動起動されるようにしますが、chkconfigコマンドがインストールされていないと、この自動起動設定時にエラーとなります。
(参考:https://www.aidanwardman.com/enabling-boot-start-in-splunk-on-rhel-9-rocky-9/)
パネル |
---|
/etc/init.dが存在していたら削除します。(install後、/etc/init.d -> rc.d/init.dとするので、/etc/init.dが存在していると、dnf install でエラーとなります。) chkconfigをインストールする |
以下の内容で /etc/sysconfig/jetty
を作成します。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
JAVA=/usr/lib/jvm/jre/bin/java |
ヒント | |||||||||
---|---|---|---|---|---|---|---|---|---|
ここで
|
...
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
[Service] |
設定を反映させ、自動起動の登録を行います。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
|
4. jetty-baseの設定
/opt/jetty-base/webapps/idp.xmlを以下のように修正します。(idp.warファイルのパス修正)xmlを以下のように修正します。(下記のようになっていることを確認します)
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
<Configure class="org.eclipse.jetty.webapp.WebAppContext"> |
idp-backchannel.iniを読み込まないようにします。
...
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
# Any other required Jetty modules... |
/opt/jetty-base/modules/idp.mod を修正します。(https と ssl をコメントアウト)
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
[depend] |
/opt/jetty-base/start.d/idp.ini を修正します。(赤字のように修正します)します。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
|
/opt/jetty-base/start.d/idp-logging.ini を修正します。ファイルが無ければ作成してください。
パネル | ||||||||
---|---|---|---|---|---|---|---|---|
| (省略)||||||||
|
情報 |
---|
ここで記載しているバージョンは lib/logbacklogging/ および log/slf4j/ 以下に配置されているライブラリのバージョンです。展開したjetty-baseが本技術ガイドに記載のものと異なる場合は、実際に配置されているライブラリのバージョンを logback.version= および この記述を間違えると、エラーメッセージ |
/opt/jetty-base/etc/tweak-ssl.xmlを以下の内容で作成します。
...
過去の技術ガイドでは | ||||||
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" class class="org.eclipse.jetty.util.ssl.SslContextFactory"> |
上記ファイルを参照するように /opt/jetty-base/modules/idp-backchannel.mod に追記します。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
(省略) |
5. httpd の設定
/etc/httpd/conf/httpd.conf の修正
...
情報 | ||
---|---|---|
加えて、SSL 3.0プロトコルに対する攻撃が発見されておりますので、当該プロトコルを無効化することをお勧めします。
|
/etc/httpd/conf.d/virtualhost-localhost80.conf
を以下の内容で作成してください。
これはShibboleth IdPが提供するreload-metadata.sh等のコマンドを使った操作を可能にするためのものです。
注意 |
---|
すでに同一のvirtual hostを別のところで定義している場合は、そちらに含めてください。 _default_:80 が定義されているファイルに下記ProxyPassを含める方法もありますが、外部からの通常のアクセスがセキュア |
パネル | ||
---|---|---|
| ||
|
...
4. Shibbolethのインストール
各ファイル名等の指定は,Version 4に準拠しています。
...
http://shibboleth.net/downloads/identity-provider/latest/から最新のIdP( shibboleth-identity-provider-4.?.?.tar.gz )をダウンロードします。
情報 |
---|
ダウンロードしたファイルの真正性を確かめるにはPGP署名(ダウンロードURLに".asc"を追加したもの)を確認してください。 |
...
shibboleth-identity-provider-4.?.?.tar.gz を適当なディレクトリに置いて、以下のコマンドを実行してください。
...
borderColor | #cccccc |
---|---|
bgColor | #eeeeee |
borderStyle | solid |
...
| ||
|
...
アンカー | ||||
---|---|---|---|---|
|
4. Shibbolethのインストール
各ファイル名等の指定は,Version 5に準拠しています。
1. Shibboleth IdP パッケージのダウンロード
http://shibboleth.net/downloads/identity-provider/latest/から最新のIdP(
...
shibboleth-identity-provider-
...
5.?.?
...
.tar.gz)をwgetでダウンロードします。
shibboleth-identity-provider-5.?.?.tar.gz をマウスの右ボタンでクリックするとショートカットメニューが表示されますが、「リンクをコピー」メニューを選択すると、クリップボードにダウンロード元のURLが得られます。
このURLからwgetでパッケージをダウンロードします。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
# wget https://shibboleth.net/downloads/identity-provider/latest/shibboleth-identity-provider-5.1.2.tar.gz |
情報 |
---|
ダウンロードしたファイルの真正性を確かめるにはPGP署名(ダウンロードURLに".asc"を追加したもの)を確認してください。 |
2. インストール
ダウンロードしたtar.gzファイルを展開し、bin/installコマンドを実行します。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
# tar xzvf shibboleth-identity-provider-5.1.2.tar.gz ↓下記2行を記載したファイル install.properties を作成する。 |
情報 |
---|
install.shのコマンドラインオプションとして -D... の指定ができなくなりましたので、バージョン5では、../install.propertiesを上記のように作成してから実行してください。 |
install.shシェルスクリプトを実行すると、以下のような問い合わせがあります。
手順に従って、進めてください。
注意 |
---|
インストール時に入力するパスワードを本運用で使う場合は、推測されにくいものを使用してください。 |
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
Installation Directory: [/opt/shibboleth-idp] ? Buildfile: /root/shibboleth-identity-provider-4.0.1/bin/build.xml install: Source (Distribution) Directory (press <enter> to accept default): [/root/shibboleth-identity-provider-4.0.1] ? [Enter] ←入力なし
INFO [net.shibboleth.idp.installer.V4Install:633] - Creating backchannel keystore, CN = upkishib-idp.nii.ac.jp URI = https://Hostname: [ Attribute Scope: [nii.ac.jp]
(省略)
|
上記のような質問に答えながら、インストールを行います。
3. パーミッションの調整
”jetty”ユーザがログファイルを出力できるようディレクトリの所有者を変更します。
...
ヒント |
---|
IdPが実際に使用する証明書の秘密鍵はまだ配置されておりませんので、所有者・パーミッションは後の手順で設定します。 |
アンカー | ||||
---|---|---|---|---|
|
4
...
.
...
ディレクトリインデックスの禁止
edit-webapp内にweb.xml を作成します。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
|
作成したweb.xml を以下の内容で修正します。
※既存の<servlet>の前に設定を追加します。<servlet>ブロックがない時は、最後(</web-app>の手前)に追加してください。
パネル | ||||||
---|---|---|---|---|---|---|
| ||||||
|
...
注意 |
---|
※jetty起動に失敗したら設定修正後、/opt/jetty-base/tmp/下にファイルが残っていたら削除してから再度起動してください。 |
...
アンカー idpInst5 idpInst5
5. サービスの起動・停止方法
サービス | 起動コマンド | 停止コマンド | 再起動コマンド |
---|---|---|---|
httpd | systemctl start httpd | systemctl stop httpd | systemctl restart httpd |
jetty | systemctl start jetty | systemctl stop jetty | systemctl restart jetty |
...
インストールが完了したら,サイト情報等の設定を行って下さい.
...