validate_report.py

#!/usr/bin/env python

"""
Cross-checks findings, validates XML files, offerte and report files.

Copyright (C) 2015-2016 Peter Mosmans [Radically Open Security]
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.

"""

from __future__ import absolute_import
from __future__ import print_function

import argparse
import mmap
import os
import re
import subprocess
import sys
import textwrap
import xml.sax

from lxml import etree as ElementTree


# When set to True, the report will be validated using docbuilder
DOCBUILDER = False
VOCABULARY = 'project-vocabulary.pws'
# Snippets may contain XML fragments without the proper entities
EXAMPLEDIR = 'examples/'
NOT_CAPITALIZED = ['a', 'an', 'and', 'as', 'at', 'but', 'by', 'for', 'in',
                   'nor', 'of', 'on', 'or', 'the', 'to', 'up']
SNIPPETDIR = 'snippets/'
TEMPLATEDIR = 'templates/'
OFFERTE = '/offerte.xml'
REPORT = '/report.xml'
WARN_LINE = 100  # There should be a separation character after x characters...
MAX_LINE = 130  # ... and before y


if DOCBUILDER:
    import docbuilder_proxy
    import proxy_vagrant
try:
    import aspell
except:
    print('[-] aspell not installed: spelling not available')


def parse_arguments():
    """
    Parses command line arguments.
    """
    parser = argparse.ArgumentParser(
            formatter_class=argparse.RawDescriptionHelpFormatter,
            description=textwrap.dedent('''\
validate_report - validates offer letters and reports

Copyright (C) 2015-2016  Peter Mosmans [Go Forward]
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.'''))
    parser.add_argument('-a', '--all', action='store_true',
                        help='Perform all checks')
    parser.add_argument('--auto-fix', action='store_true',
                        help='Try to automatically correct issues')
    parser.add_argument('-c', '--capitalization', action='store_true',
                        help='Check capitalization')
    parser.add_argument('--debug', action='store_true',
                        help='Show debug information')
    parser.add_argument('--edit', action='store_true',
                        help='Open files with issues using an editor')
    parser.add_argument('--learn', action='store_true',
                        help='Store all unknown words in dictionary file')
    parser.add_argument('--long', action='store_true',
                        help='Check for long lines')
    parser.add_argument('--offer', action='store_true',
                        help='Validate offer master file')
    parser.add_argument('--spelling', action='store_true',
                        help='Check spelling')
    parser.add_argument('-v', '--verbose', action='store_true',
                        help='increase output verbosity')
    parser.add_argument('--no-report', action='store_true',
                        help='Do not validate report master file')
    parser.add_argument('--quiet', action='store_true',
                        help='Don\'t output status messages')
    return vars(parser.parse_args())


def validate_spelling(tree, filename, options):
    """
    Checks spelling of text within tags.
    If options['learn'], then unknown words will be added to the dictionary.
    """
    result = True
    try:
        speller = aspell.Speller(('lang', 'en'),
                                 ('personal-dir', '.'),
                                 ('personal', VOCABULARY))
    except:  # some versions of aspell use a different path
        speller = aspell.Speller(('lang', 'en'),
                                 ('personal-path', './' + VOCABULARY))
    if options['debug']:
        [print(i[0] + ' ' + str(i[2]) + '\n') for i in speller.ConfigKeys()]
    try:
        root = tree.getroot()
        for section in root.iter():
            if section.text and isinstance(section.tag, basestring) and \
               section.tag not in ('a', 'code', 'monospace', 'pre'):
                for word in re.findall('([a-zA-Z]+\'?[a-zA-Z]+)', section.text):
                    if not speller.check(word):
                        if options['learn']:
                            speller.addtoPersonal(word)
                        else:
                            result = False
                            print('[-] Misspelled (unknown) word {0} in {1}'.
                                  format(word.encode('utf-8'), filename))
        if options['learn']:
            speller.saveAllwords()
    except aspell.AspellSpellerError as exception:
        print('[-] Spelling disabled ({0})'.format(exception))
    return result


def all_files():
    """
    Returns a list of all files contained in the git repository.
    """
    cmd = ['git', 'ls-files']
    process = subprocess.Popen(cmd, stdout=subprocess.PIPE,
                               stderr=subprocess.PIPE)
    return process.stdout.read().splitlines()


def open_editor(filename):
    if sys.platform in ('linux', 'linux2'):
        editor = os.getenv('EDITOR')
        if editor:
            print('{0} {1}'.format(editor, filename))
            sys.stdout.flush()
            subprocess.call([editor, '"{0}"'.format(filename)], shell=True)
        else:
            subprocess.call('xdg-open', filename)
    elif sys.platform == "darwin":
        subprocess.call(['open', filename])
    elif sys.platform == "win32":
        os.system('"{0}"'.format(filename.replace('/', os.path.sep)))


