ssh-support: enabled full handling of all backends via SSH.

- run callback deamons
- run proper authentication checks
- add relative loging.
- fixes  #5312

rhodecode/apps/ssh_support/lib/backends/__init__.py

@@ -0,0 +1,202 b''
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2016-2017 RhodeCode GmbH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License, version 3
+# (only), as published by the Free Software Foundation.
+#
+# 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 Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# This program is dual-licensed. If you wish to learn more about the
+# RhodeCode Enterprise Edition, including its added features, Support services,
+# and proprietary license terms, please see https://rhodecode.com/licenses/
+
+import os
+import re
+import logging
+import datetime
+import ConfigParser
+
+from rhodecode.model.db import Session, User, UserSshKeys
+from rhodecode.model.scm import ScmModel
+
+from .hg import MercurialServer
+from .git import GitServer
+from .svn import SubversionServer
+log = logging.getLogger(__name__)
+
+
+class SshWrapper(object):
+
+    def __init__(self, command, connection_info, mode,
+                 user, user_id, key_id, shell, ini_path, env):
+        self.command = command
+        self.connection_info = connection_info
+        self.mode = mode
+        self.user = user
+        self.user_id = user_id
+        self.key_id = key_id
+        self.shell = shell
+        self.ini_path = ini_path
+        self.env = env
+
+        self.config = self.parse_config(ini_path)
+        self.server_impl = None
+
+    def parse_config(self, config_path):
+        parser = ConfigParser.ConfigParser()
+        parser.read(config_path)
+        return parser
+
+    def update_key_access_time(self, key_id):
+        key = UserSshKeys().query().filter(
+            UserSshKeys.ssh_key_id == key_id).scalar()
+        if key:
+            key.accessed_on = datetime.datetime.utcnow()
+            Session().add(key)
+            Session().commit()
+            log.debug('Update key `%s` access time', key_id)
+
+    def get_connection_info(self):
+        """
+        connection_info
+
+        Identifies the client and server ends of the connection.
+        The variable contains four space-separated values: client IP address,
+        client port number, server IP address, and server port number.
+        """
+        conn = dict(
+            client_ip=None,
+            client_port=None,
+            server_ip=None,
+            server_port=None,
+        )
+
+        info = self.connection_info.split(' ')
+        if len(info) == 4:
+            conn['client_ip'] = info[0]
+            conn['client_port'] = info[1]
+            conn['server_ip'] = info[2]
+            conn['server_port'] = info[3]
+
+        return conn
+
+    def get_repo_details(self, mode):
+        vcs_type = mode if mode in ['svn', 'hg', 'git'] else None
+        mode = mode
+        repo_name = None
+
+        hg_pattern = r'^hg\s+\-R\s+(\S+)\s+serve\s+\-\-stdio$'
+        hg_match = re.match(hg_pattern, self.command)
+        if hg_match is not None:
+            vcs_type = 'hg'
+            repo_name = hg_match.group(1).strip('/')
+            return vcs_type, repo_name, mode
+
+        git_pattern = (
+            r'^git-(receive-pack|upload-pack)\s\'[/]?(\S+?)(|\.git)\'$')
+        git_match = re.match(git_pattern, self.command)
+        if git_match is not None:
+            vcs_type = 'git'
+            repo_name = git_match.group(2).strip('/')
+            mode = git_match.group(1)
+            return vcs_type, repo_name, mode
+
+        svn_pattern = r'^svnserve -t'
+        svn_match = re.match(svn_pattern, self.command)
+
+        if svn_match is not None:
+            vcs_type = 'svn'
+            # Repo name should be extracted from the input stream
+            return vcs_type, repo_name, mode
+
+        return vcs_type, repo_name, mode
+
+    def serve(self, vcs, repo, mode, user, permissions):
+        store = ScmModel().repos_path
+
+        log.debug(
+            'VCS detected:`%s` mode: `%s` repo_name: %s', vcs, mode, repo)
+
+        if vcs == 'hg':
+            server = MercurialServer(
+                store=store, ini_path=self.ini_path,
+                repo_name=repo, user=user,
+                user_permissions=permissions, config=self.config, env=self.env)
+            self.server_impl = server
+            return server.run()
+
+        elif vcs == 'git':
+            server = GitServer(
+                store=store, ini_path=self.ini_path,
+                repo_name=repo, repo_mode=mode, user=user,
+                user_permissions=permissions, config=self.config, env=self.env)
+            self.server_impl = server
+            return server.run()
+
+        elif vcs == 'svn':
+            server = SubversionServer(
+                store=store, ini_path=self.ini_path,
+                repo_name=None, user=user,
+                user_permissions=permissions, config=self.config, env=self.env)
+            self.server_impl = server
+            return server.run()
+
+        else:
+            raise Exception('Unrecognised VCS: {}'.format(vcs))
+
+    def wrap(self):
+        mode = self.mode
+        user = self.user
+        user_id = self.user_id
+        key_id = self.key_id
+        shell = self.shell
+
+        scm_detected, scm_repo, scm_mode = self.get_repo_details(mode)
+
+        log.debug(
+            'Mode: `%s` User: `%s:%s` Shell: `%s` SSH Command: `\"%s\"` '
+            'SCM_DETECTED: `%s` SCM Mode: `%s` SCM Repo: `%s`',
+            mode, user, user_id, shell, self.command,
+            scm_detected, scm_mode, scm_repo)
+
+        # update last access time for this key
+        self.update_key_access_time(key_id)
+
+        log.debug('SSH Connection info %s', self.get_connection_info())
+
+        if shell and self.command is None:
+            log.info(
+                'Dropping to shell, no command given and shell is allowed')
+            os.execl('/bin/bash', '-l')
+            exit_code = 1
+
+        elif scm_detected:
+            user = User.get(user_id)
+            auth_user = user.AuthUser()
+            permissions = auth_user.permissions['repositories']
+
+            try:
+                exit_code, is_updated = self.serve(
+                    scm_detected, scm_repo, scm_mode, user, permissions)
+            except Exception:
+                log.exception('Error occurred during execution of SshWrapper')
+                exit_code = -1
+
+        elif self.command is None and shell is False:
+            log.error('No Command given.')
+            exit_code = -1
+
+        else:
+            log.error(
+                'Unhandled Command: "%s" Aborting.', self.command)
+            exit_code = -1
+
+        return exit_code

rhodecode/apps/ssh_support/lib/backends/base.py

@@ -0,0 +1,149 b''
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2016-2017 RhodeCode GmbH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License, version 3
+# (only), as published by the Free Software Foundation.
+#
+# 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 Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# This program is dual-licensed. If you wish to learn more about the
+# RhodeCode Enterprise Edition, including its added features, Support services,
+# and proprietary license terms, please see https://rhodecode.com/licenses/
+
+import os
+import sys
+import json
+import logging
+
+from rhodecode.lib.hooks_daemon import prepare_callback_daemon
+from rhodecode.lib import hooks_utils
+from rhodecode.model.scm import ScmModel
+
+log = logging.getLogger(__name__)
+
+
+class VcsServer(object):
+    _path = None  # set executable path for hg/git/svn binary
+    backend = None  # set in child classes
+    tunnel = None  # subprocess handling tunnel
+    write_perms = ['repository.admin', 'repository.write']
+    read_perms = ['repository.read', 'repository.admin', 'repository.write']
+
+    def __init__(self, user, user_permissions, config, env):
+        self.user = user
+        self.user_permissions = user_permissions
+        self.config = config
+        self.env = env
+        self.stdin = sys.stdin
+
+        self.repo_name = None
+        self.repo_mode = None
+        self.store = ''
+        self.ini_path = ''
+
+    def _invalidate_cache(self, repo_name):
+        """
+        Set's cache for this repository for invalidation on next access
+
+        :param repo_name: full repo name, also a cache key
+        """
+        ScmModel().mark_for_invalidation(repo_name)
+
+    def has_write_perm(self):
+        permission = self.user_permissions.get(self.repo_name)
+        if permission in ['repository.write', 'repository.admin']:
+            return True
+
+        return False
+
+    def _check_permissions(self, action):
+        permission = self.user_permissions.get(self.repo_name)
+        log.debug(
+            'permission for %s on %s are: %s',
+            self.user, self.repo_name, permission)
+
+        if action == 'pull':
+            if permission in self.read_perms:
+                log.info(
+                    'READ Permissions for User "%s" detected to repo "%s"!',
+                    self.user, self.repo_name)
+                return 0
+        else:
+            if permission in self.write_perms:
+                log.info(
+                    'WRITE+ Permissions for User "%s" detected to repo "%s"!',
+                    self.user, self.repo_name)
+                return 0
+
+        log.error('Cannot properly fetch or allow user permissions. '
+                  'Return value is: %s, req action: %s', permission, action)
+        return -2
+
+    def update_environment(self, action, extras=None):
+
+        scm_data = {
+            'ip': os.environ['SSH_CLIENT'].split()[0],
+            'username': self.user.username,
+            'action': action,
+            'repository': self.repo_name,
+            'scm': self.backend,
+            'config': self.ini_path,
+            'make_lock': None,
+            'locked_by': [None, None],
+            'server_url': None,
+            'is_shadow_repo': False,
+            'hooks_module': 'rhodecode.lib.hooks_daemon',
+            'hooks': ['push', 'pull'],
+            'SSH': True,
+            'SSH_PERMISSIONS': self.user_permissions.get(self.repo_name)
+        }
+        if extras:
+            scm_data.update(extras)
+        os.putenv("RC_SCM_DATA", json.dumps(scm_data))
+
+    def get_root_store(self):
+        root_store = self.store
+        if not root_store.endswith('/'):
+            # always append trailing slash
+            root_store = root_store + '/'
+        return root_store
+
+    def _handle_tunnel(self, extras):
+        # pre-auth
+        action = 'pull'
+        exit_code = self._check_permissions(action)
+        if exit_code:
+            return exit_code, False
+
+        req = self.env['request']
+        server_url = req.host_url + req.script_name
+        extras['server_url'] = server_url
+
+        log.debug('Using %s binaries from path %s', self.backend, self._path)
+        exit_code = self.tunnel.run(extras)
+
+        return exit_code, action == "push"
+
+    def run(self):
+        extras = {}
+        HOOKS_PROTOCOL = self.config.get('app:main', 'vcs.hooks.protocol')
+
+        callback_daemon, extras = prepare_callback_daemon(
+            extras, protocol=HOOKS_PROTOCOL,
+            use_direct_calls=False)
+
+        with callback_daemon:
+            try:
+                return self._handle_tunnel(extras)
+            finally:
+                log.debug('Running cleanup with cache invalidation')
+                if self.repo_name:
+                    self._invalidate_cache(self.repo_name)

