5.2.5 ユーザ認証ライブラリ環境定義ファイル(cfsauth.ini)
(1) ユーザ認証ライブラリ環境定義ファイルのエントリ一覧
ユーザ認証ライブラリ環境定義ファイルで指定するエントリを示します。各エントリの詳細は,「(3) ユーザ認証ライブラリ環境定義ファイルの詳細」を参照してください。
(a) [CCM]セクション
Collaboration - Online Community Managementのデータベースサーバへの接続情報を指定します。[CCM]セクションを構成する各エントリを次の表に示します。
表5-5 [CCM]セクションのエントリ一覧
種類 | エントリ | 指定内容 | 指定内容 |
---|
Collaboration - Online Community Managementのデータベースサーバへの接続情報 | Host | データベースサーバのホスト名またはIPアドレス | 変更要 |
Port | データベースサーバのポート番号 | 変更要 |
Schema | データベースサーバのスキーマ名 | 変更要 |
User | データベースサーバへの接続ユーザのユーザID | 変更要 |
Password | データベースサーバへの接続ユーザのパスワード | 変更要 |
- (凡例)
- 変更要:実行環境に応じて変更する項目です(必須)。
(b) [DIRECTORY]セクション
ディレクトリサーバへの接続情報を指定します。[DIRECTORY]セクションを構成する各エントリを次の表に示します。
表5-6 [DIRECTORY]セクションのエントリ一覧
- (凡例)
- 変更要:実行環境に応じて変更する項目です(必須)。
- 任意:任意で指定する項目です(省略可)。
- 注※
- AdditionalPostModeエントリおよび[COMMON]セクションのAdditionalPostCheckModeエントリに「link」を指定した場合だけ,変更が必要です。
(2) ユーザ認証ライブラリ環境定義ファイルの記述形式
[セクション名]
エントリ名 = 値
- セクション名は,[ ](角括弧)で囲んで指定します。一つのセクションは,セクション名を指定してから,次のセクション名を指定するまで,またはファイルの終端までの範囲です。
- セクションの記述行には[セクション名]以外の文字は指定できません。
- エントリは,「エントリ名 = 値」の形式で指定します。
- エントリは,その値が数値か文字列かによって記述方法が異なります。
- 数値の場合
任意の10進数を-2,147,483,648~2,147,483,647の間で記述します。
- 文字列の場合
指定する文字列にサイズの指定がない場合は,1,055バイト未満の文字列を記述します。半角スペースまたは「=」(イコール)を含む場合は,「'」(シングルクォーテーション)または「"」(引用符)で囲んで記述します。
- 値の後ろには,半角の空白以外は記述できません。
- 同一名のセクションまたはエントリを複数指定した場合,最初に指定したセクションが有効になります。
- 「(3) ユーザ認証ライブラリ環境定義ファイルの詳細」で示すセクション名またはエントリ名以外は指定できません。指定した場合はエラーとなります。
- 印刷可能なASCIIコードで記述してください。
- 「;」(セミコロン)または「#」(シャープ)で始まる行は,コメント行と見なされます。
- 空白行は無視されます。
- 行の終端は改行コードまたはEOFです。なお,改行コードはCR+NL(0x0d+0x0a)です。
- ファイルの終端はEOFです。
(3) ユーザ認証ライブラリ環境定義ファイルの詳細
ユーザ認証ライブラリ環境定義ファイルは,次に示すセクションとセクションに指定するエントリによって構成されます。
- [CCM]セクション
- [DIRECTORY]セクション
以降,ユーザ認証ライブラリ環境定義ファイルを構成するセクションと指定するエントリについて説明します。
(a) [CCM]セクション
Collaboration - Online Community Managementのデータベースサーバへの接続情報を指定します。[CCM]セクションを構成する各エントリは次のとおりです。
- Hostエントリ
- Collaboration - Online Community Managementのデータベースサーバのホスト名またはIPアドレスを32バイト以内で指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「hostname」です。実行環境に応じた内容を必ず指定してください。
- Portエントリ
- Collaboration - Online Community Managementのデータベースサーバのポート番号を5,001~65,535の範囲で指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は20,000です。実行環境に応じた内容を必ず指定してください。
- Schemaエントリ
- Collaboration - Online Community Managementのデータベースサーバのスキーマ名を指定します。このエントリを指定すると,Collaboration - Online Community Managementのデータベースを検索するSQL文中のテーブル名およびテーブルの列項目にスキーマを付加します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「CLBCCM」です。
- Userエントリ
- Collaboration - Online Community Managementのデータベースサーバへの接続ユーザのユーザIDを指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「CLBCCM」です。実行環境に応じた内容を必ず指定してください。
- Passwordエントリ
- Collaboration - Online Community Managementのデータベースサーバへの接続ユーザのパスワードを指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「CLBCCM」です。実行環境に応じた内容を必ず指定してください。
(b) [DIRECTORY]セクション
ディレクトリサーバへの接続情報を指定します。[DIRECTORY]セクションを構成する各エントリは次のとおりです。
- NumOfConnectエントリ
- ユーザ認証ライブラリからディレクトリサーバに接続するコネクション数を,1~100の範囲で指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は10です。実行環境に応じた内容を必ず指定してください。
- NumOfConnectエントリの値は次の式で見積もります。
X=DocumentSpace構成定義ファイルのDBConnectionPoolCountエントリの値 + DocumentSpace構成定義ファイルのDBConnectionPoolDynamicエントリの値
Y=DocumentSpace構成定義ファイルのSessionMaxエントリの値 ÷ DocumentSpace構成定義ファイルのProcessエントリの値
- X<Yの場合,XをNumOfConnectエントリの値とします。
- X>=Yの場合,YをNumOfConnectエントリの値とします。
- なお,このエントリには,64以下の値を指定することを推奨します。
- なお,File Sharingサーバからディレクトリサーバに接続する最大コネクション数は次の式で算出できます。
- 最大コネクション数
- =NumOfConnectエントリの値×DocumentSpace構成定義ファイルのProcessエントリの値
- OperationTimeoutエントリ
- LDAPオペレーションのタイムアウト時間を,0~3,600,000の範囲で指定します。単位はミリ秒です。ユーザ認証ライブラリ環境定義ファイルの初期設定値は10,000です。0を指定した場合,タイムアウトしません。実行環境に応じた内容を必ず指定してください。
- SearchTimeoutエントリ
- LDAPの検索タイムアウト時間を,1~3,600,000の範囲で指定します。単位はミリ秒です。ユーザ認証ライブラリ環境定義ファイルの初期設定値は10,000です。実行環境に応じた内容を必ず指定してください。
- タイムアウト発生時は,LDAPコネクションを再接続します。
- TraceFileSizeエントリ
- 組織情報取得ライブラリのトレースファイルのサイズを,4,096(4KB)~2,147,483,647(2GB)の範囲で指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は18,874,368です。実行環境に応じた内容を必ず指定してください。
- TraceNumFilesエントリ
- 組織情報取得ライブラリのトレースファイルの面数を,1~16の範囲で指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は4です。実行環境に応じた内容を必ず指定してください。
- TraceLevelエントリ
- 組織情報取得ライブラリのトレースレベルを,0~30の範囲で指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は10です。実行環境に応じた内容を必ず指定してください。
- TraceFileNameエントリ
- 組織情報取得ライブラリのトレースファイル名のプリフィックス文字列をフルパスで指定します。インストール先に合わせて変更します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は,使用しているOSによって次のように異なります。
- Windows Server 2008 R2,Windows Server 2008 x64,Windows Server 2012,Windows Server 2012 R2の場合
{OS(Windows)のインストールドライブ}:¥Program Files(x86)¥Hitachi¥Collaboration¥clb_home¥log¥hptl_clb_ccu_getou
- そのほかのOS(Windows)を使用している場合
{OS(Windows)のインストールドライブ}:¥Program Files¥Hitachi¥Collaboration¥clb_home¥log¥hptl_clb_ccu_getou
- 実行環境に応じた内容を必ず指定してください。
- Serverエントリ
- ディレクトリサーバのホスト名またはIPアドレスを1,024バイト以内で指定します。uCosminexus Portal FrameworkのPortal Managerの,「接続情報」-「接続先URL」のアドレス部と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「localhost」です。実行環境に応じた内容を必ず指定してください。
- Portエントリ
- ディレクトリサーバのポート番号を,1~65,535の範囲で指定します。uCosminexus Portal FrameworkのPortal Managerの,「接続情報」-「接続先URL」のポート番号と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は389です。実行環境に応じた内容を必ず指定してください。
- BindDnエントリ
- ディレクトリサーバにバインドする際のDNを1,024バイト以内で指定します。uCosminexus Portal FrameworkのPortal Managerの,「接続情報」-「接続先ユーザ名」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「cn=Directory Manager」です。
- BindDnエントリとBindPwdエントリの両方の指定を省略した場合は,ディレクトリサーバへ匿名でアクセスします。
- BindPwdエントリ
- ディレクトリサーバにバインドする際のパスワードを1,024バイト以内で指定します。uCosminexus Portal FrameworkのPortal Managerの,「接続情報」-「接続先パスワード」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「directorymanager」です。
- BindDnエントリとBindPwdエントリの両方の指定を省略した場合は,ディレクトリサーバへ匿名でアクセスします。
- UserBaseDnエントリ
- ユーザ検索時に使用するベースDNを1,024バイト以内で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_userBaseDn」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「ou=PEOPLE,o=HITACHI,c=JP」です。実行環境に応じた内容を必ず指定してください。
- UserObjectClassエントリ
- ユーザを示すディレクトリサーバ上のオブジェクトクラスを1,024バイト以内で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_userObjectClass」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「hptlUser」です。実行環境に応じた内容を必ず指定してください。
- UserScopeエントリ
- ユーザ検索時に使用するスコープを次の数字で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_userScope」の指定が「onelevel」の場合は1を,「subtree」の場合は2を指定します。
- 1:ベースDNの1階層下のレベルだけを検索対象とします。
- 2:ベースDNとその配下のすべてのレベルを検索対象とします。
- ユーザ認証ライブラリ環境定義ファイルの初期設定値は1です。実行環境に応じた内容を必ず指定してください。
- UserKeyAttrエントリ
- オブジェクトクラスでキーとなる属性名を1,024バイト以内で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_uid」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「uid」です。実行環境に応じた内容を必ず指定してください。
- UserIdAttrエントリ
- ユーザIDを表す属性名を1,024バイト以内で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_uid」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「uid」です。実行環境に応じた内容を必ず指定してください。
- BelongOrgAttrエントリ
- ユーザの所属組織を表す属性名を1,024バイト以内で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_belongOrgDn」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「hptlDepartmentDN」です。実行環境に応じた内容を必ず指定してください。
- TypeOfBelongOrgAttrエントリ
- 所属組織の格納方法を次の数字で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_belongOrgDn」の指定した属性のデータ型が文字列型の場合は1を,DN型の場合は2を指定します。
- ユーザ認証ライブラリ環境定義ファイルの初期設定値は2です。実行環境に応じた内容を必ず指定してください。
- OrgBaseDnエントリ
- 組織検索時に使用するベースDNを1,024バイト以内で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_orgBaseDn」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「ou=department,o=HITACHI,c=JP」です。実行環境に応じた内容を必ず指定してください。
- OrgObjectClassエントリ
- 組織を示すディレクトリサーバ上のオブジェクトクラスを1,024バイト以内で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_orgObjectclass」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「hptlOrganizationalUnit」です。実行環境に応じた内容を必ず指定してください。
- OrgScopeエントリ
- 組織検索時に使用するスコープを次の数字で指定します。TypeOfParentOrgAttrエントリの指定と同じ値を指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_orgSchema」の指定値が「logical」の場合は1を,「physical」の場合は2を指定します。
- 1:1レベルを検索対象とします。
- 2:サブツリーを検索対象とします。
- ユーザ認証ライブラリ環境定義ファイルの初期設定値は1です。実行環境に応じた内容を必ず指定してください。
- OrgKeyAttrエントリ
- オブジェクトクラスでキーとなる属性名を1,024バイト以内で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_orgId」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「ou」です。実行環境に応じた内容を必ず指定してください。
- OuAttrエントリ
- 組織単位を表す属性名を1,024バイト以内で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_orgId」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「ou」です。実行環境に応じた内容を必ず指定してください。
- TypeOfOuエントリ
- 組織単位の格納方法を次の数字で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_orgId」に指定した属性のデータ型が「文字列型」の場合は1を,「DN型」の場合は2を指定します。
- ユーザ認証ライブラリ環境定義ファイルの初期設定値は1です。実行環境に応じた内容を必ず指定してください。
- ParentOrgAttrエントリ
- 上位組織を表す属性名を1,024バイト以内で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_parentOrgAttr」と同じ値を指定します。ユーザ認証ライブラリ環境定義ファイルの初期設定値は「hptlDepartmentDN」です。実行環境に応じた内容を必ず指定してください。
- TypeOfParentOrgAttrエントリ
- 上位組織の格納方法を次の数字で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_parentOrgAttr」に指定した属性のデータ型が「文字列型」の場合は1を,「DN型」の場合は2を指定します。
- ユーザ認証ライブラリ環境定義ファイルの初期設定値は2です。実行環境に応じた内容を必ず指定してください。
- AdditionalPostModeエントリ
- ユーザ検索時に兼任ユーザの情報を取得するかどうかを指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_user_in_additional_post」と同じ値を指定します。なお,指定値の大文字・小文字は区別されます。
- none:兼任ユーザの情報を取得しません。
- link:主体ユーザのユーザIDとMainPostUidAttrエントリに指定した属性の値が一致する情報を,兼任ユーザの情報として取得します。
- ユーザ認証ライブラリ環境定義ファイルの初期設定値は「none」です。次の場合は「none」が仮定されます。
- エントリの指定を省略した場合
- エントリの値の指定を省略した場合
- 不正な値を指定した場合
- MainPostUidAttrエントリ
- 主体ユーザを表す属性名を1,024バイト以内で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_user_in_main_post」と同じ値を指定します。
- AdditionalPostModeエントリおよび[COMMON]セクションのAdditionalPostCheckModeエントリに「link」を指定した場合,このエントリは必ず指定してください。
- AdditionalPostModeエントリおよび[COMMON]セクションのAdditionalPostCheckModeエントリに「none」を指定した場合,このエントリの指定は不要です。
- ユーザ認証ライブラリ環境定義ファイルの初期設定値は「hptlActualUid」です。
- NumOrgSearchUnitエントリ
- ディレクトリサーバへの1回のアクセスで取得する組織情報数を1~5,000の範囲で指定します。Collaboration - Directory Accessのプロパティ「hptl_clb_cum_request_org_size」と同じ値を指定します。
- ユーザ認証ライブラリ環境定義ファイルの初期設定値は10です。次の場合は10が仮定されます。
- エントリの指定を省略した場合
- エントリの値の指定を省略した場合
- 不正な値を指定した場合
(4) ユーザ認証ライブラリ環境定義ファイルの記述例
ユーザ認証ライブラリ環境定義ファイルの記述例を次に示します。記述例の太字の個所を実行環境に応じて変更してください。
[CCM]
Host = hostname
Port = 20000
Schema = "CLBCCM"
User = "CLBCCM"
Password = "CLBCCM"
[DIRECTORY]
NumOfConnect = 10
OperationTimeout = 10000
SearchTimeout = 10000
TraceFileSize = 18874368
TraceNumFiles = 4
TraceLevel = 10
TraceFileName = "C:¥Program Files¥Hitachi¥collaboration¥clb_home¥log¥hptl_clb_ccu_getou"
Server = localhost
Port = 389
BindDn = "cn=Directory Manager"
BindPwd = directorymanager
UserBaseDn = "ou=PEOPLE,o=HITACHI,c=JP"
UserObjectClass = hptlUser
UserScope = 1
UserKeyAttr = uid
UserIdAttr = uid
BelongOrgAttr = hptlDepartmentDN
TypeOfBelongOrgAttr = 2
OrgBaseDn = "ou=department,o=HITACHI,c=JP"
OrgObjectClass = hptlOrganizationalUnit
OrgScope = 1
OrgKeyAttr = ou
OuAttr = ou
TypeOfOu = 1
ParentOrgAttr = hptlDepartmentDN
TypeOfParentOrgAttr = 2
AdditionalPostMode = none
MainPostUidAttr = hptlActualUid
NumOrgSearchUnit = 10
(5) 注意事項
- File Sharingサーバでは,DocumentSpace構成定義ファイルのProcessエントリに指定したサービスプロセス数分のDBコネクションを使用してCollaboration - Online Community Managementのデータベースに接続します。このため,Collaboration - Online Community Managementのデータベースのシステム定義で指定するpd_max_usersには,DocumentSpace構成定義ファイルのProcessエントリに指定した値を加えて指定してください。なお,File Sharingサーバが複数存在する場合は,それぞれに指定したProcessエントリの合計値を加えて指定してください。
- File Sharingサーバでは,一つのサービスプロセスにつきNumOfConnectエントリに指定したコネクション数分のディレクトリサーバのコネクションを使用してディレクトリサーバに接続します。このため,ディレクトリサーバで指定する最大コネクション数には,NumOfConnectエントリの値×DocumentSpace構成定義ファイルのProcessエントリの値で算出した値を加えて指定してください。なお,File Sharingサーバが複数存在する場合は,File SharingサーバごとにNumOfConnectエントリの値×DocumentSpace構成定義ファイルのProcessエントリの値を算出し,算出した値を合計します。その合計値を最大コネクション数に加えて指定してください。