ospd.parser.create_args_parser()

Complexity

Conditions

9

Size

Total Lines	115
Code Lines	85

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

# Copyright (C) 2019 Greenbone Networks GmbH
def create_args_parser(description):
    """ Create a command-line arguments parser for OSPD. """

    parser = argparse.ArgumentParser(description=description)

    def network_port(string):
        """ Check if provided string is a valid network port. """

        value = int(string)
        if not 0 < value <= 65535:
            raise argparse.ArgumentTypeError(
                'port must be in ]0,65535] interval'
            )
        return value

    def cacert_file(cacert):
        """ Check if provided file is a valid CA Certificate """
        try:
            context = ssl.create_default_context(cafile=cacert)
        except AttributeError:
            # Python version < 2.7.9
            return cacert
        except IOError:
            raise argparse.ArgumentTypeError('CA Certificate not found')
        try:
            not_after = context.get_ca_certs()[0]['notAfter']
            not_after = ssl.cert_time_to_seconds(not_after)
            not_before = context.get_ca_certs()[0]['notBefore']
            not_before = ssl.cert_time_to_seconds(not_before)
        except (KeyError, IndexError):
            raise argparse.ArgumentTypeError('CA Certificate is erroneous')
        if not_after < int(time.time()):
            raise argparse.ArgumentTypeError('CA Certificate expired')
        if not_before > int(time.time()):
            raise argparse.ArgumentTypeError('CA Certificate not active yet')
        return cacert

    def log_level(string):
        """ Check if provided string is a valid log level. """

        value = getattr(logging, string.upper(), None)
        if not isinstance(value, int):
            raise argparse.ArgumentTypeError(
                'log level must be one of {debug,info,warning,error,critical}'
            )
        return value

    def filename(string):
        """ Check if provided string is a valid file path. """

        if not os.path.isfile(string):
            raise argparse.ArgumentTypeError(
                '%s is not a valid file path' % string
            )
        return string

    parser.add_argument(
        '-p',
        '--port',
        default=DEFAULT_PORT,
        type=network_port,
        help='TCP Port to listen on. Default: %(default)s',
    )
    parser.add_argument(
        '-b',
        '--bind-address',
        default=DEFAULT_ADDRESS,
        help='Address to listen on. Default: %(default)s',
    )
    parser.add_argument(
        '-u', '--unix-socket', help='Unix file socket to listen on.'
    )
    parser.add_argument(
        '-k',
        '--key-file',
        type=filename,
        help='Server key file. Default: {0}'.format(DEFAULT_KEY_FILE),
    )
    parser.add_argument(
        '-c',
        '--cert-file',
        type=filename,
        help='Server cert file. Default: {0}'.format(DEFAULT_CERT_FILE),
    )
    parser.add_argument(
        '--ca-file',
        type=cacert_file,
        help='CA cert file. Default: {0}'.format(DEFAULT_CA_FILE),
    )
    parser.add_argument(
        '-L',
        '--log-level',
        default='WARNING',
        type=log_level,
        help='Wished level of logging. Default: %(default)s',
    )
    parser.add_argument(
        '--foreground',
        action='store_true',
        help='Run in foreground and logs all messages to console.',
    )
    parser.add_argument(
        '-l', '--log-file', type=filename, help='Path to the logging file.'
    )
    parser.add_argument(
        '--version', action='store_true', help='Print version then exit.'
    )
    parser.add_argument(
        '--niceness',
        default=DEFAULT_NICENESS,
        type=int,
        help='Start the scan with the given niceness. Default %(default)s',
    )

    return parser