5.2. unicornidm.conf(5)¶

5.2.1. 概要¶

unicornidm.conf

5.2.2. 説明¶

unicornidm.conf は Unicorn ID Manager の設定ファイルです。このファイルは Python の configparser モジュールを利用して読み込まれます。 configparser モジュールの詳細については、 https://docs.python.org/3/library/configparser.html をご覧ください。

unicornidm.conf は大きく分けて次のセクションで構成されています。

メインセクション: Unicorn ID Manager サービス全体に及ぶ設定を記述するセクションです。
ターゲットセクション: ターゲットに関するセクションです。ターゲットがどのバックエンドに紐付いているか、どのようなパスワードポリシーを適用するかを定義します。
バックエンドセクション: バックエンドに関するセクションです。バックエンドへの接続用パラメーターなどを定義します。バックエンドセクションはバックエンドの type によって設定パラメーターが異なります。なお、バックエンドセクションにはかならずテンプレートファイルが必要になります。テンプレートファイルは unicornidm.conf と同じディレクトリにある、 templates ディレクトリ内に、 <name>.py のファイル名で登録します。 <name> はバックエンドの名前です。
SCIM 属性マッピングセクション: SCIM 属性と任意に定義したフロントエンド属性 (Unicorn ID Manager で使用する属性) とのマッピングのためのセクションです。
クライアントセクション: Unicorn ID Manager に付属する unicornidm-tool(8) で使用されるセクションです。

5.2.3. メインセクション¶

メインセクションは [__main__] という名前のセクションで定義されます。ここでは以下のパラメーターを定義できます。

debug_level¶

Unicorn ID Manager のデバッグレベルを定義します。定義可能な値は以下のとおりです。

DEBUG           すべてのデバッグログを出力
INFO            DEBUG を除いたデバッグログを出力
WARNING         DEBUG, INFO を除いたデバッグログを出力
ERROR           DEBUG, INFO, WARNING を除いたデバッグログを出力
CRITICAL        DEBUG, INFO, WARNING, ERROR を除いたデバッグログを出力

debug_file¶: Unicorn ID Manager のデバッグ情報を出力するファイルパスを定義します。

targets¶: ターゲット一覧をカンマ区切りで定義します。ターゲット文字列内に : を含む場合、 : の左側がシステムで利用するためのターゲット名になり、右側の文字列はターゲットの表示名になります。システムで利用するターゲット名は URL 等に利用されます。ターゲットの表示名は管理画面のダッシュボード上でターゲットを表示するために利用されます。 : を含まない場合、システムで利用するターゲット名とターゲットの表示名は同一になります。

session_time_out¶: ログインしたアカウントのセッションタイムアウト (単位: 秒) を定義します。デフォルト値は 3600 です。

password_cache_duration¶: ランダム生成されたパスワードを保持する期間 (単位: 秒) を設定します。デフォルト値は 86400 です。

items_per_page¶: ユーザーやグループの一覧取得時に出力する項目数を指定します。デフォルト値は 20 です。

multi_valued_attributes¶

複数値を持つフロントエンド属性をカンマ区切りで指定します。デフォルト値は mail,phoneNumbers,img,photo,streetAddress,locality,region,postalCode,country,entitlement,role,x509Certificate,azureLicense です。

なお、Active Directory において mail 属性に複数の値を入れることはできないので、 Active Directory で mail に複数値を格納したい場合には Active Directory のテンプレートファイル上で mail フロントエンド属性を別のバックエンド属性に紐付ける必要があります。

user_viewable_attributes¶: ユーザー一覧取得時に出力するフロントエンド属性名をカンマ区切りで定義します。デフォルト値は userName,familyName,givenName です。

group_viewable_attributes¶: グループ一覧取得時に出力するフロントエンド属性名をカンマ区切りで定義します。デフォルト値は groupName,description です。

admin_lockout_policy_duration¶: 管理者のロックアウト期間 (単位: 秒) を定義します。デフォルト値は 3600 です。

