Add documentation for access control system

This adds two new pages to the website, acl.html describing the general access control framework and permissions models, and aclpolkit.html describing the use of polkit as an access control driver. page.xsl is modified to support a new syntax <div id="include" filename="somefile.htmlinc"/> which will cause the XSL transform to replace that <div> with the contents of 'somefile.htmlinc'. We use this in the acl.html.in file, to pull the table of permissions for each libvirt object. This table is autogenerated from the enums in src/access/viraccessperms.h by the genaclperms.pl script. newapi.xsl is modified so that the list of permissions checks shown against each API will link to the description of the permissions in acl.html Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2026-08-12 06:04:46 -05:00 · 2013-08-09 17:13:02 +01:00
parent 0f3f0fad8c
commit da13f2c70c
10 changed files with 674 additions and 6 deletions
@@ -0,0 +1,124 @@
+#!/usr/bin/perl
+#
+# Copyright (C) 2013 Red Hat, Inc.
+#
+# This library 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.
+#
+# This library 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 this library.  If not, see
+# <http://www.gnu.org/licenses/>.
+#
+
+use strict;
+use warnings;
+
+my @objects = (
+    "CONNECT", "DOMAIN", "INTERFACE",
+    "NETWORK","NODE_DEVICE", "NWFILTER",
+     "SECRET", "STORAGE_POOL", "STORAGE_VOL",
+    );
+
+my %class;
+
+foreach my $object (@objects) {
+    my $class = lc $object;
+
+    $class =~ s/(^\w|_\w)/uc $1/eg;
+    $class =~ s/_//g;
+    $class =~ s/Nwfilter/NWFilter/;
+    $class = "vir" . $class . "Ptr";
+
+    $class{$object} = $class;
+}
+
+my $objects = join ("|", @objects);
+
+my %opts;
+my $in_opts = 0;
+
+my %perms;
+
+while (<>) {
+    if ($in_opts) {
+        if (m,\*/,) {
+            $in_opts = 0;
+        } elsif (/\*\s*\@(\w+):\s*(.*?)\s*$/) {
+            $opts{$1} = $2;
+        }
+    } elsif (m,/\*\*,) {
+        $in_opts = 1;
+    } elsif (/VIR_ACCESS_PERM_($objects)_((?:\w|_)+),/) {
+        my $object = $1;
+        my $perm = lc $2;
+        next if $perm eq "last";
+
+        $perm =~ s/_/-/g;
+
+        $perms{$object} = {} unless exists $perms{$object};
+        $perms{$object}->{$perm} = {
+            desc => $opts{desc},
+            message => $opts{message},
+            anonymous => $opts{anonymous}
+        };
+        %opts = ();
+    }
+}
+
+print <<EOF;
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <body>
+EOF
+
+foreach my $object (sort { $a cmp $b } keys %perms) {
+    my $class = $class{$object};
+    my $olink = lc "object_" . $object;
+    print <<EOF;
+<h3><a name="$olink">$class</a></h3>
+<table class="acl">
+  <thead>
+    <tr>
+      <th>Permission</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+EOF
+
+    foreach my $perm (sort { $a cmp $b } keys %{$perms{$object}}) {
+        my $description = $perms{$object}->{$perm}->{desc};
+
+        die "missing description for $object.$perm" unless
+            defined $description;
+
+        my $plink = lc "perm_" . $object . "_" . $perm;
+        $plink =~ s/-/_/g;
+
+        print <<EOF;
+    <tr>
+      <td><a name="$plink">$perm</a></td>
+      <td>$description</td>
+    </tr>
+EOF
+
+    }
+
+    print <<EOF;
+  </tbody>
+</table>
+EOF
+}
+
+print <<EOF;
+  </body>
+</html>
+EOF