def validate_files(filenames, options):
    """
    Checks file extensions and calls appropriate validator function.
    Returns True if all files validated succesfully.
    """
    result = True
    masters = []
    externals = []
    for filename in filenames:
        if (filename.lower().endswith('.xml') or
                filename.lower().endswith('xml"')):
            if SNIPPETDIR not in filename:
                if (OFFERTE in filename and options['offer']) or \
                   (REPORT in filename and not options['no_report'] and \
                    not TEMPLATEDIR in filename):
                    masters.append(filename)
                # try:
                type_result, xml_type = validate_xml(filename, options)
                result = result and type_result
                if xml_type in ('scan', 'finding', 'non-finding'):
                    externals.append(filename)
#                except:
#                    result = False
    if len(masters):
        for master in masters:
            result = validate_master(master, externals, options) and result
    return result


def print_output(options, stdout, stderr=None):
    """
    Prints out standard out and standard err using the verboseprint function.
    """
    if stdout and options['verbose']:
        print('[+] {0}'.format(stdout))
    if stderr and options['verbose']:
        print('[-] {0}'.format(stderr))


def validate_report():
    """
    Validates XML report file by trying to build it.
    Returns True if the report was built successful.
    """
    host, command = docbuilder_proxy.read_config(docbuilder_proxy.CONFIG_FILE)
    command = command + ' -c'
    return proxy_vagrant.execute_command(host, command)


def validate_xml(filename, options):
    """
    Validates XML file by trying to parse it.
    Returns True if the file validated successfully.
    """
    result = True
    xml_type = ''
    print_output(options, 'Validating XML file: {0}'.format(filename))
    try:
        with open(filename, 'rb') as xml_file:
            xml.sax.parse(xml_file, xml.sax.ContentHandler())
        tree = ElementTree.parse(filename, ElementTree.XMLParser(strip_cdata=False))
        type_result, xml_type = validate_type(tree, filename, options)
        result = validate_long_lines(tree, filename, options) and result and type_result
        if options['edit'] and not result:
            open_editor(filename)
    except (xml.sax.SAXException, ElementTree.ParseError) as exception:
        print('[-] validating {0} failed ({1})'.format(filename, exception))
        result = False
    except IOError as exception:
        print('[-] validating {0} failed ({1})'.format(filename, exception))
        result = False
    return result, xml_type


def get_all_text(node):
    """
    Retrieves all text within tags.
    """
    text_string = node.text or ''
    for element in node:
        text_string += get_all_text(element)
    if node.tail:
        text_string += node.tail
    return text_string.strip()


def is_capitalized(line):
    """
    Checks whether all words in @line start with a capital.

    Returns True if that's the case.
    """
    return not line or line.strip() == capitalize(line)


def capitalize(line):
    """
    Returns a capitalized version of @line, where the first word and all other
    words not in NOT_CAPITALIZED are capitalized.
    """
    capitalized = ''
    for word in line.strip().split():
        if word not in NOT_CAPITALIZED or not len(capitalized):
            word = word[0].upper() + word[1:]
        capitalized += word + ' '
    return capitalized.strip()


def validate_type(tree, filename, options):
    """
    Performs specific checks based on type.
    Currently only Finding and Non-Finding are supported.
    """
    result = True
    fix = False
    root = tree.getroot()
    xml_type = root.tag
    attributes = []
    tags = []
    if options['spelling']:
        result = validate_spelling(tree, filename, options)
    if xml_type == 'pentest_report':
        attributes = ['findingCode']
    if xml_type == 'finding':
        attributes = ['threatLevel', 'type', 'id']
        tags = ['title', 'description', 'technicaldescription', 'impact',
                'recommendation']
    if xml_type == 'non-finding':
        attributes = ['id']
        tags = ['title']
    if not len(attributes):
        return result, xml_type

    for attribute in attributes:
        if attribute not in root.attrib:
            print('[A] Missing obligatory attribute in {0}: {1}'.
                  format(filename, attribute))
            if attribute == 'id':
                root.set(attribute, filename)
                fix = True
            else:
                result = False
        else:
            if attribute == 'threatLevel' and root.attrib[attribute] not in \
               ('Low', 'Moderate', 'Elevated', 'High', 'Extreme'):
                print('[-] threatLevel is not Low, Moderate, High, Elevated or Extreme: {0}'.format(root.attrib[attribute]))
                result = False
            if attribute == 'type' and (options['capitalization'] and not \
                                        is_capitalized(root.attrib[attribute])):
                print('[A] Type missing capitalization (expected {0}, read {1})'.
                      format(capitalize(root.attrib[attribute]),
                             root.attrib[attribute]))
                root.attrib[attribute] = capitalize(root.attrib[attribute])
                fix = True
    for tag in tags:
        if root.find(tag) is None:
            print('[-] Missing tag in {0}: {1}'.format(filename, tag))
            result = False
            continue
        if not get_all_text(root.find(tag)):
            print('[-] Empty tag in {0}: {1}'.format(filename, tag))
            result = False
            continue
        if tag == 'title' and (options['capitalization'] and \
                               not is_capitalized(root.find(tag).text)):
            print('[A] Title missing capitalization in {0} (expected {1}, read {2})'.
                  format(filename, capitalize(root.find(tag).text),
                         root.find(tag).text))
            root.find(tag).text = capitalize(root.find(tag).text)
            fix = True
        if tag == 'description' and get_all_text(root.find(tag)).strip()[-1] != '.':
            print('[A] Description missing final dot in {0}: {1}'.format(filename, get_all_text(root.find(tag))))
            root.find(tag).text = get_all_text(root.find(tag)).strip() + '.'
            fix = True
    if fix:
        if options['auto_fix']:
            print('[+] Automatically fixed {0}'.format(filename))
            tree.write(filename)
        else:
            print('[+] NOTE: Items with [A] can be fixed automatically, use --auto-fix')
    return (result and not fix), xml_type