admin_lockout_policy_max_failure¶: 管理者が連続で何回ログインに失敗したあとにロックアウトするかを定義します。デフォルト値は 3 です。

admin_lockout_policy_failure_count_interval¶: 認証失敗時刻の情報が存続する期間 (単位: 秒) を定義します。デフォルト値は 1800 です。この値を 0 にした場合、認証失敗時刻情報が削除されないため、 lockout_policy_max_failure で定義した回数だけ連続で認証が失敗すれば、たとえどんなに期間を空けても必ずロックアウトされます。

allowed_hosts¶

UnicornIDM が動作しているサーバーのホスト名をカンマ区切りで設定してください。例えば、 allowed_host = host1, host2 のように指定します。 UnicornIDM は HTTP リクエストの Host ヘッダーがこの設定で指定されているホスト名のいずれにも一致しない場合にそのリクエストを拒否することがあります。

何も設定していない状態でも、 localhost 、 127.0.0.1 および サーバーの FQDN ホスト名 からのアクセスは許可されます。これらのアクセスに加えて別のホスト名での HTTP リクエストを許可したいときに追加のホスト名を指定してください。

use_x_forwarded_host 設定を yes にしている場合には、 Host ヘッダーの代わりに X-Forwarded-Host ヘッダーが検証されます。

use_x_forwarded_host¶: HTTPヘッダーの X-Forwarded-Host ヘッダーを Host ヘッダーより優先するかどうかを設定します。 yes に設定すると X-Forwarded-Host が優先されます。デフォルト値は no です。 X-Forwarded-Host ヘッダーは UnicornIDM をリバースプロキシを使った構成で使用する場合などに使用されます。この設定は主に一般ユーザーへのパスワードリセットメールに書くパスワード変更URLを構成する際に使われます。

バージョン v3.11.6 で追加.

5.2.4. ターゲットセクション¶

ターゲットセクションは [target:<name>] という名前のセクションで定義されます。 <name> はメインセクションの targets で列挙したうちのターゲット名になります。

たとえば、以下のようになります。

[__main__]
targets = Sales, Finance, Tech

[target:Sales]
...

[target:Finance]
...

[target:Tech]
...

ターゲットセクションでは以下のパラメーターを定義できます。

backends¶: ターゲットに紐づくバックエンドをカンマ区切りで定義します。

displayName¶: ターゲットの表示名です。 [__main__] セクションの targets で : を指定しなくても、このパラメーターによってターゲットの表示名を指定できます。

password_policy_max¶: パスワードポリシーのうち、パスワードの最大長を定義します。この値を 100 に設定すると、一般ユーザーのパスワード変更画面でパスワードの最大長の情報が表示されなくなります。デフォルト値は 16 です。

バージョン 3.11.5 で変更: 100 に設定した場合の挙動が上記に変更されました。

password_policy_min¶: パスワードポリシーのうち、パスワードの最小長を定義します。デフォルト値は 8 です。

password_policy_alphabet¶: 一般ユーザーがパスワードを変更する際にパスワードに含めなければならない英語アルファベットの数（大文字小文字の区別はなし）を設定します。デフォルト値は 0 です。

password_policy_upper¶: パスワードポリシーのうち、パスワードに含めなければならない英大文字の数を定義します。デフォルト値は 1 です。

password_policy_lower¶: パスワードポリシーのうち、パスワードに含めなければならない英小文字の数を定義します。デフォルト値は 1 です。

password_policy_symbol¶: パスワードポリシーのうち、パスワードに含めなければならない印字 ASCII 記号の数を定義します。デフォルト値は 0 です。

password_policy_digit¶: パスワードポリシーのうち、パスワードに含めなければならない数字の数を定義します。デフォルト値は 1 です。

