selinux: Add ui for troubleshooting

Add a new cockpit package to troubleshoot SELinux alerts. The underlying tool used is setroubleshoot, which exposes SELinux alerts via its DBUS API. Alerts on the system and possible solutions can be browsed in Cockpit, while some solutions can be applied at the press of a button. There is currently no way in Cockpit to dismiss any alerts, since the underlying API doesn't expose this functionality yet.
cockpit-project · Mar 30, 2016 · 576c975 · 576c975
1 parent 0f4657d
commit 576c975
Show file tree

Hide file tree

Showing 13 changed files with 1,389 additions and 1 deletion.
diff --git a/Makefile.am b/Makefile.am
@@ -295,6 +295,7 @@ include pkg/networkmanager/Makefile.am
 include pkg/ostree/Makefile.am
 include pkg/playground/Makefile.am
 include pkg/realmd/Makefile.am
+include pkg/selinux/Makefile.am
 include pkg/shell/Makefile.am
 include pkg/sosreport/Makefile.am
 include pkg/subscriptions/Makefile.am

diff --git a/pkg/kubernetes/Makefile.am b/pkg/kubernetes/Makefile.am
@@ -198,7 +198,7 @@ install-data-hook::
 	mkdir -p $(DESTDIR)$(kubernetesdebugdir)
 	tar -chf - -C $(srcdir) $(shared_LESS) $(shared_VIEWS) $(shared_MODULES) $(registry_VIEWS) $(registry_LESS) $(registry_MODULES) $(kubernetes_VIEWS) $(kubernetes_LESS) $(kubernetes_MODULES) | tar -xf - --strip-components=2 -C $(DESTDIR)$(kubernetesdebugdir)
 
-uninstall-hook:
+uninstall-hook::
 	rm -rf $(DESTDIR)$(kubernetesdebugdir)/scripts
 	rm -rf $(DESTDIR)$(kubernetesdebugdir)/views
 	rm -rf $(DESTDIR)$(kubernetesdebugdir)/styles

