Repositories access control with apache mod dav svn and mod perl » History » Version 40

Zack s, 2012-02-10 10:27

1 16 Jean-Philippe Lang
h1. Repositories access control with apache, mod_dav_svn and mod_perl
2 1 Nicolas Chuche
3 2 Nicolas Chuche
{{>TOC}}
4 2 Nicolas Chuche
5 4 Jean-Philippe Lang
h2. Overview
6 1 Nicolas Chuche
7 23 Eric Davis
In this documentation, we will configure apache to delegate authentication to mod_perl. It's tested on apache2 (@apache2-mpm-prefork@) with mysql and postgresql but should work with allmost every databases for which there is a perl DBD module.  Apache2 with the high speed thread model might not load Perl correctly (@apache2-mpm-worker@).
8 1 Nicolas Chuche
9 1 Nicolas Chuche
You need a working apache on your SVN server and you must install some modules at least mod_dav_svn, mod_perl2, DBI and DBD::mysql (or the DBD driver for you database as it should work on allmost all databases).
10 4 Jean-Philippe Lang
11 15 Jean-Philippe Lang
On Debian/ubuntu you can do :
12 11 Shaun Mangelsdorf
13 37 Mischa The Evil
  sudo aptitude install libapache2-svn libapache-dbi-perl libapache2-mod-perl2 libdbd-mysql-perl libdigest-sha1-perl libauthen-simple-ldap-perl
14 1 Nicolas Chuche
15 40 Zack s
On Turnkey Redmine Stack you can do :
16 40 Zack s
17 40 Zack s
  apt-get install libapache2-svn libapache-dbi-perl libapache2-mod-perl2 libauthen-simple-ldap-perl
18 40 Zack s
19 37 Mischa The Evil
If the repositories are not created automatically by reposman.rb, it is important that the repository name is the same as the project identifier in Redmine, otherwise Redmine.pm will fail to authenticate users.  For example, if the path to the repository is @/path/to/repository/foo-bar@, then the project Identifier on the Settings page must be @foo-bar@.
20 1 Nicolas Chuche
21 1 Nicolas Chuche
h2. Enabling apache modules
22 1 Nicolas Chuche
23 1 Nicolas Chuche
On debian/ubuntu :
24 1 Nicolas Chuche
25 1 Nicolas Chuche
<pre>
26 15 Jean-Philippe Lang
sudo a2enmod dav
27 21 Marko Roeder
sudo a2enmod dav_svn # if you want to use svn
28 21 Marko Roeder
sudo a2enmod dav_fs  # if you want to use git
29 15 Jean-Philippe Lang
sudo a2enmod perl
30 4 Jean-Philippe Lang
</pre>
31 1 Nicolas Chuche
32 15 Jean-Philippe Lang
h2. Apache configuration for Subversion repositories
33 1 Nicolas Chuche
34 1 Nicolas Chuche
You first need to copy or link @Redmine.pm@ to @/usr/lib/perl5/Apache/Redmine.pm@
35 37 Mischa The Evil
* Redmine.pm can be found in $REDMINE_DIR/extra/svn/Redmine.pm
36 37 Mischa The Evil
* In the Debian install, it is found /usr/share/redmine/extra/svn/Redmine.pm
37 37 Mischa The Evil
38 15 Jean-Philippe Lang
Then add the following Location directives to your apache configuration (for example in @/etc/APACHE_DIR/conf.d/@):
39 1 Nicolas Chuche
40 17 Joachim Fritschi
* the old how-to which suggested two separate locations for with @/svn@  and @/svn-private@ can be avoided
41 17 Joachim Fritschi
* with the @Satisfy any@ keyword from Apache you can define different authentication policies
42 17 Joachim Fritschi
* read access from the redmine-server or any validated user
43 17 Joachim Fritschi
* write access only validated users
44 15 Jean-Philippe Lang
45 17 Joachim Fritschi
46 15 Jean-Philippe Lang
<pre>
47 1 Nicolas Chuche
   # /svn location for users
48 1 Nicolas Chuche
   PerlLoadModule Apache::Redmine
49 1 Nicolas Chuche
   <Location /svn>
50 1 Nicolas Chuche
     DAV svn
51 19 Joachim Fritschi
     SVNParentPath "/var/svn"
52 17 Joachim Fritschi
     Order deny,allow
53 17 Joachim Fritschi
     Deny from all
54 17 Joachim Fritschi
     Satisfy any
55 1 Nicolas Chuche
56 1 Nicolas Chuche
     PerlAccessHandler Apache::Authn::Redmine::access_handler
57 1 Nicolas Chuche
     PerlAuthenHandler Apache::Authn::Redmine::authen_handler
58 17 Joachim Fritschi
     AuthType Basic
59 18 Joachim Fritschi
     AuthName "Redmine SVN Repository"