password_policy_complexity¶: パスワードポリシーのうち、パスワードの複雑性を定義します。具体的には、英大文字、英小文字、記号、数字という 4 つのカテゴリのうち、いくつのカテゴリをパスワードに含める必要があるかを定義します。デフォルト値は 3 です。このパラメーターに 4 より大きい数字を指定した場合、 password_policy_complexity は 4 とみなされます。

password_policy_prohibited¶: パスワードポリシーのうち、パスワードに含めてはならない文字 (禁止文字) を定義します。デフォルト値は空文字 (禁止文字はなし) です。

password_policy_must_not_contain_name¶: パスワードポリシーのうち、パスワードにユーザーの名前を含めてよいかどうかを定義します。デフォルト値は true (名前を含めてはならない) です。

password_policy_must_be_different_from_old¶: パスワードポリシーのうち、パスワードが 1 つ前のパスワードと異なる必要があるかを定義します。デフォルト値は true (異なる必要がある) です。

password_policy_must_be_various¶: パスワードポリシーのうち、パスワードが多様な種類の文字で構成される必要があるかを定義します。デフォルト値は true (多様である必要がある) です。このパラメーターは、 password_policy_complexity と組み合わせてより複雑なパスワードを強制したい場合に利用します。たとえば、 password_policy_complexity が 4 の場合、 aA1-aA1- というパスワードは許可されますが、実際のところ、使われている文字は、 a 、 A 、 1 、 - の 4 種類の文字だけです。このようなパスワードを許可したくない場合に password_policy_must_be_various を利用します。

password_policy_must_be_disorder¶: パスワードポリシーのうち、パスワードが不規則である必要があるかどうかを定義します。デフォルト値は true (不規則である必要がある) です。たとえば、 abcde や 12345 などの規則的な並びの文字列を禁止します。

password_policy_message_path¶: 一般ユーザーなどのパスワード変更画面で、ユーザーオリジナルのポリシーメッセージが格納されたファイルパスを定義します。デフォルト値はありません。このパラメーターの指定がない場合、システムが自動生成するポリシーメッセージが出力されます。このパラメーターに指定したファイルの拡張子が .html の場合、ユーザーオリジナルのポリシーメッセージを HTML ファイルとみなします。

password_policy_random_prohibited¶: このパラメータには UnicornIDM によって自動生成されるパスワードに含めたくない文字を列挙します。デフォルト値は !"#$%%&\'()*+,-./:;<=>?@[\\]^_`{|}~0DOQ1lI2Z5S6G8B9q です。

password_policy_random_length¶: パスワード自動生成時に使用されるパスワード文字数です。デフォルト値は 8 です。

lockout_policy_duration¶: ユーザーのロックアウト期間 (単位: 秒) を定義します。デフォルト値は 3600 です。

lockout_policy_max_failure¶: ユーザーが連続で何回ログインに失敗したあとにロックアウトするかを定義します。デフォルト値は 3 です。

lockout_policy_failure_count_interval¶: 認証失敗時刻の情報が存続する期間 (単位: 秒) を定義します。デフォルト値は 1800 です。この値を 0 にした場合、認証失敗時刻情報が削除されないため、 lockout_policy_max_failure で定義した回数だけ連続で認証が失敗すれば、たとえどんなに期間を空けても必ずロックアウトされます。

self_password_reset¶

self_password_reset を利用するかどうかを定義します。この機能を有効にすることで、ユーザーが自分自身でパスワードリセットを行うことができるようになります。

UIDM のパスワードリセット機能はリセットメールを送るアドレスをユーザーに入力させ、そのアドレスがそのユーザーの mail 属性の複数の値のどれかに一致していた場合に入力されたアドレスのみにリセットメールを送るという仕様になっています。

デフォルト値は no (self_password_reset は利用しない) です。

バージョン v3.4.0 で追加.

self_password_reset_mail_attribute¶: Unicorn ID Manager は self_password_reset 有効時、パスワードリセット用 URL をユーザーに伝達します。このときの伝達にはメールが使われます。この設定は、 メール を示す フロントエンド属性 が何かを指定するために使われます。デフォルト値は mail です。