rhodecode/apps/ssh_support/lib/backends/git.py

@@ -0,0 +1,75 b''
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2016-2017 RhodeCode GmbH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License, version 3
+# (only), as published by the Free Software Foundation.
+#
+# 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 Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# This program is dual-licensed. If you wish to learn more about the
+# RhodeCode Enterprise Edition, including its added features, Support services,
+# and proprietary license terms, please see https://rhodecode.com/licenses/
+
+import os
+import sys
+import logging
+
+from .base import VcsServer
+
+log = logging.getLogger(__name__)
+
+
+class GitTunnelWrapper(object):
+    process = None
+
+    def __init__(self, server):
+        self.server = server
+        self.stdin = sys.stdin
+        self.stdout = sys.stdout
+
+    def create_hooks_env(self):
+        pass
+
+    def command(self):
+        root = self.server.get_root_store()
+        command = "cd {root}; {git_path} {mode} '{root}{repo_name}'".format(
+            root=root, git_path=self.server.git_path,
+            mode=self.server.repo_mode, repo_name=self.server.repo_name)
+        log.debug("Final CMD: %s", command)
+        return command
+
+    def run(self, extras):
+        action = "push" if self.server.repo_mode == "receive-pack" else "pull"
+        exit_code = self.server._check_permissions(action)
+        if exit_code:
+            return exit_code
+
+        self.server.update_environment(action=action, extras=extras)
+        self.create_hooks_env()
+        return os.system(self.command())
+
+
+class GitServer(VcsServer):
+    backend = 'git'
+
+    def __init__(self, store, ini_path, repo_name, repo_mode,
+                 user, user_permissions, config, env):
+        super(GitServer, self).\
+            __init__(user, user_permissions, config, env)
+
+        self.store = store
+        self.ini_path = ini_path
+        self.repo_name = repo_name
+        self._path = self.git_path = config.get(
+            'app:main', 'ssh.executable.git')
+
+        self.repo_mode = repo_mode
+        self.tunnel = GitTunnelWrapper(server=self)

rhodecode/apps/ssh_support/lib/backends/hg.py

@@ -0,0 +1,123 b''
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2016-2017 RhodeCode GmbH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License, version 3
+# (only), as published by the Free Software Foundation.
+#
+# 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 Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# This program is dual-licensed. If you wish to learn more about the
+# RhodeCode Enterprise Edition, including its added features, Support services,
+# and proprietary license terms, please see https://rhodecode.com/licenses/
+
+import os
+import sys
+import shutil
+import logging
+import tempfile
+import textwrap
+
+from .base import VcsServer
+
+log = logging.getLogger(__name__)
+
+
+class MercurialTunnelWrapper(object):
+    process = None
+
+    def __init__(self, server):
+        self.server = server
+        self.stdin = sys.stdin
+        self.stdout = sys.stdout
+        self.svn_conf_fd, self.svn_conf_path = tempfile.mkstemp()
+        self.hooks_env_fd, self.hooks_env_path = tempfile.mkstemp()
+
+    def create_hooks_env(self):
+
+        content = textwrap.dedent(
+            '''
+            # SSH hooks version=1.0.0
+            [hooks]
+            pretxnchangegroup.ssh_auth=python:vcsserver.hooks.pre_push_ssh_auth
+            pretxnchangegroup.ssh=python:vcsserver.hooks.pre_push_ssh
+            changegroup.ssh=python:vcsserver.hooks.post_push_ssh
+            
+            preoutgoing.ssh=python:vcsserver.hooks.pre_pull_ssh
+            outgoing.ssh=python:vcsserver.hooks.post_pull_ssh
+
+            '''
+        )
+
+        with os.fdopen(self.hooks_env_fd, 'w') as hooks_env_file:
+            hooks_env_file.write(content)
+        root = self.server.get_root_store()
+
+        hgrc_custom = os.path.join(
+            root, self.server.repo_name, '.hg', 'hgrc_rhodecode')
+        log.debug('Wrote custom hgrc file under %s', hgrc_custom)
+        shutil.move(
+            self.hooks_env_path, hgrc_custom)
+
+        hgrc_main = os.path.join(
+            root, self.server.repo_name, '.hg', 'hgrc')
+        include_marker = '%include hgrc_rhodecode'
+
+        if not os.path.isfile(hgrc_main):
+            os.mknod(hgrc_main)
+
+        with open(hgrc_main, 'rb') as f:
+            data = f.read()
+            has_marker = include_marker in data
+
+        if not has_marker:
+            log.debug('Adding include marker for hooks')
+            with open(hgrc_main, 'wa') as f:
+                f.write(textwrap.dedent('''
+                # added by RhodeCode
+                {}
+                '''.format(include_marker)))
+
+    def command(self):
+        root = self.server.get_root_store()
+
+        command = (
+            "cd {root}; {hg_path} -R {root}{repo_name} "
+            "serve --stdio".format(
+                root=root, hg_path=self.server.hg_path,
+                repo_name=self.server.repo_name))
+        log.debug("Final CMD: %s", command)
+        return command
+
+    def run(self, extras):
+        # at this point we cannot tell, we do further ACL checks
+        # inside the hooks
+        action = '?'
+        # permissions are check via `pre_push_ssh_auth` hook
+        self.server.update_environment(action=action, extras=extras)
+        self.create_hooks_env()
+        return os.system(self.command())
+
+
+class MercurialServer(VcsServer):
+    backend = 'hg'
+
+    def __init__(self, store, ini_path, repo_name,
+                 user, user_permissions, config, env):
+        super(MercurialServer, self).\
+            __init__(user, user_permissions, config, env)
+
+        self.store = store
+        self.ini_path = ini_path
+        self.repo_name = repo_name
+        self._path = self.hg_path = config.get(
+            'app:main', 'ssh.executable.hg')
+
+        self.tunnel = MercurialTunnelWrapper(server=self)

rhodecode/apps/ssh_support/lib/backends/svn.py

@@ -0,0 +1,228 b''
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2016-2017 RhodeCode GmbH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License, version 3
+# (only), as published by the Free Software Foundation.
+#
+# 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 Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# This program is dual-licensed. If you wish to learn more about the
+# RhodeCode Enterprise Edition, including its added features, Support services,
+# and proprietary license terms, please see https://rhodecode.com/licenses/
+
+import os
+import re
+import sys
+import logging
+import signal
+import tempfile
+from subprocess import Popen, PIPE
+import urlparse
+
+from .base import VcsServer
+
+log = logging.getLogger(__name__)
+
+
+class SubversionTunnelWrapper(object):
+    process = None
+
+    def __init__(self, server):
+        self.server = server
+        self.timeout = 30
+        self.stdin = sys.stdin
+        self.stdout = sys.stdout
+        self.svn_conf_fd, self.svn_conf_path = tempfile.mkstemp()
+        self.hooks_env_fd, self.hooks_env_path = tempfile.mkstemp()
+
+        self.read_only = True  # flag that we set to make the hooks readonly
+
+    def create_svn_config(self):
+        content = (
+            '[general]\n'
+            'hooks-env = {}\n').format(self.hooks_env_path)
+        with os.fdopen(self.svn_conf_fd, 'w') as config_file:
+            config_file.write(content)
+
+    def create_hooks_env(self):
+        content = (
+            '[default]\n'
+            'LANG = en_US.UTF-8\n')
+        if self.read_only:
+            content += 'SSH_READ_ONLY = 1\n'
+        with os.fdopen(self.hooks_env_fd, 'w') as hooks_env_file:
+            hooks_env_file.write(content)
+
+    def remove_configs(self):
+        os.remove(self.svn_conf_path)
+        os.remove(self.hooks_env_path)
+
+    def command(self):
+        root = self.server.get_root_store()
+        command = [
+            self.server.svn_path, '-t',
+            '--config-file', self.svn_conf_path,
+            '-r', root]
+        log.debug("Final CMD: %s", command)
+        return command
+
+    def start(self):
+        command = self.command()
+        self.process = Popen(command, stdin=PIPE)
+
+    def sync(self):
+        while self.process.poll() is None:
+            next_byte = self.stdin.read(1)
+            if not next_byte:
+                break
+            self.process.stdin.write(next_byte)
+        self.remove_configs()
+
+    @property
+    def return_code(self):
+        return self.process.returncode
+
+    def get_first_client_response(self):
+        signal.signal(signal.SIGALRM, self.interrupt)
+        signal.alarm(self.timeout)
+        first_response = self._read_first_client_response()
+        signal.alarm(0)
+        return (
+            self._parse_first_client_response(first_response)
+            if first_response else None)
+
+    def patch_first_client_response(self, response, **kwargs):
+        self.create_hooks_env()
+        data = response.copy()
+        data.update(kwargs)
+        data['url'] = self._svn_string(data['url'])
+        data['ra_client'] = self._svn_string(data['ra_client'])
+        data['client'] = data['client'] or ''
+        buffer_ = (
+            "( {version} ( {capabilities} ) {url}{ra_client}"
+            "( {client}) ) ".format(**data))
+        self.process.stdin.write(buffer_)
+
+    def fail(self, message):
+        print(
+            "( failure ( ( 210005 {message} 0: 0 ) ) )".format(
+                message=self._svn_string(message)))
+        self.remove_configs()
+        self.process.kill()
+
+    def interrupt(self, signum, frame):
+        self.fail("Exited by timeout")
+
+    def _svn_string(self, str_):
+        if not str_:
+            return ''
+        return '{length}:{string} '.format(length=len(str_), string=str_)
+
+    def _read_first_client_response(self):
+        buffer_ = ""
+        brackets_stack = []
+        while True:
+            next_byte = self.stdin.read(1)
+            buffer_ += next_byte
+            if next_byte == "(":
+                brackets_stack.append(next_byte)
+            elif next_byte == ")":
+                brackets_stack.pop()
+            elif next_byte == " " and not brackets_stack:
+                break
+        return buffer_
+
+    def _parse_first_client_response(self, buffer_):
+        """
+        According to the Subversion RA protocol, the first request
+        should look like:
+
+        ( version:number ( cap:word ... ) url:string ? ra-client:string
+           ( ? client:string ) )
+
+        Please check https://svn.apache.org/repos/asf/subversion/trunk/
+           subversion/libsvn_ra_svn/protocol
+        """
+        version_re = r'(?P<version>\d+)'
+        capabilities_re = r'\(\s(?P<capabilities>[\w\d\-\ ]+)\s\)'
+        url_re = r'\d+\:(?P<url>[\W\w]+)'
+        ra_client_re = r'(\d+\:(?P<ra_client>[\W\w]+)\s)'
+        client_re = r'(\d+\:(?P<client>[\W\w]+)\s)*'
+        regex = re.compile(
+            r'^\(\s{version}\s{capabilities}\s{url}\s{ra_client}'
+            r'\(\s{client}\)\s\)\s*$'.format(
+                version=version_re, capabilities=capabilities_re,
+                url=url_re, ra_client=ra_client_re, client=client_re))
+        matcher = regex.match(buffer_)
+        return matcher.groupdict() if matcher else None
+
+    def run(self, extras):
+        action = 'pull'
+        self.create_svn_config()
+        self.start()
+
+        first_response = self.get_first_client_response()
+        if not first_response:
+            self.fail("Repository name cannot be extracted")
+            return 1
+
+        url_parts = urlparse.urlparse(first_response['url'])
+        self.server.repo_name = url_parts.path.strip('/')
+
+        exit_code = self.server._check_permissions(action)
+        if exit_code:
+            return exit_code
+
+        # set the readonly flag to False if we have proper permissions
+        if self.server.has_write_perm():
+            self.read_only = False
+        self.server.update_environment(action=action, extras=extras)
+
+        self.patch_first_client_response(first_response)
+        self.sync()
+        return self.return_code
+
+
+class SubversionServer(VcsServer):
+    backend = 'svn'
+
+    def __init__(self, store, ini_path, repo_name,
+                 user, user_permissions, config, env):
+        super(SubversionServer, self)\
+            .__init__(user, user_permissions, config, env)
+        self.store = store
+        self.ini_path = ini_path
+        # this is set in .run() from input stream
+        self.repo_name = repo_name
+        self._path = self.svn_path = config.get(
+            'app:main', 'ssh.executable.svn')
+
+        self.tunnel = SubversionTunnelWrapper(server=self)
+
+    def _handle_tunnel(self, extras):
+
+        # pre-auth
+        action = 'pull'
+        # Special case for SVN, we extract repo name at later stage
+        # exit_code = self._check_permissions(action)
+        # if exit_code:
+        #     return exit_code, False
+
+        req = self.env['request']
+        server_url = req.host_url + req.script_name
+        extras['server_url'] = server_url
+
+        log.debug('Using %s binaries from path %s', self.backend, self._path)
+        exit_code = self.tunnel.run(extras)
+
+        return exit_code, action == "push"
+
+

