source: mod_gnutls/test/https-test-client.py @ 03426e0

#!/usr/bin/python3
# PYTHON_ARGCOMPLETE_OK

# Copyright 2019 Fiona Klute
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import select
import socket
import subprocess
import sys
import traceback
import yaml

from http.client import HTTPConnection
from multiprocessing import Process
from time import sleep

class HTTPSubprocessConnection(HTTPConnection):
    def __init__(self, command, host, port=None,
                 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
                 blocksize=8192):
        super(HTTPSubprocessConnection, self).__init__(host, port, timeout,
                                                       source_address=None,
                                                       blocksize=blocksize)
        # "command" must be a list containing binary and command line
        # parameters
        self.command = command
        # This will be the subprocess reference when connected
        self._sproc = None
        # The subprocess return code is stored here on close()
        self.returncode = None
        # The set_tunnel method of the super class is not supported
        # (see exception doc)
        self.set_tunnel = None
        self._fproc = None

    @classmethod
    def _filter(cls, in_stream, out_stream):
        import fcntl
        import os
        # This filters out a log line about loading client
        # certificates that is mistakenly sent to stdout. My fix has
        # been merged, but buggy binaries will probably be around for
        # a while.
        # https://gitlab.com/gnutls/gnutls/merge_requests/1125
        cert_log = b'Processed 1 client X.509 certificates...\n'

        fd = in_stream.fileno()
        fl = fcntl.fcntl(fd, fcntl.F_GETFL)
        fcntl.fcntl(fd, fcntl.F_SETFL, fl | os.O_NONBLOCK)
        poller = select.poll()
        poller.register(fd)

        run_loop = True
        while run_loop:
            # Critical: "event" is a bitwise OR of the POLL* constants
            for x, event in poller.poll():
                print(f'fd {x}: {event}')
                if event & select.POLLIN or event & select.POLLPRI:
                    data = in_stream.read()
                    print(f'read {len(data)} bytes')
                    if cert_log in data:
                        data = data.replace(cert_log, b'')
                        print('skip')
                    out_stream.send(data)
                if event & select.POLLHUP or event & select.POLLRDHUP:
                    # Stop the loop, but process any other events that
                    # might be in the list returned by poll() first.
                    run_loop = False
                    print('received HUP')
                sys.stdout.flush()

        print('filter process cleanin up')
        sys.stdout.flush()

        in_stream.close()
        out_stream.close()

    def connect(self):
        s_local, s_remote = socket.socketpair(socket.AF_UNIX,
                                              socket.SOCK_STREAM)
        s_local.settimeout(self.timeout)

        # TODO: Maybe capture stderr?
        self._sproc = subprocess.Popen(self.command, stdout=subprocess.PIPE,
                                       stdin=s_remote, close_fds=True,
                                       bufsize=0)
        self._fproc = Process(target=HTTPSubprocessConnection._filter,
                              args=(self._sproc.stdout, s_remote))
        self._fproc.start()
        s_remote.close()
        self.sock = s_local
        print(f'socket created {self.sock}')
        sys.stdout.flush()

    def close(self):
        traceback.print_stack()
        # Wait for the process to stop, send SIGKILL if necessary
        self._sproc.terminate()
        self.returncode = self._sproc.wait(self.timeout)
        if self.returncode == None:
            self._sproc.kill()
            self.returncode = self._sproc.wait(self.timeout)

        # filter process receives HUP on socket when the subprocess
        # terminates
        self._fproc.join()

        print(f'socket closing {self.sock}')
        super().close()



