X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=web%2Fdoc-mail.wml;h=4da0f8fb2196e82d5af694a9cc008802f9af2e9e;hb=205ad9a922a6940ad5c85104f3fd08c5b4874138;hp=9f0a7d8acc7034a5f569087342878caf6cf4e482;hpb=fb6e12faf7e0f8dde1e42b0904a019c30bd68779;p=mirror%2Fuserdir-ldap.git
diff --git a/web/doc-mail.wml b/web/doc-mail.wml
index 9f0a7d8..4da0f8f 100644
--- a/web/doc-mail.wml
+++ b/web/doc-mail.wml
@@ -1,14 +1,14 @@
#use wml::debian::template title="LDAP Gateway"
The LDAP directory has a PGP secured mail gateway that
-allows users to safely and conviently effect changes to their entries. It
-makes use of PGP signed input messages to positivly identify the user and
+allows users to safely and conveniently effect changes to their entries. It
+makes use of PGP signed input messages to positively identify the user and
to confirm the validity of the request. Furthermore it implements a replay
cache that prevents the gateway from accepting the same message more than
once.
-There are three functions logically split into 3 sperate email addresses
+There are three functions logically split into 3 seperate email addresses
that are implemented by the gateway: ping, new password and
changes. The function to act on is the first argument to the program.
@@ -18,7 +18,7 @@ descriptive error text to the mailer. This can generate a somewhat hard to
read error message, but it does have all the relevent information.
Ping
-The ping command simply returns the users public record. It is usefull for
+The ping command simply returns the users public record. It is useful for
testing the gateway and for the requester to get a basic dump of their
record. In future this address might 'freshen' the record to indicate the
user is alive. Any PGP signed message will produce a reply.
@@ -31,22 +31,23 @@ daemon from triggering on arbitary signed email. The best way to invoke this
feature is with
echo "Please change my Debian password" | gpg --clearsign | mail chpasswd@db.debian.org
After validating the request the daemon will generate a new random password,
-set it in the directory and respond with an ecrpyted message containing the
+set it in the directory and respond with an encrpyted message containing the
new password. The password can be changed using one of the other interface
methods.
Changes
-An address is provided for making almost arbitary changes to the contents of
-the record. The daemon parse its input line by line and acts on each line in
-a command oriented manner. Anything, except for passwords, can be changed
-using this mechanism. Note however that because this is a mail gateway it
-does stringent checking on its input. The other tools allow fields to be set
-to virtually anything, the gateway requires specific field formats to be met.
+An address (changes@db.debian.org) is provided for making almost arbitary
+changes to the contents of the record. The daemon parses its input line by
+line and acts on each line in a command oriented manner. Anything, except for
+passwords, can be changed using this mechanism. Note however that because
+this is a mail gateway it does stringent checking on its input. The other
+tools allow fields to be set to virtually anything, the gateway requires
+specific field formats to be met.
- A line of the form 'field: value' will change the contents of
the field to value. Some simple checks are performed on value to make sure
-that it is not sent to nonsense. The values that can be changed are:
+that it is not set to nonsense. The values that can be changed are:
c, l, facsimiletelephonenumber, telephonenumber,
postaladdress, postalcode,
loginshell, emailforward, ircnick, onvacation,
@@ -84,7 +85,7 @@ be sent at once. The debian.net zone is only reloaded once per day at
midnight -0700.
- If the single word show appears on a line then a PGP encrypted version
-of the entire record will be attached to the result email.
+of the entire record will be attached to the resulting email.
After processing the requests the daemon will generate a report which contains