rhodecode/apps/ssh_support/tests/conftest.py

@@ -0,0 +1,62 b''
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2016-2017 RhodeCode GmbH
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License, version 3
+# (only), as published by the Free Software Foundation.
+#
+# 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 Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# This program is dual-licensed. If you wish to learn more about the
+# RhodeCode Enterprise Edition, including its added features, Support services,
+# and proprietary license terms, please see https://rhodecode.com/licenses/
+
+import os
+import pytest
+import ConfigParser
+
+from rhodecode.apps.ssh_support.lib.ssh_wrapper import SshWrapper
+from rhodecode.lib.utils2 import AttributeDict
+
+
[e-mail]
+def dummy_conf_file(tmpdir):
+    conf = ConfigParser.ConfigParser()
+    conf.add_section('app:main')
+    conf.set('app:main', 'ssh.executable.hg', '/usr/bin/hg')
+    conf.set('app:main', 'ssh.executable.git', '/usr/bin/git')
+    conf.set('app:main', 'ssh.executable.svn', '/usr/bin/svnserve')
+
+    f_path = os.path.join(str(tmpdir), 'ssh_wrapper_test.ini')
+    with open(f_path, 'wb') as f:
+        conf.write(f)
+
+    return os.path.join(f_path)
+
+
[e-mail]
+def dummy_env():
+    return {
+        'request':
+            AttributeDict(host_url='http://localhost', script_name='/')
+    }
+
+
[e-mail]
+def dummy_user():
+    return AttributeDict(username='test_user')
+
+
[e-mail]
+def ssh_wrapper(app, dummy_conf_file, dummy_env):
+    conn_info = '127.0.0.1 22 10.0.0.1 443'
+    return SshWrapper(
+        'random command', conn_info, 'auto', 'admin', '1', key_id='1',
+        shell=False, ini_path=dummy_conf_file, env=dummy_env)

rhodecode/apps/ssh_support/lib/ssh_wrapper.py

@@ -1,81 +1,83 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2017 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # 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 Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import os
 import sys
 import logging
 
 import click
 
 from pyramid.paster import bootstrap, setup_logging
 from pyramid.request import Request
 
 from .backends import SshWrapper
 
 log = logging.getLogger(__name__)
 
 
 def setup_custom_logging(ini_path, debug):
     if debug:
         # enabled rhodecode.ini controlled logging setup
         setup_logging(ini_path)
     else:
         # configure logging in a mode that doesn't print anything.
         # in case of regularly configured logging it gets printed out back
         # to the client doing an SSH command.
         logger = logging.getLogger('')
         null = logging.NullHandler()
         # add the handler to the root logger
         logger.handlers = [null]
 
 
 @click.command()
 @click.argument('ini_path', type=click.Path(exists=True))
 @click.option(
     '--mode', '-m', required=False, default='auto',
     type=click.Choice(['auto', 'vcs', 'git', 'hg', 'svn', 'test']),
     help='mode of operation')
 @click.option('--user', help='Username for which the command will be executed')
 @click.option('--user-id', help='User ID for which the command will be executed')
 @click.option('--key-id', help='ID of the key from the database')
 @click.option('--shell', '-s', is_flag=True, help='Allow Shell')
 @click.option('--debug', is_flag=True, help='Enabled detailed output logging')
 def main(ini_path, mode, user, user_id, key_id, shell, debug):
     setup_custom_logging(ini_path, debug)
 
     command = os.environ.get('SSH_ORIGINAL_COMMAND', '')
     if not command and mode not in ['test']:
         raise ValueError(
             'Unable to fetch SSH_ORIGINAL_COMMAND from environment.'
             'Please make sure this is set and available during execution '
             'of this script.')
     connection_info = os.environ.get('SSH_CONNECTION', '')
-    request = Request.blank('/', base_url='http://rhodecode-ssh-wrapper/')
+
+    # TODO(marcink): configure the running host...
+    request = Request.blank('/', base_url='http://localhost:8080')
     with bootstrap(ini_path, request=request) as env:
         try:
             ssh_wrapper = SshWrapper(
                 command, connection_info, mode,
-                user, user_id, key_id, shell, ini_path)
+                user, user_id, key_id, shell, ini_path, env)
         except Exception:
             log.exception('Failed to execute SshWrapper')
             sys.exit(-5)
 
         return_code = ssh_wrapper.wrap()
         sys.exit(return_code)

rhodecode/apps/ssh_support/tests/test_server_git.py

@@ -1,196 +1,145 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2017 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # 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 Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import json
-
+import mock
 import pytest
-from mock import Mock, patch
 
 from rhodecode.apps.ssh_support.lib.backends.git import GitServer
-
-
[e-mail]
-def git_server():
-    return GitServerCreator()
+from rhodecode.apps.ssh_support.tests.conftest import dummy_env, dummy_user
 
 
 class GitServerCreator(object):
     root = '/tmp/repo/path/'
-    git_path = '/usr/local/bin/'
+    git_path = '/usr/local/bin/git'
     config_data = {
         'app:main': {
-            'ssh.executable.git': git_path
+            'ssh.executable.git': git_path,
+            'vcs.hooks.protocol': 'http',
         }
     }
     repo_name = 'test_git'
     repo_mode = 'receive-pack'
-    user = 'vcs'
+    user = dummy_user()
 
     def __init__(self):
         def config_get(part, key):
             return self.config_data.get(part, {}).get(key)
-        self.config_mock = Mock()
-        self.config_mock.get = Mock(side_effect=config_get)
+        self.config_mock = mock.Mock()
+        self.config_mock.get = mock.Mock(side_effect=config_get)
 
     def create(self, **kwargs):
         parameters = {
-            'store': {'path': self.root},
+            'store': self.root,
             'ini_path': '',
             'user': self.user,
             'repo_name': self.repo_name,
             'repo_mode': self.repo_mode,
             'user_permissions': {
-                self.repo_name: 'repo_admin'
+                self.repo_name: 'repository.admin'
             },
             'config': self.config_mock,
+            'env': dummy_env()
         }
         parameters.update(kwargs)
         server = GitServer(**parameters)
         return server
 
 
[e-mail]
+def git_server(app):
+    return GitServerCreator()
+
+
 class TestGitServer(object):
+
     def test_command(self, git_server):
         server = git_server.create()
