Document the dummy_seclabel contrib module.
authorRobert Haas
Thu, 18 Nov 2010 01:46:19 +0000 (20:46 -0500)
committerRobert Haas
Thu, 18 Nov 2010 01:50:51 +0000 (20:50 -0500)
KaiGai Kohei, with editing and markup fixes by me.

doc/src/sgml/contrib.sgml
doc/src/sgml/dummy-seclabel.sgml [new file with mode: 0644]
doc/src/sgml/filelist.sgml

index c31041614b84960f7a7fb64a89985cd528b8e9bf..905799601485c2de23c155681e513d84df8e9951 100644 (file)
@@ -90,6 +90,7 @@ psql -d dbname -f SHAREDIR/contrib/module.sql
  &dblink;
  &dict-int;
  &dict-xsyn;
+ &dummy-seclabel;
  &earthdistance;
  &fuzzystrmatch;
  &hstore;
diff --git a/doc/src/sgml/dummy-seclabel.sgml b/doc/src/sgml/dummy-seclabel.sgml
new file mode 100644 (file)
index 0000000..5b5089c
--- /dev/null
@@ -0,0 +1,75 @@
+
+
+
dummy_seclabel
+
+  dummy_seclabel
+
+  The dummy_seclabel module exists only to support regression
+  testing of the SECURITY LABEL statement.  It is not intended
+  to be used in production.
+
+  Rationale
+
+  
+   The SECURITY LABEL statement allows the user to assign security
+   labels to database objects; however, security labels can only be assigned
+   when specifically allowed by a loadable module, so this module is provided
+   to allow proper regression testing.
+  
+
+  
+   Security label providers intended to be used in production will typically be
+   dependent on a platform-specific feature such as
+   SE-Linux.  This module is platform-independent,
+   and therefore better-suited to regression testing.
+  
+
+  Usage
+
+  
+   Here's a simple example of usage:
+  
+
+
+# postgresql.conf
+shared_preload_libraries = 'dummy_label'
+
+
+
+postgres=# CREATE TABLE t (a int, b text);
+CREATE TABLE
+postgres=# SECURITY LABEL ON TABLE t IS 'classified';
+SECURITY LABEL
+
+
+  
+   The dummy_seclabel provides only four hardcoded
+   labels: unclassified, classified,
+   secret, top secret and trusted.
+
+   It does not allow any other strings as security labels.
+  
+  
+   These labels are not used to enforce access controls.  They are only used
+   to check whether the SECURITY LABEL statement works as expected,
+   or not.
+  
+
+  Author
+
+  
+   KaiGai Kohei [email protected]
+  
+
+
index 9b1de856b0038ade1379e17dd9c9956bf7c8f287..39cfcee9617600dbd09b1d48021549da01b2edfc 100644 (file)
 
 
 
+