Changes between Version 1 and Version 2 of TracPermissions


Ignore:
Timestamp:
09/10/09 19:34:27 (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPermissions

    v1 v2  
    22[[TracGuideToc]]
    33
    4 Trac uses a simple, case sensitive, permission system to control what users can and can't access.
     4Trac uses a simple permission system to control what users can and can't access.
    55
    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.
    7 
    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.
     6Permission privileges are managed using the [wiki:TracAdmin trac-admin] tool.
    97
    108Non-authenticated users accessing the system are assigned the name "anonymous". Assign permissions to the "anonymous" user to set privileges for anonymous/guest users. The parts of Trac that a user does not have the privileges for will not be displayed in the navigation.
     9
    1110In 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 
    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):
    17 {{{
    18   $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
    19 }}}
    20 
    21 Then, the user 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 
    23 
    24 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.
    2511
    2612== Available Privileges ==
    2713
    28 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.
     14To 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 perform any operation.
    2915
    30 Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''):
     16Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac (note that the privilege names are case-sensitive):
    3117
    3218=== Repository Browser ===
     
    4228|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
    4329|| `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
    44 || `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties (priority, assignment, keywords, etc.) except description field, cc field add/remove when logged in or set email to pref ||
     30|| `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties (priority, assignment, keywords, etc.) except description field ||
    4531|| `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [wiki:TracTickets tickets] ||
    46 || `TICKET_EDIT_CC` || Full modify cc field ||
    47 || `TICKET_EDIT_DESCRIPTION` || Modify description field ||
    4832|| `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the description field ||
    49 
    50 Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.
    5133
    5234=== Roadmap ===
     
    5739|| `MILESTONE_DELETE` || Delete milestones ||
    5840|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
    59 || `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see #4292 ||
    60 || `ROADMAP_ADMIN` || to be removed with #3022, replaced by MILESTONE_ADMIN ||
     41|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page ||
    6142
    6243=== Reports ===
    6344
    64 || `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
     45|| `REPORT_VIEW` || View [wiki:TracReports reports] ||
    6546|| `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
    6647|| `REPORT_CREATE` || Create new [wiki:TracReports reports] ||
     
    7758|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
    7859
    79 === Permissions ===
    80 
    81 || `PERMISSION_GRANT` || add/grant a permission ||
    82 || `PERMISSION_REVOKE` || remove/revoke a permission ||
    83 || `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||
    84 
    85 
    8660=== Others ===
    8761
     
    8963|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
    9064|| `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 [wiki:0.11/TracIni `trac show_email_addresses` configuration option is `false`] ||
    9265
    9366== Granting Privileges ==
     
    10881}}}
    10982
    110 Or add all privileges:
    111 {{{
    112   $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
    113 }}}
    114 
    11583== 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.
    122 
    123 Custom groups may be defined that inherit permissions from the two built-in groups.
    12484
    12585Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
     
    13292}}}
    13393
    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 is reserved for permissions'''.
    135 
    136 == Adding a New Group and Permissions ==
    137 Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.
    138 
    139 The following will add ''bob'' to the new group called ''beta_testers'' and then will assign WIKI_ADMIN permissions to that group. (Thus, ''bob'' will inherit the WIKI_ADMIN permission)
    140 {{{
    141    $ trac-admin /path/to/projenv permission add bob beta_testers
    142    $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN
    143 
    144 }}}
     94Group 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 is reserved for permissions.
    14595
    14696== Removing Permissions ==
     
    157107You can also remove all privileges for a specific user:
    158108{{{
    159   $ trac-admin /path/to/projenv permission remove bob '*'
     109  $ trac-admin /path/to/projenv permission remove bob *
    160110}}}
    161111
    162112Or one privilege for all users:
    163113{{{
    164   $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
     114  $ trac-admin /path/to/projenv permission remove * REPORT_ADMIN
    165115}}}
    166116
    167117== Default Permissions ==
    168118
    169 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.
    170 On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.
     119Granting privileges to the special user ''anonymous'' can be used to control what an anonymous user can do before they have logged in.
    171120
    172  '''anonymous'''::
    173  BROWSER_VIEW
    174  CHANGESET_VIEW
    175  FILE_VIEW
    176  LOG_VIEW
    177  MILESTONE_VIEW
    178  REPORT_SQL_VIEW
    179  REPORT_VIEW
    180  ROADMAP_VIEW
    181  SEARCH_VIEW
    182  TICKET_VIEW
    183  TIMELINE_VIEW
    184  WIKI_VIEW
    185 
    186  '''authenticated'''::
    187  TICKET_CREATE
    188  TICKET_MODIFY
    189  WIKI_CREATE
    190  WIKI_MODIFY 
     121In the same way, privileges granted to the special user ''authenticated'' will apply to any authenticated (logged in) user.
    191122
    192123----
    193 See also: TracAdmin, TracGuide and TracFineGrainedPermissions
     124See also: TracAdmin, TracGuide and [http://trac.edgewall.org/wiki/FineGrainedPermissions FineGrainedPermissions]