-        server.read_only = False
         expected_command = (
-            'cd {root}; {git_path}-{repo_mode}'
-            ' \'{root}{repo_name}\''.format(
+            'cd {root}; {git_path} {repo_mode} \'{root}{repo_name}\''.format(
                 root=git_server.root, git_path=git_server.git_path,
                 repo_mode=git_server.repo_mode, repo_name=git_server.repo_name)
         )
-        assert expected_command == server.command
+        assert expected_command == server.tunnel.command()
+
+    @pytest.mark.parametrize('permissions, action, code', [
+        ({}, 'pull', -2),
+        ({'test_git': 'repository.read'}, 'pull', 0),
+        ({'test_git': 'repository.read'}, 'push', -2),
+        ({'test_git': 'repository.write'}, 'push', 0),
+        ({'test_git': 'repository.admin'}, 'push', 0),
 
-    def test_run_returns_exit_code_2_when_no_permissions(self, git_server, caplog):
+    ])
+    def test_permission_checks(self, git_server, permissions, action, code):
+        server = git_server.create(user_permissions=permissions)
+        result = server._check_permissions(action)
+        assert result is code
+
+    @pytest.mark.parametrize('permissions, value', [
+        ({}, False),
+        ({'test_git': 'repository.read'}, False),
+        ({'test_git': 'repository.write'}, True),
+        ({'test_git': 'repository.admin'}, True),
+
+    ])
+    def test_has_write_permissions(self, git_server, permissions, value):
+        server = git_server.create(user_permissions=permissions)
+        result = server.has_write_perm()
+        assert result is value
+
+    def test_run_returns_executes_command(self, git_server):
         server = git_server.create()
-        with patch.object(server, '_check_permissions') as permissions_mock:
-            with patch.object(server, '_update_environment'):
-                permissions_mock.return_value = 2
+        from rhodecode.apps.ssh_support.lib.backends.git import GitTunnelWrapper
+        with mock.patch.object(GitTunnelWrapper, 'create_hooks_env') as _patch:
+            _patch.return_value = 0
+            with mock.patch.object(GitTunnelWrapper, 'command', return_value='date'):
                 exit_code = server.run()
 
-        assert exit_code == (2, False)
-
-    def test_run_returns_executes_command(self, git_server, caplog):
-        server = git_server.create()
-        with patch.object(server, '_check_permissions') as permissions_mock:
-            with patch('os.system') as system_mock:
-                with patch.object(server, '_update_environment') as (
-                        update_mock):
-                    permissions_mock.return_value = 0
-                    system_mock.return_value = 0
-                    exit_code = server.run()
-
-        system_mock.assert_called_once_with(server.command)
-        update_mock.assert_called_once_with()
-
-        assert exit_code == (0, True)
+        assert exit_code == (0, False)
 
     @pytest.mark.parametrize(
         'repo_mode, action', [
             ['receive-pack', 'push'],
             ['upload-pack', 'pull']
         ])
     def test_update_environment(self, git_server, repo_mode, action):
         server = git_server.create(repo_mode=repo_mode)
-        with patch('os.environ', {'SSH_CLIENT': '10.10.10.10 b'}):
-            with patch('os.putenv') as putenv_mock:
-                server._update_environment()
+        with mock.patch('os.environ', {'SSH_CLIENT': '10.10.10.10 b'}):
+            with mock.patch('os.putenv') as putenv_mock:
+                server.update_environment(action)
 
         expected_data = {
-            "username": git_server.user,
-            "scm": "git",
-            "repository": git_server.repo_name,
-            "make_lock": None,
-            "action": [action],
-            "ip": "10.10.10.10",
-            "locked_by": [None, None],
-            "config": ""
+            'username': git_server.user.username,
+            'scm': 'git',
+            'repository': git_server.repo_name,
+            'make_lock': None,
+            'action': action,
+            'ip': '10.10.10.10',
+            'locked_by': [None, None],
+            'config': '',
+            'server_url': None,
+            'hooks': ['push', 'pull'],
+            'is_shadow_repo': False,
+            'hooks_module': 'rhodecode.lib.hooks_daemon',
+            'SSH': True,
+            'SSH_PERMISSIONS': 'repository.admin',
         }
         args, kwargs = putenv_mock.call_args
         assert json.loads(args[1]) == expected_data
-
-
-class TestGitServerCheckPermissions(object):
-    def test_returns_2_when_no_permissions_found(self, git_server, caplog):
-        user_permissions = {}
-        server = git_server.create(user_permissions=user_permissions)
-        result = server._check_permissions()
-        assert result == 2
-
-        log_msg = 'permission for vcs on test_git are: None'
-        assert log_msg in [t[2] for t in caplog.record_tuples]
-
-    def test_returns_2_when_no_permissions(self, git_server, caplog):
-        user_permissions = {git_server.repo_name: 'repository.none'}
-        server = git_server.create(user_permissions=user_permissions)
-        result = server._check_permissions()
-        assert result == 2
-
-        log_msg = 'repo not found or no permissions'
-        assert log_msg in [t[2] for t in caplog.record_tuples]
-
-    @pytest.mark.parametrize(
-        'permission', ['repository.admin', 'repository.write'])
-    def test_access_allowed_when_user_has_write_permissions(
-            self, git_server, permission, caplog):
-        user_permissions = {git_server.repo_name: permission}
-        server = git_server.create(user_permissions=user_permissions)
-        result = server._check_permissions()
-        assert result is None
-
-        log_msg = 'Write Permissions for User "%s" granted to repo "%s"!' % (
-            git_server.user, git_server.repo_name)
-        assert log_msg in [t[2] for t in caplog.record_tuples]
-
-    def test_write_access_is_not_allowed_when_user_has_read_permission(
-            self, git_server, caplog):
-        user_permissions = {git_server.repo_name: 'repository.read'}
-        server = git_server.create(
-            user_permissions=user_permissions, repo_mode='receive-pack')
-        result = server._check_permissions()
-        assert result == -3
-
-        log_msg = 'Only Read Only access for User "%s" granted to repo "%s"! Failing!' % (
-            git_server.user, git_server.repo_name)
-        assert log_msg in [t[2] for t in caplog.record_tuples]
-
-    def test_read_access_allowed_when_user_has_read_permission(
-            self, git_server, caplog):
-        user_permissions = {git_server.repo_name: 'repository.read'}
-        server = git_server.create(
-            user_permissions=user_permissions, repo_mode='upload-pack')
-        result = server._check_permissions()
-        assert result is None
-
-        log_msg = 'Only Read Only access for User "%s" granted to repo "%s"!' % (
-            git_server.user, git_server.repo_name)
-        assert log_msg in [t[2] for t in caplog.record_tuples]
-
-    def test_returns_error_when_permission_not_recognised(
-            self, git_server, caplog):
-        user_permissions = {git_server.repo_name: 'repository.whatever'}
-        server = git_server.create(
-            user_permissions=user_permissions, repo_mode='upload-pack')
-        result = server._check_permissions()
-        assert result == -2
-
-        log_msg = 'Cannot properly fetch user permission. ' \
-                  'Return value is: repository.whatever'
-        assert log_msg in [t[2] for t in caplog.record_tuples]
  No newline at end of file

rhodecode/apps/ssh_support/tests/test_server_hg.py

@@ -1,146 +1,116 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2017 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # 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 Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
+import mock
 import pytest
-from mock import Mock, patch
 
 from rhodecode.apps.ssh_support.lib.backends.hg import MercurialServer
-
-
[e-mail]
-def hg_server():
-    return MercurialServerCreator()
+from rhodecode.apps.ssh_support.tests.conftest import dummy_env, dummy_user
 
 
 class MercurialServerCreator(object):
     root = '/tmp/repo/path/'
     hg_path = '/usr/local/bin/hg'
 
     config_data = {
         'app:main': {
-            'ssh.executable.hg': hg_path
+            'ssh.executable.hg': hg_path,
+            'vcs.hooks.protocol': 'http',
         }
     }
     repo_name = 'test_hg'
-    user = 'vcs'
+    user = dummy_user()
 
     def __init__(self):
         def config_get(part, key):
             return self.config_data.get(part, {}).get(key)
-        self.config_mock = Mock()
-        self.config_mock.get = Mock(side_effect=config_get)
+        self.config_mock = mock.Mock()
+        self.config_mock.get = mock.Mock(side_effect=config_get)
 
     def create(self, **kwargs):
         parameters = {
-            'store': {'path': self.root},
+            'store': self.root,
             'ini_path': '',
             'user': self.user,
             'repo_name': self.repo_name,
             'user_permissions': {
-                'test_hg': 'repo_admin'
+                'test_hg': 'repository.admin'
             },
             'config': self.config_mock,
+            'env': dummy_env()
         }
         parameters.update(kwargs)
         server = MercurialServer(**parameters)
         return server
 
 
[e-mail]
+def hg_server(app):
+    return MercurialServerCreator()
+
+
 class TestMercurialServer(object):
-    def test_read_only_command(self, hg_server):
+
+    def test_command(self, hg_server):
         server = hg_server.create()
-        server.read_only = True
-        expected_command = (
-            'cd {root}; {hg_path} -R {root}{repo_name} serve --stdio'
-            ' --config hooks.pretxnchangegroup="false"'.format(
-                root=hg_server.root, hg_path=hg_server.hg_path,
-                repo_name=hg_server.repo_name)
-        )
-        assert expected_command == server.command
-
-    def test_normal_command(self, hg_server):
-        server = hg_server.create()
-        server.read_only = False
         expected_command = (
             'cd {root}; {hg_path} -R {root}{repo_name} serve --stdio '.format(
                 root=hg_server.root, hg_path=hg_server.hg_path,
                 repo_name=hg_server.repo_name)
         )
-        assert expected_command == server.command
-
-    def test_access_rejected_when_permissions_are_not_found(self, hg_server, caplog):
-        user_permissions = {}
-        server = hg_server.create(user_permissions=user_permissions)
-        result = server._check_permissions()
-        assert result is False
-
-        log_msg = 'repo not found or no permissions'
-        assert log_msg in [t[2] for t in caplog.record_tuples]
+        assert expected_command == server.tunnel.command()
 
-    def test_access_rejected_when_no_permissions(self, hg_server, caplog):
-        user_permissions = {hg_server.repo_name: 'repository.none'}
-        server = hg_server.create(user_permissions=user_permissions)
-        result = server._check_permissions()
-        assert result is False
-
-        log_msg = 'repo not found or no permissions'
-        assert log_msg in [t[2] for t in caplog.record_tuples]
+    @pytest.mark.parametrize('permissions, action, code', [
+        ({}, 'pull', -2),
+        ({'test_hg': 'repository.read'}, 'pull', 0),
+        ({'test_hg': 'repository.read'}, 'push', -2),
+        ({'test_hg': 'repository.write'}, 'push', 0),
+        ({'test_hg': 'repository.admin'}, 'push', 0),
 
-    @pytest.mark.parametrize(
-        'permission', ['repository.admin', 'repository.write'])
-    def test_access_allowed_when_user_has_write_permissions(
-            self, hg_server, permission, caplog):
-        user_permissions = {hg_server.repo_name: permission}
-        server = hg_server.create(user_permissions=user_permissions)
-        result = server._check_permissions()
-        assert result is True
+    ])
+    def test_permission_checks(self, hg_server, permissions, action, code):
+        server = hg_server.create(user_permissions=permissions)
+        result = server._check_permissions(action)
+        assert result is code
 
-        assert server.read_only is False
-        log_msg = 'Write Permissions for User "vcs" granted to repo "test_hg"!'
-        assert log_msg in [t[2] for t in caplog.record_tuples]
-
-    def test_access_allowed_when_user_has_read_permissions(self, hg_server, caplog):
-        user_permissions = {hg_server.repo_name: 'repository.read'}
-        server = hg_server.create(user_permissions=user_permissions)
-        result = server._check_permissions()
-        assert result is True
+    @pytest.mark.parametrize('permissions, value', [
+        ({}, False),
+        ({'test_hg': 'repository.read'}, False),
+        ({'test_hg': 'repository.write'}, True),
+        ({'test_hg': 'repository.admin'}, True),
 
-        assert server.read_only is True
-        log_msg = 'Only Read Only access for User "%s" granted to repo "%s"!' % (
-            hg_server.user, hg_server.repo_name)
-        assert log_msg in [t[2] for t in caplog.record_tuples]
+    ])
+    def test_has_write_permissions(self, hg_server, permissions, value):
+        server = hg_server.create(user_permissions=permissions)
+        result = server.has_write_perm()
+        assert result is value
 
-    def test_run_returns_exit_code_2_when_no_permissions(self, hg_server, caplog):
+    def test_run_returns_executes_command(self, hg_server):
         server = hg_server.create()
-        with patch.object(server, '_check_permissions') as permissions_mock:
-            permissions_mock.return_value = False
-            exit_code = server.run()
-            assert exit_code == (2, False)
-
-    def test_run_returns_executes_command(self, hg_server, caplog):
-        server = hg_server.create()
-        with patch.object(server, '_check_permissions') as permissions_mock:
-            with patch('os.system') as system_mock:
-                permissions_mock.return_value = True
-                system_mock.return_value = 0
+        from rhodecode.apps.ssh_support.lib.backends.hg import MercurialTunnelWrapper
+        with mock.patch.object(MercurialTunnelWrapper, 'create_hooks_env') as _patch:
+            _patch.return_value = 0
+            with mock.patch.object(MercurialTunnelWrapper, 'command', return_value='date'):
                 exit_code = server.run()
 
-        system_mock.assert_called_once_with(server.command)
         assert exit_code == (0, False)
+
+
+

rhodecode/apps/ssh_support/tests/test_server_svn.py

@@ -1,136 +1,124 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2017 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # 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 Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
+import mock
 import pytest
-from mock import Mock, patch
 
 from rhodecode.apps.ssh_support.lib.backends.svn import SubversionServer
-
-
[e-mail]
-def svn_server():
-    return SubversionServerCreator()
+from rhodecode.apps.ssh_support.tests.conftest import dummy_env, dummy_user
 
 
 class SubversionServerCreator(object):
     root = '/tmp/repo/path/'
     svn_path = '/usr/local/bin/svnserve'
     config_data = {
         'app:main': {
-            'ssh.executable.svn': svn_path
+            'ssh.executable.svn': svn_path,
+            'vcs.hooks.protocol': 'http',
         }
     }
     repo_name = 'test-svn'
-    user = 'vcs'
+    user = dummy_user()
 
     def __init__(self):
         def config_get(part, key):
             return self.config_data.get(part, {}).get(key)
-        self.config_mock = Mock()
-        self.config_mock.get = Mock(side_effect=config_get)
+        self.config_mock = mock.Mock()
+        self.config_mock.get = mock.Mock(side_effect=config_get)
 
     def create(self, **kwargs):
         parameters = {
-            'store': {'path': self.root},
+            'store': self.root,
+            'repo_name': self.repo_name,
             'ini_path': '',
             'user': self.user,
             'user_permissions': {
-                self.repo_name: 'repo_admin'
+                self.repo_name: 'repository.admin'
             },
             'config': self.config_mock,
+            'env': dummy_env()
         }
+
         parameters.update(kwargs)
         server = SubversionServer(**parameters)
         return server
 
 
[e-mail]
+def svn_server(app):
+    return SubversionServerCreator()
+
+
 class TestSubversionServer(object):
-    def test_timeout_returns_value_from_config(self, svn_server):
+    def test_command(self, svn_server):
         server = svn_server.create()
-        assert server.timeout == 30
+        expected_command = [
+            svn_server.svn_path, '-t', '--config-file',
+            server.tunnel.svn_conf_path, '-r', svn_server.root
+        ]
 
-    @pytest.mark.parametrize(
-        'permission', ['repository.admin', 'repository.write'])
-    def test_check_permissions_with_write_permissions(
-            self, svn_server, permission):
-        user_permissions = {svn_server.repo_name: permission}
-        server = svn_server.create(user_permissions=user_permissions)
-        server.tunnel = Mock()
-        server.repo_name = svn_server.repo_name
-        result = server._check_permissions()
-        assert result is True
-        assert server.tunnel.read_only is False
+        assert expected_command == server.tunnel.command()
 
-    def test_check_permissions_with_read_permissions(self, svn_server):
-        user_permissions = {svn_server.repo_name: 'repository.read'}
-        server = svn_server.create(user_permissions=user_permissions)
-        server.tunnel = Mock()
-        server.repo_name = svn_server.repo_name
-        result = server._check_permissions()
-        assert result is True
-        assert server.tunnel.read_only is True
+    @pytest.mark.parametrize('permissions, action, code', [
+        ({}, 'pull', -2),
+        ({'test-svn': 'repository.read'}, 'pull', 0),
+        ({'test-svn': 'repository.read'}, 'push', -2),
+        ({'test-svn': 'repository.write'}, 'push', 0),
+        ({'test-svn': 'repository.admin'}, 'push', 0),
+
+    ])
+    def test_permission_checks(self, svn_server, permissions, action, code):
+        server = svn_server.create(user_permissions=permissions)
+        result = server._check_permissions(action)
+        assert result is code
 
-    def test_check_permissions_with_no_permissions(self, svn_server, caplog):
-        tunnel_mock = Mock()
-        user_permissions = {}
-        server = svn_server.create(user_permissions=user_permissions)
-        server.tunnel = tunnel_mock
-        server.repo_name = svn_server.repo_name
-        result = server._check_permissions()
-        assert result is False
-        tunnel_mock.fail.assert_called_once_with(
-            "Not enough permissions for repository {}".format(
-                svn_server.repo_name))
-
-    def test_run_returns_1_when_repository_name_cannot_be_extracted(
-            self, svn_server):
-        server = svn_server.create()
-        with patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.SubversionTunnelWrapper') as tunnel_mock:
-            tunnel_mock().get_first_client_response.return_value = None
-            exit_code = server.run()
-        assert exit_code == (1, False)
-        tunnel_mock().fail.assert_called_once_with(
-            'Repository name cannot be extracted')
-
-    def test_run_returns_tunnel_return_code(self, svn_server, caplog):
+    def test_run_returns_executes_command(self, svn_server):
         server = svn_server.create()
-        fake_response = {
-            'url': 'ssh+svn://[e-mail]/test-svn/'
-        }
-        with patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.SubversionTunnelWrapper') as tunnel_mock:
-            with patch.object(server, '_check_permissions') as (
-                    permissions_mock):
-                permissions_mock.return_value = True
-                tunnel = tunnel_mock()
-                tunnel.get_first_client_response.return_value = fake_response
-                tunnel.return_code = 0
+        from rhodecode.apps.ssh_support.lib.backends.svn import SubversionTunnelWrapper
+        with mock.patch.object(
+                SubversionTunnelWrapper, 'get_first_client_response',
+                return_value={'url': 'http://server/test-svn'}):
+            with mock.patch.object(
+                    SubversionTunnelWrapper, 'patch_first_client_response',
+                    return_value=0):
+                with mock.patch.object(
+                        SubversionTunnelWrapper, 'sync',
+                        return_value=0):
+                    with mock.patch.object(
+                            SubversionTunnelWrapper, 'command',
+                            return_value='date'):
+
                 exit_code = server.run()
-        permissions_mock.assert_called_once_with()
-
-        expected_log_calls = sorted([
-            "Using subversion binaries from '%s'" % svn_server.svn_path
-        ])
+        # SVN has this differently configured, and we get in our mock env
+        # None as return code
+        assert exit_code == (None, False)
 
-        assert expected_log_calls == [t[2] for t in caplog.record_tuples]
+    def test_run_returns_executes_command_that_cannot_extract_repo_name(self, svn_server):
+        server = svn_server.create()
+        from rhodecode.apps.ssh_support.lib.backends.svn import SubversionTunnelWrapper
+        with mock.patch.object(
+                SubversionTunnelWrapper, 'command',
+                return_value='date'):
+            with mock.patch.object(
+                    SubversionTunnelWrapper, 'get_first_client_response',
+                    return_value=None):
+                    exit_code = server.run()
 
-        assert exit_code == (0, False)
-        tunnel.patch_first_client_response.assert_called_once_with(
-            fake_response)
-        tunnel.sync.assert_called_once_with()
+        assert exit_code == (1, False)

rhodecode/apps/ssh_support/tests/test_ssh_wrapper.py

@@ -1,201 +1,54 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2017 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # 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 Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
-import os
-import mock
+
 import pytest
-import ConfigParser
-
-from rhodecode.apps.ssh_support.lib.ssh_wrapper import SshWrapper
-
-
[e-mail]
-def dummy_conf(tmpdir):
-    conf = ConfigParser.ConfigParser()
-    conf.add_section('app:main')
-    conf.set('app:main', 'ssh.executable.hg', '/usr/bin/hg')
-    conf.set('app:main', 'ssh.executable.git', '/usr/bin/git')
-    conf.set('app:main', 'ssh.executable.svn', '/usr/bin/svnserve')
-
-    f_path = os.path.join(str(tmpdir), 'ssh_wrapper_test.ini')
-    with open(f_path, 'wb') as f:
-        conf.write(f)
-
-    return os.path.join(f_path)
 
 
-class TestGetRepoDetails(object):
-    @pytest.mark.parametrize(
-        'command', [
-            'hg -R test-repo serve --stdio',
-            'hg     -R      test-repo      serve       --stdio'
-        ])
-    def test_hg_command_matched(self, command, dummy_conf):
-        wrapper = SshWrapper(command, 'auto', 'admin', '3', 'False', dummy_conf)
-        type_, name, mode = wrapper.get_repo_details('auto')
-        assert type_ == 'hg'
-        assert name == 'test-repo'
-        assert mode is 'auto'
+class TestSSHWrapper(object):
 
-    @pytest.mark.parametrize(
-        'command', [
-            'hg test-repo serve --stdio',
-            'hg -R test-repo serve',
-            'hg serve --stdio',
-            'hg serve -R test-repo'
-        ])
-    def test_hg_command_not_matched(self, command, dummy_conf):
-        wrapper = SshWrapper(command, 'auto', 'admin', '3', 'False', dummy_conf)
-        type_, name, mode = wrapper.get_repo_details('auto')
-        assert type_ is None
-        assert name is None
-        assert mode is 'auto'
-
-
-class TestServe(object):
-    def test_serve_raises_an_exception_when_vcs_is_not_recognized(self, dummy_conf):
-        with mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.get_repo_store'):
-            wrapper = SshWrapper('random command', 'auto', 'admin', '3', 'False', dummy_conf)
-
+    def test_serve_raises_an_exception_when_vcs_is_not_recognized(self, ssh_wrapper):
             with pytest.raises(Exception) as exc_info:
-                wrapper.serve(
+            ssh_wrapper.serve(
                     vcs='microsoft-tfs', repo='test-repo', mode=None, user='test',
                     permissions={})
             assert exc_info.value.message == 'Unrecognised VCS: microsoft-tfs'
 
-
-class TestServeHg(object):
-
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.invalidate_cache')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.get_user_permissions')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.get_repo_store')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.MercurialServer.run')
-    def test_serve_creates_hg_instance(
-            self, mercurial_run_mock, get_repo_store_mock, get_user_mock,
-            invalidate_cache_mock, dummy_conf):
-
-        repo_name = None
-        mercurial_run_mock.return_value = 0, True
-        get_user_mock.return_value = {repo_name: 'repository.admin'}
-        get_repo_store_mock.return_value = {'path': '/tmp'}
-
-        wrapper = SshWrapper('date', 'hg', 'admin', '3', 'False',
-                             dummy_conf)
-        exit_code = wrapper.wrap()
-        assert exit_code == 0
-        assert mercurial_run_mock.called
-
-        assert get_repo_store_mock.called
-        assert get_user_mock.called
-        invalidate_cache_mock.assert_called_once_with(repo_name)
+    def test_parse_config(self, ssh_wrapper):
+        config = ssh_wrapper.parse_config(ssh_wrapper.ini_path)
+        assert config
 
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.invalidate_cache')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.get_user_permissions')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.get_repo_store')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.MercurialServer.run')
-    def test_serve_hg_invalidates_cache(
-            self, mercurial_run_mock, get_repo_store_mock, get_user_mock,
-            invalidate_cache_mock, dummy_conf):
-
-        repo_name = None
-        mercurial_run_mock.return_value = 0, True
-        get_user_mock.return_value = {repo_name: 'repository.admin'}
-        get_repo_store_mock.return_value = {'path': '/tmp'}
-
-        wrapper = SshWrapper('date', 'hg', 'admin', '3', 'False',
-                             dummy_conf)
-        exit_code = wrapper.wrap()
-        assert exit_code == 0
-        assert mercurial_run_mock.called
-
-        assert get_repo_store_mock.called
-        assert get_user_mock.called
-        invalidate_cache_mock.assert_called_once_with(repo_name)
-
-
-class TestServeGit(object):
+    def test_get_connection_info(self, ssh_wrapper):
+        conn_info = ssh_wrapper.get_connection_info()
+        assert {'client_ip': '127.0.0.1',
+                'client_port': '22',
+                'server_ip': '10.0.0.1',
+                'server_port': '443'} == conn_info
 
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.invalidate_cache')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.get_user_permissions')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.get_repo_store')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.GitServer.run')
-    def test_serve_creates_git_instance(self, git_run_mock, get_repo_store_mock, get_user_mock,
-            invalidate_cache_mock, dummy_conf):
-        repo_name = None
-        git_run_mock.return_value = 0, True
-        get_user_mock.return_value = {repo_name: 'repository.admin'}
-        get_repo_store_mock.return_value = {'path': '/tmp'}
-
-        wrapper = SshWrapper('date', 'git', 'admin', '3', 'False',
-                             dummy_conf)
-
-        exit_code = wrapper.wrap()
-        assert exit_code == 0
-        assert git_run_mock.called
-        assert get_repo_store_mock.called
-        assert get_user_mock.called
-        invalidate_cache_mock.assert_called_once_with(repo_name)
-
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.invalidate_cache')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.get_user_permissions')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.get_repo_store')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.GitServer.run')
-    def test_serve_git_invalidates_cache(
-            self, git_run_mock, get_repo_store_mock, get_user_mock,
-            invalidate_cache_mock, dummy_conf):
-        repo_name = None
-        git_run_mock.return_value = 0, True
-        get_user_mock.return_value = {repo_name: 'repository.admin'}
-        get_repo_store_mock.return_value = {'path': '/tmp'}
+    @pytest.mark.parametrize('command, vcs', [
+        ('xxx', None),
+        ('svnserve -t', 'svn'),
+        ('hg -R repo serve --stdio', 'hg'),
+        ('git-receive-pack \'repo.git\'', 'git'),
 
-        wrapper = SshWrapper('date', 'git', 'admin', '3', 'False', dummy_conf)
-
-        exit_code = wrapper.wrap()
-        assert exit_code == 0
-        assert git_run_mock.called
-
-        assert get_repo_store_mock.called
-        assert get_user_mock.called
-        invalidate_cache_mock.assert_called_once_with(repo_name)
-
-
-class TestServeSvn(object):
-
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.invalidate_cache')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.get_user_permissions')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.RhodeCodeApiClient.get_repo_store')
-    @mock.patch('rhodecode.apps.ssh_support.lib.ssh_wrapper.SubversionServer.run')
-    def test_serve_creates_svn_instance(
-            self, svn_run_mock, get_repo_store_mock, get_user_mock,
-            invalidate_cache_mock, dummy_conf):
-
-        repo_name = None
-        svn_run_mock.return_value = 0, True
-        get_user_mock.return_value = {repo_name: 'repository.admin'}
-        get_repo_store_mock.return_value = {'path': '/tmp'}
-
-        wrapper = SshWrapper('date', 'svn', 'admin', '3', 'False', dummy_conf)
-
-        exit_code = wrapper.wrap()
-        assert exit_code == 0
-        assert svn_run_mock.called
-
-        assert get_repo_store_mock.called
-        assert get_user_mock.called
-        invalidate_cache_mock.assert_called_once_with(repo_name)
+    ])
+    def test_get_repo_details(self, ssh_wrapper, command, vcs):
+        ssh_wrapper.command = command
+        vcs_type, repo_name, mode = ssh_wrapper.get_repo_details(mode='auto')
+        assert vcs_type == vcs

