gvmtools.cli.main() - Code Metrics - Inspection of "Merge pull request #198 from bjoernricks/gvm-cli-e..." - greenbone/gvm-tools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8404d4...c28027 )

unknown

created 2019-06-14 06:12 UTC

gvmtools.cli.main() D

↳ Parent: gvmtools.cli

Complexity

Conditions

Size

Total Lines	72
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	46
dl	0
loc	72
rs	4.8
c	0
b	0
f	0
cc	12
nop	0

How to fix Long Method Complexity

# -*- coding: utf-8 -*-
# Copyright (C) 2018 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import getpass
import logging
import sys

from gvm.errors import GvmError
from gvm.protocols.latest import Gmp, Osp
from gvm.transforms import CheckCommandTransform
from gvm.xml import validate_xml_string

from gvmtools.helper import do_not_run_as_root
from gvmtools.parser import create_parser, create_connection, PROTOCOL_OSP

logger = logging.getLogger(__name__)

HELP_TEXT = """
    Command line tool to access services via GMP (Greenbone Management Protocol) and OSP (Open Scanner Protocol)

    Examples:
      gvm-cli socket --help
      gvm-cli tls --help
      gvm-cli ssh --help

      gvm-cli socket --xml "<get_version/>"
      gvm-cli socket --xml "<commands><authenticate><credentials><username>myuser</username><password>mypass</password></credentials></authenticate><get_tasks/></commands>"
      gvm-cli socket --gmp-username foo --gmp-password foo < myfile.xml

    The protocol specifications for GMP and OSP are available at:
      https://docs.greenbone.net/index.html#api_documentation"""


def _load_infile(filename=None):
    if not filename:
        return None

    with open(filename) as f:
        return f.read()


def main():
    do_not_run_as_root()

    parser = create_parser(description=HELP_TEXT, logfilename='gvm-cli.log')

    parser.add_protocol_argument()

    parser.add_argument('-X', '--xml', help='XML request to send')
    parser.add_argument(
        '-r', '--raw', help='Return raw XML', action='store_true', default=False
    )
    parser.add_argument(
        'infile', nargs='?', help='File to read XML commands from.'
    )

    args = parser.parse_args()

    # If timeout value is -1, then the socket has no timeout for this session
    if args.timeout == -1:
        args.timeout = None

    if args.xml is not None:
        xml = args.xml
    else:
        try:
            xml = _load_infile(args.infile)
        except IOError as e:
            print(e, file=sys.stderr)
            sys.exit(1)

    # If no command was given, program asks for one
    if len(xml) == 0:
        xml = input()

    try:
        validate_xml_string(xml)
    except GvmError as e:
        print(e, file=sys.stderr)
        sys.exit(1)

    connection = create_connection(**vars(args))

    if args.raw:
        transform = None
    else:
        transform = CheckCommandTransform()

    if args.protocol == PROTOCOL_OSP:
        protocol = Osp(connection, transform=transform)
    else:
        protocol = Gmp(connection, transform=transform)

        # Ask for password if none are given
        if args.gmp_username and not args.gmp_password:
            args.gmp_password = getpass.getpass(
                'Enter password for ' + args.gmp_username + ': '
            )

        if args.gmp_username:
            protocol.authenticate(args.gmp_username, args.gmp_password)

    try:
        result = protocol.send_command(xml)

        print(result)
    except Exception as e:  # pylint: disable=broad-except
        print(e, file=sys.stderr)
        sys.exit(1)

    protocol.disconnect()

    sys.exit(0)


if __name__ == '__main__':
    main()


