| 2 | | = Fine grained permissions = |
| 3 | | |
| 4 | | Before Trac 0.11, it was only possible to define fine-grained permissions checks on the repository browser sub-system. |
| 5 | | |
| 6 | | Since 0.11, there's a general mechanism in place that allows custom **permission policy plugins** to grant or deny any action on any kind of Trac resources, even at the level of specific versions of such resources. |
| 7 | | |
| 8 | | Note that for Trac 0.12, `authz_policy` has been integrated as an optional module (in `tracopt.perm.authz_policy.*`), so it's installed by default and can simply be activated via the //Plugins// panel in the Trac administration module. |
| 9 | | |
| 10 | | |
| 11 | | == Permission Policies == |
| 12 | | |
| 13 | | A great diversity of permission policies can be implemented, and Trac comes with a few examples. |
| 14 | | |
| 15 | | Which policies are currently active is determined by a configuration setting in TracIni: |
| 16 | | e.g. |
| | 2 | = 粒度が細かいパーミッション = #Finegrainedpermissions |
| | 3 | |
| | 4 | Trac 0.11 より前は、リポジトリブラウザ サブシステムだけで「粒度が細かいパーミッション (fine grained permissions)」を定義することができました。 |
| | 5 | |
| | 6 | 0.11 以降、カスタマイズした **パーミッションポリシーのプラグイン** を各所に使用するための共通のメカニズムが導入されたので、すべての種類の Trac リソースのあらゆるアクションについて、そのリソースの特定バージョンのレベルまで含めて許可/拒否を設定できるようになりました。 |
| | 7 | |
| | 8 | Note: Trac 0.12 では、 `authz_policy` はオプションモジュールとして実装されました( `tracopt.perm.authz_policy.*` 配下 ) 。したがって、デフォルトでインストールされ、 Trac の管理 Web インタフェースの //プラグイン// パネルで簡単に有効にすることができます。 |
| | 9 | |
| | 10 | |
| | 11 | == パーミッションポリシー == #PermissionPolicies |
| | 12 | |
| | 13 | 様々なパーミッションポリシーを実装することができます。 Trac にはいくつかの例を同梱しています。 |
| | 14 | |
| | 15 | 現在有効なポリシーは TracIni の中で設定されているコンフィグレーションによって決定します: |
| | 16 | 例 |
| 21 | | This lists the [#AuthzSourcePolicy] described below as the first policy, followed by the !DefaultPermissionPolicy which checks for the traditional coarse grained style permissions described in TracPermissions, and the !LegacyAttachmentPolicy which knows how to use the coarse grained permissions for checking the permissions available on attachments. |
| 22 | | |
| 23 | | Among the possible optional choices, there is [#AuthzPolicy], a very generic permission policy, based on an Authz-style system. See |
| 24 | | [trac:source:branches/0.12-stable/tracopt/perm/authz_policy.py authz_policy.py] for details. |
| 25 | | |
| 26 | | Another popular permission policy [#AuthzSourcePolicy], re-implements the pre-0.12 support for checking fine-grained permissions limited to Subversion repositories in terms of the new system. |
| 27 | | |
| 28 | | See also [trac:source:branches/0.12-stable/sample-plugins/permissions sample-plugins/permissions] for more examples. |
| 29 | | |
| 30 | | |
| 31 | | === !AuthzPolicy === |
| 32 | | ==== Configuration ==== |
| 33 | | * Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (still needed for 0.12). |
| 34 | | * Copy authz_policy.py into your plugins directory (only for Trac 0.11). |
| 35 | | * Put a [http://swapoff.org/files/authzpolicy.conf authzpolicy.conf] file somewhere, preferably on a secured location on the server, not readable for others than the webuser. If the file contains non-ASCII characters, the UTF-8 encoding should be used. |
| 36 | | * Update your `trac.ini`: |
| 37 | | 1. modify the [TracIni#trac-section permission_policies] entry in the `[trac]` section |
| | 21 | このリストの1番目の [#AuthzSourcePolicy] ポリシーについては、下記に記載しています。続く !DefaultPermissionPolicy では、 TracPermissions に記載されている従来型の粒度が粗いパーミッションチェックを行ないます。そして3番目の !LegacyAttachmentPolicy は添付ファイルに対して、粒度の粗いパーミッションチェックを行ないます。 |
| | 22 | |
| | 23 | 使用可能なオプションの選択肢として、 Authz 形式のシステムにてとても一般的なパーミッションポリシーを提供する [#AuthzPolicy] があります。 |
| | 24 | 詳細については、 [trac:source:branches/0.12-stable/tracopt/perm/authz_policy.py authz_policy.py] を参照して下さい。 |
| | 25 | |
| | 26 | もう一つの評判のよいパーミッションポリシーである、 [#AuthzSourcePolicy] は pre-0.12 で再実装され、新しいシステムでは、 Subversion のリポジトリに限定して粒度の細かいパーミッション設定をサポートするようになりました。 |
| | 27 | |
| | 28 | その他の例については、 [trac:source:branches/0.12-stable/sample-plugins/permissions sample-plugins/permissions] を参照して下さい。 |
| | 29 | |
| | 30 | |
| | 31 | === !AuthzPolicy === #AuthzPolicy |
| | 32 | ==== 設定方法 ==== #Configuration |
| | 33 | * [http://www.voidspace.org.uk/python/configobj.html ConfigObj] をインストールする (0.12 でも必要) |
| | 34 | * authz_policy.py を plugins にコピーする (Trac 0.11でのみ必要) |
| | 35 | * [http://swapoff.org/files/authzpolicy.conf authzpolicy.conf] ファイルを適当な場所 (望ましくは、 Web サーバ起動ユーザ以外が読み取りできないセキュアな領域) に配置する。ファイルに非ASCII文字が含まれる場合は UTF-8 で保存してください |
| | 36 | * `trac.ini` ファイルをアップデートする: |
| | 37 | 1. `[trac]` セクションの [TracIni#trac-section permission_policies] を編集する |
| 55 | | #authz_policy.* = enabled |
| 56 | | }}} |
| 57 | | |
| 58 | | |
| 59 | | ==== Usage Notes ==== |
| 60 | | Note that the order in which permission policies are specified is quite critical, |
| 61 | | as policies will be examined in the sequence provided. |
| 62 | | |
| 63 | | A policy will return either `True`, `False` or `None` for a given permission check. `True` is returned if the policy explicitly grants the permission. `False` is returned if the policy explicitly denies the permission. `None` is returned if the policy is unable to either grant or deny the permission. |
| 64 | | |
| 65 | | NOTE: Only if the return value is `None` will the ''next'' permission policy be consulted. |
| 66 | | If none of the policies explicitly grants the permission, the final result will be `False` |
| 67 | | (i.e. permission denied). |
| 68 | | |
| 69 | | The `authzpolicy.conf` file is a `.ini` style configuration file: |
| | 55 | #authz_policy.* = enabled |
| | 56 | }}} |
| | 57 | |
| | 58 | |
| | 59 | ==== 使用方法 ==== #UsageNotes |
| | 60 | パーミッションポリシーを指定する順序はとても重要です。 |
| | 61 | ポリシーは設定された順序で評価されます。 |
| | 62 | |
| | 63 | 個々のポリシーはパーミッションチェックに対して `True`, `False`, `None` を返します。 ポリシーが明示的にパーミッションを許可する場合は、 `True` を返します。明示的に拒否する場合は、 `False` を返します。そして、パーミッションを許可も拒否もできない場合、 `None` が返されます。 |
| | 64 | |
| | 65 | Note: 戻り値が `None` の場合のみ、 ''次の'' パーミッションポリシーに問い合わせを行います。 |
| | 66 | どのポリシーも明示的にパーミッションを許可しない場合、最終的な結果は `False` となります |
| | 67 | (つまり、権限なしとみなされます)。 |
| | 68 | |
| | 69 | `authzpolicy.conf` は `.ini` スタイルの設定ファイルです: |
| 81 | | Resources are ordered left to right, from parent to child. If any |
| 82 | | component is inapplicable, `*` is substituted. If the version pattern is |
| 83 | | not specified explicitely, all versions (`@*`) is added implicitly |
| 84 | | |
| 85 | | Example: Match the WikiStart page |
| | 81 | リソースを親から子の順に、左から右へ記述します。不特定な |
| | 82 | コンポーネントがある場合は、 `*` で置き換えられます。バージョンのパターンが |
| | 83 | 明示的に記されていなければ、すべてのバージョン (`@*`) が暗黙的に追加されます。 |
| | 84 | |
| | 85 | 例: WikiStart ページを照合する |
| 103 | | * Sections are checked against the current Trac resource descriptor '''IN ORDER''' of |
| 104 | | appearance in the configuration file. '''ORDER IS CRITICAL'''. |
| 105 | | |
| 106 | | * Once a section matches, the current username is matched against the keys |
| 107 | | (usernames) of the section, '''IN ORDER'''. |
| 108 | | * If a key (username) is prefixed with a `@`, it is treated as a group. |
| 109 | | * If a value (permission) is prefixed with a `!`, the permission is |
| 110 | | denied rather than granted. |
| 111 | | |
| 112 | | The username will match any of 'anonymous', 'authenticated', <username> or '*', using normal Trac permission rules. || '''Note:''' Other groups which are created by user (e.g. by 'adding subjects to groups' on web interface page //Admin / Permissions//) cannot be used. See [trac:ticket:5648 #5648] for details about this missing feature || |
| 113 | | |
| 114 | | For example, if the `authz_file` contains: |
| | 103 | * セクションは設定ファイルに書かれている '''順に''' 現在の Trac のリソース記述子に対して |
| | 104 | チェックされます。'''順番は重要です''' |
| | 105 | |
| | 106 | * 一度 セッションにマッチすれば、'''順に''' 現在のユーザ名がセッションの |
| | 107 | キー (ユーザ名) と照合されます |
| | 108 | * キー (ユーザ名) の前に `@` を付けると、グループとして処理されます |
| | 109 | * 値 (パーミッション) の前に `!` を付けると、そのパーミッションは |
| | 110 | 拒否されます |
| | 111 | |
| | 112 | 通常の Trac パーミッションのルールを適用していれば、ユーザ名は、 'anonymous', 'authenticated', <username> '*' 等とマッチするはずです。 || '''Note:''' ユーザによって作成された (例えば、ブラウザ上から //管理 / 権限// (英語版では //Admin / Permissions//) の '権限グループの追加' (英語版では 'adding subjects to groups')) グループには使えません。詳細については [trac:#5648 #5648] を参照してください。 || |
| | 113 | |
| | 114 | 例えば、 `authz_file` が次の内容を含み: |
| 191 | | Note: In order for Timeline to work/visible for John, we must add CHANGESET_VIEW to the above permission list. |
| 192 | | |
| 193 | | |
| 194 | | ==== Missing Features ==== |
| 195 | | Although possible with the !DefaultPermissionPolicy handling (see Admin panel), fine-grained permissions still miss those grouping features (see [trac:ticket:9573 #9573], [trac:ticket:5648 #5648]). Patches are partially available, see forgotten authz_policy.2.patch part of [trac:ticket:6680 #6680]). |
| 196 | | |
| 197 | | You cannot do the following: |
| | 191 | Note: Timeline での通知を John に表示するためには、上記パーミッションリストに CHANGESET_VIEW を追加する必要があります。 |
| | 192 | |
| | 193 | |
| | 194 | ==== 利用不可となる機能 ==== #MissingFeatures |
| | 195 | 粒度が細かいパーミッションでは!DefaultPermissionPolicyで行っていたような (管理画面での) グループ機能は備わっていません ([trac:#9573 #9573], [trac:#5648 #5648] 参照)。パッチは一部利用可能です( [trac:#6680 #6680] にある authz_policy.2.patch を参照してください) |
| | 196 | |
| | 197 | 利用不可となる機能: |
| 217 | | === !AuthzSourcePolicy (mod_authz_svn-like permission policy) === #AuthzSourcePolicy |
| 218 | | |
| 219 | | At the time of this writing, the old fine grained permissions system from Trac 0.11 and before used for restricting access to the repository has been converted to a permission policy component, but from the user point of view, this makes little if no difference. |
| 220 | | |
| 221 | | That kind of fine-grained permission control needs a definition file, which is the one used by Subversion's mod_authz_svn. |
| 222 | | More information about this file format and about its usage in Subversion is available in the [http://svnbook.red-bean.com/en/1.5/svn.serverconfig.pathbasedauthz.html Path-Based Authorization] section in the Server Configuration chapter of the svn book. |
| 223 | | |
| 224 | | Example: |
| | 217 | === !AuthzSourcePolicy (mod_authz_svn のようなパーミッションポリシー) === #AuthzSourcePolicy |
| | 218 | |
| | 219 | この文書が書かれている時点では、 Trac 0.11 以前にリポジトリへの厳密なアクセス制御に使用されていた、古い「粒度が細かいパーミッション」システムは、パーミッションポリシーのコンポーネントにコンバートされました。しかし、ユーザの視点では、実現できる機能に大きな違いはありません。 |
| | 220 | |
| | 221 | 「粒度が細かいパーミッション」の制御に定義ファイルを必要とします。この定義ファイルは Subversion の mod_authz_svn で使用しているものを使います。 |
| | 222 | このファイルの形式と Subversion での用法に関する情報は、 svn book の Server Configuration (サーバ設定) の章にある [http://svnbook.red-bean.com/en/1.5/svn.serverconfig.pathbasedauthz.html Path-Based Authorization (ディレクトリごとのアクセス制御)] の項を参照してください。 |
| | 223 | |
| | 224 | 例: |
| 237 | | * '''/''' = ''Everyone has read access by default'' |
| 238 | | * '''/branches/calc/bug-142''' = ''harry has read/write access, sally read only'' |
| 239 | | * '''/branches/calc/bug-142/secret''' = ''harry has no access, sally has read access (inherited as a sub folder permission)'' |
| 240 | | |
| 241 | | ==== Trac Configuration ==== |
| 242 | | |
| 243 | | To activate fine grained permissions you __must__ specify the {{{authz_file}}} option in the {{{[trac]}}} section of trac.ini. If this option is set to null or not specified the permissions will not be used. |
| | 237 | * '''/''' = ''全員 read アクセスが可能です。これはデフォルトの動作となります'' |
| | 238 | * '''/branches/calc/bug-142''' = ''harry は read/write アクセス権を持ち、 sally は read アクセス権のみを持ちます'' |
| | 239 | * '''/branches/calc/bug-142/secret''' = ''harry はアクセス権を持たず、 sally は read アクセス権を持ちます (パーミッションはサブフォルダに継承されます)'' |
| | 240 | |
| | 241 | ==== Trac の設定 ==== #TracConfiguration |
| | 242 | |
| | 243 | 「粒度が細かいパーミッション」を有効にするには、 trac.ini ファイルの {{{[trac]}}} セクションに {{{authz_file}}} オプションを __設定しなければなりません__ 。オプションが空値に設定されていたり、そもそも指定されていない場合、パーミッションは適用されません。 |
| 263 | | repository_dir = /srv/active/svn/blahblah |
| 264 | | }}} |
| 265 | | |
| 266 | | where the svn access file, {{{/path/to/svnaccessfile}}}, contains entries such as {{{[blahblah:/some/path]}}}. |
| 267 | | |
| 268 | | '''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac. |
| 269 | | |
| 270 | | As of version 0.12, make sure you have ''!AuthzSourcePolicy'' included in the permission_policies list in trac.ini, otherwise the authz permissions file will be ignored. |
| 271 | | |
| 272 | | {{{ |
| | 263 | repository_dir = /srv/active/svn/blahblah |
| | 264 | }}} |
| | 265 | |
| | 266 | Subversion の Authz ファイル {{{/path/to/svnaccessfile}}} では、 {{{[blahblah:/some/path]}}} のようにエントリを記載します。 |
| | 267 | |
| | 268 | '''Note:''' Authz ファイルで使用するユーザ名と、 Trac で使用するユーザ名は __同じでなければなりません__。 |
| | 269 | |
| | 270 | 0.12 では、 trac.ini の permission_policies に ''!AuthzSourcePolicy'' を必ず含めて下さい。さもないと、 authz のパーミッションファイルは無視されます。 |
| | 271 | |
| | 272 | {{{ |
![(please configure the [header_logo] section in trac.ini)](/python/trac/mypz/chrome/common/trac_logo_mini.png){kind=logo}