Legend:

Before Trac 0.11, it was only possible to define fine-grained permissions checks on the repository browser sub-system.

4

5

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.

6

7

== Permission Policies ==

8

9

=== !AuthzPolicy ===

10

11

An example policy based on an Authz-style system has been added. See

12

[source:trunk/sample-plugins/permissions/authz_policy.py] for details. (See also [source:trunk/sample-plugins/permissions] for more samples.)

Note that the order in which permission policies are specified is quite critical,

32

as policies will be examined in the sequence provided.

33

34

A policy will return either `True`, `False` or `None` for a given permission check.

35

Only if the return value is `None` will the ''next'' permission policy be consulted.

36

If no policy explicitly grants the permission, the final result will be `False`

37

(i.e. no permission).

38

39

For example, if the `authz_file` contains:

40

{{{

41

[wiki:WikiStart@*]

42

* = WIKI_VIEW

43

44

[wiki:PrivatePage@*]

45

john = WIKI_VIEW

46

* =

47

}}}

48

and the default permissions are set like this:

49

{{{

50

john WIKI_VIEW

51

jack WIKI_VIEW

52

# anonymous has no WIKI_VIEW

53

}}}

54

55

Then:

56

- All versions of WikiStart will be viewable by everybody (including anonymous)

57

- !PrivatePage will be viewable only by john

58

- other pages will be viewable only by john and jack

59

60

61

=== mod_authz_svn-like permission policy ===

62

63

At the time of this writing, the old fine grained permissions system from Trac 0.10 and before used for restricting access to the repository has not yet been converted to a permission policy component, but from the user point of view, this makes little if no differences.

64

65

That kind of fine-grained permission control needs a definition file, which is the one used by Subversion's mod_authz_svn.

66

More information about this file format and about its usage in Subversion is available in the [http://svnbook.red-bean.com/svnbook/book.html#svn-ch-6-sect-4.4.2 Subversion Book (Per-Directory Access Control)].

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.

88

89

{{{

90

[trac]

91

authz_file = /path/to/svnaccessfile

92

}}}

93

94

if you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add

95

96

{{{

97

authz_module_name = modulename

98

}}}

99

100

where ''modulename'' refers to the same repository indicated by the `repository_dir` entry in the `[trac]` section.

101

102

'''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac.

103

104

==== Subversion Configuration ====

105

106

The same access file is typically applied to the corresponding Subversion repository using an Apache directive like this:

107

{{{

108

<Location /repos>

109

DAV svn

110

SVNParentPath /usr/local/svn

111

112

# our access control policy

113

AuthzSVNAccessFile /path/to/svnaccessfile

114

</Location>

115

}}}

116

117

For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess]