From fb6e12faf7e0f8dde1e42b0904a019c30bd68779 Mon Sep 17 00:00:00 2001 From: jgg <> Date: Tue, 28 Dec 1999 05:33:04 +0000 Subject: [PATCH] Doc files --- web/doc-direct.html | 101 ++++++++++++++++++++++++++++++ web/doc-direct.wml | 59 +++++++++++++++++ web/doc-general.html | 81 ++++++++++++++++++++++++ web/doc-general.wml | 47 ++++++++++++++ web/doc-mail.html | 139 +++++++++++++++++++++++++++++++++++++++++ web/doc-mail.wml | 111 ++++++++++++++++++++++++++++++++ web/hostinfo.html | 6 +- web/login.html | 6 +- web/password.html | 71 +++++++++++++++++++++ web/password.wml | 31 +++++++++ web/searchform.html | 7 ++- web/searchform.wml | 2 + web/searchhelp.html | 6 +- web/searchresults.html | 6 +- web/update.html | 6 +- 15 files changed, 661 insertions(+), 18 deletions(-) create mode 100644 web/doc-direct.html create mode 100644 web/doc-direct.wml create mode 100644 web/doc-general.html create mode 100644 web/doc-general.wml create mode 100644 web/doc-mail.html create mode 100644 web/doc-mail.wml create mode 100644 web/password.html create mode 100644 web/password.wml diff --git a/web/doc-direct.html b/web/doc-direct.html new file mode 100644 index 0000000..2a6de07 --- /dev/null +++ b/web/doc-direct.html @@ -0,0 +1,101 @@ + + + +Debian GNU/Linux -- Direct LDAP Access + + + + + + + + + + + + + + + + + +
+ +Debian Project +
+Home +About Debian +News +Distribution +Support +Developers' Corner +Search +
+

Direct LDAP Access

+

+The LDAP utilities package provides a program called ldapsearch that can be +used to exectute direct queries to the database. Generally this is done by +putting +

+HOST db.debian.org
+BASE dc=debian,dc=org
+
+in ~/.ldaprc. Then queries can be performed, for instance +
+samosa{jgg}~#ldapsearch uid=wakkerma keyfingerprint
+uid=wakkerma,ou=users,dc=debian,dc=org
+keyfingerprint=38444C2CA6AD756EB4A2E5FA612AFF59
+keyfingerprint=576E100B518D2F1636B028053CB892502FA3BC2D
+
+Shows the PGP key finger prints for the wakkerma user. The first word +in the command is the query to perform, the rest of command line are the +attributes to return, if omitted then all readable attributes are returned. +More complicated queries are possible, for instance: +
+samosa{jgg}~#ldapsearch '(&(!(loginshell=/bin/bash))(uid=*))' loginshell
+uid=admin,ou=users,dc=debian,dc=org
+
+uid=mryan,ou=users,dc=debian,dc=org
+loginshell=/usr/bin/tcsh
+
+uid=jkominek,ou=users,dc=debian,dc=org
+loginshell=/usr/bin/zsh
+
+uid=caelum,ou=users,dc=debian,dc=org
+loginshell=/usr/bin/zsh
+[..]
+
+Shows users that do not use bash as their shell. Some other interesting +queries are: + +RFC 2254 +has more information about the filter expressions. +

Other LDAP Browsers

+

+The GQ package has a graphical LDAP browser that can browse the debian.org +tree. It is somewhat ungainly with the large number of entries in our +directory, but it does work nonetheless. Configuration is similar, use the +preferences dialog to add a new host with the information given above. +

+Netscape has a browser for their mailer, but I have never been able to get +it to work, please email if you have any luck. +

+To my knowledge there are no interfaces for popular mailers like mutt and +gnus. Such an interface would allow using the directory as an enhanced address +book. +


+

Back to the Debian Project homepage. +


+You can contact us at admin@db.debian.org.

+Last Modified: Tue, Dec 28 06:03:51 UTC 1999
+Copyright © 1997-1999 SPI; See license terms + +
+ + diff --git a/web/doc-direct.wml b/web/doc-direct.wml new file mode 100644 index 0000000..1142722 --- /dev/null +++ b/web/doc-direct.wml @@ -0,0 +1,59 @@ +#use wml::debian::template title="Direct LDAP Access" +

+The LDAP utilities package provides a program called ldapsearch that can be +used to exectute direct queries to the database. Generally this is done by +putting +

+HOST db.debian.org
+BASE dc=debian,dc=org
+
+in ~/.ldaprc. Then queries can be performed, for instance +
+samosa{jgg}~#ldapsearch uid=wakkerma keyfingerprint
+uid=wakkerma,ou=users,dc=debian,dc=org
+keyfingerprint=38444C2CA6AD756EB4A2E5FA612AFF59
+keyfingerprint=576E100B518D2F1636B028053CB892502FA3BC2D
+
+Shows the PGP key finger prints for the wakkerma user. The first word +in the command is the query to perform, the rest of command line are the +attributes to return, if omitted then all readable attributes are returned. +More complicated queries are possible, for instance: +
+samosa{jgg}~#ldapsearch '(&(!(loginshell=/bin/bash))(uid=*))' loginshell
+uid=admin,ou=users,dc=debian,dc=org
+
+uid=mryan,ou=users,dc=debian,dc=org
+loginshell=/usr/bin/tcsh
+
+uid=jkominek,ou=users,dc=debian,dc=org
+loginshell=/usr/bin/zsh
+
+uid=caelum,ou=users,dc=debian,dc=org
+loginshell=/usr/bin/zsh
+[..]
+
+Shows users that do not use bash as their shell. Some other interesting +queries are: + +RFC 2254 +has more information about the filter expressions. + +

Other LDAP Browsers

+

+The GQ package has a graphical LDAP browser that can browse the debian.org +tree. It is somewhat ungainly with the large number of entries in our +directory, but it does work nonetheless. Configuration is similar, use the +preferences dialog to add a new host with the information given above. +

+Netscape has a browser for their mailer, but I have never been able to get +it to work, please email if you have any luck. +

+To my knowledge there are no interfaces for popular mailers like mutt and +gnus. Such an interface would allow using the directory as an enhanced address +book. diff --git a/web/doc-general.html b/web/doc-general.html new file mode 100644 index 0000000..1527f87 --- /dev/null +++ b/web/doc-general.html @@ -0,0 +1,81 @@ + + + +Debian GNU/Linux -- General LDAP Documentation + + + + + + + + + + + + + + + + + +
+ +Debian Project +
+Home +About Debian +News +Distribution +Support +Developers' Corner +Search +
+

General LDAP Documentation

+

+debian.org uses a single LDAP driven directory for account managment across +all the project run machines. This directory +also provides services for leaving vacation notices, updating +xplanet coordinates, +email forwarding, ssh authentication keys and other information. +

+Note: master and va do not presently use the LDAP directory. Only lully +uses replicated SSH RSA authentication keys and master does not use the +email forwarding field (but all other machines do) +

Security and Privacy

+Three levels of information security are provided by the database. The first +is completely public information that anyone can see either by issuing an +LDAP query or by visiting the web site. The next level is "maintainer-only" +information that requires authentication to the directory before it can be +accessed. The final level is admin-only or user-only information; this +information can only be viewed by the user or an administrator. +

+Maintainer-only information includes precise location information +[postalcode, postal address, lat/long] telephone numbers, and the vacation +message. +

+Admin-only/user-only information includes email forwarding, ssh keys and +the encrypted password. Note that email forwarding is necessarily publicly +viewable from accounts on the actual machines. +

+Entries in the directory are keyed to the developers PGP key, whoever has that +key can make any change to the directory through the mail interface. +

Access

+The directory has several means to access it: + +
+

Back to the Debian Project homepage. +


+You can contact us at admin@db.debian.org.

+Last Modified: Tue, Dec 28 05:58:00 UTC 1999
+Copyright © 1997-1999 SPI; See license terms + +
+ + diff --git a/web/doc-general.wml b/web/doc-general.wml new file mode 100644 index 0000000..50962bd --- /dev/null +++ b/web/doc-general.wml @@ -0,0 +1,47 @@ +#use wml::debian::template title="General LDAP Documentation" +

+debian.org uses a single LDAP driven directory for account managment across +all the project run machines. This directory +also provides services for leaving vacation notices, updating +xplanet coordinates, +email forwarding, ssh authentication keys and other information. + +

+Note: master and va do not presently use the LDAP directory. Only lully +uses replicated SSH RSA authentication keys and master does not use the +email forwarding field (but all other machines do) + +

Security and Privacy

+Three levels of information security are provided by the database. The first +is completely public information that anyone can see either by issuing an +LDAP query or by visiting the web site. The next level is "maintainer-only" +information that requires authentication to the directory before it can be +accessed. The final level is admin-only or user-only information; this +information can only be viewed by the user or an administrator. + +

+Maintainer-only information includes precise location information +[postalcode, postal address, lat/long] telephone numbers, and the vacation +message. + +

+Admin-only/user-only information includes email forwarding, ssh keys and +the encrypted password. Note that email forwarding is necessarily publicly +viewable from accounts on the actual machines. + +

+Entries in the directory are keyed to the developers PGP key, whoever has that +key can make any change to the directory through the mail interface. + +

Access

+The directory has several means to access it: + + +

+Lost or forgotten password instructions diff --git a/web/doc-mail.html b/web/doc-mail.html new file mode 100644 index 0000000..1730fe6 --- /dev/null +++ b/web/doc-mail.html @@ -0,0 +1,139 @@ + + + +Debian GNU/Linux -- LDAP Gateway + + + + + + + + + + + + + + + + + +
+ +Debian Project +
+Home +About Debian +News +Distribution +Support +Developers' Corner +Search +
+

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 +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 +that are implemented by the gateway: ping, new password and +changes. The function to act on is the first argument to the program. +

+Error handling is currently done by generating a bounce message and passing +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 +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. +

New Password

+If a user looses their password they can request that a new one be generated +for them. This is done by sending the phrase "Please change my Debian +password" to chpasswd@db.debian.org. The phrase is required to prevent the +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 +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. + +After processing the requests the daemon will generate a report which contains +each input command and the action taken. If there are any parsing errors +processing stops immediately, but valid changes up to that point are +processed. +

Notes

+

+In this document PGP refers to any message or key that GnuPG is +able to generate or parse, specificaly it includes both PGP2.x and OpenPGP +(aka GnuPG) keys. +

+Due to the replay cache the clock on the computer that generates the +signatures has to be accurate to at least one day. If it is off by several +months or more then the deamon will outright reject all messages. +

+Examples are given using GnuPG, but PGP 2.x can also be used. The correct +options to generate a clear signed ascii armored message in 'filter' mode +are pgp -fast which does the same as gpg --clearsign +

+Debian.org machines rely on secured replication to transfer login data out +of the database. Replication is performed at 15 min intervals so it can take +a short while before any changes made take effect. +


+

Back to the Debian Project homepage. +


+You can contact us at admin@db.debian.org.

+Last Modified: Mon, Dec 27 23:38:30 UTC 1999
+Copyright © 1997-1999 SPI; See license terms + +
+ + diff --git a/web/doc-mail.wml b/web/doc-mail.wml new file mode 100644 index 0000000..9f0a7d8 --- /dev/null +++ b/web/doc-mail.wml @@ -0,0 +1,111 @@ +#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 +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 +that are implemented by the gateway: ping, new password and +changes. The function to act on is the first argument to the program. + +

+Error handling is currently done by generating a bounce message and passing +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 +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. + +

New Password

+If a user looses their password they can request that a new one be generated +for them. This is done by sending the phrase "Please change my Debian +password" to chpasswd@db.debian.org. The phrase is required to prevent the +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 +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. + + + +After processing the requests the daemon will generate a report which contains +each input command and the action taken. If there are any parsing errors +processing stops immediately, but valid changes up to that point are +processed. + +

Notes

+

+In this document PGP refers to any message or key that GnuPG is +able to generate or parse, specificaly it includes both PGP2.x and OpenPGP +(aka GnuPG) keys. +

+Due to the replay cache the clock on the computer that generates the +signatures has to be accurate to at least one day. If it is off by several +months or more then the deamon will outright reject all messages. +

+Examples are given using GnuPG, but PGP 2.x can also be used. The correct +options to generate a clear signed ascii armored message in 'filter' mode +are pgp -fast which does the same as gpg --clearsign +

+Debian.org machines rely on secured replication to transfer login data out +of the database. Replication is performed at 15 min intervals so it can take +a short while before any changes made take effect. diff --git a/web/hostinfo.html b/web/hostinfo.html index c63b7ea..38fbd02 100644 --- a/web/hostinfo.html +++ b/web/hostinfo.html @@ -8,8 +8,8 @@ - - + + @@ -54,7 +54,7 @@

Back to the Debian Project homepage.


You can contact us at admin@db.debian.org.

-Last Modified: Thu, Sep 30 05:36:01 UTC 1999
+Last Modified: Thu, Sep 30 05:38:06 UTC 1999
Copyright © 1997-1999 SPI; See license terms
diff --git a/web/login.html b/web/login.html index 7e292e4..0f48d67 100644 --- a/web/login.html +++ b/web/login.html @@ -8,8 +8,8 @@ - - + +

@@ -52,7 +52,7 @@ You can also access the pages securely
<

Back to the Debian Project homepage.


You can contact us at admin@db.debian.org.

-Last Modified: Wed, Nov 24 06:29:30 UTC 1999
+Last Modified: Thu, Nov 25 07:35:32 UTC 1999
Copyright © 1997-1999 SPI; See license terms
diff --git a/web/password.html b/web/password.html new file mode 100644 index 0000000..3ec383f --- /dev/null +++ b/web/password.html @@ -0,0 +1,71 @@ + + + +Debian GNU/Linux -- Lost or Forgotten password + + + + + + + + + + +

+ + + + + + +
+ +Debian Project +
+Home +About Debian +News +Distribution +Support +Developers' Corner +Search +
+

Lost or Forgotten password

+

+If you have lost or forgotten your LDAP password (and by extension, your +machine login password) you can have it reset by sending a PGP signed +message to the mail gateway: +

+echo "Please change my Debian password" | gpg --clearsign | mail chpasswd@db.debian.org
+echo "Please change my Debian password" | pgp -fast | mail chpasswd@db.debian.org
+
+The daemon will then respond with a new randomized password encrypted +with your key. You can then use the +SSL Web pages to change your +password to something you can remember. You cannot set a new password via the +mail gateway. +

+Alternatively, you can do without a password and use PGP to manipulate your +LDAP information through the mail gateway and use +SSH RSA Authentication to access the servers. To setup OpenSSH for RSA you +need to first generate a private RSA key using ssh-keygen and select +a good password for it. Then send the public portion of the key to the LDAP +directory: +

+gpg --clearsign < ~/.ssh/identity.pub | mail change@db.debian.org
+
+You can then use this key to authenticate to the machines. Using ssh-agent +(automatically run by Debian's X configuration) you can use ssh-add to 'cache' +your password once. Note: Very few +machines have the patched SSH required to support this yet. +
+

Back to the Debian Project homepage. +


+You can contact us at admin@db.debian.org.

+Last Modified: Tue, Dec 28 06:19:17 UTC 1999
+Copyright © 1997-1999 SPI; See license terms + +
+ + diff --git a/web/password.wml b/web/password.wml new file mode 100644 index 0000000..efe8da3 --- /dev/null +++ b/web/password.wml @@ -0,0 +1,31 @@ +#use wml::debian::template title="Lost or Forgotten password" +

+If you have lost or forgotten your LDAP password (and by extension, your +machine login password) you can have it reset by sending a PGP signed +message to the mail gateway: +

+echo "Please change my Debian password" | gpg --clearsign | mail chpasswd@db.debian.org
+or
+echo "Please change my Debian password" | pgp -fast | mail chpasswd@db.debian.org
+
+The daemon will then respond with a new randomized password encrypted +with your key. You can then use the +SSL Web pages to change your +password to something you can remember. You cannot set a new password via the +mail gateway. + +

+Alternatively, you can do without a password and use PGP to manipulate your +LDAP information through the mail gateway and use +SSH RSA Authentication to access the servers. To setup OpenSSH for RSA you +need to first generate a private RSA key using ssh-keygen and select +a good password for it. Then send the public portion of the key to the LDAP +directory: +

+gpg --clearsign < ~/.ssh/identity.pub | mail change@db.debian.org
+
+You can then use this key to authenticate to the machines. Using ssh-agent +(automatically run by Debian's X configuration) you can use ssh-add to 'cache' +your password once. Note: Very few +machines have the patched SSH required to support this yet. + diff --git a/web/searchform.html b/web/searchform.html index bfa57a1..d40113d 100644 --- a/web/searchform.html +++ b/web/searchform.html @@ -8,8 +8,8 @@ - - + + @@ -311,11 +311,12 @@ settings


Debian development machines

+

Documentation


Back to the Debian Project homepage.


You can contact us at admin@db.debian.org.

-Last Modified: Wed, Nov 24 06:27:39 UTC 1999
+Last Modified: Tue, Dec 28 06:09:33 UTC 1999
Copyright © 1997-1999 SPI; See license terms
diff --git a/web/searchform.wml b/web/searchform.wml index 3898135..d41a72e 100644 --- a/web/searchform.wml +++ b/web/searchform.wml @@ -278,3 +278,5 @@ settings


Debian development machines

+

Documentation

+

Lost or forgotten password instructions

diff --git a/web/searchhelp.html b/web/searchhelp.html index 981cc57..b06ba5c 100644 --- a/web/searchhelp.html +++ b/web/searchhelp.html @@ -8,8 +8,8 @@ - - + +
@@ -49,7 +49,7 @@ message.

Back to the Debian Project homepage.


You can contact us at admin@db.debian.org.

-Last Modified: Thu, Sep 23 03:51:58 UTC 1999
+Last Modified: Thu, Sep 23 03:53:03 UTC 1999
Copyright © 1997-1999 SPI; See license terms
diff --git a/web/searchresults.html b/web/searchresults.html index 0fa299b..b910d64 100644 --- a/web/searchresults.html +++ b/web/searchresults.html @@ -8,8 +8,8 @@ - - + +

@@ -67,7 +67,7 @@ searchresults?>

Back to the Debian Project homepage.


You can contact us at admin@db.debian.org.

-Last Modified: Sat, Sep 25 01:13:40 UTC 1999
+Last Modified: Sat, Sep 25 01:15:43 UTC 1999
Copyright © 1997-1999 SPI; See license terms
diff --git a/web/update.html b/web/update.html index 8253953..e27d254 100644 --- a/web/update.html +++ b/web/update.html @@ -8,8 +8,8 @@ - - + +

@@ -379,7 +379,7 @@

Back to the Debian Project homepage.


You can contact us at admin@db.debian.org.

-Last Modified: Sat, Sep 25 00:34:38 UTC 1999
+Last Modified: Sat, Sep 25 01:07:50 UTC 1999
Copyright © 1997-1999 SPI; See license terms
-- 2.20.1