Henrik Stuart avatar Henrik Stuart committed 3b80b81

Initial version of text file based authentication for Mercurial

Comments (0)

Files changed (3)

+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+textauth
+========
+
+Textauth provides extension functionality for the distributed version control
+system, Mercurial, to control authentication using a text-based file with
+username and password information. It also provides management functionality
+for handling the authentication file by invoking the file directly from the
+command line using the Python interpreter.
+
+Caution: The extension uses HTTP basic authentication in which credentials are
+passed in base64-encoded cleartext across the wire. You /will/ be leaking
+username/password information if you are not using SSL/TLS (HTTPS).
+
+Requirements
+============
+
+Textauth requires Mercurial version 1.5 or newer.
+
+Setup
+=====
+
+In order to use the extension from Mercurial you must register it in the
+"[extensions]" part of the configuration file, e.g. by writing:
+
+textauth = /path/to/textauth.py
+
+To see how to specify the authentication file and further details, please run
+`hg help textauth`.
+
+For further details on using extensions, please see the relevant webpage on
+the Mercurial website: http://mercurial.selenic.com/wiki/UsingExtensions
+
+Using
+=====
+
+This extension is primarily intended for being useful when not running
+Mercurial behind a web server that handles authentication, e.g. when running
+`hg serve`.
+
+The first step will be to run `python textauth.py` and get usage information
+and see how it is used to create the authentication file.
+
+The second step is to add it to your repository's hgrc file (or if you're
+serving with hgwebdir to the hgweb.config file, unless you want different
+authentication files for different repositories).
+
+Finally, you can run `hg serve` as normal, and credentials will automatically
+be requested when browsing the repository using the web browser, as well as
+doing clone, pull, push, incoming, and outgoing.
+
+Note: It is also possible to use this extension in place of setting up web
+server authentication, but it is probably a good deal more efficient to let
+the web server handle it.
+# textauth.py - HTTP basic authentication for Mercurial
+#
+# Copyright 2010 Henrik Stuart <hg@hstuart.dk>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+'''Provides HTTP basic authentication for Mercurial
+
+The basic authentication uses a server-side stored password file.
+
+Note that this extension is not compatible with htpasswd generated files as
+they use a custom and non-standardised format. Instead we define our own
+format below.
+
+The configuration for this extension is read from the usual hgrc
+configuration mechanism:
+
+``textauth``
+----------
+
+Section that controls the behavior of the textauth extension.
+
+Supported arguments:
+
+``file``
+    The path to the file containing authentication information. The
+    contents of this file should be as described below.
+
+file format
+-----------
+
+The format for the file is a list of ``username:password`` pairs, where the
+password field encodes what type of password we are using. The following
+would be a typical authentication file::
+
+    user1:$plain$thisismypassword
+    user2:$md5$31435008693ce6976f45dedc5532e2c1
+    user3:$sha1$4b2c5a6d33c70caa171639d1e5a76a81f83c3cfb
+    user4:$sha224$8607c28d53f2c41d101c3fdbe87210adbd0584c21fcd5ddd7237f039
+    user5:$sha256$1da9133ab9dbd11d2937ec8d312e1e2569857059e73cc72df92e670928983ab5
+    user6:$sha384$f2e4be47d9642bdd1d208f0738a55feca0c7bc42a445f1a0233c28260141ad6bb432810dafc7ffb5891f96ad65a3206f
+    user7:$sha512$e9670bc9fb8d3a578736c31390205b1d9fef50adf941b3b349076d27e483e42b00c38998cac4370a362ffe5966d45012b95f8eb279b2cecfe1760cdf25d5ecca
+
+This extension also doubles as a management interface to this file that can be
+launched by executing the file through python::
+
+    python textauth.py
+
+This will display usage details of working with it. Its interface greatly
+mirrors that of htpasswd, but its storage format is markedly different.
+
+'''
+
+import hashlib
+
+algos = {
+        'plain': lambda x: '$plain$%s' % (x,),
+        'md5': lambda x: '$md5$%s' % (hashlib.md5(x).hexdigest(),),
+        'sha1': lambda x: '$sha1$%s' % (hashlib.sha1(x).hexdigest(),),
+        'sha224': lambda x: '$sha224$%s' % (hashlib.sha224(x).hexdigest(),),
+        'sha256': lambda x: '$sha256$%s' % (hashlib.sha256(x).hexdigest(),),
+        'sha384': lambda x: '$sha384$%s' % (hashlib.sha384(x).hexdigest(),),
+        'sha512': lambda x: '$sha512$%s' % (hashlib.sha512(x).hexdigest(),),
+        }
+
+if __name__ == '__main__':
+    import sys
+    import os
+    import getpass
+    from optparse import OptionParser
+
+    parser = OptionParser(usage='usage: %prog [options] PASSWORDFILE USERNAME')
+    parser.add_option('-p', '--plain', help='write plaintext password',
+            default=False, action='store_true')
+    parser.add_option('-m', '--md5', help='write password in md5 digest format',
+            default=False, action='store_true')
+    parser.add_option('', '--sha1', help='write password in sha1 format',
+            default=False, action='store_true')
+    parser.add_option('', '--sha224', help='write password in sha224 format',
+            default=False, action='store_true')
+    parser.add_option('', '--sha256', help='write password in sha256 format',
+            default=False, action='store_true')
+    parser.add_option('', '--sha384', help='write password in sha384 format',
+            default=False, action='store_true')
+    parser.add_option('', '--sha512', action='store_true',
+            help='write password in sha512 format (default)', default=False)
+    parser.add_option('-c', '--create', help='create password if it does not '
+            'exist', default=False, action='store_true')
+    parser.add_option('-d', '--delete', help='delete specified user from file',
+            default=False, action='store_true')
+
+    (options, args) = parser.parse_args()
+
+    algo = [None]
+
+    def _exit_if_set(new_algo):
+        if algo[0]:
+            sys.stderr.write('Cannot specify both %s and md5. exiting.\n' %
+                    (algo[0],))
+            sys.exit(1)
+        algo[0] = new_algo
+
+    if options.plain: _exit_if_set('plain')
+    if options.md5: _exit_if_set('md5')
+    if options.sha1: _exit_if_set('sha1')
+    if options.sha224: _exit_if_set('sha224')
+    if options.sha256: _exit_if_set('sha256')
+    if options.sha384: _exit_if_set('sha384')
+    if options.sha512: _exit_if_set('sha512')
+
+    algo = algo[0]
+    if not algo:
+        algo = 'sha512'
+
+    if len(args) != 2:
+        parser.print_help()
+        sys.exit(1)
+
+    fname = args[0]
+    uname = args[1]
+
+    if ':' in uname:
+        sys.stderr.write('username may not contain :\n')
+        sys.exit(1)
+
+    if not options.create and not os.path.exists(fname):
+        sys.stderr.write('use -c to create password file\n')
+        sys.exit(1)
+
+    users = set()
+    entries = []
+    if os.path.exists(fname):
+        with open(fname, 'r') as fh:
+            for l in fh:
+                l = l.strip()
+                if not l:
+                    continue
+                dbuname, dbphash = l.split(':', 1)
+                entries.append((dbuname, dbphash))
+                users.add(dbuname)
+
+    if uname in users and not options.delete:
+        sys.stderr.write('user already in file. aborting.\n')
+        sys.exit(1)
+    elif uname not in users and options.delete:
+        sys.stderr.write('user not in file. aborting.\n')
+        sys.exit(1)
+
+    if options.delete:
+        with open(fname, 'w') as fh:
+            for dbuser, dbphash in entries:
+                if dbuser == uname:
+                    continue
+                fh.write('%s:%s\n' % (dbuser, dbphash))
+    else:
+        with open(fname, 'a') as fh:
+            passwd = getpass.getpass('Enter password:')
+            verify = getpass.getpass('Verify password:')
+            if passwd != verify:
+                sys.stderr.write('password does not verify.\n')
+                sys.exit(1)
+
+            fh.write('%s:%s\n' % (uname, algos[algo](passwd)))
+
+    sys.exit(0)
+
+import base64
+import re
+import os.path
+
+from mercurial.hgweb import common
+
+def perform_authentication(hgweb, req, op):
+    def fail(msg):
+        raise common.ErrorResponse(common.HTTP_UNAUTHORIZED, msg,
+                [('WWW-Authenticate', 'Basic Realm="mercurial"')])
+
+    auth = req.env.get('HTTP_AUTHORIZATION')
+    if not auth:
+        fail('enter authorization')
+
+    try:
+        user, passwd = base64.b64decode(auth.split()[1]).split(':', 1)
+        if not passwd:
+            fail('invalid username or password')
+    except (IndexError, TypeError):
+        fail('invalid username or password')
+
+    do_auth(hgweb, req, op, user, passwd)
+
+def _decode_db_password(dbpasswd):
+    regex = re.compile(r'^\$([^\$]+)\$(.*)$')
+    m = regex.match(dbpasswd)
+    if m:
+        return m.group(1), m.group(2)
+    return None, None
+
+def do_auth(hgweb, req, op, user, passwd):
+    fname = hgweb.config('textauth', 'file')
+    fname = os.path.expanduser(fname)
+    if not file or not os.path.exists(fname):
+        raise common.ErrorResponse(common.HTTP_SERVER_ERROR,
+                'no authentication file is specified on server')
+
+    f = open(fname)
+    try:
+        db = [line.rstrip('\r\n').split(':', 1) for line in f]
+        for dbuser, dbpasswd in db:
+            if user == dbuser:
+                algo, rdbpasswd = _decode_db_password(dbpasswd)
+                if algo is None:
+                    raise common.ErrorResponse(common.HTTP_SERVER_ERROR,
+                            'invalid authentication file on server')
+                if algos[algo](passwd) == dbpasswd:
+                    req.env['REMOTE_USER'] = user
+                    return
+                else:
+                    break
+        raise common.ErrorResponse(common.HTTP_FORBIDDEN,
+                'invalid username or password')
+    finally:
+        f.close()
+
+def extsetup():
+    common.permhooks.insert(0, perform_authentication)
+
+cmdtable = {}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.