summaryrefslogtreecommitdiffstats
path: root/plugins/openscap_plugin.py
blob: ce7aa4d7121be1675b120e6ab75b912091580818 (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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# 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.configuration import Config
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()
    flows["oscap_scan"] = Flow({
        Plugin.initial: {Return: "prepare"},
        "prepare": {ReturnSuccess: "policy", ReturnFailure: "clean"},
        "policy": {ReturnSuccess: "rules", ReturnFailure: "clean",
                   ReturnAbort: "clean"},
        "rules": {ReturnSuccess: "tailoring", ReturnFailure: "clean",
                  ReturnBack: "policy", ReturnAbort: "clean"},
        "tailoring": {ReturnSuccess: "diagnose", ReturnFailure: "clean",
                      ReturnBack: "rules", ReturnAbort: "clean"},
        "diagnose": {ReturnSuccess: "clean", ReturnFailure: "clean"},
        "clean": {ReturnSuccess: Plugin.final}
        }, description = "Performs a security and configuration audit of running system")
    flows["oscap_scan"].title = "Security Audit"

    def __init__(self, *args, **kwargs):
        Plugin.__init__(self, *args, **kwargs)
        self._oval = "/usr/share/openscap/oval.xml"
        self._xccdf = "/usr/share/openscap/scap-xccdf.xml"
        self._issues = {}
    
    def prepare(self):
        self._objs = openscap.xccdf.init(self._xccdf)
        self._xccdf_policy_model = self._objs["policy_model"]
        self._policy = None
        
        self._xccdf_policy_model.register_output_callback(self.oscap_callback, self)
        self._xccdf_policy_model.register_start_callback(self.oscap_callback_start, self)
        
        self._reporting.info("OpenSCAP initialized", origin = self, level = PLUGIN)
        self._result=ReturnSuccess

    def policy(self):
        # Select the only available policy
        if len(self._xccdf_policy_model.policies)==1:
            self._result=ReturnSuccess
            self._policy = self._xccdf_policy_model.policies[0]
            return

        if not Config.operation.interactive:
            self._result=ReturnSuccess
            self._policy = self._xccdf_policy_model.policies[-1]
            return
        
        all_policies = map(lambda p: (
            p.id,
            p.profile and len(p.profile.title) and p.profile.title[0].text or "Default profile",
            p.id == None and True or False,
            p.profile and p.profile.description or "",
            "", ""
            ), self._xccdf_policy_model.policies)

        s = self._reporting.config_question_wait("Choose OpenScap profile",
                                                 "Select desired profile and press OK",
                                                 all_policies,
                                                 options = {"mode": 3, "back": False},
                                                 origin = self,
                                                 level = PLUGIN)
        if s in (ReturnBack, ReturnAbort):
            self._result = s
            return
        
        for idx, (id, val) in enumerate(s):
            if val:
                self._policy = self._xccdf_policy_model.policies[idx]
                self._reporting.info("OpenSCAP policy %s selected" % (id,), origin = self, level = PLUGIN)
            
        if self._policy is None:
            self._result=ReturnFailure
            self._reporting.error("OpenSCAP policy failed to initialize", origin = self, level = PLUGIN)
        else:
            self._reporting.info("OpenSCAP policy initialized", origin = self, level = PLUGIN)
            self._result=ReturnSuccess

    def rules(self):
        if not Config.operation.interactive:
            self._result=ReturnSuccess
            return

        all_rules = self._policy.get_selects()
        if len(all_rules) == 0:
            self._result=ReturnSuccess
            return
        
        preprocess_rules = lambda x: (x.item,
                                      self._policy.model.benchmark.get_item(x.item).title[0].text,
                                      x.selected and True,
                                      self._policy.model.benchmark.get_item(x.item).description[0].text,
                                      "",
                                      "Use checkbox disable or enable rule"
                                      )
        all_rules = map(preprocess_rules, all_rules)
        s = self._reporting.config_question_wait("Setup OpenScap rules",
                                                 "Enable or disable rules and press OK",
                                                 all_rules,
                                                 options = {"mode": 1},
                                                 origin = self,
                                                 level = PLUGIN)
        if s in (ReturnBack, ReturnAbort):
            self._result = s
            return
        
        enabled_rules = []
        for r in s:
            if r[1]:
                enabled_rules.append(r[0])

        self._policy.set_rules(enabled_rules)
        self._reporting.info("Enabled rules: %s" % repr(enabled_rules), origin = self,
                             level = PLUGIN)
        
        self._result=ReturnSuccess

    def tailoring(self):
        if not Config.operation.interactive:
            self._result=ReturnSuccess
            return

        tailor_items = self._policy.get_tailor_items()
        if len(tailor_items) == 0:
            self._result=ReturnSuccess
            return
        
        preproces_tailor_items = lambda i: (i["id"],
                                            i["titles"][i["lang"]] or "",
                                            i["selected"][1] or "",
                                            i["descs"][i["lang"]] or "",
                                            i["match"] or ".*",
                                            "Error setting the value, read the following description and try again:\n\n"+i["descs"][i["lang"]],
                                            set(i["options"].values())
                                            )
        tailor_items = map(preproces_tailor_items, tailor_items)

        s = self._reporting.config_question_wait("Setup OpenScap policy",
                                                 "Set preferred values and press OK",
                                                 tailor_items,
                                                 options = {"mode": 2},
                                                 origin = self,
                                                 level = PLUGIN)

        if s in (ReturnBack, ReturnAbort):
            self._result = s
            return
        
        preprocess_s = lambda v: {"id": v[0], "value": v[1]}
        s = map(preprocess_s, s)
        
        self._policy.set_tailor_items(s)
        self._reporting.info("Tailoring Done", origin = self, level = PLUGIN)  
        self._result=ReturnSuccess
            
    def oscap_callback(self, Msg, Plugin):
        if Msg.user2num == openscap.OSCAP.XCCDF_RESULT_NOT_SELECTED:
            if Plugin.continuing():
                return 0
            else:
                return 1
            
        try:       
            Id = Msg.user1str
            result = Msg.user2num
            self._info[Id] = result
            Issue = Plugin._issues.get(Id, None)
            Issue.set(checked = (result in
                                     (openscap.OSCAP.XCCDF_RESULT_FAIL,
                                      openscap.OSCAP.XCCDF_RESULT_PASS)),
                                happened = (result == openscap.OSCAP.XCCDF_RESULT_FAIL),
                                fixed = False,
                                reporting  = Plugin._reporting,
                                origin = Plugin,
                                level = PLUGIN)
        except Exception, e:
            print e

        if Plugin.continuing():
            return 0
        else:
            return 1        
        
        
    def oscap_callback_start(self, Msg, Plugin):
        if Msg.user2num == openscap.OSCAP.XCCDF_RESULT_NOT_SELECTED:
            if Plugin.continuing():
                return 0
            else:
                return 1
           
        
        try:
            Id = Msg.user1str
            self._info[Id] = -1
            Issue = Plugin._issues.get(Id, None)
            if Issue is None:
                title = Msg.user3str
                description = Msg.string
                Issue = SimpleIssue(Id, title)
                Issue.set(reporting  = Plugin._reporting, origin = Plugin, level = PLUGIN)
                Plugin._issues[Id] = Issue
               
        except Exception, e:
            print e

        if Plugin.continuing():
            return 0
        else:
            return 1


    def diagnose(self):
        for x in self._policy.get_selected_rules():
            self._reporting.info("Selecting rule "+x.item, origin = self, level = PLUGIN)

        self._reporting.info("Starting OpenSCAP evaluation", origin = self, level = PLUGIN)
        self._policy.evaluate()
        self._result=ReturnSuccess
        
    def clean(self):
        openscap.xccdf.destroy(self._objs)
        self._reporting.info("OpenSCAP deinitialized", origin = self, level = PLUGIN)
        self._result=ReturnSuccess


def get_plugin():
    return OpenSCAPPlugin