60 17 Joachim Fritschi
61 17 Joachim Fritschi
     #read-only access	
62 17 Joachim Fritschi
     <Limit GET PROPFIND OPTIONS REPORT>
63 19 Joachim Fritschi
        Require valid-user
64 17 Joachim Fritschi
        Allow from redmine.server.ip
65 17 Joachim Fritschi
        # Allow from another-ip
66 17 Joachim Fritschi
     	Satisfy any
67 17 Joachim Fritschi
     </Limit>
68 17 Joachim Fritschi
     # write access
69 17 Joachim Fritschi
     <LimitExcept GET PROPFIND OPTIONS REPORT>
70 17 Joachim Fritschi
   	Require valid-user
71 17 Joachim Fritschi
     </LimitExcept>
72 17 Joachim Fritschi
73 17 Joachim Fritschi
74 1 Nicolas Chuche
     ## for mysql
75 1 Nicolas Chuche
     RedmineDSN "DBI:mysql:database=databasename;host=my.db.server"
76 4 Jean-Philippe Lang
     ## for postgres
77 1 Nicolas Chuche
     # RedmineDSN "DBI:Pg:dbname=databasename;host=my.db.server"
78 4 Jean-Philippe Lang
     ## for SQLite3
79 1 Nicolas Chuche
     # RedmineDSN "DBI:SQLite:dbname=database.db"
80 1 Nicolas Chuche
81 1 Nicolas Chuche
     RedmineDbUser "redmine"
82 1 Nicolas Chuche
     RedmineDbPass "password"
83 1 Nicolas Chuche
  </Location>
84 1 Nicolas Chuche
85 1 Nicolas Chuche
</pre>
86 1 Nicolas Chuche
87 17 Joachim Fritschi
h3. Testing the configuration:
88 1 Nicolas Chuche
89 17 Joachim Fritschi
After reloading apache conf, you can try to browse some repository with:
90 17 Joachim Fritschi
91 1 Nicolas Chuche
<pre>
92 1 Nicolas Chuche
svn ls http://my.svn.server/svn/myproject
93 4 Jean-Philippe Lang
</pre>
94 1 Nicolas Chuche
95 17 Joachim Fritschi
Any non-public repository should ask for a username and password.
96 4 Jean-Philippe Lang
97 17 Joachim Fritschi
To test the authentication that allows you redmine server to read all repositories:
98 1 Nicolas Chuche
99 17 Joachim Fritschi
Reading a private repository:
100 3 Jean-Philippe Lang
<pre>
101 17 Joachim Fritschi
svn ls http://my.svn.server/svn/myproject
102 17 Joachim Fritschi
</pre>
103 17 Joachim Fritschi
Try writing to the repository:
104 17 Joachim Fritschi
<pre>
105 17 Joachim Fritschi
svn mkdir http://my.svn.server/svn/myproject/testdir
106 17 Joachim Fritschi
</pre>
107 17 Joachim Fritschi
This should fail and ask for a password.
108 17 Joachim Fritschi
109 17 Joachim Fritschi
110 17 Joachim Fritschi
h3. optional LDAP Authentication
111 17 Joachim Fritschi
112 17 Joachim Fritschi
If you want to connect your LDAP authentication to Apache, you can install the Authen::Simple::LDAP perl module. I found that connecting to my LDAP server to authenticate with every request can be quite slow. I added the following to my configuration and had a significant performance increase. If you have configured an encrypted connection to the LDAP server you will need the IO::Socket::SSL module.
113 17 Joachim Fritschi
114 20 Stefan Stefansson
> *NOTE: the above wording is a little confusing. I attempt to clear up the issues I had with this in the following paragraph.*
115 20 Stefan Stefansson
> 
116 1 Nicolas Chuche
> First of all, make sure that you have the Net::LDAP module installed as well. I installed Authen::Simple::LDAP through CPAN and found that nothing worked. Eventually I figured out that this was because the Authen::Simple::LDAP did not require the Net::LDAP module as a dependency but it is needed for our purpose here. I did this on CentOS and it seems that the Net::LDAP module can be installed via yum (@yum install perl-LDAP@) but the Authen::Simple::LDAP had to be installed via CPAN since there's no RPM for it in the CentOS repositories.
117 1 Nicolas Chuche
> 
118 37 Mischa The Evil
119 37 Mischa The Evil
To install the Authen::Simple::LDAP using CPAN use commands:
120 37 Mischa The Evil
<pre>
121 37 Mischa The Evil
cpan
122 37 Mischa The Evil
cpan> install Authen::Simple::LDAP
123 37 Mischa The Evil
</pre>
124 37 Mischa The Evil
if the installation failed due to some dependencies, resolve the dependencies first.
125 37 Mischa The Evil
126 20 Stefan Stefansson
> My second point is related to the below Apache config. The @PerlLoadModule Authen::Simple::LDAP@ is actually not required for having users authenticated via LDAP. It will happen automatically if both of the above modules are installed. So there really is no difference between the config snippet below and the one above except for the @RedmineCacheCredsMax 50@ line which is probably a good idea although it can result in users that have been deleted or removed in redmine still getting access to the repositories, at least for a little while.
127 20 Stefan Stefansson
128 17 Joachim Fritschi
<pre>
129 8 Nicolas Chuche
   PerlLoadModule Apache::Redmine
