Git::Hooks::CheckAcls - Git::Hooks plugin for branch/tag access control.
version 1.6.6
This Git::Hooks plugin hooks itself to the hooks below to guarantee that only allowed users can push commits and tags to specific branches.
update
This hook is invoked multiple times in the remote repository during git push, once per branch being updated, checking if the user performing the push can update the branch in question.
git push
pre-receive
This hook is invoked once in the remote repository during git push, checking if the user performing the push can update every affected branch.
ref-update
This hook is invoked when a push request is received by Gerrit Code Review, to check if the user performing the push can update the branch in question.
To enable it you should add it to the githooks.plugin configuration option:
git config --add githooks.plugin CheckAcls
The plugin is configured by the following git options.
The authorization specification for a repository is defined by the set of ACLs defined by this option. Each ACL specify 'who' has 'what' kind of access to which refs, by means of a string with three components separated by spaces:
who what refs
By default, nobody has access to anything, except the above-specified admins. During an update, all the ACLs are processed in the order defined by the git config --list command. The first ACL matching the authenticated username and the affected reference name (usually a branch) defines what operations are allowed. If no ACL matches username and reference name, then the operation is denied.
git config --list
The 'who' component specifies to which users this ACL gives access. It can be specified in the same three ways as was explained to the CheckAcls.admin option above.
The 'what' component specifies what kind of access to allow. It's specified as a string of one or more of the following opcodes:
C - Create a new ref.
R - Rewind/Rebase an existing ref. (With commit loss.)
U - Update an existing ref. (A fast-forward with no commit loss.)
D - Delete an existing ref.
You may specify that the user has no access whatsoever to the references by using a single hyphen (-) as the what component.
-
The 'refs' component specifies which refs this ACL applies to. It can be specified in one of these formats:
^REGEXP
A regular expression anchored at the beginning of the reference name. For example, "^refs/heads", meaning every branch.
!REGEXP
A negated regular expression. For example, "!^refs/heads/master", meaning everything but the master branch.
STRING
The complete name of a reference. For example, "refs/heads/master".
The ACL specification can embed strings in the format {VAR}. These strings are substituted by the corresponding environment's variable VAR value. This interpolation occurs before the components are split and processed.
{VAR}
This is useful, for instance, if you want developers to be restricted in what they can do to official branches but to have complete control with their own branch namespace.
git config CheckAcls.acl '^. CRUD ^refs/heads/{USER}/' git config CheckAcls.acl '^. U ^refs/heads'
In this example, every user (^.) has complete control (CRUD) to the branches below "refs/heads/{USER}". Supposing the environment variable USER contains the user's login name during a "pre-receive" hook. For all other branches (^refs/heads) the users have only update (U) rights.
This module exports two routines that can be used directly without using all of Git::Hooks infrastructure.
This is the routine used to implement the update and the pre-receive hooks. It needs a Git::More object.
Git::More
This script is heavily inspired (and, in some places, derived) from the update-paranoid example hook which comes with the Git distribution.
Gustavo L. de M. Chaves <gnustavo@cpan.org>
This software is copyright (c) 2015 by CPqD <www.cpqd.com.br>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Git::Hooks, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Git::Hooks
CPAN shell
perl -MCPAN -e shell install Git::Hooks
For more information on module installation, please visit the detailed CPAN module installation guide.