Changes between Version 1 and Version 2 of TracPermissions


Ignore:
Timestamp:
Apr 7, 2008, 11:15:27 AM (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPermissions

    v1 v2  
    1 == Trac Permissions ==
     1= Trac Permissions =
    22[[TracGuideToc]]
    33
    4 Trac uses a simple but flexible 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 privilegies are managed using the [wiki:TracAdmin trac-admin] tool.
     6Permission privileges are managed using the [wiki:TracAdmin trac-admin] tool.
    77
    8 Regular visitors, non-authenticated users, accessing the system are assigned the default
    9 role (''user'') named {{{anonymous}}}.
    10 Assign permissions to the {{{anonymous}}} user to set privilegies for non-authenticated/guest users.
     8Non-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.
    119
    12 In addition to these privileges users can be granted additional individual
    13 rights in effect when authenticated and logged into the system.
     10In 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".
    1411
    15 === Available privileges ===
     12== Available Privileges ==
    1613
    17  * {{{TRAC_ADMIN}}}
    18  * {{{LOG_VIEW}}}
    19  * {{{FILE_VIEW}}}
    20  * {{{CHANGESET_VIEW}}}
    21  * {{{BROWSER_VIEW}}}
    22  * {{{TICKET_VIEW, TICKET_CREATE, TICKET_MODIFY, TICKET_ADMIN}}}
    23  * {{{REPORT_VIEW, REPORT_CREATE, REPORT_MODIFY, REPORT_DELETE, REPORT_ADMIN, REPORT_SQL_VIEW}}}
    24  * {{{WIKI_VIEW, WIKI_CREATE, WIKI_MODIFY, WIKI_DELETE, WIKI_ADMIN}}}
    25  * {{{MILESTONE_VIEW, MILESTONE_CREATE, MILESTONE_MODIFY, MILESTONE_DELETE}}}
    26  * {{{ROADMAP_VIEW, ROADMAP_ADMIN}}}
    27  * {{{TIMELINE_VIEW}}}
    28  * {{{SEARCH_VIEW}}}
    29  * {{{CONFIG_VIEW}}}
     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.
    3015
    31 The {{{something_ADMIN}}} privileges are just shortcuts that can be used to grant a user all the ''something'' privileges in one go. Having {{{TRAC_ADMIN}}}
    32 is like being {{{root}}} on a *NIX system, it will let you do anything you want.
     16Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac (note that the privilege names are case-sensitive):
    3317
    34 === Granting privileges ===
     18=== Repository Browser ===
    3519
    36 Currently the only way to grant privileges to users is by using the
    37 {{{trac-admin}}} script. The current set of privileges can be listed
    38 with the following command:
     20|| `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] ||
     21|| `LOG_VIEW` || View revision logs of files and directories in the [wiki:TracBrowser repository browser] ||
     22|| `FILE_VIEW` || View files in the [wiki:TracBrowser repository browser] ||
     23|| `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] ||
    3924
     25=== Ticket System ===
     26
     27|| `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] ||
     28|| `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
     29|| `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
     30|| `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties (priority, assignment, keywords, etc.) except description field ||
     31|| `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [wiki:TracTickets tickets] ||
     32|| `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the description field ||
     33
     34=== Roadmap ===
     35
     36|| `MILESTONE_VIEW` || View a milestone ||
     37|| `MILESTONE_CREATE` || Create a new milestone ||
     38|| `MILESTONE_MODIFY` || Modify existing milestones ||
     39|| `MILESTONE_DELETE` || Delete milestones ||
     40|| `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
     41|| `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page ||
     42
     43=== Reports ===
     44
     45|| `REPORT_VIEW` || View [wiki:TracReports reports] ||
     46|| `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
     47|| `REPORT_CREATE` || Create new [wiki:TracReports reports] ||
     48|| `REPORT_MODIFY` || Modify existing [wiki:TracReports reports] ||
     49|| `REPORT_DELETE` || Delete [wiki:TracReports reports] ||
     50|| `REPORT_ADMIN` || All `REPORT_*` permissions ||
     51
     52=== Wiki System ===
     53
     54|| `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
     55|| `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
     56|| `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
     57|| `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments ||
     58|| `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||
     59
     60=== Others ===
     61
     62|| `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
     63|| `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
     64|| `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
     65
     66== Granting Privileges ==
     67
     68You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
    4069{{{
    4170  $ trac-admin /path/to/projenv permission list
    4271}}}
    4372
    44 This command will let the user ''bob'' delete reports:
    45 
     73This command will allow the user ''bob'' to delete reports:
    4674{{{
    4775  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
    4876}}}
    4977
    50 === Permission groups ===
     78The `permission add` command also accepts multiple privilege names:
     79{{{
     80  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
     81}}}
    5182
    52 Permissions can be grouped together to form roles such as
    53 ''developer'', ''admin'', etc.
     83== Permission Groups ==
    5484
     85Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
    5586{{{
    5687  $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
     
    6192}}}
    6293
    63 === Default permissions ===
     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.
    6495
    65 Granting privileges to the special user ''anonymous'' can be used to control
    66 what an anonymous user can do before they have logged in.
     96== Removing Permissions ==
     97
     98Permissions can be removed using the 'remove' command. For example:
     99
     100This command will prevent the user ''bob'' from deleting reports:
     101{{{
     102  $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
     103}}}
     104
     105Just like `permission add`, this command accepts multiple privilege names.
     106
     107You can also remove all privileges for a specific user:
     108{{{
     109  $ trac-admin /path/to/projenv permission remove bob *
     110}}}
     111
     112Or one privilege for all users:
     113{{{
     114  $ trac-admin /path/to/projenv permission remove * REPORT_ADMIN
     115}}}
     116
     117== Default Permissions ==
     118
     119Granting privileges to the special user ''anonymous'' can be used to control what an anonymous user can do before they have logged in.
    67120
    68121In the same way, privileges granted to the special user ''authenticated'' will apply to any authenticated (logged in) user.
    69122
    70123----
    71 See also: TracAdmin, TracGuide
     124See also: TracAdmin, TracGuide and [http://trac.edgewall.org/wiki/FineGrainedPermissions FineGrainedPermissions]