text: #!/usr/bin/env python
  # Zed Attack Proxy (ZAP) and its related class files.
  #
  # ZAP is an HTTP/HTTPS proxy for assessing web application security.
  #
  # Copyright 2017 ZAP Development Team
  #
  # 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.
  
  # This script runs a full scan against an API defined by OpenAPI/Swagger or SOAP
  # using ZAP
  #
  # It can either be run 'standalone', in which case depends on
  # https://pypi.python.org/pypi/python-owasp-zap-v2.4 and Docker, or it can be run
  # inside one of the ZAP docker containers. It automatically detects if it is
  # running in docker so the parameters are the same.
  #
  # It currently support APIS defined by:
  #	OpenAPI/Swagger URL
  #	OpenAPI/Swagger file
  #	SOAP URL
  #	SOAP File
  # It will exit with codes of:
  #	0:	Success
  #	1:	At least 1 FAIL
  #	2:	At least one WARN and no FAILs
  #	3:	Any other failure
  # By default all alerts found by ZAP will be treated as WARNings.
  # You can use the -c or -u parameters to specify a configuration file to override
  # this.
  # You can generate a template configuration file using the -g parameter. You will
  # then need to change 'WARN' to 'FAIL', 'INFO' or 'IGNORE' for the rules you want
  # to be handled differently.
  # You can also add your own messages for the rules by appending them after a tab
  # at the end of each line.
  # By default the active scan rules run are hardcoded in the API-Minimal.policy
  # file but you can change them by supplying a configuration file with the rules
  # you dont want to be run set to IGNORE.
  
  import getopt
  import json
  import logging
  import os
  import os.path
  import subprocess
  import sys
  import time
  from datetime import datetime
  from six.moves.urllib.parse import urljoin
  from zapv2 import ZAPv2
  from zap_common import *
  
  
  class NoUrlsException(Exception):
      pass
  
  
  config_dict = {}
  config_msg = {}
  out_of_scope_dict = {}
  min_level = 0
  
  # Scan rules that aren't really relevant, e.g. the examples rules in the alpha set
  blacklist = ['-1', '50003', '60000', '60001']
  
  # Scan rules that are being addressed
  in_progress_issues = {}
  
  logging.basicConfig(level=logging.INFO, format='%(asctime)s %(message)s')
  # Hide "Starting new HTTP connection" messages
  logging.getLogger("requests").setLevel(logging.WARNING)
  
  
  def usage():
      print('Usage: zap-api-scan.py -t <target> -f <format> [options]')
      print('    -t target         target API definition, OpenAPI or SOAP, local file or URL, e.g. https://www.example.com/openapi.json')
      print('    -f format         either openapi or soap')
      print('Options:')
      print('    -h                print this help message')
      print('    -c config_file    config file to use to INFO, IGNORE or FAIL warnings')
      print('    -u config_url     URL of config file to use to INFO, IGNORE or FAIL warnings')
      print('    -g gen_file       generate default config file(all rules set to WARN)')
      print('    -r report_html    file to write the full ZAP HTML report')
      print('    -w report_md      file to write the full ZAP Wiki(Markdown) report')
      print('    -x report_xml     file to write the full ZAP XML report')
      print('    -J report_json    file to write the full ZAP JSON document')
      print('    -a                include the alpha passive scan rules as well')
      print('    -d                show debug messages')
      print('    -P                specify listen port')
      print('    -D                delay in seconds to wait for passive scanning ')
      print('    -i                default rules not in the config file to INFO')
      print('    -l level          minimum level to show: PASS, IGNORE, INFO, WARN or FAIL, use with -s to hide example URLs')
      print('    -n context_file   context file which will be loaded prior to scanning the target')
      print('    -p progress_file  progress file which specifies issues that are being addressed')
      print('    -s                short output format - dont show PASSes or example URLs')
      print('    -S                safe mode this will skip the active scan and perform a baseline scan')
      print('    -T                max time in minutes to wait for ZAP to start and the passive scan to run')
      print('    -O                the hostname to override in the (remote) OpenAPI spec')
      print('    -z zap_options    ZAP command line options e.g. -z "-config aaa=bbb -config ccc=ddd"')
      print('    --hook            path to python file that define your custom hooks')
      print('')
      print('For more details see https://github.com/zaproxy/zaproxy/wiki/ZAP-API-Scan')
  
  
  def main(argv):
  
      global min_level
      global in_progress_issues
      cid = ''
      context_file = ''
      progress_file = ''
      config_file = ''
      config_url = ''
      generate = ''
      port = 0
      detailed_output = True
      report_html = ''
      report_md = ''
      report_xml = ''
      report_json = ''
      target = ''
      target_file = ''
      target_url = ''
      host_override = ''
      format = ''
      zap_alpha = False
      baseline = False
      info_unspecified = False
      base_dir = ''
      zap_ip = 'localhost'
      zap_options = ''
      delay = 0
      timeout = 0
      hook_file = None
  
      pass_count = 0
      warn_count = 0
      fail_count = 0
      info_count = 0
      ignore_count = 0
      warn_inprog_count = 0
      fail_inprog_count = 0
  
      try:
          opts, args = getopt.getopt(argv, "t:f:c:u:g:m:n:r:J:w:x:l:hdaijSp:sz:P:D:T:O:", ["hook="])
      except getopt.GetoptError as exc:
          logging.warning('Invalid option ' + exc.opt + ' : ' + exc.msg)
          usage()
          sys.exit(3)
  
      for opt, arg in opts:
          if opt == '-h':
              usage()
              sys.exit(0)
          elif opt == '-t':
              target = arg
              logging.debug('Target: ' + target)
          elif opt == '-f':
              format = arg
          elif opt == '-c':
              config_file = arg
          elif opt == '-u':
              config_url = arg
          elif opt == '-g':
              generate = arg
          elif opt == '-d':
              logging.getLogger().setLevel(logging.DEBUG)
          elif opt == '-P':
              port = int(arg)
          elif opt == '-D':
              delay = int(arg)
          elif opt == '-n':
              context_file = arg
          elif opt == '-p':
              progress_file = arg
          elif opt == '-r':
              report_html = arg
          elif opt == '-J':
              report_json = arg
          elif opt == '-w':
              report_md = arg
          elif opt == '-x':
              report_xml = arg
          elif opt == '-a':
              zap_alpha = True
          elif opt == '-i':
              info_unspecified = True
          elif opt == '-l':
              try:
                  min_level = zap_conf_lvls.index(arg)
              except ValueError:
                  logging.warning('Level must be one of ' + str(zap_conf_lvls))
                  usage()
                  sys.exit(3)
          elif opt == '-z':
              zap_options = arg
          elif opt == '-s':
              detailed_output = False
          elif opt == '-S':
              baseline = True
          elif opt == '-T':
              timeout = int(arg)
          elif opt == '-O':
              host_override = arg
          elif opt == '--hook':
              hook_file = arg
  
      check_zap_client_version()
  
      load_custom_hooks(hook_file)
      trigger_hook('cli_opts', opts)
  
      # Check target supplied and ok
      if len(target) == 0:
          usage()
          sys.exit(3)
      if format != 'openapi' and format != 'soap':
          logging.warning('Format must be either \'openapi\' or \'soap\'')
          usage()
          sys.exit(3)
  
      if running_in_docker():
          base_dir = '/zap/wrk/'
          if config_file or generate or report_html or report_xml or report_json or progress_file or context_file or target_file:
              # Check directory has been mounted
              if not os.path.exists(base_dir):
                  logging.warning('A file based option has been specified but the directory \'/zap/wrk\' is not mounted ')
                  usage()
                  sys.exit(3)
  
      if target.startswith('http://') or target.startswith('https://'):
          target_url = target
      else:
          # assume its a file
          if not os.path.exists(base_dir + target):
              logging.warning('Target must either start with \'http://\' or \'https://\' or be a local file')
              logging.warning('File does not exist: ' + base_dir + target)
              usage()
              sys.exit(3)
          else:
              target_file = target
  
      # Choose a random 'ephemeral' port and check its available if it wasn't specified with -P option
      if port == 0:
          port = get_free_port()
  
      logging.debug('Using port: ' + str(port))
  
      if config_file:
          # load config file from filestore
          with open(base_dir + config_file) as f:
              try:
                  load_config(f, config_dict, config_msg, out_of_scope_dict)
              except ValueError as e:
                  logging.warning("Failed to load config file " + base_dir + config_file + " " + str(e))
                  sys.exit(3)
      elif config_url:
          # load config file from url
          try:
              config_data = urlopen(config_url).read().decode('UTF-8').splitlines()
              load_config(config_data, config_dict, config_msg, out_of_scope_dict)
          except ValueError as e:
              logging.warning("Failed to read configs from " + config_url + " " + str(e))
              sys.exit(3)
          except:
              logging.warning('Failed to read configs from ' + config_url)
              sys.exit(3)
  
      if progress_file:
          # load progress file from filestore
          with open(base_dir + progress_file) as f:
              progress = json.load(f)
              # parse into something more useful...
              # in_prog_issues = map of vulnid -> {object with everything in}
              for issue in progress["issues"]:
                  if issue["state"] == "inprogress":
                      in_progress_issues[issue["id"]] = issue
  
      if running_in_docker():
          try:
              params = [
                        '-addonupdate',
                        '-addoninstall', 'pscanrulesBeta']  # In case we're running in the stable container
  
              if zap_alpha:
                  params.append('-addoninstall')
                  params.append('pscanrulesAlpha')
  
              add_zap_options(params, zap_options)
  
              start_zap(port, params)
  
          except OSError:
              logging.warning('Failed to start ZAP :(')
              sys.exit(3)
  
      else:
          # Not running in docker, so start one
          mount_dir = ''
          if context_file:
              mount_dir =  os.path.dirname(os.path.abspath(context_file))
  
          params = ['-addonupdate']
  
          if (zap_alpha):
              params.extend(['-addoninstall', 'pscanrulesAlpha'])
  
          add_zap_options(params, zap_options)
  
          try:
              cid = start_docker_zap('owasp/zap2docker-weekly', port, params, mount_dir)
              zap_ip = ipaddress_for_cid(cid)
              logging.debug('Docker ZAP IP Addr: ' + zap_ip)
  
              # Copy across the files that may not be in all of the docker images
              try:
                  subprocess.check_output(['docker', 'exec', '-t', cid, 'mkdir', '-p', '/home/zap/.ZAP_D/scripts/scripts/httpsender/'])
                  cp_to_docker(cid, 'scripts/scripts/httpsender/Alert_on_HTTP_Response_Code_Errors.js', '/home/zap/.ZAP_D/')
                  cp_to_docker(cid, 'scripts/scripts/httpsender/Alert_on_Unexpected_Content_Types.js', '/home/zap/.ZAP_D/')
                  cp_to_docker(cid, 'policies/API-Minimal.policy', '/home/zap/.ZAP_D/')
                  if target_file:
                      cp_to_docker(cid, target_file, '/zap/')
  
              except OSError:
                  logging.warning('Failed to copy one of the required files')
                  sys.exit(3)
  
          except OSError:
              logging.warning('Failed to start ZAP in docker :(')
              sys.exit(3)
  
      try:
          zap = ZAPv2(proxies={'http': 'http://' + zap_ip + ':' + str(port), 'https': 'http://' + zap_ip + ':' + str(port)})
  
          wait_for_zap_start(zap, timeout * 60)
          trigger_hook('zap_started', zap, target)
  
          if context_file:
              # handle the context file, cant use base_dir as it might not have been set up
              zap_import_context(zap, '/zap/wrk/' + os.path.basename(context_file))
  
          # Enable scripts
          zap.script.load('Alert_on_HTTP_Response_Code_Errors.js', 'httpsender', 'Oracle Nashorn', '/home/zap/.ZAP_D/scripts/scripts/httpsender/Alert_on_HTTP_Response_Code_Errors.js')
          zap.script.enable('Alert_on_HTTP_Response_Code_Errors.js')
          zap.script.load('Alert_on_Unexpected_Content_Types.js', 'httpsender', 'Oracle Nashorn', '/home/zap/.ZAP_D/scripts/scripts/httpsender/Alert_on_Unexpected_Content_Types.js')
          zap.script.enable('Alert_on_Unexpected_Content_Types.js')
  
          # Import the API defn
          if format == 'openapi':
              trigger_hook('importing_openapi', target_url, target_file)
              if target_url:
                  logging.debug('Import OpenAPI URL ' + target_url)
                  res = zap.openapi.import_url(target, host_override)
                  urls = zap.core.urls()
                  if host_override:
                      target = urljoin(target_url, '//' + host_override)
                      logging.info('Using host override, new target: {0}'.format(target))
              else:
                  logging.debug('Import OpenAPI File ' + target_file)
                  res = zap.openapi.import_file(base_dir + target_file)
                  urls = zap.core.urls()
                  if len(urls) > 0:
                      # Choose the first one - will be striping off the path below
                      target = urls[0]
                      logging.debug('Using target from imported file: {0}'.format(target))
          else:
              trigger_hook('importing_soap', target_url, target_file)
              if target_url:
                  logging.debug('Import SOAP URL ' + target_url)
                  res = zap._request(zap.base + 'soap/action/importUrl/', {'url':target})
                  urls = zap.core.urls()
              else:
                  logging.debug('Import SOAP File ' + target_file)
                  res = zap._request(zap.base + 'soap/action/importFile/', {'file': base_dir + target_file})
                  urls = zap.core.urls()
                  if len(urls) > 0:
                      # Choose the first one - will be striping off the path below
                      target = urls[0]
                      logging.debug('Using target from imported file: {0}'.format(target))
  
          logging.info('Number of Imported URLs: ' + str(len(urls)))
          logging.debug('Import warnings: ' + str(res))
  
          if len(urls) == 0:
              logging.warning('Failed to import any URLs')
              # No point continue, there's nothing to scan.
              raise NoUrlsException()
  
          if target.count('/') > 2:
              old_target = target
              # The url can include a valid path, but always reset to scan the host
              target = target[0:target.index('/', 8)+1]
              logging.debug('Normalised target from {0} to {1}'.format(old_target, target))
  
          # Wait for a delay if specified with -D option
          if (delay):
              start_scan = datetime.now()
              while((datetime.now() - start_scan).seconds < delay ):
                  time.sleep(5)
                  logging.debug('Delay active scan ' + str(delay -(datetime.now() - start_scan).seconds) + ' seconds')
  
          # Set up the scan policy
          scan_policy = 'API-Minimal'
          if config_dict:
              # They have supplied a config file, use this to define the ascan rules
              # Use the default one as the script might not have write access to the one just copied across
              scan_policy = 'Default Policy'
              zap.ascan.enable_all_scanners(scanpolicyname=scan_policy)
              for scanner, state in config_dict.items():
                  if state == 'IGNORE':
                      # Dont bother checking the result - this will fail for pscan rules
                      zap.ascan.set_scanner_alert_threshold(id=scanner, alertthreshold='OFF', scanpolicyname=scan_policy)
  
          if not baseline:
              zap_active_scan(zap, target, scan_policy)
  
          zap_wait_for_passive_scan(zap, timeout * 60)
  
          # Print out a count of the number of urls
          num_urls = len(zap.core.urls())
          if num_urls == 0:
              logging.warning('No URLs found - is the target URL accessible? Local services may not be accessible from the Docker container')
          else:
              if detailed_output:
                  print('Total of ' + str(num_urls) + ' URLs')
  
              alert_dict = zap_get_alerts(zap, target, blacklist, out_of_scope_dict)
  
              all_ascan_rules = zap.ascan.scanners('Default Policy')
              all_pscan_rules = zap.pscan.scanners
              all_dict = {}
              for rule in all_pscan_rules:
                  plugin_id = rule.get('id')
                  if plugin_id in blacklist:
                      continue
                  all_dict[plugin_id] = rule.get('name') + ' - Passive/' + rule.get('quality')
              for rule in all_ascan_rules:
                  plugin_id = rule.get('id')
                  if plugin_id in blacklist:
                      continue
                  all_dict[plugin_id] = rule.get('name') + ' - Active/' + rule.get('quality')
  
              if generate:
                  # Create the config file
                  with open(base_dir + generate, 'w') as f:
                      f.write('# zap-api-scan rule configuration file\n')
                      f.write('# Change WARN to IGNORE to ignore rule or FAIL to fail if rule matches\n')
                      f.write('# Active scan rules set to IGNORE will not be run which will speed up the scan\n')
                      f.write('# Only the rule identifiers are used - the names are just for info\n')
                      f.write('# You can add your own messages to each rule by appending them after a tab on each line.\n')
                      for key, rule in sorted(all_dict.iteritems()):
                          f.write(key + '\tWARN\t(' + rule + ')\n')
  
              # print out the passing rules
              pass_dict = {}
              for rule in all_pscan_rules:
                  plugin_id = rule.get('id')
                  if plugin_id in blacklist:
                      continue
                  if (not alert_dict.has_key(plugin_id)):
                      pass_dict[plugin_id] = rule.get('name')
              for rule in all_ascan_rules:
                  plugin_id = rule.get('id')
                  if plugin_id in blacklist:
                      continue
                  if not alert_dict.has_key(plugin_id) and not(config_dict.has_key(plugin_id) and config_dict[plugin_id] == 'IGNORE'):
                      pass_dict[plugin_id] = rule.get('name')
  
              if min_level == zap_conf_lvls.index("PASS") and detailed_output:
                  for key, rule in sorted(pass_dict.iteritems()):
                      print('PASS: ' + rule + ' [' + key + ']')
  
              pass_count = len(pass_dict)
  
              if detailed_output:
                  # print out the ignored ascan rules(there will be no alerts for these as they were not run)
                  for rule in all_ascan_rules:
                      plugin_id = rule.get('id')
                      if plugin_id in blacklist:
                          continue
                      if config_dict.has_key(plugin_id) and config_dict[plugin_id] == 'IGNORE':
                          print('SKIP: ' + rule.get('name') + ' [' + plugin_id + ']')
  
              # print out the ignored rules
              ignore_count, not_used = print_rules(zap, alert_dict, 'IGNORE', config_dict, config_msg, min_level,
                  inc_ignore_rules, True, detailed_output, {})
  
              # print out the info rules
              info_count, not_used = print_rules(zap, alert_dict, 'INFO', config_dict, config_msg, min_level,
                  inc_info_rules, info_unspecified, detailed_output, in_progress_issues)
  
              # print out the warning rules
              warn_count, warn_inprog_count = print_rules(zap, alert_dict, 'WARN', config_dict, config_msg, min_level,
                  inc_warn_rules, not info_unspecified, detailed_output, in_progress_issues)
  
              # print out the failing rules
              fail_count, fail_inprog_count = print_rules(zap, alert_dict, 'FAIL', config_dict, config_msg, min_level,
                  inc_fail_rules, True, detailed_output, in_progress_issues)
  
              if report_html:
                  # Save the report
                  write_report(base_dir + report_html, zap.core.htmlreport())
  
              if report_json:
                  # Save the report
                  write_report(base_dir + report_json, zap.core.jsonreport())
  
              if report_md:
                  # Save the report
                  write_report(base_dir + report_md, zap.core.mdreport())
  
              if report_xml:
                  # Save the report
                  write_report(base_dir + report_xml, zap.core.xmlreport())
  
              print('FAIL-NEW: ' + str(fail_count) + '\tFAIL-INPROG: ' + str(fail_inprog_count) +
                  '\tWARN-NEW: ' + str(warn_count) + '\tWARN-INPROG: ' + str(warn_inprog_count) +
                  '\tINFO: ' + str(info_count) + '\tIGNORE: ' + str(ignore_count) + '\tPASS: ' + str(pass_count))
  
          trigger_hook('zap_pre_shutdown', zap)
          # Stop ZAP
          zap.core.shutdown()
  
      except IOError as e:
          if hasattr(e, 'args') and len(e.args) > 1:
              errno, strerror = e
              print("ERROR " + str(strerror))
              logging.warning('I/O error(' + str(errno) + '): ' + str(strerror))
          else:
              print("ERROR %s" % e)
              logging.warning('I/O error: ' + str(e))
          dump_log_file(cid)
  
      except NoUrlsException:
          dump_log_file(cid)
  
      except:
          print("ERROR " + str(sys.exc_info()[0]))
          logging.warning('Unexpected error: ' + str(sys.exc_info()[0]))
          dump_log_file(cid)
  
      if not running_in_docker():
          stop_docker(cid)
  
      trigger_hook('pre_exit', fail_count, warn_count, pass_count)
  
      if fail_count > 0:
          sys.exit(1)
      elif warn_count > 0:
          sys.exit(2)
      elif pass_count > 0:
          sys.exit(0)
      else:
          sys.exit(3)
  
  
  if __name__ == "__main__":
      main(sys.argv[1:])
  