rhodecode/lib/base.py

@@ -1,635 +1,634 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2010-2017 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # 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 Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 """
 The base Controller API
 Provides the BaseController class for subclassing. And usage in different
 controllers
 """
 
 import logging
 import socket
 
 import markupsafe
 import ipaddress
 import pyramid.threadlocal
 
 from paste.auth.basic import AuthBasicAuthenticator
 from paste.httpexceptions import HTTPUnauthorized, HTTPForbidden, get_exception
 from paste.httpheaders import WWW_AUTHENTICATE, AUTHORIZATION
 
 import rhodecode
 from rhodecode.authentication.base import VCS_TYPE
 from rhodecode.lib import auth, utils2
 from rhodecode.lib import helpers as h
 from rhodecode.lib.auth import AuthUser, CookieStoreWrapper
 from rhodecode.lib.exceptions import UserCreationError
 from rhodecode.lib.utils import (
     get_repo_slug, set_rhodecode_config, password_changed,
     get_enabled_hook_classes)
 from rhodecode.lib.utils2 import (
     str2bool, safe_unicode, AttributeDict, safe_int, md5, aslist, safe_str)
 from rhodecode.model import meta
 from rhodecode.model.db import Repository, User, ChangesetComment
 from rhodecode.model.notification import NotificationModel
 from rhodecode.model.scm import ScmModel
 from rhodecode.model.settings import VcsSettingsModel, SettingsModel
 
 # NOTE(marcink): remove after base controller is no longer required
 from pylons.controllers import WSGIController
 from pylons.i18n import translation
 
 log = logging.getLogger(__name__)
 
 
 # hack to make the migration to pyramid easier
 def render(template_name, extra_vars=None, cache_key=None,
            cache_type=None, cache_expire=None):
     """Render a template with Mako
 
     Accepts the cache options ``cache_key``, ``cache_type``, and
     ``cache_expire``.
 
     """
     from pylons.templating import literal
     from pylons.templating import cached_template, pylons_globals
 
     # Create a render callable for the cache function
     def render_template():
         # Pull in extra vars if needed
         globs = extra_vars or {}
 
         # Second, get the globals
         globs.update(pylons_globals())
 
         globs['_ungettext'] = globs['ungettext']
         # Grab a template reference
         template = globs['app_globals'].mako_lookup.get_template(template_name)
 
         return literal(template.render_unicode(**globs))
 
     return cached_template(template_name, render_template, cache_key=cache_key,
                            cache_type=cache_type, cache_expire=cache_expire)
 
 def _filter_proxy(ip):
     """
     Passed in IP addresses in HEADERS can be in a special format of multiple
     ips. Those comma separated IPs are passed from various proxies in the
     chain of request processing. The left-most being the original client.
     We only care about the first IP which came from the org. client.
 
     :param ip: ip string from headers
     """
     if ',' in ip:
         _ips = ip.split(',')
         _first_ip = _ips[0].strip()
         log.debug('Got multiple IPs %s, using %s', ','.join(_ips), _first_ip)
         return _first_ip
     return ip
 
 
 def _filter_port(ip):
     """
     Removes a port from ip, there are 4 main cases to handle here.
     - ipv4 eg. 127.0.0.1
     - ipv6 eg. ::1
     - ipv4+port eg. 127.0.0.1:8080
     - ipv6+port eg. [::1]:8080
 
     :param ip:
     """
     def is_ipv6(ip_addr):
         if hasattr(socket, 'inet_pton'):
             try:
                 socket.inet_pton(socket.AF_INET6, ip_addr)
             except socket.error:
                 return False
         else:
             # fallback to ipaddress
             try:
                 ipaddress.IPv6Address(safe_unicode(ip_addr))
             except Exception:
                 return False
         return True
 
     if ':' not in ip:  # must be ipv4 pure ip
         return ip
 
     if '[' in ip and ']' in ip:  # ipv6 with port
         return ip.split(']')[0][1:].lower()
 
     # must be ipv6 or ipv4 with port
     if is_ipv6(ip):
         return ip
     else:
         ip, _port = ip.split(':')[:2]  # means ipv4+port
         return ip
 
 
 def get_ip_addr(environ):
     proxy_key = 'HTTP_X_REAL_IP'
     proxy_key2 = 'HTTP_X_FORWARDED_FOR'
     def_key = 'REMOTE_ADDR'
     _filters = lambda x: _filter_port(_filter_proxy(x))
 
     ip = environ.get(proxy_key)
     if ip:
         return _filters(ip)
 
     ip = environ.get(proxy_key2)
     if ip:
         return _filters(ip)
 
     ip = environ.get(def_key, '0.0.0.0')
     return _filters(ip)
 
 
 def get_server_ip_addr(environ, log_errors=True):
     hostname = environ.get('SERVER_NAME')
     try:
         return socket.gethostbyname(hostname)
     except Exception as e:
         if log_errors:
             # in some cases this lookup is not possible, and we don't want to
             # make it an exception in logs
             log.exception('Could not retrieve server ip address: %s', e)
         return hostname
 
 
 def get_server_port(environ):
     return environ.get('SERVER_PORT')
 
 
 def get_access_path(environ):
     path = environ.get('PATH_INFO')
     org_req = environ.get('pylons.original_request')
     if org_req:
         path = org_req.environ.get('PATH_INFO')
     return path
 
 
 def get_user_agent(environ):
     return environ.get('HTTP_USER_AGENT')
 
 
 def vcs_operation_context(
         environ, repo_name, username, action, scm, check_locking=True,
         is_shadow_repo=False):
     """
     Generate the context for a vcs operation, e.g. push or pull.
 
     This context is passed over the layers so that hooks triggered by the
     vcs operation know details like the user, the user's IP address etc.
 
     :param check_locking: Allows to switch of the computation of the locking
         data. This serves mainly the need of the simplevcs middleware to be
         able to disable this for certain operations.
 
     """
     # Tri-state value: False: unlock, None: nothing, True: lock
     make_lock = None
     locked_by = [None, None, None]
     is_anonymous = username == User.DEFAULT_USER
     if not is_anonymous and check_locking:
         log.debug('Checking locking on repository "%s"', repo_name)
         user = User.get_by_username(username)
         repo = Repository.get_by_repo_name(repo_name)
         make_lock, __, locked_by = repo.get_locking_state(
             action, user.user_id)
 
     settings_model = VcsSettingsModel(repo=repo_name)
     ui_settings = settings_model.get_ui_settings()
 
     extras = {
         'ip': get_ip_addr(environ),
         'username': username,
         'action': action,
         'repository': repo_name,
         'scm': scm,
         'config': rhodecode.CONFIG['__file__'],
         'make_lock': make_lock,
         'locked_by': locked_by,
         'server_url': utils2.get_server_url(environ),
         'user_agent': get_user_agent(environ),
         'hooks': get_enabled_hook_classes(ui_settings),
         'is_shadow_repo': is_shadow_repo,
     }
     return extras
 
 
 class BasicAuth(AuthBasicAuthenticator):
 
     def __init__(self, realm, authfunc, registry, auth_http_code=None,
                  initial_call_detection=False, acl_repo_name=None):
         self.realm = realm
         self.initial_call = initial_call_detection
         self.authfunc = authfunc
         self.registry = registry
         self.acl_repo_name = acl_repo_name
         self._rc_auth_http_code = auth_http_code
 
     def _get_response_from_code(self, http_code):
         try:
             return get_exception(safe_int(http_code))
         except Exception:
             log.exception('Failed to fetch response for code %s' % http_code)
             return HTTPForbidden
 
     def get_rc_realm(self):
         return safe_str(self.registry.rhodecode_settings.get('rhodecode_realm'))
 
     def build_authentication(self):
         head = WWW_AUTHENTICATE.tuples('Basic realm="%s"' % self.realm)
         if self._rc_auth_http_code and not self.initial_call:
             # return alternative HTTP code if alternative http return code
             # is specified in RhodeCode config, but ONLY if it's not the
             # FIRST call
             custom_response_klass = self._get_response_from_code(
                 self._rc_auth_http_code)
             return custom_response_klass(headers=head)
         return HTTPUnauthorized(headers=head)
 
     def authenticate(self, environ):
         authorization = AUTHORIZATION(environ)
         if not authorization:
             return self.build_authentication()
         (authmeth, auth) = authorization.split(' ', 1)
         if 'basic' != authmeth.lower():
             return self.build_authentication()
         auth = auth.strip().decode('base64')
         _parts = auth.split(':', 1)
         if len(_parts) == 2:
             username, password = _parts
             auth_data = self.authfunc(
                     username, password, environ, VCS_TYPE,
                     registry=self.registry, acl_repo_name=self.acl_repo_name)
             if auth_data:
                 return {'username': username, 'auth_data': auth_data}
             if username and password:
                 # we mark that we actually executed authentication once, at
                 # that point we can use the alternative auth code
                 self.initial_call = False
 
         return self.build_authentication()
 
     __call__ = authenticate
 
 
 def calculate_version_hash(config):
     return md5(
         config.get('beaker.session.secret', '') +
         rhodecode.__version__)[:8]
 
 
 def get_current_lang(request):
     # NOTE(marcink): remove after pyramid move
     try:
         return translation.get_lang()[0]
     except:
         pass
 
     return getattr(request, '_LOCALE_', request.locale_name)
 
 
 def attach_context_attributes(context, request, user_id):
     """
     Attach variables into template context called `c`, please note that
     request could be pylons or pyramid request in here.
     """
     # NOTE(marcink): remove check after pyramid migration
     if hasattr(request, 'registry'):
         config = request.registry.settings
     else:
         from pylons import config
 
     rc_config = SettingsModel().get_all_settings(cache=True)
 
     context.rhodecode_version = rhodecode.__version__
     context.rhodecode_edition = config.get('rhodecode.edition')
     # unique secret + version does not leak the version but keep consistency
     context.rhodecode_version_hash = calculate_version_hash(config)
 
     # Default language set for the incoming request
     context.language = get_current_lang(request)
 
     # Visual options
     context.visual = AttributeDict({})
 
     # DB stored Visual Items
     context.visual.show_public_icon = str2bool(
         rc_config.get('rhodecode_show_public_icon'))
     context.visual.show_private_icon = str2bool(
         rc_config.get('rhodecode_show_private_icon'))
     context.visual.stylify_metatags = str2bool(
         rc_config.get('rhodecode_stylify_metatags'))
     context.visual.dashboard_items = safe_int(
         rc_config.get('rhodecode_dashboard_items', 100))
     context.visual.admin_grid_items = safe_int(
         rc_config.get('rhodecode_admin_grid_items', 100))
     context.visual.repository_fields = str2bool(
         rc_config.get('rhodecode_repository_fields'))
     context.visual.show_version = str2bool(
         rc_config.get('rhodecode_show_version'))
     context.visual.use_gravatar = str2bool(
         rc_config.get('rhodecode_use_gravatar'))
     context.visual.gravatar_url = rc_config.get('rhodecode_gravatar_url')
     context.visual.default_renderer = rc_config.get(
         'rhodecode_markup_renderer', 'rst')
     context.visual.comment_types = ChangesetComment.COMMENT_TYPES
     context.visual.rhodecode_support_url = \
         rc_config.get('rhodecode_support_url') or h.route_url('rhodecode_support')
 
     context.visual.affected_files_cut_off = 60
 
     context.pre_code = rc_config.get('rhodecode_pre_code')
     context.post_code = rc_config.get('rhodecode_post_code')
     context.rhodecode_name = rc_config.get('rhodecode_title')
     context.default_encodings = aslist(config.get('default_encoding'), sep=',')
     # if we have specified default_encoding in the request, it has more
     # priority
     if request.GET.get('default_encoding'):
         context.default_encodings.insert(0, request.GET.get('default_encoding'))
     context.clone_uri_tmpl = rc_config.get('rhodecode_clone_uri_tmpl')
 
     # INI stored
     context.labs_active = str2bool(
         config.get('labs_settings_active', 'false'))
     context.visual.allow_repo_location_change = str2bool(
         config.get('allow_repo_location_change', True))
     context.visual.allow_custom_hooks_settings = str2bool(
         config.get('allow_custom_hooks_settings', True))
     context.debug_style = str2bool(config.get('debug_style', False))
 
     context.rhodecode_instanceid = config.get('instance_id')
 
     context.visual.cut_off_limit_diff = safe_int(
         config.get('cut_off_limit_diff'))
     context.visual.cut_off_limit_file = safe_int(
         config.get('cut_off_limit_file'))
 
     # AppEnlight
     context.appenlight_enabled = str2bool(config.get('appenlight', 'false'))
     context.appenlight_api_public_key = config.get(
         'appenlight.api_public_key', '')
     context.appenlight_server_url = config.get('appenlight.server_url', '')
 
     # JS template context
     context.template_context = {
         'repo_name': None,
         'repo_type': None,
         'repo_landing_commit': None,
         'rhodecode_user': {
             'username': None,
             'email': None,
             'notification_status': False
         },
         'visual': {
             'default_renderer': None
         },
         'commit_data': {
             'commit_id': None
         },
         'pull_request_data': {'pull_request_id': None},
         'timeago': {
             'refresh_time': 120 * 1000,
             'cutoff_limit': 1000 * 60 * 60 * 24 * 7
         },
         'pyramid_dispatch': {
 
         },
         'extra': {'plugins': {}}
     }
     # END CONFIG VARS
 
     # TODO: This dosn't work when called from pylons compatibility tween.
     # Fix this and remove it from base controller.
     # context.repo_name = get_repo_slug(request)  # can be empty
 
     diffmode = 'sideside'
     if request.GET.get('diffmode'):
         if request.GET['diffmode'] == 'unified':
             diffmode = 'unified'
     elif request.session.get('diffmode'):
         diffmode = request.session['diffmode']
 
     context.diffmode = diffmode
 
     if request.session.get('diffmode') != diffmode:
         request.session['diffmode'] = diffmode
 
     context.csrf_token = auth.get_csrf_token(session=request.session)
     context.backends = rhodecode.BACKENDS.keys()
     context.backends.sort()
     context.unread_notifications = NotificationModel().get_unread_cnt_for_user(user_id)
 
     # NOTE(marcink): when migrated to pyramid we don't need to set this anymore,
     # given request will ALWAYS be pyramid one
     pyramid_request = pyramid.threadlocal.get_current_request()
     context.pyramid_request = pyramid_request
 
     # web case
     if hasattr(pyramid_request, 'user'):
         context.auth_user = pyramid_request.user
         context.rhodecode_user = pyramid_request.user
 
     # api case
     if hasattr(pyramid_request, 'rpc_user'):
         context.auth_user = pyramid_request.rpc_user
         context.rhodecode_user = pyramid_request.rpc_user
 
     # attach the whole call context to the request
     request.call_context = context
 
 
 def get_auth_user(request):
     environ = request.environ
     session = request.session
 
     ip_addr = get_ip_addr(environ)
     # make sure that we update permissions each time we call controller
     _auth_token = (request.GET.get('auth_token', '') or
                    request.GET.get('api_key', ''))
 
     if _auth_token:
         # when using API_KEY we assume user exists, and
         # doesn't need auth based on cookies.
         auth_user = AuthUser(api_key=_auth_token, ip_addr=ip_addr)
         authenticated = False
     else:
         cookie_store = CookieStoreWrapper(session.get('rhodecode_user'))
         try:
             auth_user = AuthUser(user_id=cookie_store.get('user_id', None),
                                  ip_addr=ip_addr)
         except UserCreationError as e:
             h.flash(e, 'error')
             # container auth or other auth functions that create users
             # on the fly can throw this exception signaling that there's
             # issue with user creation, explanation should be provided
             # in Exception itself. We then create a simple blank
             # AuthUser
             auth_user = AuthUser(ip_addr=ip_addr)
 
         if password_changed(auth_user, session):
             session.invalidate()
             cookie_store = CookieStoreWrapper(session.get('rhodecode_user'))
             auth_user = AuthUser(ip_addr=ip_addr)
 
         authenticated = cookie_store.get('is_authenticated')
 
     if not auth_user.is_authenticated and auth_user.is_user_object:
         # user is not authenticated and not empty
         auth_user.set_authenticated(authenticated)
 
     return auth_user
 
 
 class BaseController(WSGIController):
 
     def __before__(self):
         """
         __before__ is called before controller methods and after __call__
         """
         # on each call propagate settings calls into global settings.
         from pylons import config
         from pylons import tmpl_context as c, request, url
         set_rhodecode_config(config)
         attach_context_attributes(c, request, self._rhodecode_user.user_id)
 
         # TODO: Remove this when fixed in attach_context_attributes()
         c.repo_name = get_repo_slug(request)  # can be empty
 
         self.cut_off_limit_diff = safe_int(config.get('cut_off_limit_diff'))
         self.cut_off_limit_file = safe_int(config.get('cut_off_limit_file'))
         self.sa = meta.Session
         self.scm_model = ScmModel(self.sa)
 
         # set user language
         user_lang = getattr(c.pyramid_request, '_LOCALE_', None)
         if user_lang:
             translation.set_lang(user_lang)
             log.debug('set language to %s for user %s',
                       user_lang, self._rhodecode_user)
 
     def _dispatch_redirect(self, with_url, environ, start_response):
         from webob.exc import HTTPFound
         resp = HTTPFound(with_url)
         environ['SCRIPT_NAME'] = ''  # handle prefix middleware
         environ['PATH_INFO'] = with_url
         return resp(environ, start_response)
 
     def __call__(self, environ, start_response):
         """Invoke the Controller"""
         # WSGIController.__call__ dispatches to the Controller method
         # the request is routed to. This routing information is
         # available in environ['pylons.routes_dict']
         from rhodecode.lib import helpers as h
         from pylons import tmpl_context as c, request, url
 
         # Provide the Pylons context to Pyramid's debugtoolbar if it asks
         if environ.get('debugtoolbar.wants_pylons_context', False):
             environ['debugtoolbar.pylons_context'] = c._current_obj()
 
         _route_name = '.'.join([environ['pylons.routes_dict']['controller'],
                                 environ['pylons.routes_dict']['action']])
 
         self.rc_config = SettingsModel().get_all_settings(cache=True)
         self.ip_addr = get_ip_addr(environ)
 
         # The rhodecode auth user is looked up and passed through the
         # environ by the pylons compatibility tween in pyramid.
         # So we can just grab it from there.
         auth_user = environ['rc_auth_user']
 
         # set globals for auth user
         request.user = auth_user
         self._rhodecode_user = auth_user
 
         log.info('IP: %s User: %s accessed %s [%s]' % (
             self.ip_addr, auth_user, safe_unicode(get_access_path(environ)),
             _route_name)
         )
 
         user_obj = auth_user.get_instance()
         if user_obj and user_obj.user_data.get('force_password_change'):
             h.flash('You are required to change your password', 'warning',
                     ignore_duplicate=True)
             return self._dispatch_redirect(
                 url('my_account_password'), environ, start_response)
 
         return WSGIController.__call__(self, environ, start_response)
 
 
 def h_filter(s):
     """
     Custom filter for Mako templates. Mako by standard uses `markupsafe.escape`
     we wrap this with additional functionality that converts None to empty
     strings
     """
     if s is None:
         return markupsafe.Markup()
     return markupsafe.escape(s)
 
 
 def add_events_routes(config):
     """
     Adds routing that can be used in events. Because some events are triggered
     outside of pyramid context, we need to bootstrap request with some
     routing registered
     """
     config.add_route(name='home', pattern='/')
 
     config.add_route(name='repo_summary', pattern='/{repo_name}')
     config.add_route(name='repo_summary_explicit', pattern='/{repo_name}/summary')
     config.add_route(name='repo_group_home', pattern='/{repo_group_name}')
 
     config.add_route(name='pullrequest_show',
                      pattern='/{repo_name}/pull-request/{pull_request_id}')
     config.add_route(name='pull_requests_global',
                      pattern='/pull-request/{pull_request_id}')
 
     config.add_route(name='repo_commit',
                      pattern='/{repo_name}/changeset/{commit_id}')
     config.add_route(name='repo_files',
                      pattern='/{repo_name}/files/{commit_id}/{f_path}')
 
 
 def bootstrap_request(**kwargs):
     import pyramid.testing
 
     class TestRequest(pyramid.testing.DummyRequest):
         application_url = kwargs.pop('application_url', 'http://example.com')
         host = kwargs.pop('host', 'example.com:80')
         domain = kwargs.pop('domain', 'example.com')
 
         def translate(self, msg):
             return msg
 
     class TestDummySession(pyramid.testing.DummySession):
         def save(*arg, **kw):
             pass
 
     request = TestRequest(**kwargs)
     request.session = TestDummySession()
 
-
     config = pyramid.testing.setUp(request=request)
     add_events_routes(config)
     return request
 

rhodecode/lib/hooks_daemon.py

@@ -1,241 +1,242 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2010-2017 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # 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 Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import json
 import logging
 import traceback
 import threading
 from BaseHTTPServer import BaseHTTPRequestHandler
 from SocketServer import TCPServer
 
 import rhodecode
 from rhodecode.model import meta
 from rhodecode.lib.base import bootstrap_request
 from rhodecode.lib import hooks_base
 from rhodecode.lib.utils2 import AttributeDict
 
 
 log = logging.getLogger(__name__)
 
 
 class HooksHttpHandler(BaseHTTPRequestHandler):
     def do_POST(self):
         method, extras = self._read_request()
         try:
             result = self._call_hook(method, extras)
         except Exception as e:
             exc_tb = traceback.format_exc()
             result = {
                 'exception': e.__class__.__name__,
                 'exception_traceback': exc_tb,
                 'exception_args': e.args
             }
         self._write_response(result)
 
     def _read_request(self):
         length = int(self.headers['Content-Length'])
         body = self.rfile.read(length).decode('utf-8')
         data = json.loads(body)
         return data['method'], data['extras']
 
     def _write_response(self, result):
         self.send_response(200)
         self.send_header("Content-type", "text/json")
         self.end_headers()
         self.wfile.write(json.dumps(result))
 
     def _call_hook(self, method, extras):
         hooks = Hooks()
         try:
             result = getattr(hooks, method)(extras)
         finally:
             meta.Session.remove()
         return result
 
     def log_message(self, format, *args):
         """
         This is an overridden method of BaseHTTPRequestHandler which logs using
         logging library instead of writing directly to stderr.
         """
 
         message = format % args
 
         # TODO: mikhail: add different log levels support
         log.debug(
             "%s - - [%s] %s", self.client_address[0],
             self.log_date_time_string(), message)
 
 
 class DummyHooksCallbackDaemon(object):
     def __init__(self):
         self.hooks_module = Hooks.__module__
 
     def __enter__(self):
         log.debug('Running dummy hooks callback daemon')
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         log.debug('Exiting dummy hooks callback daemon')
 
 
 class ThreadedHookCallbackDaemon(object):
 
     _callback_thread = None
     _daemon = None
     _done = False
 
     def __init__(self):
         self._prepare()
 
     def __enter__(self):
         self._run()
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         log.debug('Callback daemon exiting now...')
         self._stop()
 
     def _prepare(self):
         raise NotImplementedError()
 
     def _run(self):
         raise NotImplementedError()
 
     def _stop(self):
         raise NotImplementedError()
 
 
 class HttpHooksCallbackDaemon(ThreadedHookCallbackDaemon):
     """
     Context manager which will run a callback daemon in a background thread.
     """
 
     hooks_uri = None
 
     IP_ADDRESS = '127.0.0.1'
 
     # From Python docs: Polling reduces our responsiveness to a shutdown
     # request and wastes cpu at all other times.
     POLL_INTERVAL = 0.1
 
     def _prepare(self):
         log.debug("Preparing HTTP callback daemon and registering hook object")
 
         self._done = False
         self._daemon = TCPServer((self.IP_ADDRESS, 0), HooksHttpHandler)
         _, port = self._daemon.server_address
         self.hooks_uri = '{}:{}'.format(self.IP_ADDRESS, port)
 
         log.debug("Hooks uri is: %s", self.hooks_uri)
 
     def _run(self):
         log.debug("Running event loop of callback daemon in background thread")
         callback_thread = threading.Thread(
             target=self._daemon.serve_forever,
             kwargs={'poll_interval': self.POLL_INTERVAL})
         callback_thread.daemon = True
         callback_thread.start()
         self._callback_thread = callback_thread
 
     def _stop(self):
         log.debug("Waiting for background thread to finish.")
         self._daemon.shutdown()
         self._callback_thread.join()
         self._daemon = None
         self._callback_thread = None
 
 
 def prepare_callback_daemon(extras, protocol, use_direct_calls):
     callback_daemon = None
 
     if use_direct_calls:
         callback_daemon = DummyHooksCallbackDaemon()
         extras['hooks_module'] = callback_daemon.hooks_module
     else:
         if protocol == 'http':
             callback_daemon = HttpHooksCallbackDaemon()
         else:
             log.error('Unsupported callback daemon protocol "%s"', protocol)
             raise Exception('Unsupported callback daemon protocol.')
 
         extras['hooks_uri'] = callback_daemon.hooks_uri
         extras['hooks_protocol'] = protocol
 
     log.debug('Prepared a callback daemon: %s', callback_daemon)
     return callback_daemon, extras
 
 
 class Hooks(object):
     """
     Exposes the hooks for remote call backs
     """
 
     def repo_size(self, extras):
         log.debug("Called repo_size of %s object", self)
         return self._call_hook(hooks_base.repo_size, extras)
 
     def pre_pull(self, extras):
         log.debug("Called pre_pull of %s object", self)
         return self._call_hook(hooks_base.pre_pull, extras)
 
     def post_pull(self, extras):
         log.debug("Called post_pull of %s object", self)
         return self._call_hook(hooks_base.post_pull, extras)
 
     def pre_push(self, extras):
         log.debug("Called pre_push of %s object", self)
         return self._call_hook(hooks_base.pre_push, extras)
 
     def post_push(self, extras):
         log.debug("Called post_push of %s object", self)
         return self._call_hook(hooks_base.post_push, extras)
 
     def _call_hook(self, hook, extras):
         extras = AttributeDict(extras)
+        server_url = extras['server_url']
 
-        extras.request = bootstrap_request(
-            application_url=extras['server_url'])
+        extras.request = bootstrap_request(application_url=server_url)
 
         try:
             result = hook(extras)
         except Exception as error:
             exc_tb = traceback.format_exc()
             log.exception('Exception when handling hook %s', hook)
             error_args = error.args
             return {
                 'status': 128,
                 'output': '',
                 'exception': type(error).__name__,
                 'exception_traceback': exc_tb,
                 'exception_args': error_args,
             }
         finally:
             meta.Session.remove()
 
+        log.debug('Got hook call response %s', result)
         return {
             'status': result.status,
             'output': result.output,
         }
 
     def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         pass