diff --git a/pkg/selinux/Makefile.am b/pkg/selinux/Makefile.am
@@ -0,0 +1,71 @@
+PKGDIR=pkg/selinux
+
+setroubleshoot_MODULES = \
+	$(PKGDIR)/setroubleshoot.js \
+	$(PKGDIR)/setroubleshoot-client.js \
+	$(PKGDIR)/views/setroubleshoot-view.js \
+	$(NULL)
+
+setroubleshoot_TESTS = \
+	$(NULL)
+
+# Typically only modify stuff above this line
+
+setroubleshootdir = $(pkgdatadir)/selinux
+nodist_setroubleshoot_DATA = \
+	$(PKGDIR)/setroubleshoot.min.html.gz \
+	$(PKGDIR)/bundle.min.js.gz \
+	$(PKGDIR)/setroubleshoot.min.css.gz \
+	$(NULL)
+setroubleshoot_DATA = \
+	$(PKGDIR)/manifest.json \
+	$(NULL)
+
+setroubleshootdebugdir = $(debugdir)$(setroubleshootdir)
+setroubleshootdebug_DATA = \
+	$(PKGDIR)/bundle.js \
+	$(PKGDIR)/setroubleshoot.css \
+	$(PKGDIR)/setroubleshoot.html \
+	$(PKGDIR)/setroubleshoot.js \
+	$(PKGDIR)/setroubleshoot-client.js \
+	$(PKGDIR)/views/setroubleshoot-view.js \
+	$(NULL)
+
+install-data-hook::
+	mkdir -p $(DESTDIR)$(setroubleshootdebugdir)
+	tar -chf - -C $(srcdir) $(setroubleshoot_MODULES) | tar -xf - --strip-components=2 -C $(DESTDIR)$(setroubleshootdebugdir)
+
+uninstall-hook::
+	rm -rf $(DESTDIR)$(setroubleshootdebugdir)/views
+
+setroubleshoot_MIN = $(setroubleshoot_MODULES:.js=.min.js)
+
+setroubleshoot_BUNDLE = \
+	$(setroubleshoot_MIN) \
+	$(NULL)
+
+# Everything else into a nice big bundle
+$(PKGDIR)/bundle.min.js: $(setroubleshoot_BUNDLE)
+	$(AM_V_GEN) $(srcdir)/tools/missing $(srcdir)/tools/jsbundle $@ $^
+
+TESTS += $(setroubleshoot_TESTS)
+
+CLEANFILES += \
+	$(PKGDIR)/setroubleshoot.min.css \
+	$(PKGDIR)/setroubleshoot.min.html \
+	$(PKGDIR)/bundle.min.js \
+	$(setroubleshoot_MIN) \
+	$(nodist_setroubleshoot_DATA) \
+	$(NULL)
+
+EXTRA_DIST += \
+	$(PKGDIR)/setroubleshoot.min.css \
+	$(PKGDIR)/setroubleshoot.min.html \
+	$(PKGDIR)/bundle.min.js \
+	$(setroubleshoot_BOWER) \
+	$(setroubleshoot_BUNDLE) \
+	$(setroubleshoot_MODULES) \
+	$(setroubleshoot_DATA) \
+	$(setroubleshootdebug_DATA) \
+	$(setroubleshoot_TESTS) \
+	$(NULL)
diff --git a/pkg/selinux/bundle.js b/pkg/selinux/bundle.js
@@ -0,0 +1 @@
+/* Empty. Replaced in production by a javascript bundle. */
diff --git a/pkg/selinux/manifest.json b/pkg/selinux/manifest.json
@@ -0,0 +1,11 @@
+{
+    "version": 0,
+
+    "tools": {
+        "setroubleshoot": {
+            "label": "SELinux Troubleshoot",
+            "order": 8
+        }
+    },
+    "content-security-policy": "default-src 'self'"
+}
diff --git a/pkg/selinux/setroubleshoot-client.js b/pkg/selinux/setroubleshoot-client.js
@@ -0,0 +1,167 @@
+/*
+ * This file is part of Cockpit.
+ *
+ * Copyright (C) 2016 Red Hat, Inc.
+ *
+ * Cockpit is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * Cockpit 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Cockpit; If not, see <http://www.gnu.org/licenses/>.
+ */
+
+define([
+    "jquery",
+    "base1/cockpit",
+], function($, cockpit) {
+
+"use strict";
+var _ = cockpit.gettext;
+
+var client = {};
+
+var bus_name = "org.fedoraproject.Setroubleshootd";
+var dbus_interface = "org.fedoraproject.SetroubleshootdIface";
+var dbus_path = "/org/fedoraproject/Setroubleshootd";
+
+var bus_name_fixit = "org.fedoraproject.SetroubleshootFixit";
+var dbus_interface_fixit = bus_name_fixit;
+var dbus_path_fixit = "/org/fedoraproject/SetroubleshootFixit/object";
+
+client.init = function() {
+    client.connected = false;
+    client.proxy = cockpit.dbus(bus_name).proxy(dbus_interface, dbus_path);
+
+    client.proxy_fixit = cockpit.dbus(bus_name_fixit).proxy(dbus_interface_fixit, dbus_path_fixit);
+
+    var dfd = $.Deferred();
+
+    client.proxy.wait(function() {
+        // HACK setroubleshootd seems to drop connections if we don't start explicitly
+        client.proxy.call("start", [])
+            .done(function() {
+                client.connected = true;
+                dfd.resolve();
+            })
+            .fail(function(ex) {
+                dfd.reject(new Error(_("Unable to start setroubleshootd")));
+            });
+    });
+
+    client.alert_callback = null;
+
+    function handle_signal(event, name, args) {
+        if (client.alert_callback && name == "alert") {
+            var level = args[0];
+            var local_id = args[1];
+            client.alert_callback(level, local_id);
+        }
+    }
+
+    // register to receive calls whenever a new alert becomes available
+    // signature for the alert callback: (level, local_id)
+    client.handle_alert = function(callback) {
+        // if we didn't listen to events before, do so now
+        if (!client.alert_callback) {
+            $(client.proxy).on("signal", handle_signal);
+        }
+        client.alert_callback = callback;
+    };
+
+    // returns a jquery promise
+    client.get_alerts = function(since) {
+        var dfd_result = $.Deferred();
+        var call;
+        if (since !== undefined)
+            call = client.proxy.call("get_all_alerts_since", [since]);
+        else
+            call = client.proxy.call("get_all_alerts", []);
+        call
+            .done(function(result) {
+                dfd_result.resolve(result[0].map(function(entry) {
+                    return {
+                        local_id: entry[0],
+                        summary: entry[1],
+                        report_count: entry[2],
+                    };
+                }));
+            })
+            .fail(function(ex) {
+                dfd_result.reject(ex);
+            });
+        return dfd_result;
+    };
+
+    /* Return an alert with summary, audit events, fix suggestions (by id)
+      local_id: an alert id
+      summary: a brief description of an alert. E.g.
+                  "SELinux is preventing /usr/bin/bash from ioctl access on the unix_stream_socket unix_stream_socket."
+      report_count: count of reports of this alert
+      audit_event: an array of audit events (AVC, SYSCALL) connected to the alert
+      plugin_analysis: an array of plugin analysis structure
+          if_text
+          then_text
+          do_text
+          analysis_id: plugin id. It can be used in org.fedoraproject.SetroubleshootFixit.run_fix()
+          fixable: True when an alert is fixable by a plugin
+          report_bug: True when an alert should be reported to bugzilla
+    */
+    client.get_alert = function(local_id) {
+        var dfd_result = $.Deferred();
+        client.proxy.call("get_alert", [local_id])
+            .done(function(result) {
+                var details = {
+                  local_id: result[0],
+                  summary: result[1],
+                  report_count: result[2],
+                  audit_event: result[3],
+                  plugin_analysis: result[4],
+                };
+                // cleanup analysis
+                details.plugin_analysis = details.plugin_analysis.map(function(itm) {
+                    return {
+                        if_text: itm[0],
+                        then_text: itm[1],
+                        do_text: itm[2],
+                        analysis_id: itm[3],
+                        fixable: itm[4],
+                        report_bug: itm[5],
+                    };
+                });
+                dfd_result.resolve(details);
+            })
+            .fail(function(ex) {
+                dfd_result.reject(new Error(_("Unable to get alert") + ": " + local_id));
+            });
+        return dfd_result.promise();
+    };
+
+    /* Run a fix via SetroubleshootFixit
+       The analysis_id is given as part of plugin_analysis entries in alert details
+     */
+    client.run_fix = function(alert_id, analysis_id) {
+        var dfd_result = $.Deferred();
+        client.proxy_fixit.call("run_fix", [alert_id, analysis_id])
+            .done(function(result) {
+                dfd_result.resolve(result[0]);
+            })
+            .fail(function(ex) {
+                dfd_result.reject(new Error(_("Unable to run fix") + ": " + ex));
+            });
+        return dfd_result.promise();
+    };
+
+    // connect to dbus and start setroubleshootd
+    return dfd.promise();
+};
+
+return client;
+
+});
diff --git a/pkg/selinux/setroubleshoot.css b/pkg/selinux/setroubleshoot.css
@@ -0,0 +1,54 @@
+/*
+ * This file is part of Cockpit.
+ *
+ * Copyright (C) 2016 Red Hat, Inc.
+ *
+ * Cockpit is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * Cockpit 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Cockpit; If not, see <http://www.gnu.org/licenses/>.
+ */
+
+.setroubleshoot-log {
+    font-family: monospace;
+}
+
+.setroubleshoot-page {
+    width: 90%;
+}
+
+.setroubleshoot-listing {
+    width: 100%;
+}
+
+div#app h3 {
+    font-weight: bold;
+}
+
+/* from patternfly .list-view-pf-actions
+ * update this when we update patternfly
+ */
+.setroubleshoot-listing-action {
+    float: right;
+    margin-bottom: 20px;
+    margin-left: 20px;
+    margin-top: 20px;
+    -ms-flex-order: 2;
+    order: 2;
+}
+
+.setroubleshoot-progress-spinner {
+    display: inline-block;
+}
+
+.setroubleshoot-progress-message {
+    vertical-align: top;
+}
diff --git a/pkg/selinux/setroubleshoot.html b/pkg/selinux/setroubleshoot.html
@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<!--
+This file is part of Cockpit.
+
+Copyright (C) 2016 Red Hat, Inc.
+
+Cockpit is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
+(at your option) any later version.
+
+Cockpit 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with Cockpit; If not, see <http://www.gnu.org/licenses/>.
+-->
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title translatable="yes">SELinux Troubleshoot</title>
+    <meta name="description" content="">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <link rel="stylesheet" href="../base1/cockpit.css">
+    <link rel="stylesheet" href="setroubleshoot.css">
+
+    <script type="text/javascript" src="../base1/bundle.js"></script>
+    <script type="text/javascript" src="bundle.js"></script>
+    <!-- debug:start -->
+    <script src="setroubleshoot.js"></script>
+    <!-- debug:end -->
+</head>
+
+<body>
+    <div id="app"></div>
+</body>
+</html>