class TestRequest(yaml.YAMLObject):
    yaml_tag = '!request'
    def __init__(self, path, method='GET', headers=dict(),
                 expect=dict(status=200)):
        self.method = method
        self.path = path
        self.headers = headers
        self.expect = expect

    def __repr__(self):
        return (f'{self.__class__.__name__!s}(path={self.path!r}, '
                f'method={self.method!r}, headers={self.headers!r}, '
                f'expect={self.expect!r})')

    def _check_body(self, body):
        """
        >>> r1 = TestRequest(path='/test.txt', method='GET', headers={}, expect={'status': 200, 'body': {'exactly': 'test\\n'}})
        >>> r1._check_body('test\\n')
        >>> r1._check_body('xyz\\n')
        Traceback (most recent call last):
        ...
        https-test-client.TestExpectationFailed: Unexpected body: 'xyz\\n' != 'test\\n'
        >>> r2 = TestRequest(path='/test.txt', method='GET', headers={}, expect={'status': 200, 'body': {'contains': ['tes', 'est']}})
        >>> r2._check_body('test\\n')
        >>> r2._check_body('est\\n')
        Traceback (most recent call last):
        ...
        https-test-client.TestExpectationFailed: Unexpected body: 'est\\n' does not contain 'tes'
        >>> r3 = TestRequest(path='/test.txt', method='GET', headers={}, expect={'status': 200, 'body': {'contains': 'test'}})
        >>> r3._check_body('test\\n')
        """
        if 'exactly' in self.expect['body'] \
           and body != self.expect['body']['exactly']:
            raise TestExpectationFailed(
                f'Unexpected body: {body!r} != '
                f'{self.expect["body"]["exactly"]!r}')
        if 'contains' in self.expect['body']:
            if type(self.expect['body']['contains']) is str:
                self.expect['body']['contains'] = [
                    self.expect['body']['contains']]
            for s in self.expect['body']['contains']:
                if not s in body:
                    raise TestExpectationFailed(
                        f'Unexpected body: {body!r} does not contain '
                        f'{s!r}')

    def check_response(self, response, body):
        if self.expects_conn_reset():
            raise TestExpectationFailed(
                'Got a response, but connection should have failed!')
        if response.status != self.expect['status']:
            raise TestExpectationFailed(
                f'Unexpected status: {response.status} != '
                f'{self.expect["status"]}')
        if 'body' in self.expect:
            self._check_body(body)

    def expects_conn_reset(self):
        if 'reset' in self.expect:
            return self.expect['reset']
        return False

    @classmethod
    def _from_yaml(cls, loader, node):
        fields = loader.construct_mapping(node)
        req = TestRequest(**fields)
        return req

class TestConnection(yaml.YAMLObject):
    yaml_tag = '!connection'

    def __init__(self, actions, gnutls_params=[], protocol='https'):
        self.gnutls_params = gnutls_params
        self.actions = actions
        self.protocol = protocol

    def __repr__(self):
        return (f'{self.__class__.__name__!s}'
                f'(gnutls_params={self.gnutls_params!r}, '
                f'actions={self.actions!r}, protocol={self.protocol!r})')

    @classmethod
    def _from_yaml(cls, loader, node):
        fields = loader.construct_mapping(node)
        conn = TestConnection(**fields)
        return conn

# Override the default constructors. Pyyaml ignores default parameters
# otherwise.
yaml.add_constructor('!request', TestRequest._from_yaml, yaml.Loader)
yaml.add_constructor('!connection', TestConnection._from_yaml, yaml.Loader)



class TestExpectationFailed(Exception):
    """Raise if a test failed. The constructor should be called with a
    string describing the problem."""
    pass



def format_response(resp, body):
    s = f'{resp.status} {resp.reason}\n'
    s = s + '\n'.join(f'{name}: {value}' for name, value in resp.getheaders())
    s = s + '\n\n' + body
    return s



if __name__ == "__main__":
    import argparse
    parser = argparse.ArgumentParser(
        description='Send HTTP requests through gnutls-cli',
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
    parser.add_argument('host', nargs='?', help='Access the specified host',
                        default='localhost')
    parser.add_argument('--insecure', action='store_true',
                        help='do not validate the server certificate')
    parser.add_argument('-p', '--port', type=int,
                        help='Access the specified port', default='8000')
    parser.add_argument('--x509cafile', type=str,
                        help='Use the specified CA to validate the '
                        'server certificate')
    parser.add_argument('--test-config', type=argparse.FileType('r'),
                        help='load YAML test configuration')

    # enable bash completion if argcomplete is available
    try:
        import argcomplete
        argcomplete.autocomplete(parser)
    except ImportError:
        pass

    args = parser.parse_args()

    test_conn = None
    test_actions = None

    if args.test_config:
        config = yaml.load(args.test_config, Loader=yaml.Loader)
        if type(config) is TestConnection:
            test_conn = config
            print(test_conn)
            test_actions = test_conn.actions
    else:
        # simple default request
        test_actions = [TestRequest(path='/test.txt',
                                    expect={'status': 200, 'body': 'test\n'},
                                    method='GET')]


    # note: "--logfile" option requires GnuTLS version >= 3.6.7
    command = ['gnutls-cli', '--logfile=/dev/stderr']
    if args.insecure:
        command.append('--insecure')
    if args.x509cafile:
        command.append('--x509cafile')
        command.append(args.x509cafile)
    if test_conn != None:
        for s in test_conn.gnutls_params:
            command.append('--' + s)
    command = command + ['-p', str(args.port), args.host]

    conn = HTTPSubprocessConnection(command, args.host, port=args.port,
                                    timeout=6.0)

    try:
        for act in test_actions:
            if type(act) is TestRequest:
                try:
                    conn.request(act.method, act.path, headers=act.headers)
                    resp = conn.getresponse()
                except ConnectionResetError as err:
                    if act.expects_conn_reset():
                        print('connection reset as expected.')
                        break
                    else:
                        raise err
                body = resp.read().decode()
                print(format_response(resp, body))
                act.check_response(resp, body)
            else:
                raise TypeError(f'Unsupported action requested: {act!r}')
    finally:
        conn.close()