annotate mod_seclabels.wiki @ 292:7699308b4f9b

Add
author Kim Alvefur <zash@zash.se>
date Fri, 13 Jul 2012 15:02:26 +0200
parents a00ce355e07b
children 057b3e34e24c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
230
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 #summary Security Labels
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 #labels Stage-Alpha
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 = Introduction =
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 This module implements [http://xmpp.org/extensions/xep-0258.htmla XEP-0258: Security Labels in XMPP].
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 = Configuration =
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 As with all modules, you enable it by adding it to the modules_enabled list.
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 {{{
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 modules_enabled = {
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 ...
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 "seclabels";
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 ...
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 }
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 }}}
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 These options exist:
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 || *Name* || *Description* || *Default* ||
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 || security_catalog_name || Catalouge name || "Default" ||
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 || security_catalog_desc || Catalouge description || "My labels" ||
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 You can then add your labels in a table called security_labels. They can be both orderd and unorderd, but ordered comes first.
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 {{{
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 security_labels = {
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 { -- This label will come first
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 name = "Public",
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 label = true, -- This is a label, but without the actual label.
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33 default = true -- This is the default label.
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 },
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35 {
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36 name = "Private",
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37 label = "PRIVATE",
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38 color = "white",
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39 bgcolor = "blue"
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40 },
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41 Sensitive = { -- A Sub-selector
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
42 SECRET = { -- The index is used as name
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43 label = true
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
44 },
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
45 TOPSECRET = { -- The order of this and the above is not guaranteed.
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
46 color = "red",
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
47 bgcolor = "black",
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
48 }
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
49 }
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
50 }
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
51 }}}
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
52
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
53
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
54 Each label can have the following properties:
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
55
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
56 || *Name* || *Description* || *Default* ||
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
57 || name || The name of the label. Used for selector. || Required. ||
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
58 || label || The actual label, ie <esssecuritylabel/> || Required, can be boolean for a empty label, or a string. ||
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
59 || display || The text shown as display marking. || Defaults to the name ||
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
60 || color, bgcolor || The fore- and background color of the display marking || None ||
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
61 || default || Boolean, true for the default. Only one may be default. || false ||
a00ce355e07b Add page about mod_seclabels.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
62