summaryrefslogtreecommitdiffstats
path: root/plugins/openscap_plugin.py
blob: 4442840b2db18f3099beff8ae975db2a7202cf71 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# First Aid Kit - diagnostic and repair tool for Linux
# Copyright (C) 2007 Martin Sivak <msivak@redhat.com>
#
# 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 2 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, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

from pyfirstaidkit.plugins import Plugin,Flow
from pyfirstaidkit.reporting import PLUGIN
from pyfirstaidkit.returns import *
from pyfirstaidkit.issue import SimpleIssue
import openscap_api as openscap
import time

class OpenSCAPPlugin(Plugin):
    """Performs security audit according to the SCAP policy"""
    name = "OpenSCAP audit"
    version = "0.0.1"
    author = "Martin Sivak <msivak@redhat.com>"

    flows = Flow.init(Plugin)
    del flows["fix"]
    flows["diagnose"].description = "Performs a security and configuration audit of running system"               

    def __init__(self, *args, **kwargs):
        Plugin.__init__(self, *args, **kwargs)
        self._oval = "/usr/share/openscap/oval.xml"
        self._xccdf = "/usr/share/openscap/xccdf.xml"
        self._issues = {}
    
    def prepare(self):
        # Initialize OVAL data
        self._model = openscap.oval.definition_model_import(self._oval)
        if self._model:
            self._session = openscap.oval.agent.new_session(self._model)

        # Initialize XCCDF policies, callbacks and enable OVAL backend
        self._xccdf_model = openscap.xccdf.benchmark_import(self._xccdf)
        self._policy = None
        
        if self._session and self._xccdf_model:
            self._xccdf_policy_model = openscap.xccdf.policy_model(self._xccdf_model)
            self._xccdf_policy_model.register_output_callback(self.oscap_callback, self)
            self._xccdf_policy_model.register_engine_oval(self._session)
            # Select the first available policy
            self._policy = self._xccdf_policy_model.policies.next()
            
        if self._policy is None:
            self._result=ReturnFailure
            self._reporting.error("OpenSCAP failed to initialize", origin = self, level = PLUGIN)
        else:
            self._result=ReturnSuccess
            self._reporting.info("OpenSCAP initialized", origin = self, level = PLUGIN)

    def backup(self):
        self._result=ReturnSuccess

    def restore(self):
        self._result=ReturnSuccess

    def oscap_callback(self, Msg, Plugin):
        try:
            Id = Msg.user1str
            Issue = Plugin._issues.get(Id, None)
            if Issue is None:
                title = Msg.user3str
                description = Msg.string
                result = Msg.user2num
                Issue = SimpleIssue(Id, title)
                Issue.set(reporting  = Plugin._reporting, origin = Plugin, level = PLUGIN)
                Plugin._issues[Id] = Issue
                
                Issue.set(checked = (result in (openscap.OSCAP.OVAL_RESULT_FALSE, openscap.OSCAP.OVAL_RESULT_TRUE)),
                                happened = (result == openscap.OSCAP.OVAL_RESULT_FALSE),
                                fixed = False,
                                reporting  = Plugin._reporting,
                                origin = Plugin,
                                level = PLUGIN)
        except Exception, e:
            print e

        return Plugin.continuing()

    def diagnose(self):
        self._policy.evaluate()
        self._result=ReturnSuccess
        
    def fix(self):
        self._result=ReturnFailure
        
    def clean(self):
        openscap.oval.agent.destroy_session(self._session)
        openscap.oval.definition_model_free(self._model)
        openscap.oscap_cleanup()
        self._reporting.info("OpenSCAP deinitialized", origin = self, level = PLUGIN)
        self._result=ReturnSuccess


def get_plugin():
    return OpenSCAPPlugin