1			# -- coding: utf-8 --
2			# Copyright (C) 2018 Greenbone Networks GmbH
3			#
4			# SPDX-License-Identifier: GPL-3.0-or-later
5			#
6			# This program is free software: you can redistribute it and/or modify
7			# it under the terms of the GNU General Public License as published by
8			# the Free Software Foundation, either version 3 of the License, or
9			# (at your option) any later version.
10			#
11			# This program is distributed in the hope that it will be useful,
12			# but WITHOUT ANY WARRANTY; without even the implied warranty of
13			# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			# GNU General Public License for more details.
15			#
16			# You should have received a copy of the GNU General Public License
17			# along with this program. If not, see <http://www.gnu.org/licenses/>.
18
19			import getpass
20			import logging
21			import sys
22
23			from gvm.errors import GvmError
24			from gvm.protocols.latest import Gmp, Osp
25			from gvm.transforms import CheckCommandTransform
26			from gvm.xml import validate_xml_string
27
28			from gvmtools.helper import do_not_run_as_root
29			from gvmtools.parser import create_parser, create_connection, PROTOCOL_OSP
30
31			logger = logging.getLogger(__name__)
32
33			HELP_TEXT = """
34			Command line tool to access services via GMP (Greenbone Management Protocol) and OSP (Open Scanner Protocol)
35
36			Examples:
37			gvm-cli socket --help
38			gvm-cli tls --help
39			gvm-cli ssh --help
40
41			gvm-cli socket --xml "<get_version/>"
42			gvm-cli socket --xml "<commands><authenticate><credentials><username>myuser</username><password>mypass</password></credentials></authenticate><get_tasks/></commands>"
43			gvm-cli socket --gmp-username foo --gmp-password foo < myfile.xml
44
45			The protocol specifications for GMP and OSP are available at:
46			https://docs.greenbone.net/index.html#api_documentation"""
47
48
49			def _load_infile(filename=None):
50			if not filename:
51			return None
52
53			with open(filename) as f:
54			return f.read()
55
56
57			def main():
58			do_not_run_as_root()
59
60			parser = create_parser(description=HELP_TEXT, logfilename='gvm-cli.log')
61
62			parser.add_protocol_argument()
63
64			parser.add_argument('-X', '--xml', help='XML request to send')
65			parser.add_argument(
66			'-r', '--raw', help='Return raw XML', action='store_true', default=False
67			)
68			parser.add_argument(
69			'infile', nargs='?', help='File to read XML commands from.'
70			)
71
72			args = parser.parse_args()
73
74			# If timeout value is -1, then the socket has no timeout for this session
75			if args.timeout == -1:
76			args.timeout = None
77
78			if args.xml is not None:
79			xml = args.xml
80			else:
81			try:
82			xml = _load_infile(args.infile)
83			except IOError as e:
84			print(e, file=sys.stderr)
85			sys.exit(1)
86
87			# If no command was given, program asks for one
88			if len(xml) == 0:
89			xml = input()
90
91			try:
92			validate_xml_string(xml)
93			except GvmError as e:
94			print(e, file=sys.stderr)
95			sys.exit(1)
96
97			connection = create_connection(**vars(args))
98
99			if args.raw:
100			transform = None
101			else:
102			transform = CheckCommandTransform()
103
104			if args.protocol == PROTOCOL_OSP:
105			protocol = Osp(connection, transform=transform)
106			else:
107			protocol = Gmp(connection, transform=transform)
108
109			# Ask for password if none are given
110			if args.gmp_username and not args.gmp_password:
111			args.gmp_password = getpass.getpass(
112			'Enter password for ' + args.gmp_username + ': '
113			)
114
115			if args.gmp_username:
116			protocol.authenticate(args.gmp_username, args.gmp_password)
117
118			try:
119			result = protocol.send_command(xml)
120
121			print(result)
122			except Exception as e: # pylint: disable=broad-except
123			print(e, file=sys.stderr)
124			sys.exit(1)
125
126			protocol.disconnect()
127
128			sys.exit(0)
129
130
131			if __name__ == '__main__':
132			main()
133

greenbone / gvm-tools

Push — master ( 8404d4...c28027 )

gvmtools.cli.main() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Complexity

Duplication Side-by-Side

Filter issues like