130 17 Joachim Fritschi
   PerlLoadModule  Authen::Simple::LDAP
131 17 Joachim Fritschi
   # PerlLoadModule  IO::Socket::SSL
132 12 Todd Nine
   <Location /svn>
133 12 Todd Nine
     DAV svn
134 12 Todd Nine
     SVNParentPath "/var/svn"
135 12 Todd Nine
136 12 Todd Nine
     AuthType Basic
137 12 Todd Nine
     AuthName redmine
138 12 Todd Nine
     Require valid-user
139 12 Todd Nine
140 12 Todd Nine
     PerlAccessHandler Apache::Authn::Redmine::access_handler
141 12 Todd Nine
     PerlAuthenHandler Apache::Authn::Redmine::authen_handler
142 12 Todd Nine
  
143 12 Todd Nine
     ## for mysql
144 12 Todd Nine
     RedmineDSN "DBI:mysql:database=databasename;host=my.db.server"
145 12 Todd Nine
     ## for postgres
146 12 Todd Nine
     # RedmineDSN "DBI:Pg:dbname=databasename;host=my.db.server"
147 12 Todd Nine
148 1 Nicolas Chuche
     RedmineDbUser "redmine"
149 12 Todd Nine
     RedmineDbPass "password"
150 12 Todd Nine
     #Cache the last 50 auth entries
151 12 Todd Nine
     RedmineCacheCredsMax 50
152 15 Jean-Philippe Lang
  </Location>
153 12 Todd Nine
</pre>
154 36 neil johnson
155 1 Nicolas Chuche
h2. Apache configuration for Git repositories
156 38 Lluís Vilanova
157 38 Lluís Vilanova
*TODO*: This should probably be moved into [[HowTo configure Redmine for advanced git integration]]
158 15 Jean-Philippe Lang
159 1 Nicolas Chuche
Now that reposman.rb can create git repositories, you can use Redmine.pm to access them the same way than subversion. 
160 1 Nicolas Chuche
161 1 Nicolas Chuche
You first need to copy or link Redmine.pm to /usr/lib/perl5/Apache/Redmine.pm, then you add this configuration to apache : 
162 1 Nicolas Chuche
163 1 Nicolas Chuche
<pre>
164 1 Nicolas Chuche
165 37 Mischa The Evil
PerlLoadModule Apache::Authn::Redmine
166 1 Nicolas Chuche
167 37 Mischa The Evil
SetEnv GIT_PROJECT_ROOT /path/to/git/repos
168 37 Mischa The Evil
SetEnv GIT_HTTP_EXPORT_ALL
169 37 Mischa The Evil
170 37 Mischa The Evil
ScriptAlias /git/ /usr/bin/git-http-backend/
171 37 Mischa The Evil
172 37 Mischa The Evil
<Location /git>
173 8 Nicolas Chuche
  AuthType Basic
174 8 Nicolas Chuche
  Require valid-user
175 1 Nicolas Chuche
  AuthName "Git"
176 8 Nicolas Chuche
177 8 Nicolas Chuche
  PerlAccessHandler Apache::Authn::Redmine::access_handler
178 8 Nicolas Chuche
  PerlAuthenHandler Apache::Authn::Redmine::authen_handler
179 1 Nicolas Chuche
180 8 Nicolas Chuche
  RedmineDSN "DBI:mysql:database=redmine;host=localhost"
181 8 Nicolas Chuche
  RedmineDbUser "redmine"
182 8 Nicolas Chuche
  RedmineDbPass "password"
183 37 Mischa The Evil
  RedmineGitSmartHttp yes
184 8 Nicolas Chuche
</Location>
185 8 Nicolas Chuche
186 8 Nicolas Chuche
Alias /git-private /var/git
187 8 Nicolas Chuche
188 8 Nicolas Chuche
<Location /git-private>
189 8 Nicolas Chuche
   Order deny,allow
190 8 Nicolas Chuche
   Deny from all
191 8 Nicolas Chuche
   <Limit GET PROPFIND OPTIONS REPORT>
192 8 Nicolas Chuche
      Options Indexes FollowSymLinks MultiViews
193 8 Nicolas Chuche
   Allow from 127.0.0.1
