summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNalin Dahyabhai <nalin.dahyabhai@pobox.com>2008-06-10 17:21:44 -0400
committerNalin Dahyabhai <nalin.dahyabhai@pobox.com>2008-06-10 17:21:44 -0400
commit9f134ea09816cd53d75361dfc2299309ff33548b (patch)
treeade5083f2be5ce962efef007c592ee5dd4e6de7c
parentc2b16f1d6a251b5d5d4e59a7857a023273cd3a61 (diff)
downloadslapi-nis-9f134ea09816cd53d75361dfc2299309ff33548b.tar.gz
slapi-nis-9f134ea09816cd53d75361dfc2299309ff33548b.tar.xz
slapi-nis-9f134ea09816cd53d75361dfc2299309ff33548b.zip
more edits
-rw-r--r--doc/design.txt16
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/design.txt b/doc/design.txt
index de863af..c4a98bd 100644
--- a/doc/design.txt
+++ b/doc/design.txt
@@ -1,4 +1,4 @@
-=== Design Overview ===
+= Design Overview =
The NIS plugin module's aim is to serve up data from the directory
server using the NIS protocols. It does this by doing what any gateway
@@ -93,7 +93,7 @@ which is used to populate the map cache at startup-time, as well as to
watch for changes in the directory's contents which would need to be
reflected in the map cache.
-=== Components ===
+= Components =
== Protocol Handler ==
@@ -193,7 +193,9 @@ more than one "nis-base" value) for entries which match the provided
filter. Each entry found is then "added" to the map, using the format
specifier stored in "nis-key-format" to construct the key for the entry
in the map, with the corresponding value in the map being constructed
-using the format specifier given as the "nis-value-format".
+using the format specifier given as the "nis-value-format". The map is
+marked as a "secure" map according to the "nis-secure" attribute, if
+so set.
Should one of the directory server entries which was used to construct
one or more NIS map entries be modified or removed, the corresponding
@@ -244,8 +246,7 @@ sensible defaults for the maps which we expect to be commonly used --
this is important because it's easy to subtly construct malformed result
specifiers which could trigger undefined behavior on clients -- for
example by leaving the user's numeric UID empty in a passwd entry, which
-may be treated as "0" by inattentive clients. The "nis-secure" setting
-defaults to "no".
+may be treated as "0" by inattentive clients.
The format specifier includes function-like invocations to allow the
backend to be instructed to chase references to other entries, for
@@ -256,7 +257,7 @@ double-quoted arguments. and any arguments which contain a double-quote
need to escape the double-quote using a '\' character -- this character
itself also needs to be escaped whenever it appears.
-= Implemented Functions =
+=== Implemented Functions ===
* echo()
- Reproduces what it is given.
- Example:
@@ -363,4 +364,5 @@ The module additionally supports re-publishing the contents of the NIS
maps through a read-only virtual backend. The published results are
"flattened" to resemble the original RFC2307 schema so that naive
clients which expect a single directory server entry to contain all of
-the desired information about a user or group to make use of the data.]
+the desired information about a user or group to make use of data which
+might be stored in a more natural (LDAP-wise) representation elsewhere.]