Mercurial > hg
view hgext/factotum.py @ 50336:cf4d2f31660d stable
chg: populate CHGHG if not set
Normally, chg determines which `hg` executable to use by first consulting the
`$CHGHG` and `$HG` environment variables, and if neither are present defaults
to the `hg` found in the user's `$PATH`. If built with the `HGPATHREL` compiler
flag, chg will instead assume that there exists an `hg` executable in the same
directory as the `chg` binary and attempt to use that.
This can cause problems in situations where there are multiple actively-used
Mercurial installations on the same system. When a `chg` client connects to a
running command server, the server process performs some basic validation to
determine whether a new command server needs to be spawned. These checks include
things like checking certain "sensitive" environment variables and config
sections, as well as checking whether the mtime of the extensions, hg's
`__version__.py` module, and the Python interpreter have changed.
Crucially, the command server doesn't explicitly check whether the executable it
is running from matches the executable that the `chg` client would have
otherwise invoked had there been no existing command server process. Without
`HGPATHREL`, this still gets implicitly checked during the validation step,
because the only way to specify an alternate hg executable (apart from `$PATH`)
is via the `$CHGHG` and `$HG` environment variables, both of which are checked.
With `HGPATHREL`, however, the command server has no way of knowing which hg
executable the client would have run. This means that a client located at
`/version_B/bin/chg` will happily connect to a command server running
`/version_A/bin/hg` instead of `/version_B/bin/hg` as expected. A simple
solution is to have the client set `$CHGHG` itself, which then allows the
command server's environment validation to work as intended.
I have tested this manually using two locally built hg installations and it
seems to work with no ill effects. That said, I'm not sure how to write an
automated test for this since the `chg` available to the tests isn't even built
with the `HGPATHREL` compiler flag to begin with.
author | Arun Kulshreshtha <akulshreshtha@janestreet.com> |
---|---|
date | Mon, 27 Mar 2023 17:30:14 -0400 |
parents | 6000f5b25c9b |
children | 18c8c18993f0 |
line wrap: on
line source
# factotum.py - Plan 9 factotum integration for Mercurial # # Copyright (C) 2012 Steven Stallion <sstallion@gmail.com> # # 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. '''http authentication with factotum This extension allows the factotum(4) facility on Plan 9 from Bell Labs platforms to provide authentication information for HTTP access. Configuration entries specified in the auth section as well as authentication information provided in the repository URL are fully supported. If no prefix is specified, a value of "*" will be assumed. By default, keys are specified as:: proto=pass service=hg prefix=<prefix> user=<username> !password=<password> If the factotum extension is unable to read the required key, one will be requested interactively. A configuration section is available to customize runtime behavior. By default, these entries are:: [factotum] executable = /bin/auth/factotum mountpoint = /mnt/factotum service = hg The executable entry defines the full path to the factotum binary. The mountpoint entry defines the path to the factotum file service. Lastly, the service entry controls the service name used when reading keys. ''' import os from mercurial.i18n import _ from mercurial.pycompat import setattr from mercurial.utils import procutil from mercurial import ( error, httpconnection, registrar, url, util, ) urlreq = util.urlreq passwordmgr = url.passwordmgr ERRMAX = 128 _executable = _mountpoint = _service = None configtable = {} configitem = registrar.configitem(configtable) configitem( b'factotum', b'executable', default=b'/bin/auth/factotum', ) configitem( b'factotum', b'mountpoint', default=b'/mnt/factotum', ) configitem( b'factotum', b'service', default=b'hg', ) def auth_getkey(self, params): if not self.ui.interactive(): raise error.Abort(_(b'factotum not interactive')) if b'user=' not in params: params = b'%s user?' % params params = b'%s !password?' % params os.system(procutil.tonativestr(b"%s -g '%s'" % (_executable, params))) def auth_getuserpasswd(self, getkey, params): params = b'proto=pass %s' % params while True: fd = os.open(b'%s/rpc' % _mountpoint, os.O_RDWR) try: os.write(fd, b'start %s' % params) l = os.read(fd, ERRMAX).split() if l[0] == b'ok': os.write(fd, b'read') status, user, passwd = os.read(fd, ERRMAX).split(None, 2) if status == b'ok': if passwd.startswith(b"'"): if passwd.endswith(b"'"): passwd = passwd[1:-1].replace(b"''", b"'") else: raise error.Abort(_(b'malformed password string')) return (user, passwd) except (OSError, IOError): raise error.Abort(_(b'factotum not responding')) finally: os.close(fd) getkey(self, params) def monkeypatch_method(cls): def decorator(func): setattr(cls, func.__name__, func) return func return decorator @monkeypatch_method(passwordmgr) def find_user_password(self, realm, authuri): user, passwd = self.passwddb.find_user_password(realm, authuri) if user and passwd: self._writedebug(user, passwd) return (user, passwd) prefix = b'' res = httpconnection.readauthforuri(self.ui, authuri, user) if res: _, auth = res prefix = auth.get(b'prefix') user, passwd = auth.get(b'username'), auth.get(b'password') if not user or not passwd: if not prefix: prefix = realm.split(b' ')[0].lower() params = b'service=%s prefix=%s' % (_service, prefix) if user: params = b'%s user=%s' % (params, user) user, passwd = auth_getuserpasswd(self, auth_getkey, params) self.add_password(realm, authuri, user, passwd) self._writedebug(user, passwd) return (user, passwd) def uisetup(ui): global _executable _executable = ui.config(b'factotum', b'executable') global _mountpoint _mountpoint = ui.config(b'factotum', b'mountpoint') global _service _service = ui.config(b'factotum', b'service')