194 8 Nicolas Chuche
   </Limit>
195 8 Nicolas Chuche
</Location>
196 8 Nicolas Chuche
</pre>
197 8 Nicolas Chuche
198 8 Nicolas Chuche
To verify that you can access repository through Redmine.pm, you can use curl :
199 8 Nicolas Chuche
<pre>
200 8 Nicolas Chuche
% curl --netrc --location http://localhost/git/ecookbook/HEAD   
201 13 Thomas Pihl
ref: refs/heads/master
202 13 Thomas Pihl
</pre>
203 13 Thomas Pihl
204 22 Diego Oliveira
h2. Apache configuration for Mercurial repositories
205 22 Diego Oliveira
206 39 Lluís Vilanova
*TODO*: This should probably be moved into [[HowTo configure Redmine for advanced Mercurial integration]]
207 39 Lluís Vilanova
208 22 Diego Oliveira
Create a file caled "hgweb.config" in the same folder as "hgwebdir.cgi". This foder will be the root repository folder. Then edit the "hgweb.config" with something like this:
209 22 Diego Oliveira
210 22 Diego Oliveira
<pre>
211 22 Diego Oliveira
[paths]
212 22 Diego Oliveira
/=/path/to/root/repository/**
213 22 Diego Oliveira
214 22 Diego Oliveira
[web]
215 22 Diego Oliveira
allow_push = *
216 22 Diego Oliveira
allowbz2 = yes
217 22 Diego Oliveira
allowgz = yes
218 22 Diego Oliveira
allowzip = yes
219 22 Diego Oliveira
220 22 Diego Oliveira
</pre>
221 22 Diego Oliveira
222 22 Diego Oliveira
Follows the instructions to install Redmine.pm as described and configure your apache like this.
223 22 Diego Oliveira
224 22 Diego Oliveira
<pre>
225 22 Diego Oliveira
    RewriteEngine on
226 22 Diego Oliveira
    PerlLoadModule Apache2::Redmine
227 22 Diego Oliveira
    PerlLoadModule Authen::Simple::LDAP
228 22 Diego Oliveira
    ScriptAliasMatch ^/hg(.*)  /path/to/the/hgwebdir.cgi/$1
229 22 Diego Oliveira
    <Location /hg>
230 22 Diego Oliveira
        AuthType Basic
231 22 Diego Oliveira
        AuthName "Mercurial"
232 22 Diego Oliveira
        Require valid-user
233 1 Nicolas Chuche
234 1 Nicolas Chuche
        #Redmine auth
235 1 Nicolas Chuche
        PerlAccessHandler Apache::Authn::Redmine::access_handler
236 1 Nicolas Chuche
        PerlAuthenHandler Apache::Authn::Redmine::authen_handler
237 1 Nicolas Chuche
        RedmineDSN "DBI:mysql:database=redmine;host=localhost"
238 1 Nicolas Chuche
        RedmineDbUser "DB_USER"
239 1 Nicolas Chuche
        RedmineDbPass "DB_PASSWD"
240 1 Nicolas Chuche
    </Location>
241 37 Mischa The Evil
242 37 Mischa The Evil
    # Note: Do not use hg-private as the rewrite rule above will cause strange things to occur.
243 37 Mischa The Evil
    Alias /private-hg /path/to/hg/repos
244 37 Mischa The Evil
    
245 37 Mischa The Evil
    <Location /private-hg>
246 37 Mischa The Evil
        Order deny, allow
247 37 Mischa The Evil
        Deny from all
248 37 Mischa The Evil
        <Limit GET PROPFIND OPTIONS REPORT>
249 37 Mischa The Evil
            Options Indexes FollowSymLinks MultiViews
250 37 Mischa The Evil
            Allow from 127.0.0.1
251 37 Mischa The Evil
        </Limit>
252 37 Mischa The Evil
    </Location>
253 37 Mischa The Evil
254 22 Diego Oliveira
255 1 Nicolas Chuche
</pre>
256 22 Diego Oliveira
257 22 Diego Oliveira
h2. Gotchas
258 13 Thomas Pihl
259 13 Thomas Pihl
If you run this in Phusion Passenger, make sure you don't turn PassengerHighPerformance on. If you do, the rewrites to catch subversion dav will be bypassed with some interesting dump in the log as a result.
260 13 Thomas Pihl
Example: 
261 1 Nicolas Chuche
> ActionController::RoutingError (No route matches "/svn/rm-code" with {:method=>:get}):
262 1 Nicolas Chuche
(if your repo are named rm-code)
263 27 Bill Dieter
264 37 Mischa The Evil
When using @Authen::Simple::LDAP@ for authentication, it is not sufficient to have the Administrator role to access a repository.  The user must have a role with that specifically allows the user to browse, read, or write the repository.