##// END OF EJS Templates
acl: use configlist to retrieve the source config...
marmoute -
r33184:2b233065 default
parent child Browse files
Show More
@@ -1,342 +1,342 b''
1 # acl.py - changeset access control for mercurial
1 # acl.py - changeset access control for mercurial
2 #
2 #
3 # Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
3 # Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
4 #
4 #
5 # This software may be used and distributed according to the terms of the
5 # This software may be used and distributed according to the terms of the
6 # GNU General Public License version 2 or any later version.
6 # GNU General Public License version 2 or any later version.
7
7
8 '''hooks for controlling repository access
8 '''hooks for controlling repository access
9
9
10 This hook makes it possible to allow or deny write access to given
10 This hook makes it possible to allow or deny write access to given
11 branches and paths of a repository when receiving incoming changesets
11 branches and paths of a repository when receiving incoming changesets
12 via pretxnchangegroup and pretxncommit.
12 via pretxnchangegroup and pretxncommit.
13
13
14 The authorization is matched based on the local user name on the
14 The authorization is matched based on the local user name on the
15 system where the hook runs, and not the committer of the original
15 system where the hook runs, and not the committer of the original
16 changeset (since the latter is merely informative).
16 changeset (since the latter is merely informative).
17
17
18 The acl hook is best used along with a restricted shell like hgsh,
18 The acl hook is best used along with a restricted shell like hgsh,
19 preventing authenticating users from doing anything other than pushing
19 preventing authenticating users from doing anything other than pushing
20 or pulling. The hook is not safe to use if users have interactive
20 or pulling. The hook is not safe to use if users have interactive
21 shell access, as they can then disable the hook. Nor is it safe if
21 shell access, as they can then disable the hook. Nor is it safe if
22 remote users share an account, because then there is no way to
22 remote users share an account, because then there is no way to
23 distinguish them.
23 distinguish them.
24
24
25 The order in which access checks are performed is:
25 The order in which access checks are performed is:
26
26
27 1) Deny list for branches (section ``acl.deny.branches``)
27 1) Deny list for branches (section ``acl.deny.branches``)
28 2) Allow list for branches (section ``acl.allow.branches``)
28 2) Allow list for branches (section ``acl.allow.branches``)
29 3) Deny list for paths (section ``acl.deny``)
29 3) Deny list for paths (section ``acl.deny``)
30 4) Allow list for paths (section ``acl.allow``)
30 4) Allow list for paths (section ``acl.allow``)
31
31
32 The allow and deny sections take key-value pairs.
32 The allow and deny sections take key-value pairs.
33
33
34 Branch-based Access Control
34 Branch-based Access Control
35 ---------------------------
35 ---------------------------
36
36
37 Use the ``acl.deny.branches`` and ``acl.allow.branches`` sections to
37 Use the ``acl.deny.branches`` and ``acl.allow.branches`` sections to
38 have branch-based access control. Keys in these sections can be
38 have branch-based access control. Keys in these sections can be
39 either:
39 either:
40
40
41 - a branch name, or
41 - a branch name, or
42 - an asterisk, to match any branch;
42 - an asterisk, to match any branch;
43
43
44 The corresponding values can be either:
44 The corresponding values can be either:
45
45
46 - a comma-separated list containing users and groups, or
46 - a comma-separated list containing users and groups, or
47 - an asterisk, to match anyone;
47 - an asterisk, to match anyone;
48
48
49 You can add the "!" prefix to a user or group name to invert the sense
49 You can add the "!" prefix to a user or group name to invert the sense
50 of the match.
50 of the match.
51
51
52 Path-based Access Control
52 Path-based Access Control
53 -------------------------
53 -------------------------
54
54
55 Use the ``acl.deny`` and ``acl.allow`` sections to have path-based
55 Use the ``acl.deny`` and ``acl.allow`` sections to have path-based
56 access control. Keys in these sections accept a subtree pattern (with
56 access control. Keys in these sections accept a subtree pattern (with
57 a glob syntax by default). The corresponding values follow the same
57 a glob syntax by default). The corresponding values follow the same
58 syntax as the other sections above.
58 syntax as the other sections above.
59
59
60 Groups
60 Groups
61 ------
61 ------
62
62
63 Group names must be prefixed with an ``@`` symbol. Specifying a group
63 Group names must be prefixed with an ``@`` symbol. Specifying a group
64 name has the same effect as specifying all the users in that group.
64 name has the same effect as specifying all the users in that group.
65
65
66 You can define group members in the ``acl.groups`` section.
66 You can define group members in the ``acl.groups`` section.
67 If a group name is not defined there, and Mercurial is running under
67 If a group name is not defined there, and Mercurial is running under
68 a Unix-like system, the list of users will be taken from the OS.
68 a Unix-like system, the list of users will be taken from the OS.
69 Otherwise, an exception will be raised.
69 Otherwise, an exception will be raised.
70
70
71 Example Configuration
71 Example Configuration
72 ---------------------
72 ---------------------
73
73
74 ::
74 ::
75
75
76 [hooks]
76 [hooks]
77
77
78 # Use this if you want to check access restrictions at commit time
78 # Use this if you want to check access restrictions at commit time
79 pretxncommit.acl = python:hgext.acl.hook
79 pretxncommit.acl = python:hgext.acl.hook
80
80
81 # Use this if you want to check access restrictions for pull, push,
81 # Use this if you want to check access restrictions for pull, push,
82 # bundle and serve.
82 # bundle and serve.
83 pretxnchangegroup.acl = python:hgext.acl.hook
83 pretxnchangegroup.acl = python:hgext.acl.hook
84
84
85 [acl]
85 [acl]
86 # Allow or deny access for incoming changes only if their source is
86 # Allow or deny access for incoming changes only if their source is
87 # listed here, let them pass otherwise. Source is "serve" for all
87 # listed here, let them pass otherwise. Source is "serve" for all
88 # remote access (http or ssh), "push", "pull" or "bundle" when the
88 # remote access (http or ssh), "push", "pull" or "bundle" when the
89 # related commands are run locally.
89 # related commands are run locally.
90 # Default: serve
90 # Default: serve
91 sources = serve
91 sources = serve
92
92
93 [acl.deny.branches]
93 [acl.deny.branches]
94
94
95 # Everyone is denied to the frozen branch:
95 # Everyone is denied to the frozen branch:
96 frozen-branch = *
96 frozen-branch = *
97
97
98 # A bad user is denied on all branches:
98 # A bad user is denied on all branches:
99 * = bad-user
99 * = bad-user
100
100
101 [acl.allow.branches]
101 [acl.allow.branches]
102
102
103 # A few users are allowed on branch-a:
103 # A few users are allowed on branch-a:
104 branch-a = user-1, user-2, user-3
104 branch-a = user-1, user-2, user-3
105
105
106 # Only one user is allowed on branch-b:
106 # Only one user is allowed on branch-b:
107 branch-b = user-1
107 branch-b = user-1
108
108
109 # The super user is allowed on any branch:
109 # The super user is allowed on any branch:
110 * = super-user
110 * = super-user
111
111
112 # Everyone is allowed on branch-for-tests:
112 # Everyone is allowed on branch-for-tests:
113 branch-for-tests = *
113 branch-for-tests = *
114
114
115 [acl.deny]
115 [acl.deny]
116 # This list is checked first. If a match is found, acl.allow is not
116 # This list is checked first. If a match is found, acl.allow is not
117 # checked. All users are granted access if acl.deny is not present.
117 # checked. All users are granted access if acl.deny is not present.
118 # Format for both lists: glob pattern = user, ..., @group, ...
118 # Format for both lists: glob pattern = user, ..., @group, ...
119
119
120 # To match everyone, use an asterisk for the user:
120 # To match everyone, use an asterisk for the user:
121 # my/glob/pattern = *
121 # my/glob/pattern = *
122
122
123 # user6 will not have write access to any file:
123 # user6 will not have write access to any file:
124 ** = user6
124 ** = user6
125
125
126 # Group "hg-denied" will not have write access to any file:
126 # Group "hg-denied" will not have write access to any file:
127 ** = @hg-denied
127 ** = @hg-denied
128
128
129 # Nobody will be able to change "DONT-TOUCH-THIS.txt", despite
129 # Nobody will be able to change "DONT-TOUCH-THIS.txt", despite
130 # everyone being able to change all other files. See below.
130 # everyone being able to change all other files. See below.
131 src/main/resources/DONT-TOUCH-THIS.txt = *
131 src/main/resources/DONT-TOUCH-THIS.txt = *
132
132
133 [acl.allow]
133 [acl.allow]
134 # if acl.allow is not present, all users are allowed by default
134 # if acl.allow is not present, all users are allowed by default
135 # empty acl.allow = no users allowed
135 # empty acl.allow = no users allowed
136
136
137 # User "doc_writer" has write access to any file under the "docs"
137 # User "doc_writer" has write access to any file under the "docs"
138 # folder:
138 # folder:
139 docs/** = doc_writer
139 docs/** = doc_writer
140
140
141 # User "jack" and group "designers" have write access to any file
141 # User "jack" and group "designers" have write access to any file
142 # under the "images" folder:
142 # under the "images" folder:
143 images/** = jack, @designers
143 images/** = jack, @designers
144
144
145 # Everyone (except for "user6" and "@hg-denied" - see acl.deny above)
145 # Everyone (except for "user6" and "@hg-denied" - see acl.deny above)
146 # will have write access to any file under the "resources" folder
146 # will have write access to any file under the "resources" folder
147 # (except for 1 file. See acl.deny):
147 # (except for 1 file. See acl.deny):
148 src/main/resources/** = *
148 src/main/resources/** = *
149
149
150 .hgtags = release_engineer
150 .hgtags = release_engineer
151
151
152 Examples using the "!" prefix
152 Examples using the "!" prefix
153 .............................
153 .............................
154
154
155 Suppose there's a branch that only a given user (or group) should be able to
155 Suppose there's a branch that only a given user (or group) should be able to
156 push to, and you don't want to restrict access to any other branch that may
156 push to, and you don't want to restrict access to any other branch that may
157 be created.
157 be created.
158
158
159 The "!" prefix allows you to prevent anyone except a given user or group to
159 The "!" prefix allows you to prevent anyone except a given user or group to
160 push changesets in a given branch or path.
160 push changesets in a given branch or path.
161
161
162 In the examples below, we will:
162 In the examples below, we will:
163 1) Deny access to branch "ring" to anyone but user "gollum"
163 1) Deny access to branch "ring" to anyone but user "gollum"
164 2) Deny access to branch "lake" to anyone but members of the group "hobbit"
164 2) Deny access to branch "lake" to anyone but members of the group "hobbit"
165 3) Deny access to a file to anyone but user "gollum"
165 3) Deny access to a file to anyone but user "gollum"
166
166
167 ::
167 ::
168
168
169 [acl.allow.branches]
169 [acl.allow.branches]
170 # Empty
170 # Empty
171
171
172 [acl.deny.branches]
172 [acl.deny.branches]
173
173
174 # 1) only 'gollum' can commit to branch 'ring';
174 # 1) only 'gollum' can commit to branch 'ring';
175 # 'gollum' and anyone else can still commit to any other branch.
175 # 'gollum' and anyone else can still commit to any other branch.
176 ring = !gollum
176 ring = !gollum
177
177
178 # 2) only members of the group 'hobbit' can commit to branch 'lake';
178 # 2) only members of the group 'hobbit' can commit to branch 'lake';
179 # 'hobbit' members and anyone else can still commit to any other branch.
179 # 'hobbit' members and anyone else can still commit to any other branch.
180 lake = !@hobbit
180 lake = !@hobbit
181
181
182 # You can also deny access based on file paths:
182 # You can also deny access based on file paths:
183
183
184 [acl.allow]
184 [acl.allow]
185 # Empty
185 # Empty
186
186
187 [acl.deny]
187 [acl.deny]
188 # 3) only 'gollum' can change the file below;
188 # 3) only 'gollum' can change the file below;
189 # 'gollum' and anyone else can still change any other file.
189 # 'gollum' and anyone else can still change any other file.
190 /misty/mountains/cave/ring = !gollum
190 /misty/mountains/cave/ring = !gollum
191
191
192 '''
192 '''
193
193
194 from __future__ import absolute_import
194 from __future__ import absolute_import
195
195
196 import getpass
196 import getpass
197
197
198 from mercurial.i18n import _
198 from mercurial.i18n import _
199 from mercurial import (
199 from mercurial import (
200 error,
200 error,
201 match,
201 match,
202 registrar,
202 registrar,
203 util,
203 util,
204 )
204 )
205
205
206 urlreq = util.urlreq
206 urlreq = util.urlreq
207
207
208 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
208 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
209 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
209 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
210 # be specifying the version(s) of Mercurial they are tested with, or
210 # be specifying the version(s) of Mercurial they are tested with, or
211 # leave the attribute unspecified.
211 # leave the attribute unspecified.
212 testedwith = 'ships-with-hg-core'
212 testedwith = 'ships-with-hg-core'
213
213
214 configtable = {}
214 configtable = {}
215 configitem = registrar.configitem(configtable)
215 configitem = registrar.configitem(configtable)
216
216
217 # deprecated config: acl.config
217 # deprecated config: acl.config
218 configitem('acl', 'config',
218 configitem('acl', 'config',
219 default=None,
219 default=None,
220 )
220 )
221 configitem('acl', 'sources',
221 configitem('acl', 'sources',
222 default='serve',
222 default=['serve'],
223 )
223 )
224
224
225 def _getusers(ui, group):
225 def _getusers(ui, group):
226
226
227 # First, try to use group definition from section [acl.groups]
227 # First, try to use group definition from section [acl.groups]
228 hgrcusers = ui.configlist('acl.groups', group)
228 hgrcusers = ui.configlist('acl.groups', group)
229 if hgrcusers:
229 if hgrcusers:
230 return hgrcusers
230 return hgrcusers
231
231
232 ui.debug('acl: "%s" not defined in [acl.groups]\n' % group)
232 ui.debug('acl: "%s" not defined in [acl.groups]\n' % group)
233 # If no users found in group definition, get users from OS-level group
233 # If no users found in group definition, get users from OS-level group
234 try:
234 try:
235 return util.groupmembers(group)
235 return util.groupmembers(group)
236 except KeyError:
236 except KeyError:
237 raise error.Abort(_("group '%s' is undefined") % group)
237 raise error.Abort(_("group '%s' is undefined") % group)
238
238
239 def _usermatch(ui, user, usersorgroups):
239 def _usermatch(ui, user, usersorgroups):
240
240
241 if usersorgroups == '*':
241 if usersorgroups == '*':
242 return True
242 return True
243
243
244 for ug in usersorgroups.replace(',', ' ').split():
244 for ug in usersorgroups.replace(',', ' ').split():
245
245
246 if ug.startswith('!'):
246 if ug.startswith('!'):
247 # Test for excluded user or group. Format:
247 # Test for excluded user or group. Format:
248 # if ug is a user name: !username
248 # if ug is a user name: !username
249 # if ug is a group name: !@groupname
249 # if ug is a group name: !@groupname
250 ug = ug[1:]
250 ug = ug[1:]
251 if not ug.startswith('@') and user != ug \
251 if not ug.startswith('@') and user != ug \
252 or ug.startswith('@') and user not in _getusers(ui, ug[1:]):
252 or ug.startswith('@') and user not in _getusers(ui, ug[1:]):
253 return True
253 return True
254
254
255 # Test for user or group. Format:
255 # Test for user or group. Format:
256 # if ug is a user name: username
256 # if ug is a user name: username
257 # if ug is a group name: @groupname
257 # if ug is a group name: @groupname
258 elif user == ug \
258 elif user == ug \
259 or ug.startswith('@') and user in _getusers(ui, ug[1:]):
259 or ug.startswith('@') and user in _getusers(ui, ug[1:]):
260 return True
260 return True
261
261
262 return False
262 return False
263
263
264 def buildmatch(ui, repo, user, key):
264 def buildmatch(ui, repo, user, key):
265 '''return tuple of (match function, list enabled).'''
265 '''return tuple of (match function, list enabled).'''
266 if not ui.has_section(key):
266 if not ui.has_section(key):
267 ui.debug('acl: %s not enabled\n' % key)
267 ui.debug('acl: %s not enabled\n' % key)
268 return None
268 return None
269
269
270 pats = [pat for pat, users in ui.configitems(key)
270 pats = [pat for pat, users in ui.configitems(key)
271 if _usermatch(ui, user, users)]
271 if _usermatch(ui, user, users)]
272 ui.debug('acl: %s enabled, %d entries for user %s\n' %
272 ui.debug('acl: %s enabled, %d entries for user %s\n' %
273 (key, len(pats), user))
273 (key, len(pats), user))
274
274
275 # Branch-based ACL
275 # Branch-based ACL
276 if not repo:
276 if not repo:
277 if pats:
277 if pats:
278 # If there's an asterisk (meaning "any branch"), always return True;
278 # If there's an asterisk (meaning "any branch"), always return True;
279 # Otherwise, test if b is in pats
279 # Otherwise, test if b is in pats
280 if '*' in pats:
280 if '*' in pats:
281 return util.always
281 return util.always
282 return lambda b: b in pats
282 return lambda b: b in pats
283 return util.never
283 return util.never
284
284
285 # Path-based ACL
285 # Path-based ACL
286 if pats:
286 if pats:
287 return match.match(repo.root, '', pats)
287 return match.match(repo.root, '', pats)
288 return util.never
288 return util.never
289
289
290 def hook(ui, repo, hooktype, node=None, source=None, **kwargs):
290 def hook(ui, repo, hooktype, node=None, source=None, **kwargs):
291 if hooktype not in ['pretxnchangegroup', 'pretxncommit']:
291 if hooktype not in ['pretxnchangegroup', 'pretxncommit']:
292 raise error.Abort(_('config error - hook type "%s" cannot stop '
292 raise error.Abort(_('config error - hook type "%s" cannot stop '
293 'incoming changesets nor commits') % hooktype)
293 'incoming changesets nor commits') % hooktype)
294 if (hooktype == 'pretxnchangegroup' and
294 if (hooktype == 'pretxnchangegroup' and
295 source not in ui.config('acl', 'sources').split()):
295 source not in ui.configlist('acl', 'sources')):
296 ui.debug('acl: changes have source "%s" - skipping\n' % source)
296 ui.debug('acl: changes have source "%s" - skipping\n' % source)
297 return
297 return
298
298
299 user = None
299 user = None
300 if source == 'serve' and 'url' in kwargs:
300 if source == 'serve' and 'url' in kwargs:
301 url = kwargs['url'].split(':')
301 url = kwargs['url'].split(':')
302 if url[0] == 'remote' and url[1].startswith('http'):
302 if url[0] == 'remote' and url[1].startswith('http'):
303 user = urlreq.unquote(url[3])
303 user = urlreq.unquote(url[3])
304
304
305 if user is None:
305 if user is None:
306 user = getpass.getuser()
306 user = getpass.getuser()
307
307
308 ui.debug('acl: checking access for user "%s"\n' % user)
308 ui.debug('acl: checking access for user "%s"\n' % user)
309
309
310 # deprecated config: acl.config
310 # deprecated config: acl.config
311 cfg = ui.config('acl', 'config')
311 cfg = ui.config('acl', 'config')
312 if cfg:
312 if cfg:
313 ui.readconfig(cfg, sections=['acl.groups', 'acl.allow.branches',
313 ui.readconfig(cfg, sections=['acl.groups', 'acl.allow.branches',
314 'acl.deny.branches', 'acl.allow', 'acl.deny'])
314 'acl.deny.branches', 'acl.allow', 'acl.deny'])
315
315
316 allowbranches = buildmatch(ui, None, user, 'acl.allow.branches')
316 allowbranches = buildmatch(ui, None, user, 'acl.allow.branches')
317 denybranches = buildmatch(ui, None, user, 'acl.deny.branches')
317 denybranches = buildmatch(ui, None, user, 'acl.deny.branches')
318 allow = buildmatch(ui, repo, user, 'acl.allow')
318 allow = buildmatch(ui, repo, user, 'acl.allow')
319 deny = buildmatch(ui, repo, user, 'acl.deny')
319 deny = buildmatch(ui, repo, user, 'acl.deny')
320
320
321 for rev in xrange(repo[node], len(repo)):
321 for rev in xrange(repo[node], len(repo)):
322 ctx = repo[rev]
322 ctx = repo[rev]
323 branch = ctx.branch()
323 branch = ctx.branch()
324 if denybranches and denybranches(branch):
324 if denybranches and denybranches(branch):
325 raise error.Abort(_('acl: user "%s" denied on branch "%s"'
325 raise error.Abort(_('acl: user "%s" denied on branch "%s"'
326 ' (changeset "%s")')
326 ' (changeset "%s")')
327 % (user, branch, ctx))
327 % (user, branch, ctx))
328 if allowbranches and not allowbranches(branch):
328 if allowbranches and not allowbranches(branch):
329 raise error.Abort(_('acl: user "%s" not allowed on branch "%s"'
329 raise error.Abort(_('acl: user "%s" not allowed on branch "%s"'
330 ' (changeset "%s")')
330 ' (changeset "%s")')
331 % (user, branch, ctx))
331 % (user, branch, ctx))
332 ui.debug('acl: branch access granted: "%s" on branch "%s"\n'
332 ui.debug('acl: branch access granted: "%s" on branch "%s"\n'
333 % (ctx, branch))
333 % (ctx, branch))
334
334
335 for f in ctx.files():
335 for f in ctx.files():
336 if deny and deny(f):
336 if deny and deny(f):
337 raise error.Abort(_('acl: user "%s" denied on "%s"'
337 raise error.Abort(_('acl: user "%s" denied on "%s"'
338 ' (changeset "%s")') % (user, f, ctx))
338 ' (changeset "%s")') % (user, f, ctx))
339 if allow and not allow(f):
339 if allow and not allow(f):
340 raise error.Abort(_('acl: user "%s" not allowed on "%s"'
340 raise error.Abort(_('acl: user "%s" not allowed on "%s"'
341 ' (changeset "%s")') % (user, f, ctx))
341 ' (changeset "%s")') % (user, f, ctx))
342 ui.debug('acl: path access granted: "%s"\n' % ctx)
342 ui.debug('acl: path access granted: "%s"\n' % ctx)
General Comments 0
You need to be logged in to leave comments. Login now