Changes between Version 4 and Version 5 of TracPermissions
- Timestamp:
- May 5, 2015, 2:14:41 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracPermissions
v4 v5 1 = Trac Permissions =1 = Trac Permissions 2 2 [[TracGuideToc]] 3 3 4 4 Trac uses a simple, case sensitive, permission system to control what users can and can't access. 5 5 6 Permission privileges are managed using the [TracAdmin trac-admin] tool or (new in version 0.11)the ''General / Permissions'' panel in the ''Admin'' tab of the web interface.6 Permission privileges are managed using the [TracAdmin trac-admin] tool or the ''General / Permissions'' panel in the ''Admin'' tab of the web interface. 7 7 8 8 In addition to the default permission policy described in this page, it is possible to activate additional permission policies by enabling plugins and listing them in the `[trac] permission_policies` configuration entry in the TracIni. See TracFineGrainedPermissions for more details. … … 11 11 In addition to these privileges, users can be granted additional individual rights in effect when authenticated and logged into the system. All logged in users belong to the virtual group "authenticated", which inherits permissions from "anonymous". 12 12 13 == Graphical Admin Tab == 14 ''This feature is new in version 0.11.'' 15 16 To access this tab, a user must have `TRAC_ADMIN privileges`. This can be performed as follows (more on the trac-admin script below): 13 == Graphical Admin Tab 14 15 To access this tab, a user must have one of the following permissions: `TRAC_ADMIN`, `PERMISSION_ADMIN`, `PERMISSION_GRANT`, `PERMISSION_REVOKE`. The permissions can be granted using the `trac-admin` command (more on `trac-admin` below): 17 16 {{{ 18 17 $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN 19 18 }}} 20 19 21 Then, the user `bob` will be able to see the Admin tab, and can then access the permissions menu. This menu will allow you to perform all the following actions, but from the browser without requiring root access to the server (just the correct permissions for your user account). 22 20 Then, the user `bob` will be able to see the Admin tab, and can then access the permissions menu. This menu will allow you to perform all the following actions, but from the browser without requiring root access to the server (just the correct permissions for your user account). '''Use at least one lowercase character in user names, as all-uppercase names are reserved for permissions.''' 21 22 1. [[Image(htdocs:../common/guide/admin.png)]] 23 1. [[Image(htdocs:../common/guide/admin-permissions.png)]] 24 1. [[Image(htdocs:../common/guide/admin-permissions-TICKET_ADMIN.png)]] 23 25 24 26 An easy way to quickly secure a new Trac install is to run the above command on the anonymous user, install the [http://trac-hacks.org/wiki/AccountManagerPlugin AccountManagerPlugin], create a new admin account graphically and then remove the TRAC_ADMIN permission from the anonymous user. 25 27 26 == Available Privileges == 28 From the graphical admin tab, users with `PERMISSION_GRANT` will only be allowed to grant permissions that they possess, and users with `PERMISSION_REVOKE` will only be allowed to revoke permissions that they possess. For example, a user cannot grant `MILESTONE_ADMIN` unless they have `PERMISSION_GRANT` and `MILESTONE_ADMIN`, and they cannot revoke `MILESTONE_ADMIN` unless they have `PERMISSION_REVOKE` and `MILESTONE_ADMIN`. `PERMISSION_ADMIN` just grants the user both `PERMISSION_GRANT` and `PERMISSION_REVOKE`, and users with `TRAC_ADMIN` can grant or revoke any permission. 29 30 == Available Privileges 27 31 28 32 To enable all privileges for a user, use the `TRAC_ADMIN` permission. Having `TRAC_ADMIN` is like being `root` on a *NIX system: it will allow you to perform any operation. … … 30 34 Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''): 31 35 32 === Repository Browser ===36 === Repository Browser 33 37 34 38 || `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] || … … 37 41 || `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] || 38 42 39 === Ticket System ===43 === Ticket System 40 44 41 45 || `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] || … … 46 50 || `TICKET_EDIT_CC` || Full modify cc field || 47 51 || `TICKET_EDIT_DESCRIPTION` || Modify description field || 48 || `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the reporter and description fields. It also allows managing ticket properties in the WebAdmin panel. || 52 || `TICKET_EDIT_COMMENT` || Modify comments || 53 || `TICKET_BATCH_MODIFY` || [wiki:TracBatchModify Batch modify] tickets || 54 || `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the reporter and description fields. It also allows managing ticket properties in the [trac:WebAdmin] panel. || 49 55 50 56 Attention: the "view tickets" button appears with the `REPORT_VIEW` permission. 51 57 52 === Roadmap ===58 === Roadmap 53 59 54 60 || `MILESTONE_VIEW` || View milestones and assign tickets to milestones. || … … 60 66 || `ROADMAP_ADMIN` || to be removed with [trac:#3022 #3022], replaced by MILESTONE_ADMIN || 61 67 62 === Reports ===68 === Reports 63 69 64 70 || `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. || … … 69 75 || `REPORT_ADMIN` || All `REPORT_*` permissions || 70 76 71 === Wiki System ===77 === Wiki System 72 78 73 79 || `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages || 74 80 || `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages || 75 81 || `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages || 82 || `WIKI_RENAME` || Rename [wiki:TracWiki wiki] pages || 76 83 || `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments || 77 84 || `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. || 78 85 79 === Permissions ===86 === Permissions 80 87 81 88 || `PERMISSION_GRANT` || add/grant a permission || … … 83 90 || `PERMISSION_ADMIN` || All `PERMISSION_*` permissions || 84 91 85 86 === Others === 92 === Others 87 93 88 94 || `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page || 89 95 || `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries || 90 96 || `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins || 91 || `EMAIL_VIEW` || Shows email addresses even if [trac:wiki:0.11/TracIni trac show_email_addresses configuration option is false] || 92 93 == Granting Privileges == 97 || `EMAIL_VIEW` || Shows email addresses even if [wiki:TracIni#trac-section trac show_email_addresses] configuration option is false || 98 99 == Creating New Privileges 100 101 To create custom permissions, for example to be used in a custom workflow, enable the optional [trac:ExtraPermissionsProvider tracopt.perm.config_perm_provider.ExtraPermissionsProvider] component in the "Plugins" admin panel, and add the desired permissions to the `[extra-permissions]` section in your [wiki:TracIni#extra-permissions-section trac.ini]. For more information, please refer to the documentation on the [wiki:TracIni#extra-permissions-section TracIni] page after enabling the component. 102 103 == Granting Privileges 94 104 95 105 You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command: … … 113 123 }}} 114 124 115 == Permission Groups == 116 117 There are two built-in groups, "authenticated" and "anonymous".[[BR]] 118 Any user who has not logged in is automatically in the "anonymous" group.[[BR]] 119 Any user who has logged in is also in the "authenticated" group.[[BR]] 120 The "authenticated" group inherits permissions from the "anonymous" group.[[BR]] 121 eg. if the "anonymous" group has permission WIKI_MODIFY, it's not necessary to add the WIKI_MODIFY permisison to the "authenticated" group as well. 125 == Permission Groups 126 127 There are two built-in groups, "authenticated" and "anonymous". 128 Any user who has not logged in is automatically in the "anonymous" group. 129 Any user who has logged in is also in the "authenticated" group. 130 The "authenticated" group inherits permissions from the "anonymous" group. 131 For example, if the "anonymous" group has permission WIKI_MODIFY, 132 it is not necessary to add the WIKI_MODIFY permission to the "authenticated" group as well. 122 133 123 134 Custom groups may be defined that inherit permissions from the two built-in groups. … … 132 143 }}} 133 144 134 Group membership can be checked by doing a {{{permission list}}} with no further arguments; the resulting output will include group memberships. '''Use lowercase for group names, as uppercase isreserved for permissions'''.135 136 == Adding a New Group and Permissions ==145 Group membership can be checked by doing a {{{permission list}}} with no further arguments; the resulting output will include group memberships. '''Use at least one lowercase character in group names, as all-uppercase names are reserved for permissions'''. 146 147 == Adding a New Group and Permissions 137 148 Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group. 138 149 … … 144 155 }}} 145 156 146 == Removing Permissions ==157 == Removing Permissions 147 158 148 159 Permissions can be removed using the 'remove' command. For example: … … 165 176 }}} 166 177 167 == Default Permissions ==178 == Default Permissions 168 179 169 180 By default on a new Trac installation, the `anonymous` user will have ''view'' access to everything in Trac, but will not be able to create or modify anything.