def validate_long_lines(tree, filename, options):
    """
    Checks whether <pre> section contains lines longer than MAX_LINE characters
    Returns True if the file validated successfully.
    """
    if not options['long']:
        return True
    result = True
    fix = False
    root = tree.getroot()
    for pre_section in root.iter('pre'):
        if pre_section.text:
            fixed_text = ''
            for line in pre_section.text.splitlines():
                fixed_line = line
                if len(line.strip()) > MAX_LINE:
                    if ' ' not in line[WARN_LINE:MAX_LINE]:
                        print('[-] {0} Line inside <pre> too long: {1}'.
                              format(filename, line.encode('utf-8')[WARN_LINE:]))
                        result = False
                        for split in ['"', '\'', '=', '-', ';']:
                            if split in line.encode('utf-8').strip()[WARN_LINE:MAX_LINE]:
                                print('[A] can be fixed')
                                fix = True
                                index = line.find(split, WARN_LINE)
                                fixed_line = line[:index + 1] + '\n'
                                fixed_line += line[index + 1:]
                fixed_text += fixed_line.encode('utf-8')
    if fix:
        if options['auto_fix']:
            print('[+] Automatically fixed {0}'.format(filename))
#            tree.write(filename)
        print(fixed_text)
    return result


def validate_master(filename, externals, options):
    """
    Validates master file.
    """
    result = True
    print_output(options, '[*] Validating master file {0}'.format(filename))
    try:
        xmltree = ElementTree.parse(filename,
                                    ElementTree.XMLParser(strip_cdata=False))
        if not find_keyword(xmltree, 'TODO', filename):
            print('[-] Keyword checks failed for {0}'.format(filename))
            result = False
        print_output(options, 'Performing cross check on scans, findings and non findings...')
        if not cross_check_files(filename, externals):
            print('[-] Cross checks failed for {0}'.format(filename))
            result = False
        else:
            print_output(options, '[+] Cross checks successful')
    except (ElementTree.ParseError, IOError) as exception:
        print('[-] validating {0} failed ({1})'.format(filename, exception))
        result = False
    return result


def report_string(report_file):
    """
    Return the report_file into a big memory mapped string.
    """
    try:
        report = open(report_file)
        return mmap.mmap(report.fileno(), 0, access=mmap.ACCESS_READ)
    except IOError as exception:
        print('[-] Could not open {0} ({1})'.format(report_file, exception))
        sys.exit(-1)


def cross_check_files(filename, externals):
    """
    Checks whether all (non) findings are included in the report file.
    Returns True if the checks were successful.
    """
    result = True
    report_text = report_string(filename)
    for external in externals:
        if (EXAMPLEDIR not in external) and (SNIPPETDIR not in external) and \
           (TEMPLATEDIR not in external):
            if report_text.find(external) == -1:
                    print('[-] could not find a reference in {0} to {1}'.format(filename, external))
                    result = False
    return result


def find_keyword(xmltree, keyword, filename):
    """
    Finds keywords in an XML tree.
    This function needs lots of TLC.
    """
    result = True
    section = ''
    for tag in xmltree.iter():
        if tag.tag == 'section' and' id' in tag.attrib:
            section = 'in {0}'.format(tag.attrib['id'])
        if tag.text:
            if keyword in tag.text:
                print('[-] {0} found in {1} {2}'.format(keyword, filename, section))
                result = False
    return result


def main():
    """
    The main program. Cross-checks, validates XML files and report.
    Returns True if the checks were successful.
    """
    options = parse_arguments()
    if options['all']:
        options['capitalization'] = True
        options['long'] = True
    if options['learn']:
        print_output(options, 'Adding unknown words to {0}'.format(VOCABULARY))
#    if options['spelling']:
#        if not os.path.exists(VOCABULARY):
#            print_output(options, 'Creating project-specific vocabulary file {0}'.
#                  format(VOCABULARY))
#            options['learn'] = True
    print_output(options, 'Validating all XML files...')
    result = validate_files(all_files(), options)
    if result:
        print_output(options, 'Validation checks successful')
        if DOCBUILDER:
            print_output(options, 'Validating report build...')
            result = validate_report() and result
    if result:
        print('[+] Succesfully validated everything. Good to go')
    else:
        print('[-] Errors occurred')
    if options['spelling'] and options['learn']:
        print('[*] Don\'t forget to check the vocabulary file {0}'.
              format(VOCABULARY))


if __name__ == "__main__":
    main()