Wiki source code of Access Rights
Version 2.1 by Guillaume Lerouge on 2009/02/24
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | |
| 2 | 1 Access Rights | ||
| 3 | |||
| 4 | This page aims at explaining how access rights work in XWiki. It will help you configure access rights on your wiki so that every user can only see and do what he should be allowed to. | ||
| 5 | |||
| 6 | 1.1 An overview of rights | ||
| 7 | |||
| 8 | Here is a lists of all the rights available in XWiki and their default setting. | ||
| 9 | |||
| 10 | * ~~*Right name:* brief description of the right~~ | ||
| 11 | ** ~~Availability: where you can set this right~~ | ||
| 12 | *** ~~Page: this right can be set at the page level~~ | ||
| 13 | *** ~~Space: this right can be set at the space level~~ | ||
| 14 | *** ~~Wiki: this right can be set at the wiki level~~ | ||
| 15 | ** ~~Default status: whether the right is allowed or denied when the checkbox is left blank~~ | ||
| 16 | *** ~~ALLOWED: this means that users CAN perform the given action if no other right is set~~ | ||
| 17 | *** ~~DENIED: this means that users CANNOT perform the given action if no other right is set~~ | ||
| |
2.1 | 18 | ** ~~Priority order: which setting wins over another~~ |
| 19 | |||
| |
1.1 | 20 | * *View:* whether users can see the page |
| 21 | ** Availability: this right is available at the page, space and wiki level | ||
| 22 | ** Default status: ALLOWED | ||
| |
2.1 | 23 | ** Priority order: deny > allow > no setting |
| 24 | |||
| |
1.1 | 25 | * *Comment:* whether users can add a comment to the page |
| 26 | ** Availability: this right is available at the page, space and wiki level | ||
| 27 | ** Default status: ALLOWED | ||
| |
2.1 | 28 | ** Priority order: deny > allow > no setting |
| 29 | |||
| |
1.1 | 30 | * *Edit:* whether users can edit and save modifications to the page |
| 31 | ** Availability: this right is available at the page, space and wiki level | ||
| 32 | ** Default status: ALLOWED | ||
| |
2.1 | 33 | ** Priority order: deny > allow > no setting |
| 34 | |||
| |
1.1 | 35 | * *Delete:* whether users can delete the page |
| 36 | ** Availability: this right is available at the page, space and wiki level | ||
| |
2.1 | 37 | ** Default status: DENIED (unless you're the document creator) |
| 38 | ** Priority order: deny > allow > no setting | ||
| 39 | |||
| |
1.1 | 40 | * *Admin:* whether users can manage administration settings for the space / wiki |
| 41 | ** Availability: this right is available at the space and wiki level | ||
| |
2.1 | 42 | ** Default status: ALLOWED |
| 43 | ** Priority order: allow > deny > no setting | ||
| 44 | |||
| |
1.1 | 45 | * *Register:* whether users can create new user accounts |
| |
2.1 | 46 | ** Availability: this right is available at the wiki level |
| |
1.1 | 47 | ** Default status: ALLOWED |
| |
2.1 | 48 | ** Priority order: allow > deny > no setting |
| 49 | |||
| |
1.1 | 50 | * *Program:* whether users can use protected APIs & Groovy code in wiki pages |
| |
2.1 | 51 | ** Availability: this right is available at the wiki level |
| |
1.1 | 52 | ** Default status: DENIED |
| |
2.1 | 53 | ** Priority order: allow > deny > no setting |
| 54 | |||
| 55 | 1.1 Access Rights execution order | ||
| 56 | |||
| 57 | In XWiki, the check for access rights follows this path: | ||
| 58 | |||
| 59 | First, the wiki tries to find out to which groups the current user belongs to. | ||
| 60 | |||
| 61 | Let's say Mike belongs to the following groups: Sales, Marketing and Management. | ||
| 62 | |||
| 63 | Mike tries to view a page. | ||
| 64 | |||
| 65 | XWiki will: | ||
| 66 | |||
| 67 | * Check for admin rights at the wiki level | ||
| 68 | ** Mike and/or one of his groups has an Allow right -> Mike has admin rights on the page | ||
| 69 | ** Mike and/or one of his groups have a Deny right -> Mike doesn't have admin rights on the page | ||
| 70 | ** Mike and/or the Sales group have a Deny right but the Management group has an Allow right -> Mike has admin rights on the page (Allow wins over Deny for Admin) | ||
| 71 | ** No right set for Mike or his groups and no Admin right set for any other user or group -> Mike has admin rights on the page | ||
| 72 | ** No right set for Mike or his groups and other users or groups have admin rights allowed -> Mike doesn't have admin rights on the page | ||
| 73 | |||
| 74 | * * Check if Mike or one of the groups he belongs to has admin rights on the space | ||
| 75 | |||
| 76 | |||
| 77 | * *XWiki Enterprise* | ||
| 78 | * Admin rights on space? if no, | ||
| 79 | * Admin rights on wiki? if no, | ||
| 80 | * View / Comment / Edit / Delete rights on page? if no, | ||
| 81 | * View / Comment / Edit / Delete rights on space? if no, | ||
| 82 | * View / Comment / Edit / Delete / Register / Programming rights on wiki? if no, | ||
| 83 | * The wiki can be accessed and managed by anyone | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | * *XWiki Enterprise Manager* | ||
| 89 | * Admin rights on space? if no, | ||
| 90 | * Admin rights on wiki? if no, | ||
| 91 | * Admin rights on wiki farm? if no, | ||
| 92 | * View / Comment / Edit / Delete rights on page? if no, | ||
| 93 | * View / Comment / Edit / Delete rights on space? if no, | ||
| 94 | * View / Comment / Edit / Delete / Register rights on wiki? if no, | ||
| 95 | * View / Comment / Edit / Delete / Register / Programming rights on wiki farm? if no, | ||
| 96 | * The wiki farm can be accessed and managed by anyone | ||
| 97 | |||
| 98 | #warning("Setting user rights on a wiki farm can be tricky. Always remember that you can have both local users and global users. Rights for local users are independent of rights for global users.") | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 |