バージョン v3.4.0 で追加.

self_password_reset_url_duration¶: self_password_reset 有効時、パスワードリセット用 URL の有効期間 (単位: 秒) を定義します。デフォルト値は 3600 です。

バージョン v3.4.0 で追加.

self_password_reset_smtp_host¶: self_password_reset 有効時、メール配送に利用する SMTP サーバーのホスト名を指定します。デフォルト値は「」 (localhost に配送) です。

バージョン v3.4.0 で追加.

self_password_reset_smtp_port¶: self_password_reset 有効時、メール配送に利用する SMTP サーバーのポート番号を指定します。デフォルト値は 0 (self_password_reset_smtp_tls が有効な場合 465 、無効な場合 25 に配送) です。

バージョン v3.4.0 で追加.

self_password_reset_smtp_tls¶: self_password_reset 有効時、メール配送に利用する SMTP サーバーへの接続に、 TLS を利用するかどうかのフラグを指定します。デフォルト値は no (TLS は利用しない) です。

バージョン v3.4.0 で追加.

self_password_reset_smtp_login_name¶: self_password_reset 有効時、メール配送に利用する SMTP サーバーへの接続時に、認証を行うためのユーザー名を指定します。デフォルト値は「」です。「」の場合、 SMTP 接続時の認証は行われません。

バージョン v3.4.0 で追加.

self_password_reset_smtp_login_password_file¶: self_password_reset_smtp_login_name のパスワードを格納したファイルパスを指定します。デフォルト値は「」です。

バージョン v3.4.0 で追加.

self_password_reset_from¶: self_password_reset 有効時、メール配送の際の From: を指定します。デフォルト値は「」 (Unicorn ID Manager のインストールされたホスト名) です。

バージョン v3.4.0 で追加.

self_password_reset_bcc¶: self_password_reset 有効時、メール配送の際の Bcc: を指定します。デフォルト値は「」 (Bcc: に値はセットされない) です。

バージョン v3.4.0 で追加.

self_password_reset_subject¶: self_password_reset 有効時、メール配送の際の件名を指定します。デフォルト値は「」 (システムで自動生成) です。

バージョン v3.4.0 で追加.

self_password_reset_body_file¶

self_password_reset 有効時、メール配送の際のボディの内容を含むファイルパスを指定します。デフォルト値は「」 (システムで自動生成) です。

ボディに %(url)s というプレースホルダーを含めると、そのプレースホルダーにパスワードリセット用の URL が挿入されます。 %(url)s が含まれない場合、ボディの末尾にパスワードリセット用の URL が追記されます。

ボディに %(name)s というプレースホルダーを含めると、そのプレースホルダーにユーザー名が挿入されます。 %(name)s が含まれない場合、ボディにユーザー名は含まれません。

例:

%(name)s様

ご利用のアカウントに対してパスワードリセットの要求が行われました。
以下の URL にアクセスしてパスワードリセットを行ってください。

%(url)s

なお、この URL は一定時間経過後、無効になります。

バージョン v3.4.0 で追加.

self_modify¶: self_modify を利用するかどうかを定義します。この機能を有効にすることで、ユーザーが自身の属性を変更することができるようになります。デフォルト値は no (self_modify は利用しない) です。

バージョン v3.7.0 で追加.

self_modify_attributes¶: self_modify を利用する際、どのフロントエンド属性を変更可能かを指定します。デフォルト値は familyName, givenName, mail です。

バージョン v3.7.0 で追加.

self_modify_duration¶: self_modify を利用する際のユーザーのセッションタイムアウトを指定します。デフォルト値は 3600 (秒) です。

バージョン v3.7.0 で追加.

header_auth¶

