2.8 外部認証サーバ連携コンフィグファイル(exauth.properties)
外部認証連携に必要な設定をするための定義ファイルです。
形式
指定キー名=設定値
格納先フォルダ
共通コンポーネントのインストール先フォルダ\confまたは/opt/HiCommand/Base64/conf
定義の反映契機
コンフィグファイルを保存すると即座に反映されます。
但し,コンフィグファイルの定義変更時にログイン中のユーザーは,再度ログインするまで変更内容が反映されません。また,コンフィグファイルの定義変更時にログイン中のユーザーは,認証方式がログイン時と異なって表示される場合があります。
記述内容
指定キー名と設定値を1行に1つずつ指定します。外部認証サーバ連携コンフィグファイルを記述するときは,次の点に注意してください。
「#」で始まる行はコメント行として扱われます。
空白行は無視されます。
大文字と小文字は区別されます。
設定値の前後には,空白を指定できません。
設定値は「"」で囲まないでください。
設定項目
分類 |
キー名 |
設定項目 |
設定できる値 |
デフォルト値 |
---|---|---|---|---|
共通項目 |
auth.server.type |
外部認証連携の種別を指定する。 |
|
internal |
auth.server.name |
連携する外部認証サーバのサーバ識別名を64バイト以内で指定する。 「auth.server.type」に「ldap」を指定した場合,必ず指定する。それ以外の場合は,指定不要。 |
|
- (インストール時の初期値:ServerName) |
|
auth.group.mapping |
Active Directoryと外部認証連携する場合に,グループ連携するかどうかを指定する。 |
|
false |
|
LDAP用設定項目※1 |
auth.ldap.サーバ識別名※2.protocol |
LDAPディレクトリサーバとの接続のプロトコルを指定する。 「auth.server.type」に「ldap」以外を指定した場合は,指定不要。 「tls」を指定した場合,LDAPディレクトリサーバで使用する暗号方式は,次のいずれかである必要がある。
|
|
- |
auth.ldap.サーバ識別名※2.host |
LDAPディレクトリサーバのホスト名,IPv4アドレス,またはIPv6アドレスを指定する。 IPv6アドレスを指定する場合は,「[]」で囲んで指定する。 「auth.ldap.サーバ識別名.dns_lookup」に「false」を指定した場合は,必ず指定する。 「auth.ldap.サーバ識別名.protocol」に「tls」を指定した場合は,LDAPディレクトリサーバのサーバ証明書のCNと同じホスト名を指定する必要がある。IPアドレスは使用できない。 |
ホスト名またはIPアドレスに指定できる文字列 |
- |
|
auth.ldap.サーバ識別名※2.port |
LDAPディレクトリサーバのポート番号を指定する。 |
1~65535 |
389 |
|
auth.ldap.サーバ識別名※2.timeout |
LDAPディレクトリサーバの接続タイムアウト時間を秒数で指定する。0を指定した場合,通信エラーが発生するまで待つ。 |
0~120 |
15 |
|
auth.ldap.サーバ識別名※2.attr |
認証ユーザーのユーザーIDの値が定義されている属性名を指定する。 |
属性名に使用できる文字列 |
- (インストール時の初期値:sAMAccountName) |
|
auth.ldap.サーバ識別名※2.basedn |
LDAPディレクトリサーバの認証ユーザーを検索する際の基点となるDNを指定する。 |
DNに指定できる文字列 |
- |
|
auth.ldap.サーバ識別名※2.retry.interval |
LDAPディレクトリサーバとの通信に失敗した場合のリトライ間隔(単位:秒)を指定する。 |
1~60 |
1 |
|
auth.ldap.サーバ識別名※2.retry.times |
LDAPディレクトリサーバとの通信に失敗した場合のリトライ回数を指定する。 |
0~50 |
20 |
|
auth.ldap.サーバ識別名※2.domain.name |
LDAPディレクトリサーバのドメイン名を指定する。 次のどちらかの条件を満たす場合,必ず指定する。
|
ドメイン名に指定できる文字列 |
- |
|
auth.ldap.サーバ識別名※2.dns_lookup |
LDAPディレクトリサーバをDNSから検索するかどうかを指定する。 |
|
false |
- 注※1
「auth.server.type」に「ldap」以外を指定した場合,設定内容は無視されます。
- 注※2
サーバ識別名には,「auth.server.name」で指定したサーバ識別名と同じ値を指定してください。
定義例
次の条件を満たす場合の定義例
Active Directoryと外部認証連携する
グループ連携しない
LDAP検索用ユーザーの登録が不要
DNSを使用しない
auth.server.type=ldap auth.server.name=ServerName1 auth.ldap.ServerName1.protocol=ldap auth.ldap.ServerName1.host=adhost1 auth.ldap.ServerName1.attr=cn auth.ldap.ServerName1.basedn=cn=Users,dc=example,dc=com
次の条件を満たす場合の定義例
Active Directoryと外部認証連携する
グループ連携する
LDAP検索用ユーザーの登録が必要
DNSを使用する
auth.server.type=ldap auth.server.name=ServerName1 auth.ldap.ServerName1.protocol=ldap auth.ldap.ServerName1.attr= sAMAccountName auth.ldap.ServerName1.basedn=dc=example,dc=com auth.ldap.ServerName1.domain.name=example.com auth.ldap.ServerName1.dns_lookup=true auth.group.mapping=true