HTTPヘッダーによる認証（ヘッダー認証）を有効にするかどうかを定義します。この機能が有効の場合、header_auth_user_header で設定されたHTTPヘッダーにユーザー名が入っていれば、他の認証情報なしでそのユーザーをログイン済みとして扱います。ただしその HTTPリクエストが header_auth_trust_ips で指定した IP アドレスからの場合に限ります。

デフォルト値は no (ヘッダー認証は利用しない) です。

バージョン 3.7.1 で追加.

バージョン 3.11.5 で変更: この属性を yes に設定した場合、一般ユーザーは他の認証方式ではログインできなくなるようになりました。

header_auth_trust_ips¶: header_auth を利用する際の信頼できるソース IP アドレスをカンマ区切りで指定します。ソース IP アドレスは CIDR 表記やサブネットマスクによる表記で指定することもできます。その場合、表記のネットワークアドレス範囲内にソース IP アドレスが含まれれば、そのアクセスは信頼できるアクセスとみなされます。デフォルト値は 127.0.0.1 です。

バージョン v3.7.1 で追加.

header_auth_user_header¶: header_auth を利用する際のユーザー名を示すヘッダー名を指定します。 header_auth 機能では、この属性で示したヘッダー名を参照します。デフォルト値は Remote-User です。

バージョン v3.7.1 で追加.

header_auth_require_old_password¶: header_auth を利用する際パスワード変更画面で、古いパスワードの入力を要求するかどうかを指定します。デフォルト値は yes (古いパスワードの入力が必要) です。

バージョン v3.7.2 で追加.

extension_ldap_ppolicy_unlock¶: ldap_ppolicy_unlock 拡張を利用するかどうかを定義します。この拡張は ldap バックエンドが OpenLDAP でかつ、 ppolicy overlay を利用してアカウントロックを実装している場合に、ロック状態のアカウントをブラウザーからアンロックできるようにする機能です。デフォルト値は no (ldap_ppolicy_unlock 拡張は利用しない) です。

5.2.5. バックエンドセクション¶

バックエンドセクションは [backend:<name>] という名前のセクションで定義されます。 <name> はターゲットセクションの backends で列挙したうちのバックエンド名になります。

たとえば、以下のようになります。

[__main__]
targets = Sales, Finance, Tech

[target:Sales]
backends = b1, b2

[target:Finance]
backends = b2

[target:Tech]
backends = b3

[backend:b1]
...

[backend:b2]
...

[backend:b3]
...

バックエンドセクションはバックエンドのタイプによって定義可能なパラメーターが異なります。詳細は unicornidm.template.ldap(5) unicornidm.template.samba_ldap(5) unicornidm.template.ad(5) unicornidm.template.google(5) unicornidm.template.azure(5) unicornidm.template.command(5) をご覧ください。

5.2.6. SCIM 属性マッピングセクション¶

注釈

この章はプログラマー向けの情報を記載しています。それ以外の人は読む意味がない、読んでも理解できない可能性が高いです。

SCIM 属性マッピングセクションには [scim-attribute-map-user] というセクションと、 [scim-attribute-map-group] というセクションがあります。それぞれ、ユーザー向けとグループ向けの SCIM 属性マッピングを行います。

SCIM 属性マッピングとは、 SCIM で定義されている属性と Unicorn ID Manager で使用する任意のフロントエンド属性とをマッピングする機構です。

たとえば、以下のように定義します。

[scim-attribute-map-user]
externalId     = userName
name.givenName = givenName

この場合、ユーザー情報を扱う際、 SCIM の externalId を Unicorn ID Manager の userName に、 name.givenName を Unicorn ID Manager の givenName にマッピングします。

SCIM 属性に . (ドット) を含まなければそのまま Unicorn ID Manager のフロントエンド属性にマッピングされます。 . を含む場合、その SCIM 属性は Complex 属性である必要があります。

5.2.7. クライアントセクション¶

クライアントセクションは unicornidm-tool(8) で利用されます。詳細は unicornidm-tool(8) をご覧ください。